TagBrowseOpen Fields
- Last UpdatedNov 01, 2024
- 3 minute read
The fields in the following table can be used with the TagBrowseOpen Cicode function.
|
Field Name |
Description |
Length |
Values |
|---|---|---|---|
|
ADDR |
The register address. |
254 |
The address of the register in the I/O device that the variable is associated with. The format and prefix of the address will depend on the protocol the I/O device uses. |
|
ARR_SIZE |
Array size |
11 |
An integer representing the size of the array configured for a variable tag. 1 means it is not an array. |
|
CLUSTER |
Cluster name. |
16 |
The cluster the tag exists on. |
|
COMMENT |
Comment. |
254 |
A user-configured comment. |
|
CUSTOM1 |
Custom field #1. |
64 |
A user-defined string. |
|
CUSTOM2 |
Custom field #2. |
64 |
A user-defined string. |
|
CUSTOM3 |
Custom field #3. |
64 |
A user-defined string. |
|
CUSTOM4 |
Custom field #4. |
64 |
A user-defined string. |
|
CUSTOM5 |
Custom field #5. |
64 |
A user-defined string. |
|
CUSTOM6 |
Custom field #6. |
64 |
A user-defined string. |
|
CUSTOM7 |
Custom field #7. |
64 |
A user-defined string. |
|
CUSTOM8 |
Custom field #8. |
64 |
A user-defined string. |
|
DEADBAND |
The deadband set for a tag. |
11 |
A numeric value (real) that indicates how much the value of a variable tag can fluctuate within a defined threshold without updates being sent through to the system. The threshold is represented as a percentage of the tag's engineering range. The default value is 0 (zero), which captures every value change. |
|
ENG_FULL |
The engineering full scale point for a tag. |
11 |
Numeric value (real). This value represents engineering units. It is the upper limit used for trends and bar graphs. It is a scaled value derived from the Raw Full Scale property. |
|
ENG_UNITS |
Engineering units. |
8 |
The engineering units that the value represents. The predefined values (see below) are in the Help.dbf in 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 a tag. |
11 |
Numeric value (real). This value represents engineering units. It is the lower limit used for trends and bar graphs. It is a scaled value derived from the Raw Zero Scale property. |
|
EQUIPMENT |
Equipment name. |
254 |
The name of the piece of equipment with which the tag is associated. 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). |
|
FULLNAME |
The full name of the variable tag. |
254 |
The full name of the variable tag in the format: <ClusterName>.<TagName>. |
|
HISTORIAN |
Determines if the alarm will be included in an automated configuration process within the Historian environment. |
6 |
True or False (blank). |
|
ITEM |
Equipment item. |
63 |
The name of an item with which the tag is associated. Items form part of an equipment hierarchy. They can be used to associate tags, alarms and trends with a particular attribute of a physical piece of equipment. |
|
RAW_FULL |
The raw full scale for the tag. |
11 |
Numeric value (real). It is a raw value read from the I/O device. It represents the upper limit used by Plant SCADA to calculate scaled engineering values. If not defined, Raw Zero Scale and Raw Full Scale will default to the full range value based on the data type. |
|
RAW_ZERO |
The raw zero scale for this value. |
11 |
Numeric value (real). It is a raw value read from the I/O device. It represents the lowest value used by Plant SCADA to calculate scaled engineering values. If not defined, Raw Zero Scale and Raw Full Scale will default to the full range value based on the data type. |
|
TAG |
Tag name. |
79 |
The configured tag name. |
|
TYPE |
Tag type string. |
16 |
RDT_DIGITAL 0 |
|
WRITE_ROLES |
The roles that have write permissions for the variable tag. |
254 |
Indicates which roles have write permissions for a variable tag when using an OPC UA or Industrial Graphics client. Only users included in the specified role(s) will be able to send values to the variable tag from a client application. |