AlmBrowseOpen Fields

ACKDATE

Event acknowledgement date (short format).

12

Short date format (based on the system locale settings).

For example, "dd-mm-yy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

Note: An extended date format is used by default. The short date format only applies when [Alarm]ExtendedDate is set to 0 in the Citect.ini file.

ACKDATEEXT

Event acknowledgement date (extended format).

12

The date format used when [Alarm]ExtendedDate is set to 1 in the Citect.ini file.

For non-hardware alarms, extended date format (based on the system locale settings).

For example, "dd-mm-yyyy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

ACKMILLI

Millisecond precision for the event acknowledgement time.

6

For high resolution time stamped digital and time stamped analog alarms, this value represents the milliseconds part of the acknowledgement time.

ACKTIME

Event acknowledgement time.

12

This can be in 12 hour format (for example, h:mm:ss tt), or 24 hour format (for example, H:mm:ss) depending on the regional date and time settings on the local computer.

Note: This works between UTC time January 1 1970 - January 18 2038, otherwise "".

ACKUTC

Event acknowledgment time in UTC format.

12

Integer that represents a time value based on the number of seconds since Jan 1, 1970 (in UTC format).

ACQDESC

Acquisition error description.

254

Textual representation of an alarm acquisition error.

ACQERROR

Acquisition error.

6

Numeric value (integer).

ALARMTYPE

Alarm type.

16

Text describing the following alarm types:

"Digital", "Analog", "Advanced", "Multi-Digital", "Time Stamped", "Time Stamped Digital", "Time Stamped Analog".

ALMCOMMENT

Alarm comment.

254

A text-based comment added to an alarm during configuration.

AREA

Alarm area.

16

Numeric value (integer) representing area.

ARR_SIZE

Array size.

16

Integer (1 means it is not an array).

CATEGORY

Alarm category.

16

Numeric value (integer) representing the alarm category.

CAUSE1

The first cause defined for the alarm.

254

Up to eight causes can be defined for an alarm to help operators determine the most appropriate course of action.

See Add Cause and Response Information to Alarms.

CAUSE2

The second cause defined for the alarm.

254

CAUSE3

The third cause defined for the alarm.

254

CAUSE4

The fourth cause defined for the alarm.

254

CAUSE5

The fifth cause defined for the alarm.

254

CAUSE6

The sixth cause defined for the alarm.

254

CAUSE7

The seventh cause defined for the alarm.

254

CAUSE8

The eighth cause defined for the alarm.

254

CLASSIFICATION

The class of the event.

32

The classification applied to an event. For example:

Action - The event was logged due to an action being performed.

Comment - The event was logged due to a comment being created.

Configuration - The event was logged due to configuration changes being made.

System - The event has been logged due to an occurrence that affects the entire system, such as the server being stopped and restarted.

Alarm type - Type of alarm (for example, digital, multi-digital, etc.).

CLUSTER

The cluster to which the the tag belongs.

32

The cluster name.

COMMENT

Comment.

64

If hardware alarm = "".

Or a configured event description or trend comment.

CONSEQUENCE1

The first consequence defined for an alarm.

254

Up to eight consequences can be defined for an alarm to help operators determine the most appropriate course of action.

See Add Cause and Response Information to Alarms.

CONSEQUENCE2

The second consequence defined for an alarm.

254

CONSEQUENCE3

The third consequence defined for an alarm.

254

CONSEQUENCE4

The fourth consequence defined for an alarm.

254

CONSEQUENCE5

The fifth consequence defined for an alarm.

254

CONSEQUENCE6

The sixth consequence defined for an alarm.

254

CONSEQUENCE7

The seventh consequence defined for an alarm.

254

CONSEQUENCE8

The eighth consequence defined for an alarm.

254

CUSTOM1

Alarm custom field #1

64

A user-defined string.

CUSTOM2

Alarm custom field #2

64

A user-defined string.

CUSTOM3

Alarm custom field #3

64

A user-defined string.

CUSTOM4

Alarm custom field #4

64

A user-defined string.

CUSTOM5

Alarm custom field #5

64

A user-defined string.

CUSTOM6

Alarm custom field #6

64

A user-defined string.

