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 used when applying a workflow in space mode.

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

Parameter	Default	Notes
macro body		There must be at least one `state` macro in the body. The following macros can be put in the body of a `workflow` macro: Page: description macro — Describe your workflow templates. Page: pagefooter macro — Add content to page footer Page: pageheader macro — Add content to page header Page: read-ack macro — Request user read confirmation of content Page: state macro — Define workflow states & basic transitions Page: trigger macro — Trigger actions when events are fired Page: workflow-instructions macro — Add message to "create page/blog" screen Page: workflowparameter macro — Define editable workflow value references
`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 † Users added using this parameter must have space administration permission to remove sticky labels.
`name`		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@` - a predefined value reference. Page: Customize approval decision buttons Page: How can I fast-track a single rejection or a single approval decision Page: Use attachment events in workflow triggers
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 Page: Using labels when applying a workflow in space mode
`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 Page: Using labels when applying a workflow in space mode	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 Page: Using labels when applying a workflow in space mode
`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 administrator, a Confluence administrator, or users listed in the `adminusers` parameter Page: Using labels when applying a workflow in space mode
User interface These parameters facilitate the customisation of various elements of the user interface.
`footer` or `footertemplate`		Display a space-level page template in the footer of all pages and 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 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` is specified, it defaults to the current space See also: pageheader macro, include-segment macro, set-message macro, workflow-instructions macro
`progresstracker`	`true`	Should the Progress Tracker be available in the workflow state dialog box? `true` – yes, include the Progress Tracker `false` – no, remove the Progress Tracker See also: `hidefrompath` parameter on the 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. It is recommended to use the pagestatus macro instead.	4.3.2+

The workflow macro is automatically added when creating a workflow using the workflow builder.

You can add or edit the workflow and its parameters using the editor options:

workflowbuilder-editworkflow_advancedoptioncollapsed.png

Expanding the Advanced section lets you to add values for the content, sticky labels, adminusers, updatestatus, and progresstracker parameters. You can also edit the header and footer parameter values in the page layout editor.

Example

{workflow:name=Example|content=pages|label=example|updatestatus=true}
   {description}Example workflow{description}
   {state:Editing}
   {state}
   {state:Done}
   {state}
{workflow}

All examples

See: Examples

workflow macro

Overview

Where to use it?

Parameters

Filters

User interface

Example

All examples

Related pages