Trip Sequences Supported by Redirection Actions

%A

Use this trip code to include any relevant alarm attribute information in an e-mail or pager message, or append the information to a System Command Action’s command line.

Use the syntax %A<attribute>%, where <attribute> can be any one of the alarm attributes listed in the next table.

ClearSCADA formats any date and time trip sequences using the recipients date format.

(see separate table)

%K

Only applies to manually redirected Actions (see Configure the Properties on the Action Tab), Action Rosters, and alarm redirection Calendars, where such manual redirections require a comment.

Use the %K trip character to include the manual redirection comment in the redirection message. (As this is a trip character, as opposed to a trip sequence, you only enter % before the code—do not enter another % after the code.)

The %K content will be blank if no comment is entered by the user that manually redirects the alarm.

For an example that demonstrates using this trip character in an alarm redirection e-mail message, see Allow an Operator to Enter a Comment when Manually Redirecting an Alarm.

Displays the redirection comment that was entered when the alarm was manually redirected. For example,

Known event - maintenance engineer notified

%N

The name of the computer that was main when ClearSCADA redirected the alarm.

(As this is a trip character, as opposed to a trip sequence, you only enter % before the code—do not enter another % after the code.)

WEST17

%O

Any field from the source object’s table.

For fields that are in an object’s main table, use the syntax %O<field>%, where <field> is the name of the field.

For fields that are in an aggregate table off an object’s main table, use the syntax %O<aggregate>.<field>%, where <aggregate> is the name of the aggregate field and <field> is the name of the field in that aggregate.

Use the syntax %O<reference>.<field>% to display the value of a field on an item that is associated with the item that is raising the alarm. For instance, you can display the name of the outstation that is associated with the point for which ClearSCADA is redirecting an alarm. There is no limit to the number of references that you can follow in this way.

You can display a list of the available fields and references by using the OPC Data Bar or the database Schema. Also see Use Trip Sequences to Include Geographical Information.

%OAlarmDesc%

displays the alarm description,
for example,
Acknowledged Uncleared

%OOutstationId.Name%

displays the name of the outstation associated with the point for which ClearSCADA is redirecting an alarm

%r

(Note that the ‘r’ trip character is lower case, where as many other trip characters are upper case.)

Any field from the alarm redirection action itself.

For fields that are in a redirection action’s table, use the syntax %r<field>%, where <field> is the name of the field.

Use the syntax %r<reference>.<field>% to display the value of a field on an item that is associated with the redirection action. For instance, you can display the recipient of an e-mail redirection action. There is no limit to the number of references that you can follow in this way.

You can display a list of the available fields and references by using the OPC Data bar or the database Schema. Also see Use Trip Sequences to Include Geographical Information.

%rName%

displays the name of the redirection action,
for example,
E-Mail Alarm Details

%rUserId.Name%

displays the name of the recipient of the redirected alarm

%U

Any field from the CDBUser table for the recipient. This trip character is typically used for personalizing a message.

For fields that are in an object’s main table, use the syntax %U<field>%, where <field> is the name of the field.

For fields that are in an aggregate table off an object’s main table, use the syntax %U<aggregate>.<field>%, where <aggregate> is the name of the aggregate field and <field> is the name of the field in that aggregate.

Use the syntax %U<reference>.<field>% to display the value of a field on an item that is associated with the recipient of the redirected alarm. For instance, you can display the name of the recipient’s Help View, listing instructions on how to deal with any redirected alarms. There is no limit to the number of references that you can follow in this way.

You can display a list of the available fields and references by using the OPC Data bar or the database Schema. Also see Use Trip Sequences to Include Geographical Information.

%UName%

displays the name of the user,
for example,
John

%UHelpViewId.Name%

displays the name of the Help View that is associated with the recipient of the redirected alarm

%ASeverity%

The severity of the alarm (supersedes %E).

Low

%ASource%

The source of the alarm (supersedes %S).

Western Site. Point AIP3

%AMessage%

The alarm message (supersedes %M).

State changed to High, value is 80.00

%ACookie%

An alarm cookie (identifier) that uniquely identifies the alarm. This is used to acknowledge an alarm by voice interface, using telephony software (supersedes %I).

