CCH Central and Workflow Version Release Notes

Transcription

1 CCH Central and Workflow Version Release Notes

2 Legal Notice Disclaimer Wolters Kluwer (UK) Limited has made every effort to ensure the accuracy and completeness of these Release Notes. However, Wolters Kluwer (UK) Limited, its staff and agents will not be liable for any errors or omissions and use of the software is subject to the customer s licence with Wolters Kluwer (UK) Limited. These Release Notes should not be relied upon as a detailed specification of the system or the software. Wolters Kluwer (UK) Limited may make changes to these Release Notes from time to time. Copyright These Release Notes may not be copied, altered, edited, disposed of or distributed without the prior consent of Wolters Kluwer (UK) Limited. The content is confidential. Unless indicated otherwise all elements of this software product are owned by Wolters Kluwer (UK) Ltd Wolters Kluwer (UK) Limited Trademark Rights Microsoft, Windows, Windows NT, Windows for Workgroups, Windows 98, 2000, XP, MS- DOS, Windows Vista, Windows 7, Windows 8, Windows 10, Windows Server, Microsoft SQL Server, and Microsoft Office, are either registered trademarks or trademarks of Microsoft Corporation. Novell and NetWare are trademarks of Novell Inc. Citrix MetaFrame is a registered trademark or trademarks of Citrix Systems, Inc. All rights reserved. All other trademarks are the property of their respective owners. Wolters Kluwer (UK) Limited 145 London Road, Kingston Upon Thames, Surrey KT2 6SR CCH CENTRAL AND WORKFLOW OCTOBER 2017 II

3 Contents Release Highlights 1 Prerequisites 1 1. Software Enhancements 2 CCH Central CCH Central User Interface - Classic View has been removed Recurring Tasks Add Job Enhancements on the Preview Panel Tasks Homepage control Employee Department Add Photo on Clients or Contacts 9 CCH Workflow Workflow Wizard Enhancements on the Workflow Log console Enhancements on the Workflow Service console Enhancements on the Queue console Assignment Jobs workflows - New Custom Reference Dates and Date Rules Assignment Template Workflow settings Standard Workflows - Changes to Add new workflow Quality Improvements CCH Central CCH Workflow Known Issues CCH Central CCH Workflow System Administrator Workflow Wizard Configuration Key 22 III CCH CENTRAL AND WORKFLOW OCTOBER 2017

4

5 Release Highlights This release contains the following items: Recurring Tasks Enhancements on the Workflow Management Console Other enhancements Fault fixes Full details of these changes are included within this document. Prerequisites Installing CCH Central and Workflow This release is installed using the Central Suite Installer. This ensures that all prerequisites are in place and that all the products for which you are licenced are installed in the correct sequence. You can find out more about the Central Suite Installer here: 1 CCH CENTRAL AND WORKFLOW OCTOBER 2017

6 1. Software Enhancements CCH Central 1.1 CCH Central User Interface - Classic View has been removed In this release, the CCH Central User Interface is set to use only the Ribbon mode at Practice and Employee level and the Classic View is no longer available. Note: The employee that logs into Central to perform the database upgrade for and that had set the classic mode, will still have the classic mode set the first time when he logs into Central after the database upgrade is finished. The next time when that employee will log into Central, the Ribbon mode will be turned on. The configuration key, Ribbon, which enabled/disabled the Ribbon mode in the previous versions and the Enable/Disable Ribbon option from the Support tab within the ribbon has been removed. 1.2 Recurring Tasks In this release, users can schedule repeating tasks without the need to re-create the tasks every time they need to work on them. When a task is marked as completed, the next task is automatically generated based on the repeating pattern that was set up in the completed task. Note: This functionality is available only for Central tasks which are created from the To Do tab within Client, Contact, Assignment, Employee, and Supplier. The recurring functionality is not available for Workflow, Document Management, and Practice Management tasks. To create a recurring task on a client, contact, assignment, employee, or supplier: 1. Open the client/contact/assignment/employee/supplier. 2. Select the To Do tab. 3. Click on the Tasks option from the ribbon and select the task type to create a new task or open an existing Central task from the To Do grid or the Tasks Home Page control. CCH CENTRAL AND WORKFLOW OCTOBER

