Parameters for Alarm Viewers

Parameters for substitution in Alarm Viewers

You may include any of the following parameters, which will be substituted with characteristics of the selected alarm, in your command:

Parameter

Value

%ACK

Y or N, if selected alarm is acknowledged

%CATEGORY

OPC Category: Level, Discrete, or System (AMV Control only)

%CONDITION

OPC Condition: Level, Trip, or System (AMV Control only)

%DATETIME

Alarm Generation date and time

%DT

same as %DATETIME

%DATE

Alarm Generation date

%TIME

Alarm Generation time

%ID

Alarm Identifier of the selected alarm

%CLASS

Alarm class of the selected alarm

%RESOURCE

Factory resource of the selected alarm

%RES

same as %RESOURCE

%REFERENCE

Alarm reference identifier for the selected alarm

%REF

same as %REFERENCE

%MESSAGE

Alarm message for the selected alarm

%MSG

same as %MESSAGE

%SCREEN

(Alarm Viewer Control only) Provide access to the screen associated with an alarm so the user can run CimView using that screen and any additional options.

%STATE

Current alarm state of the selected alarm

%SUB
CONDITION

OPC Subcondition (AMV Control only).

Parameter for a selected alarm

(AMV Control only) The following parameter provides a user access to other CimView screens.

Parameter

Value

%SCREEN

Provide access to the screen associated with an alarm so that the user can run CimView using that screen and any additional options they wish.

Parameters in Alarm Viewer that don't require a selected alarm

The following additional parameters do not require the user to select an alarm:

Parameter

Value

%%

An embedded percent sign

%USER

User ID of the user invoking the command

%PRODUCT

CIMPLICITY distribution directory

%CIM

same as %PRODUCT

%DIRECTORY

CIMPLICITY project directory

%DIR

same as %DIRECTORY

%PROJECT

CIMPLICITY project name

%PRJ

same as %PROJECT

More information

Step 2.4. Create custom buttons.