Templates
- Robert Alexander Marshall
Overview
Workflows are stored as templates. Workflow macros in the template define the major functionality of your workflow, such as states (and the transitions between them), tasks, and triggers.
The workflow macro defines your workflow template. The workflow is then created by adding macros such as the state macro, to the body of this workflow macro.
Workflow templates
can be created and edited with either the workflow builder or the markup editor
can be applied to all the pages and blog posts in a whole space, or applied individually to each page (or blog post)
Basic Syntax
In this example workflow, there are two states and one trigger.
{workflow:name=Example}
{state:Start|submit=Stop}
{state}
{state:Stop|submit=Start}
{state}
{trigger:statechanged|state=Stop}
{set-message}State is: Stop{set-message}
{trigger}
{workflow}The workflow template can be viewed and edited in the workflow builder visual editor.
Comala Document Management Templates
Templates are stored at
global level in the Global Workflows dashboard
space level in
Several workflow templates are bundled with Comala Document Management and are available on installation of the app. Workflow templates can be created within the app for use in your instance. Workflows can also be imported to the global instance or imported to a space.
Editing a workflow template
A workflow template can be edited using the visual editing tool workflow builder visual editor.
Workflow builder can be toggled between the visual editor and the markup editor.
Changes made in workflow builder visual editor change/update the markup automatically.
Editing of the workflow template markup can be done directly in the markup editor.
Changes made in the markup editor change/update the workflow in workflow builder visual editor automatically.
Triggers can only be created using markup. The trigger markup can be added either using the markup editor or can be copied and pasted into the Triggers option in the Edit Workflow panel in workflow builder.
Any triggers added to a workflow template are listed as Rules in the workflow builder visual editor.
All Examples
See: Examples
Macros
-
workflow macro — Defines a workflow template
workflow macro - body macros
-
description macro — Describe your workflow templates.
-
pagefooter macro — Add content to page footer
-
pageheader macro — Add content to page header
-
read-ack macro — Request user read confirmation of content
-
state macro — Define workflow states & basic transitions
-
trigger macro — Trigger actions when events are fired
-
workflow-instructions macro — Add message to "create page/blog" screen
-
workflowparameter macro — Define editable workflow Value References
state macro - body macros
-
approval macro — Add content-focus reviews to states
-
state-selection macro — Specify direct state transitions
-
task macro — Add tasks to workflow states
trigger macro - body macros
See: Actions