Editing and customizing workflows using the code editor

Owned by Robert Alexander Marshall
Last updated: Nov 22, 2024
5 min read
1 Overview | 2 Accessing the code editor | 3 Using the code editor | 3.1 States, transitions, and approvals | 3.2 Workflow parameters | 3.3 Workflow triggers | 4 Search help | 5 Code validation | 6 Related pages

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:

cdmc_codeeditor_createnewworkflowtemplatecode.png

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, workflow parameters, states, transitions, and approvals

cdmc_codeeditor_trigger_eventname_schema_onchangestate_highlighted.png

  • a search tool accessed by the keyboard shortcut CMD+F

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 app space settings:

  • choose the </> icon in the Actions options for a workflow

In the visual editor, open the code editor

  • using the { } toggle button option

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

  • string, meta, and regex values in blue

  • boolean values, true or false, in orange

  • numbers and operators are in green

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 dropdown is displayed to help you add these and complete the property definition.

States, transitions, and approvals

The code editor also provides a JSON schema dropdown to

  • add a workflow state and its attributes, including color, description, expiry due date, and whether the state is an initial or final state in the workflow

  • add state transitions

  • add an approval

Workflow parameters

The code editor provides a JSON schema dropdown to add workflow parameters.

Workflow triggers

The code editor provides JSON schema dropdowns to create and add a workflow trigger. Dropdowns are provided for each of the events, conditions, and actions of the workflow trigger.

  • event

  • conditions

  • actions

The trigger actions also have a JSON schema dropdown to support adding the code. Choose action.

The "action", schema defaults to adding a "send-email" action.

To add a different action

  • remove the "send-email" action

  • add the "" to display the JSON action schema

Search help

The code editor includes a search tool.

  • type CMD+F to display the search help

Added search strings found in the code are highlighted. You can filter the search to match case, regexp, and word. A Replace option is also available.

Code validation

At the moment of typing, the code editor validates and highlights JSON syntax errors.

This is usually displayed at the point in the code where you add the required elements for a workflow property, such as a trigger.

The dialog box also displays a Syntax error found error message.

A complete validation of the JSON as a valid workflow is not done until the save button is clicked. If there are errors, the edited workflow cannot be saved, and an error message is displayed

Related pages