8637

%ACategory%

The alarm category (supersedes %C).

Point State

%AAckComment%

Any comment entered when the alarm was acknowledged.

Known Event - Engineer Called

%AAckUsername%

The user that acknowledged the alarm.

RJohnson

%AAckDate%

The date that the alarm was acknowledged.

2005-04-01

%AAckTime%

The time that the alarm was acknowledged.

11:22:25.888

%AAckDateTime%

The date and time that the alarm was acknowledged.

2005-04-01 11:22:25.888

%AResponse%

Any response entered in relation to the alarm.

Severe conditions - Checking Alarm Cause

%AResponseUsername%

The user that entered the response.

ARichards

%AResponseDate%

The date that the response was entered.

2005-04-01

%AResponseTime%

The time that the response was entered.

11:56:07.882

%AResponseDateTime%

The date and time that the response was entered.

2005-04-01 11:56:07.882

%ACondName%

The ‘condition’ with which the alarm is associated. For example, the state of a particular type of point.

For further information, see Use Trip Sequences to Include Alarm Condition and Subcondition Details.

DNP3AnalogInState1
(indicating that the alarm is associated with the state of a DNP3 analog input point)

%ACondActiveDate%

The date on which the alarm condition became active.

2005-04-01

%ACondActiveTime%

The time at which the alarm condition became active.

11:22:09.755

%ACondActiveDateTime%

The time and date at which the alarm condition became active.

2005-04-01 11:22:09.755

%ASubCondName%

The name of the active ‘subcondition’ with which the alarm is associated. For example, a particular point state.

For further information, see Use Trip Sequences to Include Alarm Condition and Subcondition Details.

HighHigh

%ASubCondActiveDate%

The date on which the alarm subcondition became active (supersedes %D).

2005-04-01

%ASubCondActiveTime%

The time at which the alarm subcondition became active (supersedes %T).

11:22:09.755

%ASubCondActiveDateTime%

The time and date at which the alarm subcondition became active.

2005-04-01 11:22:09.755

%ASubCondDef%

The definition of the alarm subcondition (the status change that triggered the alarm).

Current State = 1

%ASubCondDesc%

The description of the alarm subcondition.

Pump Running

%AInactiveDate%

The date that the alarm cleared.

2005-04-01

%AInactiveTime%

The time at which the alarm cleared.

11:22:01.473

%AInactiveDateTime%

The date and time at which the alarm cleared.

2005-04-01 11:22:01.473

%AReceiptDate%

The date that the server received the alarm notification.

2005-04-01

%AReceiptTime%

The time that the server received the alarm notification.

11:22:09.755

%AReceiptDateTime%

The date and time that the server received the alarm notification.

2005-04-01 11:22:09.755

%C

The category of the alarm.

(Now superseded by %ACategory% (see above).)

Point State

%D

The date of the alarm.

(Now superseded by %ASubCondActiveDate% (see above).)

2003-03-18

%E

A description of the severity of the alarm.

(Now superseded by %ASeverity% (see above).)

High

%I

An alarm cookie (identifier) that uniquely identifies the alarm. This is used to acknowledge an alarm by voice interface, using telephony software.

(Now superseded by %ACookie% (see above).)

8637

%M

The alarm message.

(Now superseded by %AMessage% (see above).)

Communications State - Disconnected

%R

A description of the item that is in alarm.

This trip character can only be used if:

• A custom description field is configured for the database items on your system

and:

• That custom field is configured as the first Search Key field in the Metadata window (see Extra Database Fields in the ClearSCADA Guide to Server Administration).

(Now superseded by %O<field>% (see above).)

(Do not confuse %R with %r, which has different functionality (see above).)

Change in River Level

%S

The source of the alarm.

(Now superseded by %ASource% (see above).)

Western Site. Outstation F3

%T

The time of the alarm.

(Now superseded by %ASubCondActiveTime% (see above).)

10:32:15

%V

The value of the point that is in alarm (this is only available for alarms on points, and includes any point formatting and units).

(Now superseded by %OCurrentValueFormatted% (see above).)

95.6