CUSTOM7

Alarm custom field #7

64

A user-defined string.

CUSTOM8

Alarm custom field #8

64

A user-defined string.

DATE

Alarm date in short format.

12

Short date format (based on the system locale settings).

For example, "dd-mm-yy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

Note: An extended date format is used by default. The short date format only applies when [Alarm]ExtendedDate is set to 0 in the Citect.ini file.

DATEEXT

Alarm date in extended format.

12

The date format used when [Alarm]ExtendedDate is set to 1 in the Citect.ini file.

For non-hardware alarms, extended date format (based on the system locale settings).

For example, "dd-mm-yyyy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

DEADBAND

Alarm deadband.

12

For analog, and timestamped analog alarms, a numeric value (real).

DELAY

The delay configured for the alarm.

12

The delay period in the following format:

hh:mm:ss

The value will be between 0 seconds (00:00:00) and 24 hours (24:00:00).

DELTAMILLI

Millisecond precision for the delta time.

6

For high resolution time stamped digital and time stamped analog alarms, it is the milliseconds part of the delta time.

DELTATIME

The time difference between OnDate/OnTime and OffDate/OffTime.

12

The delta time in the following format:

hh:mm:ss

DESC

Alarm description.

254

For analog alarms:

"DEVIATION", "RATE OF CHANGE", "LOW", "HIGH", "LOW LOW", "HIGH HIGH".

For other alarm types:

Configured descriptions.

DEVDELAY

Deviation delay.

16

Delay value (in seconds) for analog alarms and time stamped analog alarms.

DEVIATION

Alarm deviation.

12

For analog and time stamped analog alarms:

Numeric value (real).

DISABLECOMMENT

A comment added by a user when an alarm is shelved.

254

A user defined text string.

DISABLEDDATE

The date an alarm was disabled.

12

The date format is based on the system locale settings.

Extended date format:

(for example, dd-mm-yyyy).

Short date format:

(for example, dd-mm-yy).

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

Note: Extended date format is used by default. The short date format only applies when [Alarm]ExtendedDate is set to 0 in the Citect.ini file.

DISABLEDTIME

The time an alarm was disabled.

12

A time string that indicates when an alarm was disabled.

This can be in 12 hour format (for example, h:mm:ss tt), or 24 hour format (for example, H:mm:ss) depending on the regional date and time settings on the local computer.

DISABLEENDDATE

The disable end date for a shelved alarm (short format).

12

Short date format (based on the system locale settings).

For example, "dd-mm-yy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

Note: An extended date format is used by default. The short date format only applies when [Alarm]ExtendedDate is set to 0 in the Citect.ini file.

DISABLEENDDATEEXT

The disable end date for a shelved alarm (extended format).

12

The date format used when [Alarm]ExtendedDate is set to 1 in the Citect.ini file.

For non-hardware alarms, extended date format (based on the system locale settings).

For example, "dd-mm-yyyy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

DISABLEENDTIME

The disable end time for a shelved alarm.

12

A time string that indicates when a shelved alarm will no longer be disabled.

This can be in 12 hour format (for example, h:mm:ss tt), or 24 hour format (for example, H:mm:ss) depending on the regional date and time settings on the local computer.

ENG_ZERO

The engineering zero scale for this value.

11

Numeric value (real).

EQUIPMENT

The name of the equipment associated with the alarm.

254

This can be a name that represents a single piece of equipment, or a name that also reflects the location of the equipment within the equipment hierarchy (where a period (.) is used to indicate levels in the hierarchy).

FORMAT

Alarm format.

12

For analog, and time stamped analog alarms, a numeric value (real).

FULLNAME

Event user full name.

20

For non-hardware alarms, the configured full name of the event user if exists. Otherwise "System".

GROUP

Alarm group.

16

For multi-digital alarms, a numeric value

HDELAY

High delay.

16

Delay value (in seconds) for analog alarms and time stamped analog alarms.

HELP

Alarm help.

254

The name of the help page.

HHDELAY

High high delay.

16

Delay value (in seconds) for analog alarms and time stamped analog alarms.

HIGH

Alarm high

12

For analog and time stamped analog alarms, a numeric value (real).

