Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Excerpt | ||
---|---|---|
| ||
The JSON code editor includes
|
...
Excerpt | ||||
---|---|---|---|---|
| ||||
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:
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
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.
|
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 colour, 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 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 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 properties of the trigger.
event
...
conditions
...
actions
...
The actions also have a JSON schema dropdown to support the addition of the code.
...
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
If you toggle into the visual editor, the JSON template with a syntax code error is not saved.
Examples
Child pages (Children Display) | ||
---|---|---|
|
...