Workflow Parameters
Overview
Workflow parameters allow you to add dynamic information and parameter values to your workflow – they are placeholders for information that is located somewhere else.
One or more editable workflow parameters can be added to a workflow. Their values can be changed at the space level. Each time the workflow encounters the workflow parameter, for example in a trigger action, the value at that moment in time is retrieved.
Workflow parameters can be used to help manage your reviewers or expiry dates for your approved pages. Using workflow parameters allows your workflow to dynamically adapt to changing situations - for example, using a workflow in different spaces each with different team members that must be added as reviewers - without editing the workflow template itself.
Where can they be used?
You can use parameter references in the following situations
in workflow approvals for the values of reviewers
in workflow states as a value for state expiry
trigger actions that support workflow parameters
Types of workflow parameter
Workflow parameters can be created to use different data types for the content value.
string workflow parameter value is a string of characters
user workflow parameter value is one or more Confluence usernames
group workflow parameter value is one or more Confluence group names
duration workflow parameter value is a 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.
A workflow parameter cannot be used as a value for another workflow parameter.
Example
You can use a user workflow parameter to manage the reviewers for your workflow approvals.
In a 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 "@Tea…"
When the workflow is applied to the content, the value(s) of the @Team_Reviewers@ workflow parameter is added to the workflow popup. These are the users who must undertake the content review.
In the space settings Document Management dashboard the number of parameters defined in a workflow is displayed when the workflow is enabled for the space.
The values of the workflow parameters used by the workflow in the current space are edited by choosing the @ Parameters button.
The @ Parameters button is only displayed if the workflow includes at least one workflow parameter and is made active in the space document management dashboard. Workflow parameters default value can also be changed by editing the workflow template.
Choose @ Parameters to display all workflow parameters in a dialog box.
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; for the project team or the expiration due date.
If the workflow is added as a page-level workflow, the value of the workflow parameter can be edited using the page tools menu option, Manage Workflow Parameters.