7 4. The Task dialog will open: 5. To create a recurring task, tick the new option, Recurring, located in the right side of the Notes section within the Task dialog. 6. From the Frequency list, select Weekly, Monthly, Quarterly, or Annual. 7. The Date Next can be edited and represents the Start Time of the next task. It is automatically populated depending on the selected frequency and on the Start Time of the current task. For example, if the current task has the Start Time on 9 th of October and the selected frequency is Monthly, then the recurring task will be created with the Start Time on 9 th of November. 3 CCH CENTRAL AND WORKFLOW OCTOBER 2017

8 8. Mark the current task as completed. The next task is automatically generated based on the repeating pattern that was set up in the previous task. On the new crated task: The Subject is the same as on the previous task. The Date field is populated with the date when the task was created. The Start Time and the End Time are populated with the Date Next set in the previous task. The Recurring option is ticked by default. The Frequency is populated by default with the frequency set in the previous task. The Date Next is automatically populated depending on the selected frequency and on the Start Time of the current task. 1.3 Add Job Two new fields, Start Date and Hours, have been added to the Add Job/Schedule dialog: CCH CENTRAL AND WORKFLOW OCTOBER

9 The Hours set on the job are used within the Employee Planner when tasks are allocated to employees. The Start Date set on the job is used to calculate the Planned hours within the Employee Budget Homepage control. Note: The Hours field from the Add/Edit Job/Schedule is a numerical field and users can add only whole numbers. When a job is rolled forward using either the Job Roll Forward option from the right click menu on the job or the Job Roll Forward workflow activity, the value entered in the Hours field from the actual job is rolled forward on the new job with the same value. The Start Date on a job that is roll forward will come from the Frequency set on assignment plus the Start Date from the prior job. If a job that belongs to a quarterly assignment is rolled forward the Start Date on the job will be advanced by one quarter. Note: To allocate work on an employee from a Job within the Employee Planner screen, please refer to the CCH Practice Management Release Notes. 5 CCH CENTRAL AND WORKFLOW OCTOBER 2017

10 1.4 Enhancements on the Preview Panel In this release, the following enhancements have been made on the Preview Panel from Find Clients and Find Contacts screen: Users can view and open the tasks created on clients or contacts in the new section, Tasks, from the Preview Panel. The sections from the Preview Panel are now resizable Tasks on the Preview Panel A new section, Tasks, has been added near the Notes in the Preview Panel within Find Clients and Find Contacts screen, allowing users the ability to view and open the tasks created on clients or contacts. In the Tasks tab within the Preview Panel are displayed all the tasks created on the client or contact except the completed tasks. In the Tasks grid within the Preview Panel are displayed the following columns: Task Id: Displays the ID of the task. Subject: Displays the subject of the task. Status: Displays the status of the task (e.g. Not Started, Planned, etc) Due Date: Displays the End Time of the task. CCH CENTRAL AND WORKFLOW OCTOBER

11 Users can open and edit the task from the Tasks tab within the Preview Panel by clicking on the Subject: Resizable sections in the Preview Panel Users can now resize the sections from the Preview Panel: 1. In the Preview Panel, hover over any of the vertical borders that combines two sections until a double ended arrow appears: 2. When the arrow is visible, click and drag the arrow which will drag the border of the section. Do this to make the section larger or smaller. 7 CCH CENTRAL AND WORKFLOW OCTOBER 2017

12 1.5 Tasks Homepage control Employee Department A new field, Employee Department, has been added to the Tasks Homepage control and it displays the department set for the employee that has the task assigned. By default, Employee Department is available in the Field Chooser and it can be placed near any other column header from the Tasks grid. Users can group and sort the Tasks grid ascending or descending by Employee Department: CCH CENTRAL AND WORKFLOW OCTOBER

13 1.6 Add Photo on Clients or Contacts In this release, users can add a photo to the Client or Contact screen. By default, a blank box is displayed near the OK and Cancel buttons within the Client or Contact screen. To add a photo to a client s or contact s profile: 1. Open the client or the contact. 2. Right click on the blank box located in the top right section of the Client/Contact screen. Add Photo and Remove Photo options are displayed: 3. Select Add Photo. 4. From the Open dialog, navigate to the location where the image is located. 9 CCH CENTRAL AND WORKFLOW OCTOBER 2017

