Using Tokens in Content Rules and Policy References

The following tables provide a full list of tokens that can be used in certain What To Do? actions and Policy References.

References to Email policy content are only available when an Email Gateway is included in the peer group.

Token	Description/Value	Where it can be used...
%ADMIN%	The administrator account email address used by the Policy Engine.	Informs
%ALARM_DESCRIPTION%	The description of the raised alarm.	Email Alarm Messages
%ALARM_TEXT%	The text of the raised alarm.	Email Alarm Messages
%ALARM_TYPE%	The type of the raised alarm.	Email Alarm Messages
%CONTENTDETECTED%	The names of the triggered content rules.	Block Pages, Informs
%DETECTED%	Items detected by the What To Look For? clauses in invoked content rules.	Informs
%DIAGNOSTICS%	A complete report of the data analysis.	Block Pages, Informs
%FORMATSUBTYPE%	The low level type of data recognized.	Block Pages, Informs
%FORMATTYPE%	The type of data recognized.	Block Pages, Informs
%HOSTNAME%	The hostname of the machine on which an alarm has been raised.	Email Alarm Message
%IPADDRESS%	The IP address of the machine on which an alarm has been raised.	Email Alarm Message
%PROXY%	The hostname of the server that initiated the warning page.	Block Page, Quota Warning Page
%ROUTE%	The name of the route that determined the policy.	Block Pages, Informs
%ROUTEQUOTA%	The total quota time for the current route.	Block Pages, Quota Warning Pages
%RULES%	A comma separated list of matched rules.	Block Pages, Informs
%SERVERADDRESS%	The hostname of the Clearswift Gateway .	Informs
%URL%	The full URL of the request.	Block Pages, Informs
%URL_CATEGORY%	The  URL category name for the current request.	Block Pages, Informs
%USER%	The user name, or, if no user name is available, the IP address of the client machine.	Block Pages, Informs
%USERADDRESS%	The IP address of the client machine.	Block Pages, Informs
%USER_QUOTA_REMAINING%	The remaining quota time for the user for the current route.	Block Pages, Quota Warning Pages
%USER_QUOTA_USED%	The quota time used by the user for the current route.	Block Pages, Quota Warning Pages

Tell me about...

• Tokens for use in Information Governance informs

  Token	Description
  %DOC_LIST_MATCHES%	The file name and file location if available, and a list of matches for each registered document where a match was found.
  %DOC_NAMES%	The file name and file location if available of registered documents where a match was found.
  %DOC_NAMES_CLASSIFICATION%	The file name and file location if available, and the classification of registered documents where a match was found.
  %DOC_NAMES_MATCH%	The file name and file location if available, and the percentage match of registered documents where a match was found.
  %DOC_OWNERS_COUNT%	The number of document owners where a match has been found. This token is available in both the subject and the body of a message.
  %DOC_NAMES_PROPERTIES%	The file name and file location if available, and any custom properties for each registered document where a match was found.
  %DOC_SETS%	The collection name where matched registered documents were detected.
  %DOC_SET_OWNERS%	The details of document owners of matched documents.

  When informs are copied to the document owners, tokens will only show information relevant to documents registered for that particular document owner.

• Where tokens are supported

  Where supported	Meaning
  Alert	A Generate an Alert action in a Content Rule.
  Annotation	A Message Annotation Policy Reference.
  Block Page	A Block Page Policy Reference.
  Email Alarm Message	An email message that is sent to a specified address when an alarm is raised, if the Gateway is configured to do so.
  Inform	An Inform Policy Reference.
  Log entry	A Log a Message action in a Content Rule.
  Quota Warning Page	A Quota Warning Policy Reference.
  Tag subject	A Tag the Message Subject action in a Content Rule.
  Add header	An Add a Message Header action in a Content Rule.
  Notify Sender	An email message that is sent to a sender when a message is released, if the Gateway is configured to do so.
  Notify Auditor	An email message that is sent to an auditor when a message is released, if the Gateway is configured to do so.