Workflows are scripted using macro notation, which is stored in a template. But working with this markup notation is not always simple, unless you are an advanced and experienced user.

Workflow builder is a graphical way to create custom workflows without using the more complex markup language.

It is also an easier way to understand and communicate the document life-cycles within your organization, or when starting a new project with a customer or stakeholder.


How to Use the Workflow Builder

Depending on the workflow scope i.e., global, space or page, you need different permissions to use workflow builder i.e., global admin, space admin or any page edit permission if page mode is enabled (see Page vs. Space Mode).

Workflow builder can be accessed for a workflow in:

  • the space workflows Document Management dashboard in space tools
  • the global workflows template dashboard in global administration

 If page mode is enabled then it can also be accessed on a page:

  • when adding and customizing a page workflow.
  • via the Edit with workflow builder option in the page action menu on a page with a page workflow added and applied.


The most common method of accessing workflow builder is through the space administration menu. To use the workflow builder for space workflows, first ensure you have space admin privileges, then:

  • go to the space tools Document Management Dashboard in the space.
  • choose the ellipsis menu for a workflow.
  • choose Edit to open workflow builder .















The details of the workflow are displayed as a visual workflow diagram and a list of workflow elements.


These two main panel sections of workflow builder are:

  • the Workflow Navigator (right side) contains the visual workflow diagram, button links to create or update the different elements of your workflow (e.g. workflow, states, parameters).
  • the Workflow Panel (left side) is contextual, so you will see one of two different views depending on what the task you're performing. You will either see:



Workflow Panel - workflow viewWorkflow Panel - state view

Workflow view is displayed if you click anywhere on the white space in the right-hand workflow navigator panel background.

State view is shown if you click on any of the state lozenges in the workflow navigator panel or the state icons in the workflow panel.

Choose the workflow name to edit the overall workflow - workflow name, description, type of content to be applied to, add trigger markup or manage display of workflow popup progress tracker.

Edit page layout, workflow parameters or workflow read confirmation for the final state by choosing the appropriate icon/name.

You can drag and drop state names in this panel to re-order the states in the workflow. Any change in the list order will be reflected in the visual workflow in the navigator panel.

Choose the state name to edit the state name, description, status color, make the state a final state, add a due date or allow users to manually add tasks when in the state.

Edit or add transitions, approvals or tasks to be added by the workflow by choosing the appropriate icon/name.


For the state you want to view or edit, select the state lozenge in the right hand workflows navigator, and the left side panel will display the state information (such as name and description).

Edit the workflow details

Edit the workflow details by clicking on the top workflow panel area, where the details are, or by clicking on the Workflow button on the top of the Workflow Navigator panel.

This panel allows the visual editing of the workflow (the workflow macro)

  • the workflow description
  • content labels that filter the content the workflow will be applied to


Advanced Edit Workflow options 

Advanced OptionWorkflow EditorNotesMarkup added to workflow macro
Sticky labels

Sticky labels

  • set labels that ONLY admin users can remove from content

Adding the sticky label simple

....|stickylabels=true}

Admin users

Admin users

  • add one or more users to be admin users for the workflow for example to allow specific users to remove any Sticky labels

Adding the user elle as admin user for the workflow

...|adminusers=elle}

Content Type

Pages

  • check box to enable application of the workflow to page content

Blog Posts

  • toggle checkbox to enable application of the  workflow to blog posts content

Default is application of the workflow to both page and blog posts.

You cannot uncheck both Blog Posts and Pages at the same time. For example, if only Pages is checked and you wish to change the application of the workflow to Blog Posts you will need to check both before unchecking Pages.

Adding and apply the workflow to page content.

Unchecking Blog Posts will only apply the workflow to page content

...|content=pages}

Unchecking Pages will only apply the workflow to blog posts content

...|content=news}

Note that there is no markup added for the default for application of workflow to both page as and blog posts.



Options

Display Progress Tracker

  • checkbox to display the progress tracker in the workflow popup on the content

Update {status} macro when workflow state changes

  • option to allow the workflow to update the Comala Page Status macro (if the macro is added to the content)

If Display Progress Tracker is unchecked

... |progresstracker=false}

If Update {status} macro is checked

...|updatestatus=true}

The  {status} macro is the Comala Page Status macro NOT the Confluence  {status} macro

Triggers

You can also copy and paste the markup for one or more workflow triggers (see below)


Triggers

The current version of the Workflow Builder only accepts triggers by using the wiki markup notation. 

Open the advanced section when editing the workflow details, and add your wiki markup there.


Any triggers in the workflow are seen as Rules in the workflow panel.



Open Rules to see a simple overview of each trigger. 

For details of how to create triggers for the workflow please refer to the  trigger macro.

Edit page layout

When in the workflow view you will see Page Layout with a number beside it, which indicates how many elements are already set.

The elements are

  • Page Header
  • Page Footer
  • Workflow Instructions

Choose each element to add, edit or remove.

