Candidate user expressions
A candidate user is a user who can perform a workflow task. You can specify candidate users by using candidate user expressions, such as role(Business Steward), user(John), or group(Data Custodians).
You can include a comma or other punctuation marks, except semicolon, in your candidate user expressions. If you use punctuation marks, you must enclose the user expressions in curly brackets, for example {role(Business Steward; Community, Inc)}.
It is best practice to use curly brackets for all user expressions, whether the user expression contains a punctuation mark or not.
| Expression | Description |
|---|---|
| role(<roleName>) |
Assigns the task to users with the specified role on the workflows business item. In case of a global workflow, you can use global role names. Example: role(Business Steward): Assigns the task to users with the Business Steward role. |
| role(<roleName>;<communityName>) |
Assigns the task to users with the specified role on the specified community. This is independent of the current workflow business item. Example: role(Business Steward;Sales Community): Assigns the task to users with the Business Steward role in the Sales community. |
| role(<roleName>; <communityName>; <vocabularyName>) |
Assigns the task to users with the specified role on the vocabulary with the specified name in the given community. This is independent of the current workflow business item. Example: role(Business Steward;Sales Community;Pre Sales): Assigns the task to users with the Business Steward role on the Pre Sales vocabulary in the Sales community. |
| role(<roleName>;<entityLevel>) |
Assigns the task to users with a role on the workflow business item, but only if they have the role on the specified level. Possible entity levels are Term, Vocabulary and Community, which respectively indicate roles to be on the Asset, Domain or Community level. Example: role(Business Steward;Term): Assigns the task to users with the Business Steward role on the asset. |
| role(<roleName>;<relationName>) |
Assigns the task to users with the specified role on assets that are related to the current workflow business item with the given relation name. Example: role(Stakeholder;Complies To): Assigns the task to stakeholders of assets that are related by the Complies To relation. |
| role(<roleName>; <entityLevel>; <relationName>) |
A combination of the role(<roleName>; <entityLevel>) and role(<roleName>; <relationName>) expressions. This expression assigns the task to users of the target-related asset with a role on the given entity level. Example: role(Stakeholder; Term; Complies to): Assigns the task to stakeholders on the Asset level of assets that are related by the Complies to relation. |
| user(<userName>) |
Assigns the task to the user with the specified name. Example: user(John): Assigns the task to John. |
| group(<groupName>) |
Assigns the task to the users in the specified group. Example: group(Data Custodians): Assigns the task to the users in the Data Custodians group. |