Macros Supported in SapphireIMS

SapphireIMS provides a list of pre-defined macros or keywords along with asset and service desk mail notification templates or form fields which are replaced with values from the records when the Emails are sent or when the field is pre-populated using queries which contain these macros.

Macros can be inserted into both Subject and Body of the Emails.

Macros which are field values in the record (both fixed and additional fields) can be inserted by selecting the field from a drop down list which generates the macro in a text box. This can be then copied into the subject or body of the mail.

There are other Macros which have to be entered manually in the body field. The Macros are given below under each of the areas.

In the case of form fields, dynamic queries could be written to pre-populate the field. For example, if it is a select box, then the selections can be pre-populated with a set of values which can be fetched using a DB query. The query itself could use a macro and at the time of execution of the query the macro will be substituted with the actual value.

The macros are listed under different areas like User Management, ITSM and CMDB.

User Management

These macros are used in Email notifications.

Serial No	Macro Name	Description
1	MACRO_CUSTOMER_TITLE	Replaces with the customer title field.
2	MACRO_USER_NAME	Replaces with the user ID field
3	MACRO_FULL_NAME	Replaces with the full name of the user
4	MACRO_EMAIL	Replaces with the Email address of the user
5	MACRO_UPN	Replaces with the user principal name (applicable if AD users are present)
6	MACRO_EMPLOYEE_ID	Replaces with the Employee ID

Asset Management

Macros in the Mail Subject

Serial No	Macro Name	Description
1	Asset Number	Asset Number
2	Asset Type	CI Type
3	Asset Status	Configured Asset Lifecycle Field
4	System Name	System Name of the Asset
5	Host Name	Host Name of the Asset
6	Action	Action performed on the Asset (for example, New Asset Added)
7	Allocated User	This refers to the user to whom the asset is allocated
8	Asset Verification Status	Status of the Asset Verification (Not applicable for Pre-notification)

Macros in the Mail Body

Serial No	Macro Name	Description
1	MACRO_ASSET_EXPIRY_TIMESCALE	Date on which the license of the asset expires
2	MACRO_DELINKED_RESOURCE	Host name de-linked from inventory
3	MACRO_ASSETTYPE	Asset Type
4	MACRO_ASSET_NUMBER	Asset Number
5	Mismatch Comment	The comment entered if the verification status is a mismatch. (Not applicable for Pre-Notification)

Compliance notification related macros in the Mail Subject and Mail Body

{Rule Name} - Name of the e-mail notification rule

{Rule Type} - Type of the e-mail notification rule (agreement expiry rule, license expiry rule, non compliance rule)

{Notify Before Days} - Notify number of days before the license or agreement is going to expire

Service Desk

Macros for both Mail Subject and Body in Email Notification Templates

Serial No	Macro Name	Description
1	Category	Category of the request
2	Sub Category	Sub Category of the request
3	Location	Location of the requestor
4	Department	Department Name of the requestor
5	Request ID	Unique ID of the submitted Request
6	Action	This refers to the action performed on the request. For example, State Changed from New to Assign
7	Title	Title of the request
8	SLA Name	Configured SLA Name for which the mail is sent (Mail Notification can be sent before or after SLA breach)
9	Escalation Level	Escalation Level defined in the SLA for which the mail is sent
10	Breach Time	Breach Time of the SLA for which the mail is sent
11	Time Interval	Time Interval of the SLA for which the mail is sent
12	Cc Mail ID	Mail ID to which a copy of the mail is to be sent
13	Contact Numbers	Contact Numbers of the submitter of the request
14	Derived Field1, Derived Field2 and Derived Field3	Derived fields of the request to be sent
15	Description	Description of the service request
16	Expected Closure Time	Expected Closure Time of the request
17	Impact	Impact of the request
18	Impacted Asset	Asset for which the request is raised
19	Priority	Priority of the request
20	Service	Service of the request
21	Source	Mode of submission of the request
22	State	Work flow state of the request
23	Submission Time	Time of submission of the request
24	Last Updated Time	Time of last update of the request
25	Type	Type of the request
26	Urgency	Urgency of the request
27	Work group	Work group of the request

Macros for the Mail Body in Email Notification Templates