14 Note: Only JPG files can be added as photos to Client s or Contact s profile. 5. Select the image and click on Open. 6. The selected image is displayed on the Client or Contact screen: To remove the photo from the Client or Contact screen, right click on the image and select Remove Photo. CCH CENTRAL AND WORKFLOW OCTOBER

15 CCH Workflow 1.1 Workflow Wizard In the previous release, the Workflow Wizard functionality was by default disabled. In this release, the Workflow Wizard is by default available, so that the configuration key (WorkflowStandardDesignerWizardVisibility) that controls the visibility of the Workflow Wizard functionality is set to the value of 1 upon upgrade. For further information regarding setting up the configuration key, please refer to the System Administration section for Workflow Wizard Configuration key. Note: For more information on creating workflow templates using the Workflow Wizard, please read the Creating a Template using the Workflow Wizard section within the CCH Online Help. 1.2 Enhancements on the Workflow Log console The following enhancements have been made to the Workflow Log console: New fields are available in the Workflow Log and users have now more details about the running workflows, such as the employee who assigned the workflow, the client or the contact that has the workflow assigned, information specific to each workflow type and other details. The log messages related to stopping the Workflow Service has been improved and new informational and warning workflow log messages are available when progressing Client/Contact and Document activities Enhancements on the Workflow Log grid In this release, users can customize the Workflow Log grid using new fields which are by default available via the right click menu > Field Chooser: Client Name: Displays the name of the client or contact that have the workflow assigned. Employee ID: Displays the ID of the employee who assigned the workflow. Step Owner: Displays the name of the employee who has the workflow task assigned. Workflow Subject Details: Displays information specific to each Workflow Type: o Client/Contact: Displays the name of the client or contact that has the workflow assigned and it is a link to the Client screen > Workflow tab. o Assignment Jobs: Displays the name of the job that has the workflow assigned and opens the Client screen > Assignments tab. 11 CCH CENTRAL AND WORKFLOW OCTOBER 2017

16 o Document: Displays the ID of the document that has the workflow attached and it opens the Client screen > Document Centre tab. o Personal Tax: Displays the Tax Year and opens the corresponding Tax Return that has the workflow started. o Accounts Production: Displays the Accounts Production Period End Date and opens the Accounts Production screen corresponding to the workflow that is started on that period. o Corporation Tax: Displays the Period of Account End Date and opens the corresponding Tax Return that has the workflow started. Other fields that are available by default in the Field Chooser: Workflow Definition Id: Displays the id of the workflow. Workflow Instance Id: Displays the GUID of the workflow. Workflow Primary Key Id: Displays the Contact ID for Client/Contact, Assignment Jobs, Document, Personal Tax and Corporation Tax workflows. For Accounts Production workflows, it displays the workflow Instance ID. Workflow Subject Name: Displays the workflow type. (e.g. Client/Contact, Personal Tax, etc) Workflow Version: Displays the version of CCH Workflow in which the workflow was started. (e.g ) Activity Assembly: Displays details (e.g. dll s version) about the dll that is used. Activity Name: Displays the activity type. (e.g. Create document, Check assignment, etc) Exception: Displays more details in case an error occurs. It is populated only related to an error message. Logger: Displays the class that logged the message. CCH CENTRAL AND WORKFLOW OCTOBER

17 Process Name: Displays the name of the process that is executing. (e.g. Workflow.Server.Versioning.exe) Server Name: Displays the name of the machine where the Workflow Service is installed. Thread: Displays the executing thread ID. Note: The Workflow Current Step field has been removed from the Workflow Log Log messages improvements The Workflow Log console is an important diagnostic tool for understanding the behaviour of the application as well as troubleshooting any issue with the application and so, the messages logged in the Description column within the Workflow Log grid that are related to the Client/Contact and Document activities have been improved in this release, producing a positive effect on readability and usability. When a Client/Contact or a Document activity is progressed with success, in the Description field from the log are displayed informational messages that contain details about the progressed activity such as the activity type, the name of the activity, the document Id or the name of the client that has the workflow started. An example of a log message after a Central Task is progressed: An example of a log message after an automated Client/Contact activity (e.g. Check Business Type) is progressed with success: An example of a log message after the Document activity, Convert Doc to , is progressed with success: In case a Client/Contact or Document activity fails to progress, in the Description field from the log a warning message is displayed containing details about the activity and the reason the activity failed to progress. An example of a log message after an automated Client/Contact activity (e.g. Check Business Type) fails to progress: An example of a log message after an automated Document activity (e.g. Automated Lock) fails to progress: When the Workflow Service is manually stopped, the following message is displayed in the log: 13 CCH CENTRAL AND WORKFLOW OCTOBER 2017

