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 as a parameter values value to your workflow  – they are placeholders for information that is located somewhere elseelsewhere.

One or more editable workflow parameters can be added to a custom 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 the value at that moment in time 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. Using workflow parameters allows By using a workflow parameter, your workflow to can dynamically adapt to changing situations - for .

For example, using a you want to use the same workflow in different spaces, but each with space uses different team members that must as workflow approval reviewers

  • users or user groups can be added as

reviewers - without editing the workflow template itself
  • a value for a workflow parameter

  • the workflow approval is configured to assign users as reviewers using the parameter value

  • the parameter value used by the workflow is set in the space document management dashboard in each space

Tip

The included Quality Management System Workflow uses a workflow parameter value to assign reviewers to the approval in the In Approval state.

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

...

Excerpt
nameworkflow_parameters_types

You can edit a custom workflow to add one or more workflow parameters. When adding a workflow parameter, you can select one of several data types for the

...

value.

...

Adding a string type parameter as a placeholder for a project name value using workflow parameterImage Added
  • 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.

...

You cannot use a workflow parameter

...

as a value for another workflow parameter.

Example

You can use a user workflow parameter to manage the reviewers for your workflow approvals.

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 Removedit has been created with a value that Editing a user parameter used as a placeholder for approval reviewers with workflow builderImage Added
  • its value is the users Suni and Matilde

In the Approval content review, we simply add the name of the workflow parameter as reviewers.

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

Here, we have used configured the approval to use the workflow parameter value to set all the reviewers that have to who must approve it.

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

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

Info

Once the The workflow parameter is added to the workflow, it will appear a workflow appears as an option in the dialog box when typing "@Tea…"

When you apply the workflow is applied to the contenta document, 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.

Excerpt
nameworkflowparameters_example_reviewers_spaceedit

In the space settings Document Management dashboard the When you make a workflow active, the number of parameters defined in a workflow is displayed when in the workflow is enabled for the spacespace document management dashboard.

cdmc_documentmanagementdashboard_customworkflow_paramters_enabled.pngImage RemovedThe cdmc-spacedocumentmanagementdashboard_customworkflow_active_with3parameters.pngImage Added

You can change the values of the workflow parameters used by the workflow in the current space are edited by choosing the @ Parameters button lozenge and editing the values.

cdmdc_spacewf_parameters_button.png

The @ Parameters button lozenge is only displayed if the workflow includes at least one workflow parameter and is made active in the space document management dashboard. Workflow parameters The workflow parameter default value can also be is 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 is used when a workflow event next encounters the workflow parameter, for example, when the workflow is applied to other content across the spaceon the creation of a new page.

This allows the same workflow to be used use of a workflow in different spaces, with different values for the reviewers for , the approval; for the project team, or the expiration due date in each space.

Tip

You can add an additional workflow parameter parameters for each different team of reviewers or an expiration due date dates for a different workflow state. This allows the management of you to manage your document process locally, changing the values for the workflow parameter for each space without the need to create creating a different workflow for each space.

If you add the workflow is added as a page-level workflow, you can edit the value of the workflow parameter can be edited using using the Manage Workflow Parameters option in the page tools menu option, Manage Workflow Parameters.

...

Related pages