Serial No	Macro Name	Description
1	MACRO_REQUESTID	Request ID to which the mail notification has to be sent.
2	MACRO_STATE_CHANGE_OPERATIONS	Next possible states based on workflow. Used for e-mail based approval.
3	MACRO_AUTOCLOSE_TIMEINTERVAL	The time interval after which the request will be automatically closed.
4	MACRO_AUTOSTATETRANSITION_TIMEINTERVAL	The time interval after which auto state transition of the request will happen.
5	MACRO_AUTOSTATETRANSITION_PRENOTIFICATIONLEVEL	Auto state transition pre-notification level. Ex: Level One and Level Two.
6	MACRO_AUTOSTATETRANSITION_FROMSTATE	The state from which the auto state transition/auto functional escalation is happening.
7	MACRO_AUTOSTATETRANSITION_TOSTATE	The state to which the auto state transition/auto functional escalation will happen.
8	MACRO_LINKED_REQUESTID	Request ID to which the current record is linked.
9	MACRO_REMINDER_PRENOTIFICATIONLEVEL	Reminder pre-notification level. Ex: Level One and Level Two.
10	MACRO_REMINDER_TIME	Reminder breach time. This refers to the time that elapses after the configured reminder date. For more information on Reminders, see Reminders.
11	MACRO_OLD_OWNER	Previous owner name. Used in owner change template.
12	MACRO_NEW_OWNER	New owner name. Used in owner change template.
13	MACRO_OLD_APPROVAL_MANAGER	Previous approval manager name. Used in approval manager change template.
14	MACRO_NEW_APPROVAL_MANAGER	New approval manager name. Used in approval manager change template.
15	MACRO_REQUEST_SUMMARY	The record summary block.
16	MACRO_CLICK_HERE_FOR_DETAILS	Link to the record,
17	MACRO_USER_FULLNAME	Replaces with the User's full name. The following conditions apply. This macro can be used in the Email body for only Email routing configuration if configured for "Users" or "Specific Role" under "Notify To" and only for a single selected user or a single selected role, and with "Info Role" not configured.
18	MACRO_ROUTING_ROLE	Replaces with the Role name . This macro can be used in the Email body for only Email routing configuration if and only if configured for "Info" roles and only for a single selected role, and with "Notify To" not configured.

Note: The pre-defined macros in the mail subject have to be given inside curly braces {} and the pre-defined macros in the mail body have to be specified as listed above.

There are macros for use in form fields.

Macros supported in form field’s Dynamic Query and Default value query

USERID_MACRO - UserID of the logged in user.

ASSETID_MACRO - ID of the asset selected in ticket’s fixed field CI.

PROBLEMID_MACRO - ProblemID of the ticket on which the query is getting executed.

PROJECT_MACRO - ID of the project to which the ticket belongs to.

SERVICE_MACRO - Service ID of the ticket.

CATEGORY_MACRO - Category ID of the ticket.

SUBCATEGORYID_MACRO - Sub category ID of the ticket.

DERIVEDFIELD1_MACRO - Derived Field Level One ID of the ticket.

DERIVEDFIELD2_MACRO - Derived Field Level Two ID of the ticket.

DERIVEDFIELD3_MACRO - Derived Field Level Three ID of the ticket.

STATE_MACRO - Start State ID of the project.

SUBMITTER_MACRO - UserID of the Submitter of the ticket.

Macros supported in CMDB form fields

The following macros can be used in the CMDB module for form fields added from Settings > Asset and Inventory Management > Form Fields

MACRO_USERID

MACRO_USER_FULL_NAME

MACRO_MODULE_ID

MACRO_ASSET_ID

MACRO_ASSET_NUMBER

MACRO_ASSET_TYPE

MACRO_ALLOCATED_TO

MACRO_LINKED_INVENTORY

MACRO_ASSET_STATUS

MACRO_LOCATION

MACRO_DEPARTMENT

These macros can be used for asset additional fields in the CMDB > Asset Management > Asset Edit page

Macros supported in dependent additional field query

MACRO_PARENTFIELD_ID - FieldID of the additional field on which the current additional field depends.

MACRO_PARENTFIELD_VALUE - Selected value of the additional field on which the current additional field depends.

MACRO_CHILDFIELD_ID - FieldID of the dependent additional field.

MACRO_USER - UserID of the logged in user.

MACRO_SUBMITTER - UserID of the submitter of the ticket.

MACRO_PROJECT - ProjectID of the ticket.

MACRO_PROBLEMID - ProblemID of the ticket.

MACRO_SERVICE - ServiceID of the ticket.

MACRO_CATEGORY - CategoryID of the ticket.

MACRO_SUBCATEGORY - SubCategoryID of the ticket.

MACRO_DERIVEDFIELD1 - Derived Field Level One ID of the ticket.

MACRO_DERIVEDFIELD2 - Derived Field Level Two ID of the ticket.

MACRO_DERIVEDFIELD3 - Derived Field Level Three ID of the ticket.

MACRO_STATE - Start state of the project.

MACRO_ASSETID - ID of the asset selected in ticket’s fixed field ‘CI’.

MACRO_SEARCHTEXT - Search text that the user enters while searching for a value in the dependent additional field.

Macros used in auto request transition

REQUEST_PROPERTY_MACRO - ID of the request property mentioned in the configured properties file.

PROBLEMID_MACRO - ProblemID of the ticket.

Note: For all other pre/post actions , supported MACROs will be mentioned in the sample properties file.