18 Note: The new log messages are not displayed in the Log grid when progressing workflows started in a version prior to Enhancements on the Workflow Service console The following enhancements have been made to the Workflow Service console: If the Workflow Service is stopped, then a red background is displayed within the Workflow Service console with the Status: Workflow Service is not running. If the Workflow Service is not responding more than one minute, then a red background is displayed within the Workflow Service console with the Status: Workflow Service is not responding. CCH CENTRAL AND WORKFLOW OCTOBER

19 1.4 Enhancements on the Queue console Previously, the messages from the XML and Serialized queues were processed very fast (one message was processed in 5 milliseconds) so that if the number of messages from the queues was under 50, the XML and Serialized grids from the Queues console were not populated. In this release, we changed the way the messages from the queues are processed without affecting the performance. For example, if the Workflow Service is stopped while one or multiple workflows are progressed, the messages that remain in the Xml Queue until the Workflow Service starts again to process the messages are displayed in the XML Queue grid even if the number of messages is under Assignment Jobs workflows - New Custom Reference Dates and Date Rules Three new Workflow Custom Reference Dates have been created and are enabled for Assignment Jobs workflows: 31 January following job period end date Job period start date Job period end date Six new Date Rules have been created for use when creating new Assignment Jobs workflows: Job period start date Job period end date 1 month after Job period end date 6 months after Job period end date 11 months after Job period end date 31 January following Job period end date 15 CCH CENTRAL AND WORKFLOW OCTOBER 2017

20 1.6 Assignment Template Workflow settings Within the Assignment Template window, the Default Workflow column has been removed and replaced with a Workflow Tab, this allows multiple Assignment Jobs workflows to be assigned to an assignment. Note: The Assignment Jobs workflows that were set as Default Workflows within the Assignment Templates screen in a prior version, are displayed and marked as Default in the Available section within the Workflow tab. In this release, to start an Assignment Jobs workflow, users need to associate the workflow with the assignment template and then the workflow can be started on the job: 1. Select File > Maintenance > Assignment > Assignment Templates 1. Highlight the desired assignment template: e.g. Annual Accounts. 2. Select the Workflow tab. 3. Select a workflow template. 4. Move the workflow from the Unavailable to the Available section using the right arrow. 5. Repeat steps 3 and 4 to add more workflow templates. 6. Click OK to close the Assignment Templates screen. 7. Open the client. 8. Select the Assignments tab. 9. Highlight the job from the assignment that was created based on the assignment template that has Assignment Jobs workflows associated in the Assignment Templates screen. 10. Right click on the job, then select Start Workflow. 11. Select the workflow and click OK. Note: The Assignment Jobs workflows that are not associated with an assignment template cannot be started on a job. Those workflows are not displayed in the Start Workflow dialog from the job. 1.7 Standard Workflows - Changes to Add new workflow The following changes have been made to the Add new workflow window: Type: This was previously Subject and moved to be the first selection option Deadline Date Type: Defaults to Offset Date CCH CENTRAL AND WORKFLOW OCTOBER

21 The same changes are visible in the Step 1 of the Workflow Wizard, Details tab: 17 CCH CENTRAL AND WORKFLOW OCTOBER 2017

22 2. Quality Improvements 2.1 CCH Central The following quality issues were resolved in CCH Central : Extra Fields are not visible on clients for all employees Previously, if an employee group, for example Central Basic User, had the Can Modify option ticked for an Extra Field Group within the Extra Field Security screen, then the extra fields that belong to that group were not visible on the clients for the employees that belong to other employee groups. 2.2 CCH Workflow The following quality issues were resolved in CCH Workflow : ITS/ Filtered Workflows Homepage Control displays Team Security Restricted clients in error Previously, if a workflow was attached to a client that had the Apply Team Security option ticked in the Responsibility tab and if a filter was applied on the Workflow Homepage control, the employee that was not part of the client team security could view the workflow attached to the restricted client in the Workflow Homepage control ITS/56705 Terminated workflows when reaching the Create Document activity after the update Previously, the workflows started in a version prior to were terminated when the Create Document activity was reached ITS/ Filtered WF HP control > Select Employee step appears completed and workflow is terminated if the step is progressed (since ) In the previous version, if a filter was applied on the Workflow Homepage control and if the step in progress required the selection of an employee, the Select Employee step was displayed as a normal step and if that step was completed the workflow was terminated ITS/ Workflows Homepage Control fails when displaying over 9000 records in Use Icon mode The performance of the Workflow Homepage control with high volume of records (more than 9000) has been improved. CCH CENTRAL AND WORKFLOW OCTOBER

