...
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
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 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 (in both both space mode and and page mode)
If the workflow parameter is configured aseditable
, a user can edit the parameter value using the ellipsis menu option in the workflow popup.Users – via the workflow popup (in both both space mode and and page mode)
If the workflow parameter is configured aseditable
, a user can edit the parameter value using the page tools menu option.Users – Workflow setup via the workflow popup (in both both space mode and and page mode)
If the workflow parameter is configured aseditable
, a user will be prompted to add or confirm the workflow parameter value(s) when adding the workflow to content
...
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 | Name of the parameter. | 3.0+ | ||||||||||||||
macro body | The default value for the parameter
| 3.0+ | ||||||||||||||
| The description for the parameter
| 3.0+ | ||||||||||||||
|
| Should this parameter be editable at the page or blog post level?
Tip: If set to
| 3.0.3+ | |||||||||||||
|
| Parameter type
| 3.0+ | |||||||||||||
|
| Required if the parameter List options
| 3.0+ |
Panel | ||
---|---|---|
| ||
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 following 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.
...