Overview
Workflow parameters are value references that allow you to add dynamic information and parameter values to your workflow – they are placeholders for information that's located somewhere else.
One or more editable workflow parameters can be added to a workflow.
Each time the workflow parameter reference is encountered by the workflow, for example in a JSON trigger action, the value at that moment in time will be retrieved. This means your workflow can dynamically adapt to changing situations.
Workflow parameters can be used for example to manage reviewers or expiry dates for the workflow.
Where can they be used?
You can use parameter references in the following situations
any macro parameter (including macro bodies, where applicable) which support value references
JSON trigger actions that support workflow parameters
Types of workflow parameter
Workflow parameters can be created to use different types of data for the content value.
string workflow parameter value can be a string of characters
user workflow parameter value can be one or more Confluence usernames
group workflow parameter value can be one or more Confluence group names
duration workflow parameter value can be a time period or set date
list workflow parameter value is a list of values that are options for the value of the workflow parameter
You can create and edit workflow parameters using workflow builder.
Example
You can use a user workflow parameter to manage the reviewers for your workflow approvals.
In our workflow, we have created the user workflow parameter named Team_Reviewers.
it has been created with a value that is the users Suni and Matilde
In the Approval content review, we simply add the name of the workflow parameter as reviewers.
Here we have used the workflow parameter to set all the reviewers that have to approve.
The workflow parameter name is added enclosed in the @ symbol.
ℹ Once the workflow parameter is added to the workflow, it will appear as an option in the dialog box when typing "@Te…"
When the workflow is applied to the content, the value(s) of the @Team_Reviewers@ workflow parameter is added to the workflow popup as the users who must undertake the content review.
The value of the workflow parameter can be changed in the space settings Document Management dashboard by a space admin.
The changed value will be used by the workflow when it next encounters the workflow parameter, for example when the workflow is applied to other content across the space.
This allows the same workflow to be used in different spaces with different values for the reviewers for the approval.
You can add an additional workflow parameter for each different team of reviewers. This allows you to manage your review teams locally changing the values for the workflow parameter (a user type or group type workflow parameter) for each space without the need to create a different workflow for each space.
If the workflow is added as a page-level workflow to an individual page, the value of the workflow parameter can be edited using the page tools menu option, Manage Workflow Parameters.