23 2.1.5 Workflow Wizard - Step Properties - Mandatory missing information was displayed until focusing on another step Previously, when selecting the Next button on the Step Properties tab within the Workflow Wizard after completing the mandatory information on the last step of the workflow, a validation message dialog was displayed until focusing on another step from the grid Workflow Wizard - The Pass/Fail automated activities have a single outcome Previously, the properties of the Pass/Fail automated activities (Workflow Launcher, Job Roll Forward, Check Assignment, Create Document, Publish Document to Portal, Convert doc to ) were displayed with a single outcome within the Workflow Wizard Workflow Wizard - Index Out of range error when using the Workflow Launcher step Previously, if the Workflow Wizard was run to create a workflow that contained the Workflow Launcher activity, an Index Out of range error message was displayed at the end of the wizard and the workflow was not properly saved Workflow Wizard - Workflows cannot be deleted or edited Previously, a workflow created with the Workflow Wizard and not started on a client, could not be deleted or edited when using right click > Edit option on the workflow name within the Standard Workflows screen and a warning message was displayed Convert doc to activity fails to progress if the client s address is ended with more than three characters Previously, if the client s address contained more than three characters in the end, for example test@qa.partners, then the workflow activity Convert doc to failed to progress WorkflowServiceConfiguration key from dbo.productconfiguration table is not properly updated when stopping the service Previously, the details like LastShutDownDate or IsRunning from the WorkflowServiceConfiguration key within the dbo.productconfiguration table, were not updated properly when the Workflow Service was stopped. 19 CCH CENTRAL AND WORKFLOW OCTOBER 2017

24 3. Known Issues 3.1 CCH Central Recurring option is available on the existing Document Management and Practice Management tasks The Recurring option is available on the Document Management and Practice Management tasks created prior to Recurring option is not available in Assignment > Task screen If the Assignment Task is opened from Assignment Details screen > Home tab > Tasks and Appointments grid, then the Recurring option is not available Preview Panel - The modifications made to the size of the sections are not saved if the Find Clients or Find Contacts screen is closed and reopened When the sections from the Preview Panel are resized, the modifications made are not retained if the Find Clients or Find Contacts screen is closed and then reopened Add Job dialog with Frequency: Year or without Frequency Job field is displaying only the current year When adding a new job on an assignment that has the Frequency: Annual with the Algorithm: YYYY or an assignment that does not have a frequency set, then the Job field from the Add Job dialog is displaying only the current year. 3.2 CCH Workflow Workflow Wizard Cannot change the type of the End of Workflow step The End of Workflow step cannot be changed from Central Task to another step type when using the Workflow Wizard Workflow Homepage control > Filter returns error if it is applied on workflows that contains Central Due Date Task in progress If the filter that is applied on the Workflow Homepage control should return records related to Central Due Date activities that are in progress, an error during data refresh message is displayed. CCH CENTRAL AND WORKFLOW OCTOBER

25 3.2.3 Workflow Log - Same message is displayed three times in the log when starting/resuming workflows When a workflow is started, resumed, or cancelled, the related message is displayed three times in the Workflow Log console. 21 CCH CENTRAL AND WORKFLOW OCTOBER 2017

26 4. System Administrator 4.1 Workflow Wizard Configuration Key The ability to turn on or off the Workflow Wizard functionality is controlled by the WorkflowStandardDesignerWizardVisibility configuration key which is automatically created with the default value of 1 upon upgrade under Maintenance > User Defined > Configuration. Key Value Comments WorkflowStandardDesignerWizardVisibility 1 The Workflow Wizard is available in the system. WorkflowStandardDesignerWizardVisibility 0 The Workflow Wizard is not available in the system. Note - Exit out of CCH Central once the Key Name and Key Value has been entered. Upon reentry, the configuration key is active. CCH CENTRAL AND WORKFLOW OCTOBER