Notification variables
Use notification variables to display dynamic information in the body of a notification such as a field value, a link to a record, or a link to system preferences.
Syntax
Specify a notification variable using this syntax:
${variable-name+variable-parameters}
The variable-name portion is always required. Not all notification variables support the variable-parameters portion. When available, most variable parameters are optional. See the list of available notification variables for variable names and available parameters.
Available variables
The system provides these notification variables.
| Variable | Description | Available parameters |
|---|---|---|
| $\{`field-name`\} | Display the value of the specified field. | None |
| $\{`image-field-name`\} | Display an image associated with a record. This variable is typically used with HTML to specify the source of an image element. | None |
| - $\{URI\} - $\{URI\_REF\} | Display a link to the current record.- URI: The link text is the word Note: These variables don't apply to records in Workspace. To link to a record in Workspace, create a mail script that prints a URL to a notification. For more information, see Linking to a record in Workspace. | Any valid sysparm URL parameter. For example:- sysparm_scriptlet - sysparm_view |
| - $\{`reference-field`.URI\} - $\{`reference-field`.URI\_REF\} | Display a link to the record listed in a reference field.- URI: The link text is the word LINK - URI_REF: The link text is the display value of the record. | Any valid sysparm URL parameter. For example:- sysparm_scriptlet - sysparm_view |
| $\{CMS\_URI\} | Display a link to the specified record within a CMS page. | <CMS-site>/<CMS-page>: The required relative path to the CMS page. |
| $\{notification:body\} | Display the body contents of an email template or email notification. Use this notification variable to specify where to display body content in an email layout. | None |
| $\{mail\_script:`script-name`\} | Run the specified mail script. | None |
| $\{NOTIF\_UNSUB\} | Display a link unsubscribe from this notification. | link_text: specify the text to display as a link within quotation marks. |
| $\{NOTIF\_PREFS\} | Display a link to set notification preferences. | link_text: specify the text to display as a link within quotation marks. |
| $\{comments:n\} | Display the most recent comments that were made on the target record. The number of comments to display is n. For example, `${comments:3}` displays the last three comments that were made to the record. To display all comments, use the variable `${comments}`. | Any number greater than 0. |
| $\{comments\_and\_work\_notes:n\} | Display the most recent comments and work notes that were made on the target record. The number of comments and work notes to display is n. For example, `${comments_and_work_notes:3}` displays the last three comments and work notes that were made to the record. To display all comments and work notes, use the variable `${comments_and_work_notes}`. | Any number greater than 0. |
Examples
Refer to the following examples to see how each notification variable is rendered in the output:
| Variable | Example | |||||
|---|---|---|---|---|---|---|
| $\{`field-name`\} | Source: `Incident ${number} - comments added` Output: `Incident INC1000001 - comments added` | |||||
| $\{`image-field-name`\} | Source: ` Image omitted: apple-watch.png notification image variable | |||||
| - $\{URI\} - $\{URI\_REF\} | $\{URI\} Source: `Click here to view incident: ${URI}` $\{URI\} Output: Image omitted: variable-uri.png $\{URI\_REF\} Source: `Click here to view incident: ${URI_REF}` $\{URI\_REF\} Output: Example that shows how the link text word Link serves as the link to the current record Image omitted: variable-uri-ref.png Example that shows how the link text displayed is the value of the record | |||||
| - $\{`reference-field`.URI\} - $\{`reference-field`.URI\_REF\} | Source: Image omitted: RelatedRecordLink.png Example that shows a link to a record listed in a reference field | |||||
| $\{CMS\_URI\} | Source: `${CMS_URI+ess/incident_detail}` Output: a link to a target CMS page such as `https://| $\{notification:body\} | Source: | Image omitted: email-layout-go-to-instance-button.png Output: How a variable for the email body works in an email layout. Image omitted: email-preview-with-layout.png How the variable for the link to notification preferences works. $\{mail\_script:`script-name`\} | $\{NOTIF\_UNSUB\} | $\{NOTIF\_PREFS\} | Parent Topic:Create an email notification |