Page Header

Page Footer

The visibility for the page header and page footer can be set according to different user permissions for the content:

  • all users who can either view or edit the content
  • read-only access users
  • contributors (edit and admin permissions)


Workflow instructions

Set workflow instructions will only be used when the workflow is applied in space mode.


The panels allow editing of the parameters for the following workflow macros:

Edit workflow states

When in the state view (by clicking in any state in the Workflow Navigator), you will see in the Workflow Panel the state information, which includes things like due date, approvals, tasks and transitions. You can edit the state details by clicking on the top Workflow Panel area where the state details are, or by clicking on the State button at the top of the Workflow Navigator.

State view: The Workflow Panel (i.e., left side menu) changes when a state is selected (In progress is selected), to display the state contextual menu


Workflow builder allows the customization of all the state macro parameters: name, state indicator circle and lozenge color, description, due date and other advanced attributes and parameters:


Workflow builder in this panel is editing details for each individual state macro in the workflow.

Reorder the workflow states

Reordering the states of your workflow is now easier than ever. When in the state view you can see a list of the existing states in the left hand Workflow Panel.

Just drag and drop a state to a lower or higher position, and you will see how the diagram changes to reflect the new order.

Workflow builder will not allow you to drag and drop a state to be the first state in the workflow. The current first state cannot be dragged and dropped to another position in the workflow.

To move a state to be the first state in the workflow you must use the markup editor and copy and paste the state markup to be the first state macro in the workflow.


For example:

  • add a new state Todo for pending activity using workflow builder.


  • choose the { } markup editor icon


  • Locate the Todo state macro markup and cut and paste the markup to position it before the current opening state macro for the In Progress state.


  • choose Save.

  • choose the workflow builder icon to return to workflow builder.

The Todo state is now the first state in the workflow.


Approvals

When in the state view, the number of transitions, approvals and tasks are listed for the state.


View a list of any existing approvals by clicking on Approvals in the state panel area. 

Any existing approvals are displayed by name and appended with an approval icon.

Approval IconIndicates ...

Anyone can approve.

Reviewer(s) can be assigned.

Credentials required for a reviewer.

Reviewer(s) are preassigned.


Add or edit an approval

To add a new approval to the current state, click + Add Approval OR choose an existing named approval to edit.


Setting reviewers for an approval

Reviewers for an approval can be set in one of three ways in the Add Approval or Edit Approval panel in workflow builder.

The options are different for each Reviewers option button.

Reviewers - Anyone can approve

In this option the approval can be configured so that a minimum number of reviewers must undertake the content review and agree for a transition to occur.


Reviewers - Limit who can approve and/or assign

This option will allow reviewers to be assigned. Choosing each of the Assignable Reviewers buttons will display further options for each option. 


Reviewers - Set all reviewers that have to approve

At least one user needs to be added to be automatically assigned for this Reviewers option to be added to the approval.


All the Reviewers options can also be configured in the Advanced settings for the approval.


Each approval can be set

  • to require credentials for a reviewer
  • to have a condition for the approval to become active
  • to allow roles to be added for reviewers.


Approvals can also be reordered just by dragging and dropping to a higher or lower position.

The order of the approvals will be the initial order they are displayed in the workflow popup on the page before any approvals are undertaken when no conditions are set for any of the approvals.

Further details of content reviews (approvals) can be found in the approval macro pages.

Tasks

In the state view you can edit the existing tasks by clicking on the listed tasks in the Workflow Panel area. To add a new task, click on the + Task button on the top of the Workflow Navigator.


Tasks can also be reordered just by dragging and dropping to a higher or lower position.


Workflow builder uses the task macro to create and set the behaviour of workflow tasks.

Transitions

When in the state view you can edit the existing transitions by clicking on the listed transitions in the Workflow Panel area, or add a new one by clicking on the + Transition button on the top of the Workflow Navigator.

The details of the markup and macros used can be found in the documentation transitions pages.

Parameters

When in the workflow view you can edit the existing parameters or add a new one by clicking on the + Parameter button on the top of the Workflow Navigator.


This feature uses the  workflowparameter macro - an example of a type of value reference that can be used in workflows.

Workflow Read Confirmation

A read confirmation can be enabled in a workflow using workflow builder (or markup editor).

The Workflows Builder can be used to add a read confirmation to any workflow for the final state.

 

Note: read confirmation will only be available for the final state in the workflow.

Editing the Read Confirmation

Clicking the read confirmation link will bring up the configuration options, including:

  • users assigned to read/confirm the page.
  • user groups assigned to read/confirm the page.
  • a due date indicating when read confirmation should occur by.
  • allow a reviewer to decide to enable or disable the read confirmation on the approved transition to the final state.

   


Read confirmations use the read-ack macro.

Not supported

  • Graphical trigger creation.
  • The {comment macro} is deprecated. Please use the description field of other macros to include extra contextual information.


Authoring using workflow builder