{"id":58918,"date":"2023-02-17T15:11:47","date_gmt":"2023-02-17T07:11:47","guid":{"rendered":"https:\/\/oihelp.corporate.ifs.com\/help\/sentinel\/working-with-sentinel-monitors\/tokens\/"},"modified":"2024-07-09T08:56:29","modified_gmt":"2024-07-09T00:56:29","slug":"tokens","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/sentinel\/working-with-sentinel-monitors\/tokens\/","title":{"rendered":"Tokens in Sentinel"},"content":{"rendered":"\n<p class=\"intro-text\">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.<\/p>\n<h2 class=\"page-subheading\">Inserting Tokens<\/h2>\n<p class=\"intro-text\">In the <strong>message<\/strong> box of an action, insert tokens as follows:<\/p>\n<ol class=\"intro-text\">\n<li>Position your cursor where you want to add a token.<\/li>\n<li>Click a row in the <strong>Tokens<\/strong> grid, which is positioned beneath the <strong>Message<\/strong> box, to select a token.<\/li>\n<li>Click <strong>Insert Token<\/strong>.<br \/>\nThe selected token is inserted into the message, at the correct location. The token name is enclosed in square brackets, for example: <strong>[Monitor]<\/strong><span style=\"font-family: 'Segoe UI', Arial, sans-serif;\">.<\/span><\/li>\n<li>Repeat the process to add more tokens.<\/li>\n<\/ol>\n<hr \/>\n<h2 class=\"page-subheading\">Removing Tokens<\/h2>\n<p class=\"intro-text\">Tokens can be removed from the message, and from the subject line.<\/p>\n<ul class=\"intro-text\">\n<li class=\"intro-text\">Position your cursor and press the delete key to delete the token from the message content, or from the subject line.<\/li>\n<\/ul>\n<hr \/>\n<h2 class=\"page-subheading\">Standard Available Tokens<\/h2>\n<table>\n<tbody class=\"intro-text\">\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>Token<\/strong><\/td>\n<td><strong>Description<\/strong><\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Asset<\/td>\n<td>The asset being tested.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Asset Report<\/td>\n<td>A link to the asset report for the asset being tested.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Case Id<\/td>\n<td>The Case Id of the case raised for the event (if applicable)<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Case Link<\/td>\n<td>A link to the case raised for the event (if applicable)<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Comment Link<\/td>\n<td>Open the asset report timeline for the event ready to enter a comment.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Confidence<\/td>\n<td>The confidence level for the entity being tested.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Entity<\/td>\n<td>The entity being tested.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Event Id<\/td>\n<td>Unique identifier for the event.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Event View<\/td>\n<td>The list of events for this monitor.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Metadata<\/td>\n<td>Associated event metadata.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Monitor<\/td>\n<td>The name of the monitor.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Original State<\/td>\n<td>The original state of the event (not overridden).<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Potential Impact<\/td>\n<td>The potential impact of the state.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Previous State<\/td>\n<td>The previous state of the event.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Process<\/td>\n<td>The name of the process.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Recommended Action<\/td>\n<td>The recommended action to take.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Severity<\/td>\n<td>The severity of the event.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>State<\/td>\n<td>The state of the event.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>State Reason<\/td>\n<td>The reason for the state (may be overridden).<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Suppression Reasons<\/td>\n<td>The reasons this event may have been suppressed.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Test<\/td>\n<td>The name of the test.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Timestamp<\/td>\n<td>The time of the event.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Trend<\/td>\n<td>A link to the Explorer trend for the entity being tested.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Trend End Time<\/td>\n<td>The end time of the Trend used for creating a custom Explorer Trend URL.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Trend Start Time<\/td>\n<td>The start time of the Trend used for creating a custom Explorer Trend URL.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Value<\/td>\n<td>The value of the entity being tested.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<hr \/>\n<h2 class=\"page-subheading\">Auxiliary Data Tokens<\/h2>\n<p class=\"intro-text\">If the test has auxiliary data, this is available as a token in the message content.<\/p>\n<ul>\n<li class=\"intro-text\">Type the token, enclosed in square brackets, so that the literal value at the time of the event is included in the message content.<\/li>\n<\/ul>\n<p class=\"intro-text\">The auxiliary data is also included in the message under the token, below other event information.<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Token Outcomes in a Message<\/h2>\n<p class=\"intro-text\">When the action is invoked, the token is displayed as the literal value at the time of the event. For example:<\/p>\n<table>\n<tbody class=\"intro-text\">\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>Token<\/strong><\/td>\n<td><strong>Literal Value in SMS or Email Action<\/strong><\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>[Monitor]<\/td>\n<td>Monitor 1<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>[State]<\/td>\n<td>High Exceeded<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>[Timestamp]<\/td>\n<td>20\/7\/2011 2:18:00 PM<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p class=\"intro-text\">And below are some examples of auxiliary data tokens:<\/p>\n<table>\n<tbody class=\"intro-text\">\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>Token<\/strong><\/td>\n<td><strong>Auxiliary Data<\/strong><\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>[Ninety]<\/td>\n<td>Fixed Value: 90<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>[Pressure]<\/td>\n<td>Attribute :thp<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p class=\"intro-text\">Some of the tokens show a hyperlink, as described in the next section.<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Action Hyperlinks<\/h2>\n<p class=\"intro-text\">Some of the tokens available for use by actions include hyperlinks.<\/p>\n<p class=\"intro-text\">For actions that use these tokens, the hyperlink is included in the message.<\/p>\n<p class=\"intro-text\">These tokens are:<\/p>\n<p class=\"intro-text\"><strong>Asset Report<\/strong>:\u00a0A link to the asset report for the asset being tested.<\/p>\n<ul>\n<li class=\"intro-text\">Click the hyperlink in the message content to view the asset report.<\/li>\n<\/ul>\n<p class=\"intro-text\"><strong>Comment Link<\/strong>:\u00a0A link to the comment tab of the <strong>Event, Info and Comment<\/strong> screen for the event that triggered the action.<\/p>\n<ul>\n<li class=\"intro-text\">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.<\/li>\n<\/ul>\n<p class=\"intro-text\"><strong>EventView<\/strong>:\u00a0The list of events for this monitor.<\/p>\n<ul>\n<li class=\"intro-text\">Click the hyperlink in the message content to view the list of events for the monitor.<\/li>\n<\/ul>\n<p class=\"intro-text\"><strong>Trend<\/strong>: A link to the Explorer trend for the entity being tested.<\/p>\n<ul>\n<li class=\"intro-text\">Click the hyperlink in the message content to view the Explorer trend for the entity.<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>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.<\/p>\n<p class=\"continue-reading-button\"> <a class=\"continue-reading-link\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/sentinel\/working-with-sentinel-monitors\/tokens\/\">Read more<i class=\"crycon-right-dir\"><\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":67342,"parent":58774,"menu_order":14,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[11],"tags":[964,1022,965,968,339,1021,1023,962,969,1024,967],"class_list":["post-58918","page","type-page","status-publish","has-post-thumbnail","hentry","category-tutorial","tag-actions","tag-asset","tag-auxiliary","tag-email","tag-hyperlink","tag-message","tag-metadata","tag-severity","tag-sms","tag-state","tag-tokens","Product-sen"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/58918","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=58918"}],"version-history":[{"count":8,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/58918\/revisions"}],"predecessor-version":[{"id":65242,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/58918\/revisions\/65242"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/58774"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/67342"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=58918"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=58918"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=58918"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}