JSON code editor
Contents:
Overview
Use the JSON Code Editor to create and customize workflows in Comala Document Management. Only the space administrator can edit the workflow template using the code editor.
The JSON Code Editor provides flexibility for power users who need more customization than the visual workflow builder allows. With the JSON code editor, you can,
Manually define and modify workflows by editing the JSON structure directly.
Import and export workflows across different spaces or instances by copying and pasting JSON code.
Refine workflow logic, including triggers, conditions, transitions, and notifications.
Apply advanced configurations, such as integrating external systems or automating document approvals with precise control.
Steps to use the JSON code editor
You can edit an existing custom workflow or create a new one and edit it with the JSON code editor. In this example, let’s create a new workflow and build it with the code editor.
Log in to your Confluence space and go to Space settings.
Choose Comala document management under App links.
Now, click Create New Workflow on the App links page.
The visual builder is displayed by default. Click the
{}
icon to open the JSON code editor.The workflow template JSON code is displayed in the workflow schema box and can be edited directly in the editor.
Click Save to save your code.
The JSON code editor includes the following:
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
a search tool accessed by the keyboard shortcut CMD+F
Workflow builder also lets you toggle between the visual and code editors using the editor icon buttons in the right-hand navigator panel.
Changes applied in one editor are dynamically updated in the other editor.
If migrating from server to cloud, each server workflow can be translated to a cloud-compatible JSON workflow template using the Workflow Translator for Cloud in the data center and server apps. The cloud-compatible JSON for each workflow can be copied from the translator and pasted into the cloud app code editor.
Need support? Create a request with our support team.