This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email support@appfire.com

Workflow Parameters

Owned by Robert Alexander Marshall
Last updated: Sept 20, 2023
4 min read

Overview

Workflow parameters 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. Their values can be changed at space level. Each time the workflow parameter is encountered by the workflow, for example in a trigger action,  the value at that moment in time will be retrieved.

Workflow parameters can be used to manage your reviewers or expiry dates for your approved pages. This 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.

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 types of data for the content value.

Adding a string type parameter as a placeholder for a project name value using workflow parameter

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

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.

Editing a user parameter used as a placeholder for approval reviewers with workflow builder

  • 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 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 using the Set Parameters button.

The Set Parameters button is only displayed if the displayed workflow in space workflow configuration includes at least one workflow parameter.

Choose Set 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 to an individual page, the value of the workflow parameter can be edited using the page tools menu option, Manage Workflow Parameters.

Related pages

Â