Page Comparison

...

The workflowparameter macro allows you to create editable editable value references.

A workflow parameter can be configured to a specific type of data value, for example duration period; Confluence user name(s); Confluence group name(s); text string; or a list of set option values.

...

One or more workflowparameter macros can be put in a a workflow macro.

Must be placed before the the state macro(s) in the workflow markup.

...

Space Admins – Parameters - Space Tools when your workflow is applied in in space mode or or page mode
Image RemovedImage Added
For
- for a workflow parameter to be added to the space tools Parameters tab, a default value must have been added to the workflow.
The
- the value set in space tools Parameters will be retrieved by the workflow only on initial application of the workflow

Changing the workflow parameter in the parameters dashboard does not change the default value set in a workflow template or the value used for this workflow that has already been applied to a document. The space parameter value is used as the default value only for subsequent new applications of this workflow in the space.

Users – via the Workflow Popup workflow popup (in both both space mode and and page mode)
If the workflow parameter is configured as editable, a user can edit the parameter value using the ellipsis menu option in the workflow popup.
Image RemovedImage Added
Users – via the Workflow Popup workflow popup (in both both space mode and and page mode)
If the workflow parameter is configured as editable, a user can edit the parameter value using the page tools menu option.
Users – Workflow setup via the Workflow Popup workflow popup (in both Space Mode and Page Modeboth space mode and page mode)
If the workflow parameter is configured as editable, a user will be prompted to add or confirm the workflow parameter value(s) when adding the workflow to content
Image RemovedImage Added

...

If a workflow parameter value is edited, the new value will be used by the workflow the next time the workflow action to retrieve the parameter value occurs.

Parameters

The workflow parameter must be defined with a unique name and the data type for its value.

...

Parameter

Required

Default

Notes

Ver

unnamed first parameter
or name

Name of the parameter.

3.0+

macro body

The default value for the parameter

can use any character set supported by your Confluence server – except some reserved characters
can be overridden in Parameters - Space Tools if the template is used in Space Mode space mode
can be overridden at page or blog post level, via Workflow Popup workflow popup, in both Page Mode and Space Mode page mode and space mode, if edit=true is set

3.0+

description

The description for the parameter

plain text
can use any character set supported by your Confluence server – except some reserved characters

Filter by label (Content by label)

showLabels	false
max	6
showSpace	false
sort	title
cql	label = "macro-workflowparameter" and label = "parameter-description" and label = "example" and space = currentSpace ( )

3.0+

edit

false

Should this parameter be editable at the page or blog post level?

true – yes, make it editable via the Workflow Popup workflow popup
false – no, it can only be edited via Parameters - Space Tools

Tip: If set to true, the value of the parameter can be used as a normal Value Reference value reference and can be accessed via the get-metadatamacro.

edit=true can also be required to be set upon transition to a state by setting them in the requiredparams list for that state.

Filter by label (Content by label)

showLabels	false
max	6
showSpace	false
sort	title
cql	label = "macro-workflowparameter" and label = "parameter-edit" and label = "example" and space = currentSpace ( )

3.0.3+

type

string

Parameter type

string – text
- Usually plain text, but can contain wiki notation depending on where the parameter value will be used
user – a single username or comma separated list of usernames
duration – an ISO 8601 duration
group – a single Confluence group or comma separated list of group names
list – a list of values to choose from – see: options parameter below

Filter by label (Content by label)

showLabels	false
max	6
showSpace	false
sort	title
cql	label = "macro-workflowparameter" and label in ( "parameter-type" , "type-duration" , "type-user" , "type-string" , "type-group" , "type-list" ) and label = "example" and space = currentSpace ( )

3.0+

options

string

Required if the parameter type is list.

List options

comma-separated list of values
can use any character set supported by your Confluence server – except some reserved characters
supports Value References value references

Filter by label (Content by label)

showLabels	false
max	6
showSpace	false
sort	title
cql	label = "macro-workflowparameter" and label = "parameter-options" and label = "example" and space = currentSpace ( )

3.0+

Panel

bgColor	#DEEBFF

Info

Parameter values and unprocessed content

When adding a space workflow, a parameter reference value may only be available for use by the workflow after a workflow process occurs - such as a transition.

For example, the initial state should not include the use of the parameter reference value for a duedate due date or pre-assigned reviewers for approvals to avoid blocking your workflow as these values may not be available until after a workflow process has taken place

To process content and ensure parameter values are set up, a space admin can also choose to Initialize states on applying a space workflow. This action will process the pages and the workflow parameter value will be available for use by the workflow in the initial state.

Events

The following Eventsfollowing events are generated when page-level parameters are updated

pageparameterupdate

A workflow trigger can be configured to listen for this event.

Examples

When the following workflow is first added to a space or page in a space, then a space admin can edit the value via via Parameters - Space Tools.

...

A new value for the parameter added to the the Parameters dashboard will be used when the workflow is added to the content.

...

A default value needs to be added to the body of the workflow parameter for the parameter value to be editable in the space tools Parameters parameters dashboard. Editing

Editing the parameter value in

...

the space parameters dashboard will not change the value used in a workflow that has already been added and applied to content in the space.

Adding edit=true allows end-users to edit the value at the page or blog post level, both in Page Mode and Space Mode page mode and space mode.

Code Block

language	text

{workflow:name=Parameters}
	{workflowparameter:Review Group|type=group|edit=true}
      confluence-users
   {workflowparameter}
   {state:Test}
	  {approval:Review|group=@Review Group@} 
   {state}
{workflow}

...

Versions Compared

Old Version 6

New Version Current

Key

Parameters

Events

Examples