Administrator/Workflows

A user guide for working with workflows. We cover how to create and modify workflows.

This section is about managing workflows within the system.

By clicking on Administrator/Workflows, you gain access to the list of workflows.

Workflows List

The Workflows list overview allows you to see all workflows defined in the system. Workflows are global and shared by all departments within the organization.

Workflows can be activated and deactivated as needed. This does not affect existing form types that use the workflow but makes it impossible to create new form types for that specific workflow.

Create Workflow

There are four tabs to consider when creating a new workflow.

TabDescription
GeneralEnter general details for the workflow.
TableEdit the statuses, transitions, and dialogs that make up the workflow.
GraphA graphical representation of the workflow.
ProcessingDefault processing settings for the workflow, such as automatic deadlines, etc.

General Tab

The general page allows us to fill out the following fields.

FieldDescription
TitleSpecify the title of the workflow; support multiple languages if your account is configured for it.
Entity TypeSelect the entity type of the workflow; once set, it cannot be changed. This can be Message, Action, Document, Hearing, or Audit.
Disable transitions checkingThis allows you to override any transitions, making it possible to freely move tickets between any transitions on the case board. Great for implementing Kanban processes or other non-gated processes.
Start case statusSet the default case start status. This is the case status that will be assigned to a new case for this workflow if no other rules override it.
Close case statusSet the default close case status used for default close operations.
Early case processSpecify that this workflow supports the use of Early case process rules set up to assign new cases to case handlers based on specified rules.
Associated hearing workflowDocument only. Allows you to specify an associated hearings workflow for this document workflow that will handle any hearings initiated for a document attached to this workflow.
Associated audit workflowDocument only. Allows you to specify an associated audit workflow for this document workflow to handle all hearings.

Table Tab

The Table Tab allows us to build and modify the workflow entities. There are three types of available entities.

EntityDescription
Case StatusCase statuses are defined states a case can be in. For example, you might have a case status called New for a newly registered form entry and Closed for the final possible state for a case.
TransitionsTransitions control the flow of cases between case statuses. It makes it possible to enforce a workflow by specifying the legal transitions between statuses. For example, you might make it possible to only move a case from New to Under work by adding a single transition between those statuses.

DONE

| Dialogs | Dialogs are collections of fields that can be attached to a transition. For example, you might decide that you want the user to add a comment when moving a case from the case status New to Under work, and a dialog attached to this transition between those fields will prompt the dialog to pop up for the user to fill out when moving between the statuses. |

Create Status

To create a new Case status, you need to enter the following fields.

FieldDescription
NameThe name of the case status, supporting multiple languages.
Status GroupThe Status Group for this Case Status (see the table below for explanations).
DescriptionAn optional description for the case status.

The possible Status Groups are detailed below.

Status GroupDescription
OpenA case is in a newly opened state (the first time it was opened). This is primarily used to signal a new case starting.
UnprocessedA case has been created but not yet opened by any case handler.
In progressA case is being worked on.
In action processA case triggered an action process and is waiting for it to be resolved.
ClosedA case has been closed.
DeletedA case has been deleted.

Create Transitions

A transition represents a change between two statuses (for example, you might move a case from New status to Being worked on status).

A transition can have an optional dialog attached to it to collect information as part of the transition.

When we talk about transitions, we will use source as the start status of the transition and target as the end status.

We have the following fields when creating a transition.

FieldDescription
Transition NameThe name of the Transition we are defining.
From statusThe starting Case Status for the transition.
To statusThe ending Case Status for the transition.
DialogAn optional dialog attached to the transition.
Related WorkflowWhen transitioning to a Case Status of the Status Group In action process, we can set a related workflow that will be used to trigger the creation of a new Action when this transition is performed. This option is currently only available for Message Workflows.
Start StatusSpecify what status a newly created Action should have in the Related Workflow.

The Related Workflow option is only used when the To status is a Case Status of the Status Group In action process.

Create Dialog

A dialog represents a set of fields configurable by the end user to collect information or trigger actions on a change of status for a case (a transition). Dialogs are attached to transitions.

The fields you can specify are as follows:

FieldDescription
Dialog nameThe name of the workflow dialog, supporting multiple languages.
DescriptionAn optional description for the dialog.
FieldsThe list of fields used in the dialog.

