Overview
A Comala Document Management workflow is created using JSON (Javascript Object Notation) code.
There are two places you can create or customize a custom workflow template by editing the JSON code:
adding a workflow JSON trigger in the visual editor
using the code editor to edit the whole workflow JSON template
The JSON code editor includes
color coding to distinguish property names, values, and different data types
autocomplete feature for workflow properties and values
dropdown selectors for available property names, including workflow triggers
The visual editor can also be used to create or edit workflows without the need to add or edit code directly. Changes in one editor are automatically updated when the workflow is viewed in the other.
Accessing the code editor
You can access the code editor for a custom workflow in the space document management dashboardusing the </> icon in the Actions options in the space document management dashboard
using the { } toggle button option in the workflow builder visual editor
Using the code editor
If you are familiar with JSON, you can use the Comala Document Management code editor to edit an existing workflow or create your own.
Color coding is used to distinguish property names, values, and different data types in the workflow template JSON code:
workflow property names in grey
property and array values in blue
boolean values,
trueorfalse, in red
Data is represented within data or name pairs of curly braces { } and square brackets [ ]. Highlight one of the braces or brackets, and the paired brace or bracket is highlighted.
When editing in the code editor, adding "" displays JSON schema options to help add workflow properties, values, and data.
To activate the JSON schema prompt, click within the "" .
JSON schema is then displayed for the selected workflow object to help add further properties and values.
For example, the value options for the event for a workflow trigger to listen for.
Scroll with the mouse in the JSON schema box to view additional options. Click the keyboard’s Arrow keys to move up or down and select an option.
A workflow trigger has multiple parameters; a JSON schema is displayed to help you add these and complete the property definition.
The code editor validates any changes and displays a syntax error if a JSON code error is found.
The code editor does not allow you to save a template with a validation error, and when you toggle into the visual editor, the JSON template with a code error is not saved.