Managing workflow definitions

A Third-Party Manager workflow definitionClosed The template used to build a workflow which is the outline of tasks that must be completed. is the outline of tasks to complete in the workflowClosed A series of tasks generated based on an event or form submission.. It is a template that can be reused. For an example of building a workflow definition using various types of tasks, see Example of a workflow definition.

The system uses the workflow definitions to assign a workflow. See Managing workflow assignments. When a workflow is assigned by the system, the workflow is an exact copy of the workflow definition at that point in time.

A workflow may have one custom initializer for the system to execute based on certain logic and conditions. For example, the supplied Unexpected Answer TaskClosed Part of a workflow that itemizes certain work to be completed. Initializer is a custom initializer. It inserts a snippetClosed A predefined task or group of tasks that can be inserted into a workflow or workflow definition. Snippets are created and managed similiar to how workflow definitions are created and managed. for each unexpected answer found in a submitted formClosed A form is a questionnaire to gather information.. See Handling unexpected answers.

Create a workflow definition

The steps to create a workflow definition follow.

  1. Select Settings, Content Control, then Workflow Builder. Workflow Builder displays in a separate browser tab. 
  2. On the left menu, select Workflow Definitions.
  3. Select the Workflow Definitions button.
  4. Complete the following.
  5. Click Save. You will see the Workflow Definition Editor with a blank workflow definition.

  6. From the Workflow Definition pane on the left, select the gear icon to set the following:

    • Expected Duration: Enter n days after a workflow is activated for the workflow to be due.

    • Allow ad-hoc changes: Select to allow users to manage predecessors, move tasks, and add and remove tasks and snippets.

    • Disallow ad-hoc changes; Select to restrict users to only taking task ownership. Users will not be able to change the workflow.

  7. Select Save. The workflow definition is created. Continue to the next section to add tasks to the workflow definition.

Complete the workflow definition or a workflow snippet

Once the workflow definition is created, you will add tasks. Types of tasks you can add are described in Using workflows, section Types of tasks. The same steps are used to add tasks to a workflow snippet. See Managing workflow snippets.

For an example of building a workflow definition using different types of tasks and snippets, see Example of a workflow definition

Use the following steps to add tasks.

  1. Open the workflow definition or workflow snippet.

  2. To add tasks:

    • For a workflow definition, hover over Event or Form Submission and select the three dots.

    • For a workflow snippet, hover over Workflow Snippet and select the three dots.

  3. Select the type of task to add from the selection. For task descriptions, see Using workflows, section Types of tasks. The task is added to the bottom of the workflow or Section task. Once added, you can click the three dots for the task and move the task.

  4. Complete the information in the Task Editor specific to the type of task. These are common fields to complete.

  5. From any task pane, select the task's gear icon to view Task Settings. Complete any of the following for each task:

    • Required: Select to prevent the workflow from being closed until the task is marked as complete.

    • Due Within: Enter the number of days from task activation that the task is due to be complete. If the value is set at 0, not notifications will be sent. After that date, if the notification is selected, a Late Task Notification is sent. See Late Task setting below.

    • Take Ownership Within: Enter the number of days from task activation that a user must assume ownership. If ownership is not taken within the number of days and Task Unassigned is selected (below), notifications are sent to the workflow user queue associated with the task as well as the emails entered in Send Alerts To, which follows.

    • Send Alerts To: Enter one or more emails separated by semicolons for the Task Alert notification which is sent when a task becomes active. To set up a Task Alert, see Managing notifications.

    • Notifications To Send: Select the notifications to send to the workflow user queue identified for the task.

      • Task Activated to inform the user queue when a task is activated. Notifications are sent to all users in workflow queue initially assigned to a task or that the task is routed to.
      • ToDo Reminder to inform the To Do creator that the To Do item that the item is due.
      • ToDo Overdue to inform the To Do creator that the To Do item is overdue.
        • Late Task to inform the user queue that they have an overdue task, per the Due Within (set above) timeframe.
      • Task Unassigned: Notifies the user queue that the task is active and has not been assigned in the Take Ownership Within timeframe which was set earlier on this dialog.
      • Task Route Change: Notifies the users when the routing of a task has been altered.
    • Allow Edit of Task Name: Select to allow changes to the name of the task while the workflow is active. A change does not affect the workflow definition.

    • Enable Auto-assign: It is recommended that every phase of a review cycle have this checkbox selected. This ensures someone has ownership. If there is one person in the queue, that person is assigned versus waiting for the person to take ownership of the task. If the task is auto-assigned, the Task Unassigned notification is not sent.

  6. Select Save.

Edit, clone, or delete a workflow definition

  1. Select Settings, Content Control, then Workflow Builder.
  2. From the left menu, select Workflow Definition.
  3. In the grid, select any of the following:
    to edit the workflow definition. Select the right arrow on the name of the workflow definition to edit the Name, Description, Active setting, and so on. Update tasks, as desired.
    to clone a workflow definition and edit it to create a new workflow definition.
    to delete and remove the workflow definition.