Alarm Redirection Guide - Use Trip Sequences to Include Geographical Information (Trip Sequences Supported by Redirection Actions)

Use Trip Sequences to Include Geographical Information

If your system uses ClearSCADA's Geographical Location features, you can configure alarms so that they redirect based on the region with which the alarms are associated (see Control Alarm Redirection by Geographical Region). If you use an E-Mail Action or Pager Action to redirect alarms based on regional criteria, you can include trip codes in the redirected alarm messages to include some of that criteria. The type of information that you can include varies depending on Redirection Scheme that is specified for the E-Mail Action or Pager Action (see Specify Whether to Redirect Alarms to Users According to Geographical Criteria).

This topic provides examples of some of the trip sequences that you might want to include in the redirected alarm messages.

Remember that you use:

%O to extract a field from the source alarm object’s table
%r to extract a field from the alarm redirection action itself
%U to extract a field from the alarm redirection recipient’s CDBUser table.

For more information about trip codes and the required syntax, see Trip Sequences Supported by Redirection Actions.

Required Data	Trip Sequence
The geographical position of the database item to which the redirected alarm relates, at the time that the alarm redirection was triggered.	%OGISLocation.GeoPosition% You can separate the information further by using one of the following: %OGISLocation.Latitude% %OGISLocation.Longitude% %OGISLocation.Altitude% (if applicable)
The geographical position of the User, User Group, or User Roster to which ClearSCADA redirected the alarm message. The position is that which applied to the recipient at the time that the alarm redirection was triggered.	%UGISLocation.GeoPosition% Again, you can separate the information further into just Latitude, Longitude, or Altitude (if applicable) by using similar syntax to that shown above, prefixed with %U rather than %O.
The names of the geographical Region(s) for which the recipient User, User Group, or User Roster is responsible. (Only applicable when the recipient is assigned, or inherits, one or more Responsible Regions (see Assign Regions of Responsibility).)	%UResponsibleRegionNames%
The ID of the User, User Group, or User Roster to which the alarm was redirected. (Only applicable when the E-Mail Action or Pager Action's Redirection Scheme is set to 'User, Group, or Roster' and the adjacent Send To field is populated (see Define the E-Mail Action Details, and see Define the Pager Action Details).)	%rUserId%
The ID of the default recipient (User, User Group, or User Roster) to which the alarm will be redirected if none of the intended recipients meet the redirection criteria. (Only applicable when the Find in Region section of the E-Mail Action or Pager Action's Form is populated (see Specify Whether to Redirect Alarms to Users According to Geographical Criteria).)	%rDefaultRecipientId%
The ID of the geographical Region to which the intended recipients of the redirected alarm are responsible. (Only applicable when the E-Mail Action or Pager Action's Redirection Scheme is set to 'To Region Users' and the corresponding Region field is populated (see Specify Whether to Redirect Alarms to Users According to Geographical Criteria).)	%rRegionId%
The ID of the geographical Region within which the alarm has to be located in order for ClearSCADA to redirect the alarm. (Only applicable when the Region field is populated for the redirection action on the Redirection tab of the database item to which the alarm relates (see Specify the Geographical Region within which Alarm Redirections are to Trigger).)	%OAlarmRedirection.Region1Id% (where the number 1 to 15 indicates the individual redirection action to which the Region relates; 1 being the alarm redirection configured in the top row on the Redirection tab, and 15 being the alarm redirection configured in the bottom row.)

Required Data

Trip Sequence

The geographical position of the database item to which the redirected alarm relates, at the time that the alarm redirection was triggered.

%OGISLocation.GeoPosition%

You can separate the information further by using one of the following:

%OGISLocation.Latitude%

%OGISLocation.Longitude%

%OGISLocation.Altitude%
(if applicable)

The geographical position of the User, User Group, or User Roster to which ClearSCADA redirected the alarm message.

The position is that which applied to the recipient at the time that the alarm redirection was triggered.

%UGISLocation.GeoPosition%

Again, you can separate the information further into just Latitude, Longitude, or Altitude (if applicable) by using similar syntax to that shown above, prefixed with %U rather than %O.

The names of the geographical Region(s) for which the recipient User, User Group, or User Roster is responsible.

(Only applicable when the recipient is assigned, or inherits, one or more Responsible Regions (see Assign Regions of Responsibility).)

%UResponsibleRegionNames%

The ID of the User, User Group, or User Roster to which the alarm was redirected.

(Only applicable when the E-Mail Action or Pager Action's Redirection Scheme is set to 'User, Group, or Roster' and the adjacent Send To field is populated (see Define the E-Mail Action Details, and see Define the Pager Action Details).)

%rUserId%

The ID of the default recipient (User, User Group, or User Roster) to which the alarm will be redirected if none of the intended recipients meet the redirection criteria.

(Only applicable when the Find in Region section of the E-Mail Action or Pager Action's Form is populated (see Specify Whether to Redirect Alarms to Users According to Geographical Criteria).)

%rDefaultRecipientId%

The ID of the geographical Region to which the intended recipients of the redirected alarm are responsible.

(Only applicable when the E-Mail Action or Pager Action's Redirection Scheme is set to 'To Region Users' and the corresponding Region field is populated (see Specify Whether to Redirect Alarms to Users According to Geographical Criteria).)

%rRegionId%

The ID of the geographical Region within which the alarm has to be located in order for ClearSCADA to redirect the alarm.

(Only applicable when the Region field is populated for the redirection action on the Redirection tab of the database item to which the alarm relates (see Specify the Geographical Region within which Alarm Redirections are to Trigger).)

%OAlarmRedirection.Region1Id%

(where the number 1 to 15 indicates the individual redirection action to which the Region relates; 1 being the alarm redirection configured in the top row on the Redirection tab, and 15 being the alarm redirection configured in the bottom row.)

As with other trip codes, you can use the OPC Data Bar or the Database Schema to ascertain the names of other fields that you might want to include in the redirected alarm messages. For more information, see Access Property Tags in the ClearSCADA Guide to Core Configuration, and see Working with the Database Schema in the ClearSCADA Guide to the Database.