HIGHHIGH

Alarm high high

12

For analog and time stamped analog alarms, a numeric value (real).

HISTORIAN

Determines if the alarm will be included in an automated configuration process within the Historian environment.

6

True or False (blank).

ITEM

Name of equipment item.

63

The name configured in the alarm's Item Name field.

LDELAY

Low delay.

16

Delay value (in seconds) for analog alarms and time stamped analog alarms.

LLDELAY

Low low delay.

16

Delay value (in seconds) for analog alarms and time stamped analog alarms.

LOCALTIMEDATE

Alarm date and time.

24

yyyy-mm-dd hh:mm:ss[.ttt].

This works between: UTC time January 1 1970 - January 18 2038, otherwise "".

LOGSTATE

Log state text.

13

"ACTIVE", "INACTIVE", "DISABLED", "ENABLED", "ACKNOWLEDGED", "LOW", "HIGH", "LOW LOW", "HIGH HIGH", "RATE", "DEVIATION", "CLEARED", "UNACKNOWLEDGED".

LOW

Alarm low.

12

For analog and time stamped analog alarms, a numeric value (real).

LOWLOW

Alarm low low.

12

For analog and time stamped analog alarms, a numeric value (real).

MESSAGE

The event message.

254

Text entered in the Alarm Desc field of digital, advanced and time-stamped alarms.

MILLISEC

Alarm milliseconds.

6

Numeric value (integer).

NAME

Alarm name.

80

A meaningful description of the alarm defined in the Alarm Name property.

NATIVE_COMMENT

Event comment.

64

A text-based comment added to an event on the SOE page at runtime.

NATIVE_DESC

Alarm description.

80

For analog alarms, the alarm state text.

Otherwise, the configured alarm description.

NATIVE_NAME

Alarm name.

80

Configured alarm name.

NATIVE_SUMDESC

Event description text.

80

For non-hardware analog alarms: the event state string.

For non-hardware other alarms: the event [or if it does not exist] the alarm description.

OFFDATE

Event off date (short format).

12

Short date format (based on the system locale settings).

For example, "dd-mm-yy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

Note: An extended date format is used by default. The short date format only applies when [Alarm]ExtendedDate is set to 0 in the Citect.ini file.

OFFDATEEXT

Extended event off date.

12

The date format used when [Alarm]ExtendedDate is set to 1 in the Citect.ini file.

For non-hardware alarms, extended date format (based on the system locale settings).

For example, "dd-mm-yyyy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

OFFMILLI

Millisecond precision for the off time.

6

For high resolution timestamped digital and timestamped analog alarms, it is the milliseconds part of the off time.

OFFTIME

Event off time.

12

This can be in 12 hour format (for example, h:mm:ss tt), or 24 hour format (for example, H:mm:ss) depending on the regional date and time settings on the local computer.

Note: This works between UTC time January 1 1970 - January 18 2038, otherwise "".

OFFTIMEDATE

Special SQL formatted date and time.

28

For non-hardware alarms: HH:MI:SS.

Note: The format can be configured in the citect.ini file using the [Alarm]TimeDate parameter.

OFFUTC

Alarm off time in UTC format.

12

Integer that represents a "time" value based on the number of seconds since Jan 1, 1970 (in UTC format not Local).

OLD_DESC

Multi digital old state description.

8

"Invalid", "OFF", "ON", "ON State 2", "ON State 3", "ON State 4", "ON State 5", "ON State 6", "ON State 7".

ONDATE

Event on date (short format).

12

Short date format (based on the system locale settings).

For example, "dd-mm-yy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

Note: An extended date format is used by default. The short date format only applies when [Alarm]ExtendedDate is set to 0 in the Citect.ini file.

ONDATEEXT

Event on date (extended format).

12

The date format used when [Alarm]ExtendedDate is set to 1 in the Citect.ini file.

For non-hardware alarms, extended date format (based on the system locale settings).

For example, "dd-mm-yyyy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

ONMILLI

Millisecond precision for the on time.

6

For high resolution timestamped digital and timestamped analog alarms, it is the milliseconds part of the on time.

ONTIME

Event on time.

12