DONE

As you can see, there is a sizable selection of field types. Let’s examine each and understand their significance before constructing our custom dialog.

Field TypeTriggersDescription
TextfieldNoA single-row free text entry field.
TextareaNoA text area with more columns for free text entry.
Text EditorA text area with basic formatting for free text entry.
NumberNoAllows entering any numeric value.
DateNoUsed for specifying a date.
Perform TaskYesA field allowing you to specify who performed the task.
Action NameYesThe title field that will be used when creating a new Action entry for a transition going into an In action process group state.
CommentYesAllows the user to comment on the transition between states and set who is getting notified about the comment.
AcknowledgementYesLets the user acknowledge that specific users performed their tasks.
Task Assignment SetupYesAllows the user to create tasks of a specific type when transitioning between statuses. One can also control if one wants to collect a Due date, Planned hours, and Planned start date.

You can add fields to the dialog, seeing the preview of the dialog on the left-hand side. Once you have specified all the fields, you can click the Save Changes button at the bottom right to save the changes to the workflow.

Graph Tab

The Graph Tab shows a graphical representation of the workflow. Each box represents a Case Status in the workflow, and each line between the Case Statuses represents a transition between two states. The above workflow is very simple; below is a more complex workflow example.

Use the Graph Tab to validate your workflow and ensure you did not miss any transitions. A Case Status without any transitions is a typical signal that one might have missed a transition or that the Case Status is not needed.

Processing Tab

The processing tab contains settings to set defaults for case deadlines and escalations for all form types and forms associated with this particular workflow.

Due dates

Allows the control of how due date notifications are handled. This allows one to set general due date handling settings for this workflow and thus forms using this workflow.

Forms let you override these so you can, for example, have a form Accident with much shorter automatic due dates compared to the general workflow. Form settings will override the workflow.

The available fields.

FieldDescription
Number of days before overdueThe number of days since the last update happened to a case before it’s considered overdue.
Reminder email frequencyThe frequency of sending overdue email notifications. These are options like Off, Every day, Everyone Monday, etc.
Time of day to send overdue emailsSpecify the time of day to send the email. For example, you might want overdue notices to be delivered after 9 in the morning. This is not an exact time. The email will be sent sometime after the specified time, depending on your email system and sending time.

Escalation

Allows the control of how escalations are handled. This allows one to set general escalation handling settings for this workflow and thus forms using this workflow.

Forms let you override these so you can, for example, have a form Accident with much shorter automatic escalation dates compared to the general workflow. Form settings will override the workflow.

The available fields.

FieldDescription
Escalation of overdue cases enabledEnable or disable the escalation.
Escalate after N hours overdueThe number of hours since the last case update happened before it’s considered for escalation.
Escalation strategyThe strategy to pick to whom to escalate the case. See available strategies below.
Time of day to escalate messagesWhat time of the day to escalate messages.
Number of hours for next due date after escalationThe next due date after escalating the case to a new case handler.

The available strategies.

StrategyDescription
Direct supervisorThe case will be sent to the person’s closest direct supervisor with permission to process cases. If there is more than one potential supervisor, one of them will be picked at random.
Time of day to send overdue emailsSpecify the time of day to send the email. For example you might overdue notices to be delivered after 9 in the morning. This is not an exact time. The email some time after the specified time depending on your email system and sending time.

Escalation

Allows the control of how escalations are handled. This allows one to set general escalation handling settings for this workflow and thus forms using this workflow.

Forms let you override these so you can for example have a form Accident that have much shorter automatic escalation date compared to the general workflow. Form settings will override the workflow.

The available fields.

FieldDescription
Escalation of overdue cases enabledEnable or disable the escalation.
Escalate after N hours overdueThe number of hours since the last case update happened before it’s considered for escalation.
Escalation strategyThe strategy to pick to whom to escalate the case. See available strategies below.
Time of day to escalate mesagesWhat time of the day to escalate messages.
Number of hours for next due date after escalationThe next due date after escalating the case to a new case handler.

The available strategies.

StrategyDescription
Direct supervisorThe case will be sent to the persons closest direct supervisor with permission to process cases. If there are more than one potential supervisor it will pick on of them on random.