Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
Excerpt | ||
---|---|---|
| ||
Define pre-requisite conditions for approvals, select transitions and triggers |
Conditions allow you to specify additional prerequisite requirements for Triggers and some Transitions.
They are a set of optional parameters which can be added to the macros (listed below) to impose additional limits on when the macro will be active.
In addition, due to support for Value References, you can even create your own custom conditions by comparing metadata values.
Basic example
Code Block | ||
---|---|---|
| ||
{workflow:name=Conditions} {state:Editing|approved=Done|rejected=Editing} {approval:Review|permission=administer|assignable=true} {state} {state:Done|final=true|updated=Editing} {state} {workflow} |
In the example above, only an administrator can review the content.
Compatible Macros
Note: If a macro has a parameter of the same name as a condition, the parameter – and documentation for that parameter on the macro page – takes precedence.
|
Conditions
Condition | Value | Notes | Ver | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
A specific value, of valid type for the value reference.
| Does the value of a value reference match the specified value?
| |||||||||||||||
If used in a trigger macro that's listening to the | ||||||||||||||||
One invalid parameter in a list of users in a conditionWILL disable the transition for the other listed users. The non-existent parameter is a blocker for an approval or a state-selection transition. | ||||||||||||||||
| A comma-separated list of group names
| Is the current user a member of one or more of the specified groups? | ||||||||||||||
When applied to the approval macro it is an approval macro parameter - it is not used as a condition. For example, you can prefix the list (not items in the list) with | ||||||||||||||||
| Name of an {approval} | Has an
| ||||||||||||||
When applied to an approval macro in a state with multiple | ||||||||||||||||
| A comma-separated list of content labels. | Does the content have one or more of the labels specified? | ||||||||||||||
| Title of required ancestor page.
| Does the current page have a parent or ancestor page of the specified page title? | ||||||||||||||
|
| Is this page set as the space home page?
See also: How to set space home page | ||||||||||||||
|
| Did the content editor uncheck the "Notify watchers" checkbox (indicating a "minor change") before updating the content?
| This condition can only The | |||||||||||||
This condition can only be used in a trigger macro when listening to either the | ||||||||||||||||
|
| Is the page an orphan (no parent page)?
| ||||||||||||||
| A comma-separated list of content labels. | Does the parent (or any ancestor pages) have one or more of the labels specified?
| ||||||||||||||
|
| Does the user have the specified permission for the content?
See also: Roles and Permissions | ||||||||||||||
† Irrespective of additional view restrictions resulting from Publishing ‡ Additional administrators can be defined via the | ||||||||||||||||
| A space key.
| Is the page or blog post in the space defined by the space key?
Note: The space key is usually shown in URLs, or on the Space Tools → Space Overview screen. | ||||||||||||||
| A state name. | Is the workflow for this content currently in the named state?
| ||||||||||||||
| A state name. | Is there an unpublished version of this content in the corresponding Draft Space?
| ||||||||||||||
This condition requires the Comala Publishing app to be installed. | ||||||||||||||||
| Content title.
| Does the content (page or blog post) have the specified title?
| ||||||||||||||
| Comma-separated list defining one or more users via their username or user groups.
| Is the current user one of the users listed? Note: You can include
| ||||||||||||||
When applied to the approval macro it is an approval macro parameter - it is not used as a condition. You can prefix the list (not items in the list) with | ||||||||||||||||
| Comma-separated list of Value References | Does the value reference define users? This is useful when using workflowparameter macro to create editable value references – you can check to see if the entered values are valid user accounts.
| 4.1 | |||||||||||||
Denotes conditions which can only be used on pages, not blog posts. † Conditions are evaluated as AND conditions, with the exception of user and group. When both conditions are used, it's applied an OR clause i.e., (user or group) either one of those parameters is required for the condition to be true. |
Negation
Conditions are compared to values. Values can optionally be negated with a !
(pling / exclamation mark) symbol:
Code Block | ||
---|---|---|
| ||
{...|condition=value|...} -- value must match {...|condition=a,b,c|...} -- one or more of the values must match {...|condition=!value|...} -- value must not match {...|condition=!a,b,c|...} -- none of the values must match |
Invalid workflow parameter for a user
One invalid parameter in a list of users in a condition WILL disable the transition for the other listed users. The non-existent parameter will act as a blocker for other users.
Table of Contents | ||||
---|---|---|---|---|
|
Invalid workflow parameter for a user in a condition for a select transition
If a workflow parameter is used to specify a user for a state-select
transition the transition will be disabled If the user set in the parameter is invalid (deleted or non-existent).
The transition will become active if the parameter becomes valid by adding a valid value or is deleted.
For example if the workflow parameter @myParam@
has an invalid user value, the transition button in the workflow popup will be disabled.
Code Block | ||
---|---|---|
| ||
{state:In Progress|taskable=true} {state-selection:states=Approved|user=@MyParam@} {state} |
If the invalid workflow parameter is one of a list of users for the state-select
transition, the transition will be disabled for the other users listed in the condition. The non-existent parameter is a blocker for the transition.
Code Block | ||
---|---|---|
| ||
{state:In Progress|taskable=true} {state-selection:states=Approved|user=@MyParam@, admin, elle} {state} |
An error is shown indicating that there is an error in the workflow definition regarding the list of users who can undertake the transition.
Invalid workflow parameter in a condition for an approval
If a workflow parameter is used to specify a single user for an approval, the Approve and Reject buttons in the workflow popup will be disabled if the user set in the parameter is invalid (deleted or non-existent).
Code Block | ||
---|---|---|
| ||
{state:Review|approved=Approved|rejected=Rejected} {approval:Review the page|user=@MyParam@} {state} |
The transition will become active if the parameter becomes valid by adding a valid value or is deleted.
If the invalid parameter is one of a list of users for the approval then the approval is disabled for all users.
Code Block | ||
---|---|---|
| ||
{state:Review|approved=Approved|rejected=Rejected} {approval:Review the page|assignable=true|user=@MyParam@, admin, elle} {state} |
The non-existent user defined in the parameter blocks the approval.
An error is shown indicating that there is an error in the workflow definition regarding the list of users who can approve.
The approval will become active for each defined user if the parameter becomes valid by adding a valid value or is deleted.
Examples
Filter by label (Content by label) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|