Attributes in tagDefinitionList

In this section, you can find the descriptions of all the attributes for the tagDefinitionList item on the Output tab.

Note: The tagDefinitionList item is displayed on the Output tab only when you choose getTagDefinitions from the Operation list on the General tab.

The following table lists the descriptions of all the attributes in the tagDefinitionList item:

Attribute Name Data Type Description
pointName String The name of the tag on the PI Data Archive server.
descriptor String The description of the PI tag.
piServerName String The name of the PI Data Archive server that records the tag.
pointClass String The attribute that specifies point class from the point classes that belong to the PI Data Archive server.
pointType String The attribute that specifies the data type for the values that a point stores.

Supported point types include: Digital, Timestamp, Float64, Float32, Float16, Int32, Int16, String, and Blob.

pointSource String The attribute that identifies the source of data for a PI point.
changeDate String The last time when the PI point was changed.
creationDate String The time when the PI point was created.
digitalSet String The name of the digital set.

This attribute is only relevant when the pointType attribute is Digital.

engineeringUnits String The default unit of measurement for the PI point.
extendedDescription String Optional extended description for the PI point.
sourceTag String Reference to another PI point.

Data stream of this PI point is used as the source for the given PI point.

displayDigits String The attribute that determines the display precision of PI point values.
archiving String The attribute that enables or disables values archiving.

Supported values are 0 and 1.

scan String The attribute that enables or disables interface scanning.

Supported values are 0 and 1.

compressing String The attribute that determines whether snapshot events are selected to be sent to the archive file for storage.

Supported values are 0 and 1.

zero String The lowest possible value of a PI point.
span String The range between the maximum and minimum values for a point.

The sum of zero and span determines the highest possible value.

excdev String Exception deviation, the set of values that define a deadband used for exception reporting.

If this attribute is used, the excdevpercent attribute is recalculated.

excdevpercent String Percentage of exception deviation.

If this attribute is used, the excdev attribute is recalculated.

compdev String Compression deviation, the compression algorithm used to reduce the data flow from the interfaces to the PI Data Archive server.

If this attribute is used, the compdevpercent attribute is recalculated.

compdevpercent String Percentage of compression deviation.

If this attribute is used, the compdev attribute is recalculated.