null


Skip to end of banner
Go to start of banner

Creating a custom workflow

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Overview

A custom workflow can be created by editing an existing workflow or creating a new workflow in a space using either

A workflow can also be imported by copying and pasting the JSON code from a workflow template in another space or site.

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

cdmc-documentmanagementdashboard_duplicate_baw_wf.png

A dialog box is displayed with the selected workflow name appended with Copy.

cdmc_duplicate_dialogbox_baw_copy.png

A workflow bundled with the app cannot be overwritten.

  • edit the workflow name

cdmc_duplicate_dialogbox_baw_copy_newnameadded.png

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.

cdmc_Actions_options_editvisualbuilder.png

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

cdmc_workflowbuilder_customwf_alphaprojectworkflow.png
  • 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.

cdcm_wfbuilder_copy_baw_wf.png

Code editor

Workflow JSON code can be edited using the code editor.

The editor can also be used to import other workflows into the current space by copying and pasting the JSON markup for the workflow from another space or site.

JSON is a code language used to build the workflow. Only use this code editor if you are familiar with JSON.

You can access the code editor for a space custom workflow in the space settings Document Management dashboard.

cdmc_customworkflow_codeeditor_actions_option.png

The workflow template JSON code is displayed in the workflow schema box and can be edited directly in the editor.

cdcm_codeeditor_customworkflow.png

You can also open the code editor using the toggle button option in the workflow builder visual editor. For example, after choosing the Create New Workflow option button in the document management dashboard.

cdmc_wfbuilder_createworkflow_toggleoption_codceeditor.pngThe workflow template JSON code is edited directly in the editor.

Access the Code editor for a custom workflow using the </> icon in the Actions options in the space document management dashboard. cdmc_Actions_options_editcodeeditor.png

The workflow template JSON code is edited directly in the editor.

cdcm_codeeditor_copybaw_withscrollbar.png

The code editor validates any changes. Errors are displayed with details of the validation. The code editor does not allow the application of code with a validation error.

JSON markup for triggers can also be added to a workflow using the workflow builder visual editor rather than the code editor.

When editing a custom workflow in the workflow builder visual editor, the code editor is accessed using the code icon button in the right-hand navigator panel.

Changes applied to the code editor are dynamically updated in workflow builder visual editor.

Accessing the code editor using this option in the visual editor allows you to toggle between the visual and code editors.




  • No labels