ON THIS PAGE:
Tokens are system-generated variables that can be added to the message content of an action. The token variable name forms part of the text of an action message, once it has been added.
Inserting Tokens
In the message box of an action, insert tokens as follows:
- Position your cursor where you want to add a token.
- Click a row in the Tokens grid, which is positioned beneath the Message box, to select a token.
- Click Insert Token.
The selected token is inserted into the message, at the correct location. The token name is enclosed in square brackets, for example: [Monitor]. - Repeat the process to add more tokens.
Removing Tokens
Tokens can be removed from the message, and from the subject line.
- Position your cursor and press the delete key to delete the token from the message content, or from the subject line.
Standard Available Tokens
Token | Description |
Asset | The asset being tested. |
Asset Report | A link to the asset report for the asset being tested. |
Case Id | The Case Id of the case raised for the event (if applicable) |
Case Link | A link to the case raised for the event (if applicable) |
Comment Link | Open the asset report timeline for the event ready to enter a comment. |
Confidence | The confidence level for the entity being tested. |
Entity | The entity being tested. |
Event Id | Unique identifier for the event. |
Event View | The list of events for this monitor. |
Metadata | Associated event metadata. |
Monitor | The name of the monitor. |
Original State | The original state of the event (not overridden). |
Potential Impact | The potential impact of the state. |
Previous State | The previous state of the event. |
Process | The name of the process. |
Recommended Action | The recommended action to take. |
Severity | The severity of the event. |
State | The state of the event. |
State Reason | The reason for the state (may be overridden). |
Suppression Reasons | The reasons this event may have been suppressed. |
Test | The name of the test. |
Timestamp | The time of the event. |
Trend | A link to the Explorer trend for the entity being tested. |
Trend End Time | The end time of the Trend used for creating a custom Explorer Trend URL. |
Trend Start Time | The start time of the Trend used for creating a custom Explorer Trend URL. |
Value | The value of the entity being tested. |
Auxiliary Data Tokens
If the test has auxiliary data, this is available as a token in the message content.
- Type the token, enclosed in square brackets, so that the literal value at the time of the event is included in the message content.
The auxiliary data is also included in the message under the token, below other event information.
Token Outcomes in a Message
When the action is invoked, the token is displayed as the literal value at the time of the event. For example:
Token | Literal Value in SMS or Email Action |
[Monitor] | Monitor 1 |
[State] | High Exceeded |
[Timestamp] | 20/7/2011 2:18:00 PM |
And below are some examples of auxiliary data tokens:
Token | Auxiliary Data |
[Ninety] | Fixed Value: 90 |
[Pressure] | Attribute :thp |
Some of the tokens show a hyperlink, as described in the next section.
Action Hyperlinks
Some of the tokens available for use by actions include hyperlinks.
For actions that use these tokens, the hyperlink is included in the message.
These tokens are:
Asset Report: A link to the asset report for the asset being tested.
- Click the hyperlink in the message content to view the asset report.
Comment Link: A link to the comment tab of the Event, Info and Comment screen for the event that triggered the action.
- Click the hyperlink in the message content to open the Event, Info and Comment screen for the event that triggered the action. The timeline report appears, containing the event that caused the email action. The Event, Info and Comment screen is open, with the cursor in the comment box, in the Comments tab.
EventView: The list of events for this monitor.
- Click the hyperlink in the message content to view the list of events for the monitor.
Trend: A link to the Explorer trend for the entity being tested.
- Click the hyperlink in the message content to view the Explorer trend for the entity.