This can be in 12 hour format (for example, h:mm:ss tt), or 24 hour format (for example, H:mm:ss) depending on the regional date and time settings on the local computer.

Note: This works between UTC time January 1 1970 - January 18 2038, otherwise "".

ONTIMEDATE

Special SQL formatted date and time.

28

For non-hardware alarms: HH:MI:SS.

Note: The format can be configured in the citect.ini file using the [Alarm]TimeDate parameter.

ONUTC

Alarm on time in UTC format.

12

Integer that represents a "time" value based on the number of seconds since Jan 1, 1970 (in UTC format not Local).

PAGING

Alarm paged flag.

8

A flag to indicate that the alarm is going to be paged. Values are 1 (TRUE) or 0 (FALSE).

PAGINGGROUP

Paging group for alarm.

80

A freeform text field indicating the sequence of people to notify in the event the alarm occurred.

PRIORITY

Alarm category priority.

4

Numeric value (integer).

PRIV

Alarm privilege.

16

Numeric value (integer) that represents the level of privilege an operator requires to acknowledge or disable the alarm.

RATE

Alarm rate.

12

For analog and time stamped analog alarms, a numeric value (real).

RECEIPTLOCALTIMEDATE

The alarm’s occurrence time.

28

Displays the alarm’s occurrence time (if known), otherwise it displays the receipt time of the alarm.

RECEIPTDATE

The date the master station received the event (short format).

For example, the date the RTU received the event.

12

Short date format (based on the system locale settings).

For example, "dd-mm-yy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

Note: An extended date format is used by default. The short date format only applies when [Alarm]ExtendedDate is set to 0 in the Citect.ini file.

RECEIPTDATEEXT

The date the master station received the event (extended format).

For example, the date the RTU received the event.

12

The date format used when [Alarm]ExtendedDate is set to 1 in the Citect.ini file.

For non-hardware alarms, extended date format (based on the system locale settings).

For example, "dd-mm-yyyy".

This works between UTC time January 1 1970 - January 18 2038, otherwise "".

RECEIPTMILLISEC

Millisecond precision for the receipt time.

6

For high resolution timestamped digital and timestamped analog alarms, it is the milliseconds part of the receipt time.

RECEIPTTIME

The time the master station received the event.

For example, the time the RTU received the event.

16

This can be in 12 hour format (for example, h:mm:ss tt) or 24 hour format (for example, H:mm:ss) depending on the regional date and time settings on the local computer.

RECEIPTTIMEINT

Receipt time in UTC format.

12

An integer that represents a "time" value based on the number of seconds since Jan 1, 1970 (in UTC format not Local).

RECEIPTTIMETICKS

Receipt time measured using ticks.

20

Time expressed as the number of ticks elapsed since 12:00:00 midnight, January 1, 1601 in UTC format.

Each tick is 100 nanoseconds.

RESPONSE1

The first response defined for the alarm.

254

Up to eight responses can be defined for an alarm to help operators determine the most appropriate course of action.

See Add Cause and Response Information to Alarms.

RESPONSE2

The second response defined for the alarm.

254

RESPONSE3

The third response defined for the alarm.

254

RESPONSE4

The fourth response defined for the alarm.

254

RESPONSE5

The fifth response defined for the alarm.

254

RESPONSE6

The sixth response defined for the alarm.

254

RESPONSE7

The seventh response defined for the alarm.

254

RESPONSE8

The eighth response defined for the alarm.

254

RESPONSENUM

The number of alarm responses that have been configured for an alarm tag.

8

0 to 8.

SETPOINT

The set point value. This is only applicable to analog alarms.

16

An analog variable tag, expression or base value that determines if a deviation alarm is to be triggered.

STATE

Alarm state string.

16

For analog and time stamped analog alarms:

"OFF", "DEVIATION", "RATE OF CHANGE", "LOW", "HIGH", "LOW LOW", "HIGH HIGH".

For multi-digital alarms:

"OFF", "ON", "ON State 2", "ON State 3", "ON State 4", "ON State 5", "ON State 6", "ON State 7".

For double point status alarms:

The configured state name.

For all other alarms:

"OFF", "ON".

STATE_DESC

Multi-digital state description.

8

