workflow macro
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 application of a workflow.
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 or read-ack macro.
Parameters
Parameter | Required | Default | Notes | |
---|---|---|---|---|
macro body | There must be at least one The following macros can be put in the body of a
| |||
| Defines additional users who should be treated as admin users from the perspective of the workflow:
† Users added using this parameter must have space administration permission to remove sticky labels. Filter by labelThere are no items with the selected labels at this time. | |||
| Name of the workflow:
| |||
FiltersIn Space Mode, these parameters can be used to determine which content the workflow should be applied to. | ||||
|
| Which types of content should the workflow be applied to?
| ||
Prior to version 5.1, Global workflows applied in Space Mode did not respect the | ||||
|
| Should the purpose of the label parameter be inverted?
| 4.9 | |
| Which labels should this workflow be applied to?
| |||
| Should one or more labels be protected from removal?
| |||
User InterfaceThese parameters facilitate customisation of various elements of the user interface. | ||||
| Display a Space-level Page Template in the footer of all pages / blog posts that the workflow is applied to:
See also: pagefooter macro | 3.1+ | ||
| Display a Space-level Page Template in the header of all pages / blog posts that the workflow is applied to:
See also: pageheader macro, include-segment macro, set-message macro, workflow-instructions macro | |||
|
| Should the Progress Tracker be available in the Workflow Popup?
See also: | ||
|
| If a page or blog post contains the Confluence status macro, should it be updated whenever the workflow state changes?
This is primarily for old templates that used the {status} macro as a mechanism to display workflow status in the page content. 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