startConfiguration Keys
How To

Configuration Keys

CCH Workflow
Last update: Reading time 3 minutes
ConfigurationWorkflow Management

    The following configuration key is used within CCH Workflow and is created upon upgrade.​  To amend the following configuration key, navigate to Maintenance > User Defined > Configuration:

    Service Nag

    The purpose of this configuration key is to allow you to hide the following two Workflow service messages, which are received when accessing CCH Central;  'CCH Workflow Service is either not installed or updated to the latest version' and the 'CCH Workflow service has been manually stopped'.

    Key Name

    Key Value

    Comments

    WorkflowServiceNagDisabled

    0

    The two Workflow service nags are enabled

    WorkflowServiceNagDisabled

    		 1

    The two Workflow service nags are disabled

    The key value being set to 0 or not present results in no change to the application.

    Note: Exit out of CCH Central once the relevant information has been entered.  Upon re-entry, the new value is active.

    Control the number of workflow log items

    The WorkflowLoggerMaxDays configuration key, which is automatically created with the default value of 0 upon upgrade, enable practices to set the maximum number of days the log item records are kept within the WF.Log table under File > Maintenance > User Defined > Configuration.

    Key Value

    Comments

    WorkflowLoggerMaxDays

    0

    0 means the records are not deleted due to age.

    WorkflowLoggerMaxDays

    1 or any other value

    Set the maximum number of days the log item records are kept.

    The WorkflowLoggerMaxRows configuration key, which is automatically created with the default value of 1000 upon upgrade, enable practices to set the maximum number of rows in the log table (WF.Log) under File > Maintenance > User Defined > Configuration.

    Key Value

    Comments

    WorkflowLoggerMaxRows

    0

    0 means the records are not deleted due to the number of records.

    WorkflowLoggerMaxRows

    1000

    Set the maximum number of rows in the log table.

    The WorkflowLoggerPollIntervalSeconds configuration key, which is automatically created with the default value of 300 upon upgrade, enable practices to set the poll interval in seconds for the workflow service to run maintenance on the log table (WF.Log) under File > Maintenance > User Defined > Configuration.

    Key Value

    Comments

    WorkflowLoggerPollIntervalSeconds

    300

    Set the poll interval in seconds for the workflow service to run maintenance on the log table.

    The configuration keys are used in combination. For example, if the WorkflowLoggerMaxDays=10, the WorkflowLoggerMaxRows=10,000 and the WorkflowLoggerPollIntervalSeconds=300, then the Workflow Service will verify every 5 minutes that all records older than 10 days will be deleted and only the top 10,000 rows are kept in the log item table.

    Note: The Key values being set to 0 or not present, means the table will not be limited by date or row counts. Exit out of CCH Central once the Key Name and Key Value has been entered. Upon re-entry, the configuration key is active.

    Related documents

    CCH Workflow 2025.3: Release Notes
    The document provides release notes for CCH Workflow version 2025.3, highlighting installation prerequisites through the Central Suite Installer and introducing a new configuration key, Wf_DocumentExtraFields, which enables the merging of document extra fields. Firms wishing to disable this feature can adjust the key value. It includes legal disclaimers regarding accuracy and confidentiality, as well as trademark information. The content is proprietary to Wolters Kluwer (UK) Limited and is not to be reproduced without permission.
    VAT Workflow : Quick Start Guide
    This document serves as a comprehensive guide for managing VAT returns using the CCH Central Workflow system. It details the steps for creating a customized VAT workflow by saving the standard workflow as a practice-specific version, updating assignment responsibilities, and setting up VAT assignments and jobs. The guide covers the process for adding workflows to clients, customizing the homepage for workflow management, and tracking tasks within the workflow system. Additionally, it highlights automation features for task assignment and periodic workflow creation with links to further resources for detailed instructions.
    Progressing the tasks
    This document outlines the process for managing workflow tasks. Users can complete tasks via the Tasks homepage by selecting their names and using the ribbon bar for options like "Mark as complete." Multiple simple tasks can be completed in bulk. Tasks can also be reassigned to different employees, or specific employees can be selected for subsequent workflow steps. The document includes images to illustrate these procedures.
    Progressing workflows
    This document provides instructions on progressing tasks within a workflow homepage, detailing actions such as completing milestones, selecting outcomes, passing or failing tasks, and selecting employees. Users are guided on how to navigate the interface, including right-click options to manage tasks effectively. The document also mentions non-milestone tasks, directing users on how to reveal these tasks and proceed with their completion. Additionally, it highlights the ability to add comments to choices made within the workflow.
    Introduction to the Workflow homepage control
    The document provides an overview of the Workflow homepage control, detailing its functionality for monitoring workflow progression. It covers how to customize the interface, select workflows, and change view options, including due dates and employee views. The document also highlights the use of the "Field Chooser" for adding relevant columns, adjusting totals displayed for workflow steps, adding or editing comments, and applying filters to streamline the displayed workflows. Visual aids and step-by-step instructions complement the descriptions for ease of use.