Roles
Definition
A role is a dynamic variable used to assign actions to a Support person or Support group (groups / employees) without having to name each of them individually.
- Roles are used in workflows, business rules, scheduled alerts and email templates.
- They are grouped by category based on their context of use: Domain, Customized, System, CI roles.
EndDefinition
Operating principle
- You can use the
icon found next to fields proposing the use of roles to access a list of roles. A data entry wizard will appear.
- Each Support person/group is searched for when the role is called by the system so that the current value within the context of use is retrieved. The relevant users are identified by their name and email address. The value of the role (and Support person/group) can therefore vary each time it is called. You are however, not required to modify it each time.
Support person performing a workflow action identified when the action starts; Recipients of a notification email when an alert is triggered.
Classification of roles
"Domain" Roles | |
---|---|
Syntax: #[WF_ROLE.Name of domain role]#
|
![]() |
"Customized" Roles | |
Syntax: #[CUSTOM_ROLE.Name of customized role]#
|
![]() |
"System" Roles | |
Syntax: #[WF_ROLE.@Name of system role]#
|
![]() |
"CI" Roles | |
Syntax: #[WF_ROLE.Name of CI role]#
|
![]() |
Examples
1. Roles in the Phone process workflow:
- The Analysis & Resolution step is performed by the Phone maintenance role:
--> Including the #[WF_ROLE.Phone]# domain role enables you to identify the group of Support persons based on the location of the incident requestor.
- The User Approval step is performed by the role identifying the incident requestor:
--> the #[CUSTOM_ROLE.Requestor]# system role
Domain roles: Incidents are assigned to the Technician role and are handled by a different group based on the location of the user:
Role | Domain | Group |
---|---|---|
Technician | New York |
Company 1 |
Boston |
Company 2 |
|
HQ |
Internal IT |
Notes
- When the SQL query associated with a customized role returns several values, only the first one will be taken into account.
Best practice
- To ensure that no syntax errors are made, you should use the data entry wizard to insert roles.
- We recommend that you enter roles manually only if you are copying and pasting from an existing email in order to adapt the syntax to another situation.
- Customized roles:
- To reactivate a customized role, you should select an end date after the current date or clear it.
- If you want a customized role to continue working correctly in existing elements but you want to make it unavailable for new elements, you should archive the role by entering an end date. You should not delete the role.
- If you want a customized role to work correctly in alerts that return a list of records, you should always use the syntax in(@ID@ in the SQL query instead of =@ID@.
Create a customized role, Manager for financial approval of the requestor
SELECT AM_VALIDATOR.employee_id
FROM sd_request
INNER JOIN am_employee AM_REQUESTOR
ON AM_REQUESTOR.employee_id = sd_request.requestor_id
INNER JOIN am_employee AM_VALIDATOR
ON AM_VALIDATOR.employee_id = AM_REQUESTOR.validator_id
WHERE sd_request.request_id IN ( @ID@ )
Caution
- To select a role in the data entry wizard, click the role you want and close the window. You are not required to click any button to validate.
- In the event of an error, delete the instruction in the email manually and open the data entry wizard again.
Screens description: Customized roles
Menu access: Administration > Parameters > Customized Roles
Customized roles
Description: Name of the customized role.
End Date: The end of validity of the customized role after which it can no longer be used.
Define a context for a customized role
Table Name: Context where the customized role will be used.
A role associated with the AM_ACTION table can only be used for a workflow linked to the same table.
Data Type: Type of data returned by the SQL query:
- Email: Email address
- Employee: User login
- Group: Group login
SQL: SQL query run when the role is called. It returns values based on the type of data specified.
- The @ID@ variable identifies the current record.
Procedures and Wizards
How to specify roles in an email
1. Display the screen for creating an email.
2. Specify the roles you want:
Click
next to the fields proposing the use of roles.
In the data entry wizard:
- Select the tab containing the role you want to insert.
See Description of categories
- Click the role you want.
- Close the window. The role syntax will automatically be inserted.
- You can also enter the role you want manually. You must ensure that the syntax for the category is correct.
3. To modify or delete the role in the email, delete it manually and, if required, select it again as described in step 2.
How to create a customized role
1. Select Administration > Parameters > Customized Roles in the menu and click .
2. Enter the name of the role and the end date if applicable and click [ FINISH ].
3. Select the Context tab and click . Define the settings of the customized role and click [ FINISH ].
Wizards
List of system roles
Role | Function | Notes | Corresponding Field/Tag |
---|---|---|---|
@Recipient | Recipient of the incident or request |
|
|
@Recipient and default Group | Recipient of the incident/request and default group |
|
|
@Requestor | Person reporting the incident/request |
|
|
@Requestor and default Group | Requestor of the incident/request and default group |
|
|
@Closing Group | Group performing the closing action, changing the meta-status of the incident/request to Completed |
|
|
@Group in charge of Release | Group associated with the release project |
|
|
@Incident/Request Owning Group | Group to which the person creating the incident/request belongs |
|
|
@Catalog Group | Group in charge of the incident/request using the topics defined in the incident or service catalog |
|
|
@Submitted by | Person who created the incident/request |
|
|
@Closing Support Person | Person performing the closing action, changing the meta-status of the incident/request to Completed |
|
|
@Asset Owner | Main user to whom the asset is assigned |
|
|
@Manager of Recipient's Location | Manager of the location where the recipient of the incident/request belongs |
|
|
@Manager of Location of Requesting Person | Manager of the location where the requestor of the incident/request belongs |
|
|
@Release Manager | Support person associated with the release project |
|
|
@Recipient Department Manager | Manager of the department where the recipient of the incident/request belongs |
|
|
@Requestor Department Manager | Manager of the department where the incident/request's requestor belongs |
|
|
@Incident Owner | Manager of the incident/request |
|
|
@Recipient Manager | Direct Manager of the incident/request recipient |
|
|
@Catalog Manager | Manager in charge of the incident/request using the topics defined in the catalog |
|
|
@CI Manager | Manager of the CI involved in the incident/request |
|
|
@Requestor Manager | Direct Manager of the incident/request's requestor |
|
|
@@Manager of Group responsible for the Catalog | Manager of the group in charge of the incident/request |
|
|
@Manager for Financial Approval | Direct Financial Approval Manager of the incident/request's requestor |
|
|