This space is no longer being updated.Purpose
The workflow macro is used to define a workflow and is used to contain a collection of states, approvals and triggers. All macros used to define the workflow must be encased inside a workflow macro.
Syntax
{workflow:name=workflow_name[|label=label_name][|content=pages,news][|stickylabels=label1,label2, ...][|adminusers=user1,user2,...][|header/headertemplate=[spacekey:]template_page][|footer/footertemplate=[spacekey:]template_page][|progresstracker=true/false][updatestatus=true/false]}
<workflow code goes here>
{workflow}
Parameters
Parameters | Mandatory | Default | Description |
|---|---|---|---|
| Yes | – | Names the workflow. Workflow names must be unique within a space. |
| No | – | A comma delimited list of labels. The workflow will apply only to pages that have one of the specified labels (or none of the labels if the |
invertlabel | No | false | Boolean value to reverse the label parameter. |
| No |
| Comma-separated list of types of content the workflow applies to. If omitted the workflow applies to all supported types. Supported types are presently |
| No | – | A comma-separated list of labels which, once added, can only be removed by a Confluence or space administrator. |
| No | – | A comma-separated lists of users who should be considered workflow administrators. Using this parameter expands the access to the admin=true function beyond Confluence and space administrators. |
| No | – | The template name to be rendered as a header on all pages on which the workflow is present. The template reference can include the space, i.e., |
| No | – | The template name to be rendered as a footer on all pages on which the workflow is present. The template reference can include the space, i.e., |
progresstracker | No | true | Boolean value to turn the progress tracker on or off for this workflow. |
updatestatus | No | false | Boolean value to update status macros in the page with the current workflow state when the state is changed. Useful when working with predefined templates that already include the status macro. See the pagestatus macro for another way to display the workflow state within a page. |
Examples
Workflow Header
You can create a template and have that template rendered on all pages on which the workflow is active. For example, create a template PageHeader in the space DOCS with the following Confluence wiki markup code.
{metadata-list}
|| Reviewer | emendator ||
|| Editor in Chief | primus ||
{metadata-list}
The workflow refers to the PageHeader template:
{workflow|header=DOCS:PageHeader}
<workflow code>
{workflow}
For more information of the wiki markup language, see Confluence Wiki Markup. The use of the headertemplate/footertemplate parameters is an alternative to defining the header and footer in the workflow code with the pageheader and pagefooter macros.
Note
If the reference to the template does not specify a space key, it will refer to a page in the same space where the workflow is active.
