Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
nameworkflowparameters_use_rationale

Workflow parameters allow you to add dynamic information and parameter values to your workflow  – they are placeholders for information that 's 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 parameter is encountered by encounters the workflow parameter, for example in a trigger action,  the value at that moment in time will be is retrieved.

Excerpt
nameworkflowparameters_use_example_short_desc

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

...

Workflow parameters can be created to use different data types of data for the content value.

...

  • string workflow parameter value can be is a string of characters

  • user workflow parameter value can be is one or more Confluence usernames

  • group workflow parameter value can be is one or more Confluence group names

  • duration workflow parameter value can be is 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

...

Excerpt
nameworkflowparameters_example_reviewers

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 builderImage RemovedEditing a user parameter used as a placeholder for approval reviewers with workflow builderImage Added
  • 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.

editing an approval using workflow builder to add reviewers using a workflow parameter as a value referenceImage Removedediting an approval using workflow builder to add reviewers using a workflow parameter as a value referenceImage Added

The workflow parameter name is added enclosed in the @ symbol.

Info

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 . These are the users who must undertake the content review.

Image RemovedImage Added
Excerpt
nameworkflowparameters_example_reviewers_spaceedit

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.

cdmc_documentmanagementdashboard_customworkflow_paramters_enabled.pngImage Added

The value values of the workflow parameter can be changed parameters used by the workflow in the space settings Document Management dashboard by a space admin using the Set current space are edited by choosing the @ Parameters button.

Image Removedcdmdc_spacewf_parameters_button.pngImage Added

The Set @ Parameters button is only displayed if the displayed workflow in space workflow configuration 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 Set @ Parameters to display all workflow parameters in a dialog box.

Image RemovedImage Added

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.

Tip

You can add an additional workflow parameter for each different team of reviewers or an expiration due date for a different workflow state. This allows the management of your document process locally, changing the values for the 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.

...