Versions Compared

Key

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

...

Parameters

Mandatory

Default

Description

unnamed first parameter

Yes

 

Name of the approval. Names must be unique withing a state macro and can use any character set supported by Confluence expect the special characters used by the workflow syntax and Confluence (e.g. {. |}, ,|, etc.).

user(1)

No

 

A comma-separated list of specific user names or Value References.(2)

group(1)

No

 

A comma-separated list of specific group names or Value References.(2)

exclude(3)

No A comma-separated list of specific user names or Value References who cannot approve or reject the approval.

selectedapprover(1)

No

 

A comma-separated list of specific user names, group names, or Value References to choose from, when a single approver is to be selected.

selectedapprovers(1)

No

 

A comma-separated list of specific user names, group names, or Value References to choose from, when one or more approvers are to be selected.

weight

No

40

A numeric value used to determine the order in which multiple approvals within a given state appear. The lightest weight approvals are shown first, and the heaviest last. Valid values range from 1 to 2^32^.

label

No

 

Sets the label which must be present on the page or news/blog post to make the approval active.

assignable

No

false

If set to true, the user could assign the approval to another user or users.

rememberassignees
NofalseIf set to true any subsequent times the workflow transitions to a state with this approval, it will automatically be assigned to the same users who were assigned last time.

minimum

No

1

A numeric value or Value Reference that sets the minimum number of users that have to approve the approval.

credentials

No

0

If set to 1, then approvers have to provide their password; if set to 2, approvers need to provide both their user name and password. See Credentials below.

approvelabelNoApproveSets the text that will be displayed in the approval "approve" action button.
rejectlabelNoRejectSets the text that will be displayed in the approval "reject" action button.

Conditions

No

 

Sets the conditions that have to be met in order to enable this approval. If no conditions are set, then any user who has permission to see draft versions can approve or reject.

...