|
Field Name |
Description |
Length |
Values |
|---|---|---|---|
|
ACKDATE |
Event acknowledge date |
12 |
short: dd-mm-yy [default] extended: dd-mm-yyyy Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, otherwise "". Note:The format can be changed by setting ExtendedDate to FALSE under the section [Alarm] in the citect.ini file. |
|
ACKDATEEXT |
Extended Event Acknowledge date |
12 |
For non-Hardware alarms: dd-mm-yyyy |
|
ACKTIME |
Event acknowledge time |
12 |
hh:mm:ss [am|pm]. Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, otherwise "" |
|
ACKUTC |
Event Acknowledgment Time |
12 |
Integer that represents a "time" value - the number of seconds since Jan 1, 1970 in UTC format not Local. |
|
ACQERROR |
Acquisition Error |
6 |
Numeric value (integer) |
|
ALARMTYPE |
Alarm type (text) |
16 |
"Digital", "Analog", "Advanced", "Multi-Digital", "Time Stamped", "Time Stamped Digital", "Time Stamped Analog" |
|
ALMCOMMENT |
Alarm comment |
254 |
|
|
AREA |
Alarm area |
16 |
Numeric value (integer) |
|
ARR_SIZE |
Array size |
|
Integer (1 means it is not an array) |
|
CATEGORY |
Alarm category |
16 |
Numeric value (integer) |
|
CLUSTER |
The cluster the tag exists on |
32 |
|
|
COMMENT |
Comment |
64 |
If hardware alarm = "". Or configured event description or trend comment |
|
CUSTOM1 |
Alarm custom field #1 |
64 |
|
|
CUSTOM2 |
Alarm custom field #2 |
64 |
|
|
CUSTOM3 |
Alarm custom field #3 |
64 |
|
|
CUSTOM4 |
Alarm custom field #4 |
64 |
|
|
CUSTOM5 |
Alarm custom field #5 |
64 |
|
|
CUSTOM6 |
Alarm custom field #6 |
64 |
|
|
CUSTOM7 |
Alarm custom field #7 |
64 |
|
|
CUSTOM8 |
Alarm custom field #8 |
64 |
|
|
DATE |
Alarm Date in default format |
12 |
short: dd-mm-yy [default] extended: dd-mm-yyyy Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, otherwise "". Note: The format can be changed by setting ExtendedDate to FALSE under the section [Alarm] in the citect.ini file. |
|
DATEEXT |
Extended Alarm date |
12 |
dd-mm-yyyy |
|
DEADBAND |
Alarm deadband |
12 |
For Analog, and Timestamped Analog alarms: Numeric value (real) |
|
DELTATIME |
Event on duration |
12 |
hh:mm:ss |
|
DESC |
Alarm description |
254 |
For Analog Alarms "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". For others - configured descriptions. |
|
DEVIATION |
Alarm deviation |
12 |
For Analog, and Timestamped Analog alarms: Numeric value (real) |
|
ENG_ZERO |
The engineering zero scale for this value |
11 |
Numeric value (real) |
|
ERRDESC |
Extra Citect info on alarms |
80 |
For Hardware alarms: error description according to the configuration. |
|
ERRPAGE |
Alarm from this Citect page |
80 |
For Hardware alarms: the Citect page the alarm is assigned to. |
| EQUIPMENT | Name of Equipment | 254 | |
|
FORMAT |
Alarm format |
12 |
For Analog, and Timestamped Analog alarms: 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 Argyle (Multi-digital) Digital alarms: Numeric value |
|
HELP |
Alarm help |
254 |
The name of the help page. |
|
HIGH |
Alarm high |
12 |
For Analog, and Timestamped Analog alarms: Numeric value (real) |
|
HIGHHIGH |
Alarm high high |
12 |
For Analog, and Timestamped Analog alarms: Numeric value (real) |
|
ITEM |
Name of equipment item |
63 |
|
|
LOCALTIMEDATE |
Alarm Date and Time |
24 |
yyyy-mm-dd hh:mm:ss[.ttt]. Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, 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 Timestamped Analog alarms: Numeric value (real) |
|
LOWLOW |
Alarm low low |
12 |
For Analog, and Timestamped Analog alarms: Numeric value (real) |
|
MILLISEC |
Alarm milliseconds |
6 |
Numeric value (integer) |
|
NAME |
Alarm name |
80 |
|
|
NATIVE_COMMENT |
Event Comment |
64 |
For non-Hardware alarms: the event description. |
|
NATIVE_DESC |
Alarm description |
80 |
Analog alarm - Alarm state text. Otherwise - 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 on date |
12 |
short: dd-mm-yy [default] extended: dd-mm-yyyy Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, otherwise "". Note: The format can be chaged by setting ExtendedDate to FALSE under the section [Alarm] in the citect.ini file. |
|
OFFDATEEXT |
Extended Event off date |
12 |
For non-Hardware alarms: dd-mm-yyyy |
|
OFFMILLI |
Alarm summary milliseconds |
6 |
For High Resolution, Timestamped Digital and Timestamped Analog alarms it is the milliseconds part of the off time |
|
OFFTIME |
Event off time |
12 |
hh:mm:ss [am|pm]. Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, otherwise "" |
|
OFFTIMEDATE |
Special SQL formatted date and time |
12 |
For non-Hardware alarms: HH:MM:SS. Note: The format can be configured in the citect.ini file by specifying TimeDate under the section [Alarm]. |
|
OFFUTC |
Event off time |
|
Integer that represents a "time" value - the number of seconds since Jan 1, 1970 in UTC format not Local. |
|
OLD_DESC |
Argyle old state desc. |
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 |
12 |
short: dd-mm-yy [default] extended: dd-mm-yyyy Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, otherwise "". Note: The format can be chaged by setting ExtendedDate to FALSE under the section [Alarm] in the citect.ini file. |
|
ONDATEEXT |
Extended Event on date |
12 |
For non-Hardware alarms: dd-mm-yyyy |
|
ONMILLI |
Alarm summary milliseconds |
6 |
For High Resolution, Timestamped Digital and Timestamped Analog alarms it is the milliseconds part of the on time |
|
ONTIME |
Event on time |
12 |
hh:mm:ss [am|pm]. Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, otherwise "" |
|
ONTIMEDATE |
Special SQL formatted date and time |
12 |
For non-Hardware alarms: HH:MM:SS. Note: The format can be configured in the citect.ini file by specifying TimeDate under the section [Alarm]. |
|
ONUTC |
Event on time |
Integer that represents a "time" value - 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) |
|
PSI_TYPE |
PSI type code |
Integer |
|
| QUALITY | |||
|
RANGE |
Process range |
16 |
|
|
RATE |
Alarm rate |
12 |
For Analog, and Timestamped Analog alarms: Numeric value (real) |
| RECEIPTLOCAL TIMEDATE |
Displays the alarm’s occurrence time (if known), otherwise it displays the receipt time of the alarm. | ||
| RECEIPTDATE | Date the master station received the event. For example, Date the RTU received the event. | ||
|
STATE |
Alarm state string |
16 |
"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" |
|
STATE_DESC |
Argyle state description |
8 |
"Invalid", "OFF", "ON", "ON State 2", "ON State 3", "ON State 4", "ON State 5", "ON State 6", "ON State 7" |
|
STATE_DESC0 |
Argyle state 0 |
64 |
For Argyle (Multi-digital) Digital alarms: "OFF". For others: "INVALID" |
|
STATE_DESC1 |
Argyle state 1 |
64 |
For Argyle (Multi-digital) Digital alarms: "ON". For others: "INVALID" |
|
STATE_DESC2 |
Argyle state 2 |
64 |
For Argyle (Multi-digital) Digital alarms: "ON state 2". For others: "INVALID" |
|
STATE_DESC3 |
Argyle state 3 |
64 |
For Argyle (Multi-digital) Digital alarms: "ON state 3". For others: "INVALID" |
|
STATE_DESC4 |
Argyle state 4 |
64 |
For Argyle (Multi-digital) Digital alarms: "ON state 4". For others: "INVALID" |
|
STATE_DESC5 |
Argyle state 5 |
64 |
For Argyle (Multi-digital) Digital alarms: "ON state 5". For others: "INVALID" |
|
STATE_DESC6 |
Argyle state 6 |
64 |
For Argyle (Multi-digital) Digital alarms: "ON state 6". For others: "INVALID" |
|
STATE_DESC7 |
Argyle state 7 |
64 |
For Argyle (Multi-digital) 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 |
|
|
TAGEX |
Extended Alarm tag |
32 |
<cluster>.<tag> when cluster defined Otherwise <tag>. |
|
TAGGENLINK |
Indicates Tag was imported from an IO Device |
Name of the IO Device from which this tag was generated |
|
|
TIME |
Alarm Time |
12 |
hh:mm:ss [am|pm]. Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, otherwise "" |
|
TIMEDATE |
Special SQL formatted time |
24 |
HH:MM:SS. Note: The format can be configured in the citect.ini file by specifying TimeDate under the section [Alarm]. |
|
TYPE |
Alarm, Trend or Tag type string |
16 |
For Alarms: "DISABLED", "UNACKNOWLEDGED", "ACKNOWLEDGED", "CLEARED" For Trends: "1" - Periodic, "2" - Event, "3" - Periodic Event |
|
TYPENUM |
Alarm type |
4 |
Numeric value (integer) |
|
USERNAME |
Event user name |
16 |
For non-Hardware alarms the configured name of the event user if exists. Otherwise "System". |
| USERLOCATION | The IP of the machine which last raised, performed an action on or modified the alarm. | 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 |
Analog Alarms - numeric value formatted according to configuration. |
Click to return to Browse Function Field Reference
Published June 2018