"OFF", "ON", "ON State 2", "ON State 3", "ON State 4", "ON State 5", "ON State 6", "ON State 7".

STATE_DESC0

Multi-digital state 0.

64

For multi-digital alarms: "OFF".

For others: "INVALID".

STATE_DESC1

Multi-digital state 1.

64

For multi-digital alarms: "ON".

For others: "INVALID".

STATE_DESC2

Multi-digital state 2.

64

For multi-digital alarms: "ON state 2".

For others: "INVALID".

STATE_DESC3

Multi-digital state 3.

64

For multi-digital alarms: "ON state 3".

For others: "INVALID".

STATE_DESC4

Multi-digital state 4.

64

For multi-digital alarms: "ON state 4".

For others: "INVALID".

STATE_DESC5

Multi-digital state 5.

64

For multi-digital alarms: "ON state 5".

For others: "INVALID".

STATE_DESC6

Multi-digital state 6.

64

For multi-digital alarms: "ON state 6".

For others: "INVALID".

STATE_DESC7

Multi-digital state 7.

64

For multi-digital alarms: "ON state 7".

For others: "INVALID".

SUMDESC

Event description text.

80

Analog alarm - event state text.

Otherwise - configured event [or alarm in case event not defined] description.

SUMSTATE

Event state text.

16

Displays the last active state of the alarm.

"OFF", "ON", "ON State 2", "ON State 3", "ON State 4", "ON State 5", "ON State 6", "ON State 7", "DEVIATION", "RATE OF CHANGE", "LOW", "HIGH", "LOW LOW", "HIGH HIGH", "Invalid".

SUMTYPE

Event state.

16

For non-hardware alarms: "DISABLED", "UNACKNOWLEDGED", "ACKNOWLEDGED", "CLEARED".

TAG

Tag name.

80

The configured tag name.

TAGEX

Extended alarm tag.

32

<cluster>.<tag> when a cluster is defined.

Otherwise <tag>.

TAGGENLINK

Indicates a tag was imported from an I/O device.

16

Name of the I/O device from which this tag was generated.

TIME

The time the event occurred.

12

This can be in 12 hour format (hh:mm:ss tt), or 24 hour format (HH:mm:ss) depending on the current date and time settings on the local computer.

Note: This works between UTC time January 1 1970 - January 18 2038, otherwise "".

TIMEDATE

Special SQL formatted time.

28

For non-hardware alarms: HH:MI:SS.

Note: The format can be configured in the citect.ini file using the [Alarm]TimeDate parameter.

TIMEINT

Event time in UTC format.

12

Integer that represents a time value based on the number of seconds since Jan 1, 1970 (in UTC format).

TIMETICKS

Event time measured using ticks.

20

Time expressed as the number of ticks elapsed since 12:00:00 midnight, January 1, 1601 in UTC format.

Each tick is 100 nanoseconds.

TSQUALITY

The quality of the alarm tag. This is passed to the alarm server by the I/O server when a value change occurs.

64

Expected time stamp quality strings are:

Time Good, Time Uncertain, Clock Not Synchronized, or empty string if no match is found.

TYPE

Alarm type.

16

"DISABLED", "UNACKNOWLEDGED", "ACKNOWLEDGED", "CLEARED"

TYPENUM

Alarm type represented as a numeric value.

4

Values are:

-1 - Invalid

0 - Digital

1 - Analog

2 - Advanced

3 - Multi-Digital

4 - ArgAna

5 - User event

6 - Time stamped

7 - Hardware

8 - Time stamped digital

9 - Time stamped analog

USERDESC

The text related to a user event.

64

If you specify an asterisk '*' as the first character of the sTag argument in AlarmSumAppend, the summary entry becomes a user event. This value is the text that follows the asterisk.

USERNAME

Event user name.

16

For non-hardware alarms, the configured name of the event user (if it exists).

Otherwise "System".

USERLOCATION

The IP of the machine which last raised, modified, or performed an action on the alarm.

80

Note: If the last action performed is from a system machine, the IP will not over ride the last user machine IP address.

VALUE

(alarm fields)

Formatted alarm value.

16

For analog alarms, a numeric value formatted according to configuration.