Creating a custom workflow

Create a custom workflow

Custom workflows are added to the space document management dashboard. You can

Create a new custom workflow

In the space document management dashboard

choose the Create New Workflow button

cdmc_documentmanagementdashbaord_createnewworkflowbutton_defaultworkflows_alldisabled.png

This opens the workflow builder visual editor.

cdmc_documentmanagementdashbaord_createnewworkflow_wfbuilder_noname_entered.png

The visual editor displays a simple two state workflow template as a starting point for your new custom workflow.

enter a name for the new custom workflow
choose Apply

The saved workflow can be edited in the visual editor to add

Duplicate a workflow to create a custom workflow

In the document management app space settings, you can create a duplicate of an existing workflow and edit this copy to create a new custom workflow.

You can do this by

choosing Duplicate in the Actions options for an existing workflow

A dialog box is displayed with the selected workflow name appended with Copy.

edit the workflow name

Workflow names are validated - this checks that there is no existing workflow with the same name in the space and for the use of reserved characters.

choose Submit

The new workflow is added to the app space settings as an editable custom workflow.

A custom workflow has additional options in the Actions options.

remove the workflow from the space
edit with code editor
edit with workflow builder visual editor

Choose the Actions pencil icon option to open the workflow in the visual editor.

You can use the visual editor to

add and edit states, transitions, and state colors
approvals and reviewers
workflow parameters
workflow triggers
add a label condition

cdmc_workflowbuilder_customworkflow_threestates_oneparameter.png

Save the edited workflow
Exit workflow builder to the app space settings

The new custom workflow is added to the app space settings.

Workflow builder visual editor

Workflow builder visual editor in Comala Document Management offers several simple ways to customize the look and feel of the workflows in a space

It is a graphical way to edit a copy of an existing workflow or create a new workflow without using the complex macro JSON code.

Code editor

Import a workflow template using the code editor to add a custom workflow

In addition to using the code editor to edit a workflow template, it can also be used to import other workflows into the current space by copying and pasting the workflow template JSON code for the workflow from another space or site.

The workflow template is created using JSON code. Only use the code editor if you are familiar with JSON code.

The workflow template JSON code is displayed in the workflow schema box and can be edited directly in the editor.

cdmc_code_editor_update_customworkflow_color_coded_json.png

The code editor displays the workflow template with the following:

workflow property names in grey
string, meta, and regex values in blue
boolean values, true or false, in orange
numbers and operators are in green

When editing in the code editor, JSON schema autocomplete options are displayed to help add workflow properties, values, and data

The workflow template JSON code is edited directly in the editor.

Overview