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

To create a new custom workflow, in the space settings Document Management dashboard, you can create a duplicate of an existing workflow and edit this copy.

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.

A workflow bundled with the app cannot be overwritten.

edit the workflow name

Workflow names are validated - checking there is no other existing workflow with the same name and for the use of reserved characters.

choose Submit

The new workflow is added to the document management dashboard 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 workflow builder visual editor.

Use the visual editor to edit the workflow - add and edit: states, transitions, state colors, workflow parameters.

Save the edited workflow
Exit workflow builder to the space settings document management dashboard

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

A space administrator can edit the workflow template using the code editor.

The code editor 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:

workflow objects in grey
object and array values in blue
boolean values, true or false, in red

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