Cicode Programming Reference > Browse Function Field Reference

Browse Function Field Reference

See Server Browse Function Fields for Server fields.

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 chaged 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", "Argyle Analog", "Time Stamped", "Time Stamped Digital", "Time Stamped Analog"

ALMCOMMENT

Alarm comment

254

 

AREA

Alarm area

16

Numeric value (integer)

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, Argyle 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, Argyle Analog and Timestamped Analog alarms: Numeric value (real)

ENG_FULL

The engineering full scale for this value

11

Numeric value (real)

ENG_UNITS

Engineering units

8

The predefined values (see below) are in the Help.dbf of the bin directory but the user may specify it as a free text:

%, Amps, deg, ft, ft/min, ft/s, ft/sec, gal, gal/h, gal/min, gal/s, gal/sec, Hz, kg, kg/h, kg/min, kg/s, kg/sec, km/h, kPa, kW, litres, lt, lt/h, lt/min, lt/s, lt/sec, m/min, m/s, m/sec, metres, Rev, Rev/h, RPM, t, t/h, Tonnes, Volts, Watts.

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.

EXPRESSION

Logged variable name

65

The logged variable name (clustername.tagname).

If the expression contains simple Cicode containing a single tag name, such as "LT131" or "LT131<1000", the tag name is returned (in both these cases LT131). If the expression contains a function call or more than one tag name, an empty string is returned.

FILENAME

File where the trend data is to be stored

231

 

FILES

The number of history files stored on the hard disk (for this tag)

4

 

FORMAT

Alarm format

12

For Analog, Argyle 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 Digital alarms: Numeric value

HELP

Alarm help

254

The name of the help page.

HIGH

Alarm high

12

For Analog, Argyle Analog and Timestamped Analog alarms: Numeric value (real)

HIGHHIGH

Alarm highhigh

12

For Analog, Argyle Analog and Timestamped Analog alarms: Numeric value (real)

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, Argyle Analog and Timestamped Analog alarms: Numeric value (real)

LOWLOW

Alarm lowlow

12

For Analog, Argyle Analog and Timestamped Analog alarms: Numeric value (real)

LSL

Lower specification limit

16

 

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 not exists the alarm] description

NODE

Local node name

32

 

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.

ORATODATE

Special SQL formatted time

12

The first 12 characters of the string:

"TO_DATE('<sql_time_date>', '<sql_time_format>')".

ORATOOFFDATE

Special SQL formatted time

12

For non-Hardware alarms: The first 12 characters of the string:

"TO_DATE('<sql_off_time_date>', '<sql_time_format>')".

ORATOONDATE

Special SQL formatted time

12

For non-Hardware alarms: The first 12 characters of the string:

"TO_DATE('<sql_on_time_date>', '<sql_time_format>')".

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.

PERIOD

The period of the history file

32

In hh:mm:ss (hours:minutes:seconds).

PRIORITY

Alarm category priority

4

Numeric value (integer)

PRIV

Alarm privilege

16

Numeric value (integer)

RANGE

Process range

16

 

RATE

Alarm rate

12

For Analog, Argyle Analog and Timestamped Analog alarms: Numeric value (real)

RAW_FULL

The raw full scale for this value

11

Numeric value (real)

RAW_ZERO

The raw zero scale for this value

11

Numeric value (real)

RUNNING

Running time in seconds

16

Numeric value (real)

SAMPLEPER

Sample period of the trend in seconds

16

Numeric value (real)

SDEVIATION

Standard deviation

16

 

SPCFLAG

Indicates tag is a Statistical Process Control (SPC) tag

   

STARTS

Number of starts

16

Numeric value (real)

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 Digital alarms: "OFF".

For others: "INVALID"

STATE_DESC1

Argyle state 1

64

For Argyle Digital alarms: "ON".

For others: "INVALID"

STATE_DESC2

Argyle state 2

64

For Argyle Digital alarms: "ON state 2".

For others: "INVALID"

STATE_DESC3

Argyle state 3

64

For Argyle Digital alarms: "ON state 3".

For others: "INVALID"

STATE_DESC4

Argyle state 4

64

For Argyle Digital alarms: "ON state 4".

For others: "INVALID"

STATE_DESC5

Argyle state 5

64

For Argyle Digital alarms: "ON state 5".

For others: "INVALID"

STATE_DESC6

Argyle state 6

64

For Argyle Digital alarms: "ON state 6".

For others: "INVALID"

STATE_DESC7

Argyle state 7

64

For Argyle Digital alarms: "ON state 7".

For others: "INVALID"

STORMETHOD

Storage method for the SPC data

16

"Scaled" or "Floating Point"

SUBGRPSIZE

The size of each subgroup

8

 

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

"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].

TOTALISER

Running total of value

16

Numeric value (real)

TRIGGER

(accumulator fields)

Last trigger value, used to check for rising edge of the trigger code

5

0 OR 1

TRIGGER

(trend fields)

The variable tag that triggers data logging

65

The variable tag (clustername.tagname) that triggers data logging.

If the trigger contains simple Cicode containing a single tag name, such as "LT131<50", the tag name is returned (in this case LT131). If the expression contains a function call or more than one tag name, an empty string is returned.

TYPE

Alarm or Trend 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)

USERDESC

Event user description

64

For non-Hardware alarms the configured user description if exists. Otherwise "".

USERNAME

Event user name

16

For non-Hardware alarms the configured name of the event user if exists.

Otherwise "System".

USL

Upper specification limit

16

 

VALUE

(alarm fields)

Formatted alarm value

16

Analog Alarms - numeric value formatted according to configuration.

Others - "ON", "OFF"

VALUE

(accumulator fields)

The value to be added to the totaliser while trigger is true

16

Numeric value (real)

XDOUBLEBAR

Process mean

16

 

Server Browse Function Fields

Field Name

Description

Length

Values

CLUSTER

The name of the cluster to which the server belongs.

16

COMMENT

Comment

48

LEGACYPORT

The port number the server is listening on for legacy connections. If no legacy port number was configured, this field contains the default legacy port number for the server type.

16

Number between 1 and 65535.

MODE

Indicates whether the server is configured as a primary or standby.

16

For Alarm, Report and Trend servers:

1 - primary
0 - standby

For I/O servers the MODE field is set to "0".

NAME

The name of the server

16

NETADDR

The network addresses associated with the server.

70

A comma-separated list of one or more names. The field contains the network address names as configured, and not IP addresses.

PORT

The port number the server is listening on. If no port number was configured, this field contains the default port number for the server type.

16

Number between 1 and 65535.

TYPE

Specifies the purpose of the server

16

"Alarm", "I/O", "Report", "Trend"