workflow macro

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

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 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

• Page:
  Attachment events
• Page:
  Customise Approval Buttons
• Page:
  Fast-tracked Rejections and Approvals

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:
  Space mode workflow application

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:
  Space mode workflow application

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:
  Space mode workflow application

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

• Page:
  Space mode workflow application

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

See also: {pagefooter} macro

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

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

Should the Progress Tracker be available in the Workflow Popup?

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

See also: hidefrompath parameter on {state} macro

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.