Expand all   Collapse all

This documentation relates to the 5.2 release of Comala Workflows

 Documentation for other versions of Comala Workflows is available too.

Overview

The {workflow} macro defines a workflow in your workflow template, and optionally defines page headers and footers, as well as content filters for Space Mode use.

Where to use it?

Required – exactly one per workflow template.

The {workflow} macro must be the first macro in your template.

It must contain at least one {state} macro.

Parameters

ParameterRequiredDefaultNotes
macro body(info)

(info) There must be at least one {state} macro in the body.

The following macros can be put in the body of a {workflow} macro:

Content by label

There is no content with the specified labels


adminusers



Defines additional users who should be treated as admin users from the perspective of the workflow:

  • Comma-separated list of usernames
  • Listed users can delete labels defined in stickylabels parameter
  • Can use Administrator state override
  • Also affects any macro with an admin=true parameter

Content by label

There is no content with the specified labels


name

(tick)


Name of the workflow:

  • In Space Mode, the workflow must have a unique name amongst the enabled workflows
  • The name can use any character set supported by your Confluence server – except some reserved characters.
  • Can be accessed via @pageworkflowname@ Predefined reference

Content by label

There is no content with the specified labels


Filters

In Space Mode, these parameters can be used to determine which content the workflow should be applied to.

content


pages,news

Which types of content should the workflow be applied to?

  • Comma-separated list of content types
  • Supported types: pages, news (blog posts)
  • Only takes effect in Space Mode

Content by label

There is no content with the specified labels


Prior to version 5.1, Global workflows applied in Space Mode did not respect the news only filter (they would be applied to pages too). This bug is fixed in version 5.1 and above.
invertlabel
false

Should the purpose of the label parameter be inverted?

  • true – yes, only apply the workflow to content with none of the listed labels
  • false – no, apply the workflow to content that has one or more of the listed labels

Content by label

There is no content with the specified labels

4.9

label



Which labels should this workflow be applied to?

  • Comma-separated list of labels
  • Workflow will be applied to any content with one or more of the listed labels
  • Only takes effect in Space Mode

Content by label

There is no content with the specified labels


stickylabels



Should one or more labels be protected from removal?

  • Comma-separated list of labels which must not be removed
  • Once added, the labels can only be removed by a Space Admin, Confluence Admin or users listed in the adminusers parameter

Content by label

There is no content with the specified labels


User Interface

These parameters facilitate customisation of various elements of the user interface.

footer or
footertemplate



Display a Space-level Page Template in the footer of all pages / blog posts that the workflow is applied to:

  • Full path to template: SPACEKEY:Page Template Title
  • If no SPACEKEY specified, it will default to the current space

Content by label

There is no content with the specified labels

See also: {pagefooter} macro

3.1+

header or
headertemplate



Display a Space-level Page Template in the header of all pages / blog posts that the workflow is applied to:

  • Full path to template: SPACEKEY:Page Template Title
  • If no SPACEKEY specified, it will default to the current space

Content by label

There is no content with the specified labels

See also: {pageheader} macro, {include-segment} macro, {set-message} macro, {workflow-instructions} macro


progresstracker
true

AWP-3784

Should the Progress Tracker be available in the Workflow Popup?

  • true – yes, include the Progress Tracker
  • false – no, remove the Progress Tracker

Content by label

There is no content with the specified labels

See also: hidefrompath parameter on {state} macro


updatestatus
false

If a page or blog post contains the Confluence {status} macro, should it be updated whenever the workflow state changes?

  • true – yes, update the {status} macro to show the name of the current workflow state
  • false – no, don't update

This is primarily for old templates that used the {status} macro as a mechanism to display workflow status in the page content.

Content by label

There is no content with the specified labels

It is recommended to use the {pagestatus} macro instead.

4.3.2+

Example

{workflow:name=Example}
   {description}Example workflow{description}
   {state:Editing}
   {state}
   {trigger:pagecreated}
   {trigger}
{workflow}

All examples

See: Examples

See also

Workflow Authoring Guide:

Administration Guides: