PI point columns

Selected(x)

Enter an x to have PI Builder act on the row when you click Publish, Delete, or Retrieve.

This column is required in PI Builder and may be named Select(x) to support PI Tag Configurator worksheets.

n/a

Name

To change the name, enter a new name in the NewName or NewTag column.

This column is required in PI Builder.

n/a

ObjectType

Set to PIPoint.

This column is required in PI Builder.

n/a

Error

If an error occurs during a delete, publish, or retrieve operation for a specific row in the worksheet, PI Builder displays the error message for that row in the Error column cell. The error continues to be displayed until you clear it or perform the next delete, publish, or retrieve operation.

no

NewName

Enter a new name to change the point name in Data Archive.

This column may be named NewTag to support PI Tag Configurator worksheets.

yes

Description

This column may be named Descriptor to support PI Tag Configurator worksheets.

yes

digitalset

The name of the digital state set associated with the PI Point. This applies only to PI Points whose point type is digital.

yes

displaydigits

Controls the display formatting of numeric PI Point values on-screen and in reports.

yes

engunits

Describes the engineering units of measurement used for values of the PI Point.

yes

exdesc

Extended descriptor for the PI Point.

yes

future

The 'future' PI Point attribute

no1

pointsource

String that associates a PI Point with an interface or PI application.

yes

pointtype

Possible values:

• Blob

• Digital

• Float16

• Float32

• Float64

• Int16

• Int32

• Integer

• String

• TimeStamp

yes

ptclassname

The name of the point class to which the PI Point belongs.

no

sourcetag

May be used by some interfaces to output PI Point data to other systems. It is also used to specify the name of the PI Point whose value is used to calculate alarm conditions, SQC alarm conditions, and totalizer results.

yes

archiving

Indicates if data is to be archived for the PI Point. A value of '1' indicates that it is and a value of '0' indicates that it is not.

yes

compressing

Indicates if data is to be compressed for the PI Point. A value of '1' indicates that it is and a value of '0' indicates that it is not.

yes

compdev

Compression deviation indicates the number of engineering units the value of a PI Point must change for a new compressed value to be archived.

yes

compmax

Compression maximum time is the maximum allowable time span between compressed archived values for the PI Point. If the time stamp of a value exceeds compmax, it will be archived even if the value does not fall outside compdev or compdevpercent.

yes

compmin

Compression minimum time is the minimum allowable time span between compressed archived values for the PI Point. If the time stamp of a value is less than compmin, it will be discarded even if the value falls outside compdev or compdevpercent.

yes

compdevpercent

Compression deviation percent specifies the compression deviation as a percent of the PI Point's span rather than absolute deviation in engineering units.

yes

excdev

Exception deviation indicates to the PI Point's interface the number of engineering units the value must change for a new value to be sent to the PI Point's snapshot.

yes

excmax

Exception maximum time indicates to the PI Point's interface the maximum allowable time span between values being sent to the PI Point's snapshot.

yes

excmin

Exception minimum time indicates to the PI Point's interface the minimum allowable time span between values being sent to the PI Point's snapshot.

yes

excdevpercent

Exception deviation percent specifies the exception deviation as a percent of the PI Point's span rather than absolute deviation in engineering units.

yes

scan

May be used by some interfaces to determine whether a PI Point's data should be updated. If the interface uses the flag, a value of '1' indicates that the PI Point's data should be updated and a value of '0' indicates that it should not be updated. Refer to your particular PI interface documentation to determine if it uses this point attribute.

yes

shutdown

Specifies whether shutdown events should be recorded for a PI Point. A value of '1' indicates that shutdown events should be recorded and a value of '0' indicates that they should not be recorded.

yes

span

Specifies the difference between the top and bottom of the range of values used when calculating whether a new value should be archived or discarded based on the exception or compression settings for the PI Point.

yes

step

Specifies whether numeric values should be interpolated when being archived. A value of '0' indicates that they should be linearly interpolated and a value of '1' indicates that the raw, discrete values should be archived.

yes

typicalvalue

This attribute is used to document an example of a reasonable value for a PI Point. For numeric PI Points, it must be greater than or equal to the zero point attribute and less than or equal to the zero plus the span point attributes. Some interfaces use typicalvalue as a default value for their PI Points.

yes

zero

This attribute is used to specify the lowest value possible for a numeric PI Point.

yes

action1

Specifies the digital state that is set when the corresponding test in the Test1 attribute triggers an alarm.

yes

action2

Specifies the digital state that is set when the corresponding test in the Test2 attribute triggers an alarm.

yes

action3

Specifies the digital state that is set when the corresponding test in the Test3 attribute triggers an alarm.

yes

action4

Specifies the digital state that is set when the corresponding test in the Test4 attribute triggers an alarm.

yes

action5

Specifies the digital state that is set when the corresponding test in the Test5 attribute triggers an alarm.

yes

AutoAck

Specifies whether the alarm is automatically acknowledged when it is triggered.

yes

ControlAlg

Reserved for future use.

yes

ControlTag

The name of the PI Point that is used to enable and disable the alarm.

yes

Deadband

Threshold value within the alarm limit that the PI Point must pass after an alarm is triggered before the point is considered to no longer be in alarm.

yes

Options

Used to specify calculation parameters for alarm, SQC alarm, and totalizer PI Points.

yes

ReferenceTag

For alarm PI Points, this is the name of the PI Point whose value is used in the comparisons specified in the Test1-Test5 attributes to determine whether to trigger an alarm. For SQC alarm PI Points, this attribute is present but unused.

yes

srcptid

The unique PI Point id number associated with the PI Point specified in the sourcetag point attribute.

yes

test1

Specifies a test to be run to determine if an alarm is to be raised. If the condition is true, the digital state used will be the one specified in the Action1 attribute.

yes

test2

Specifies a test to be run to determine if an alarm is to be raised. If the condition is true, the digital state used will be the one specified in the Action2 attribute.

yes

test3

Specifies a test to be run to determine if an alarm is to be raised. If the condition is true, the digital state used will be the one specified in the Action3 attribute.

yes

test4

Specifies a test to be run to determine if an alarm is to be raised. If the condition is true, the digital state used will be the one specified in the Action4 attribute.

yes

test5

Specifies a test to be run to determine if an alarm is to be raised. If the condition is true, the digital state used will be the one specified in the Action5 attribute.

yes

txt1

Reserved for future use.

yes

txt2

Reserved for future use.

yes

txt3

Reserved for future use.

yes

txt4

Reserved for future use.

yes

txt5

Reserved for future use.

yes

convers

Conversion factor used for scaling PI Point values.

yes

filtercode

Indicates the time constant of a first-order filter used to smooth incoming data. This affects compressed PI Point data. It doesn't affect exception reporting for PI Point data.

yes

instrumenttag

Used by some interfaces to identify a tag from an external system that is related to the PI Point. Some interfaces use the extended descriptor (exdesc) for this purpose. Refer to your particular PI interface documentation for more details.

yes

location1

An integer used by many interfaces to specify the interface ID number. Refer to your particular PI interface documentation for more details.

yes

location2

An integer parameter whose use is determined by the interface associated with a PI Point. Refer to your particular PI interface documentation for more details.

yes

location3

An integer parameter whose use is determined by the interface associated with a PI Point. Refer to your particular PI interface documentation for more details.

yes

location4

An integer used by many interfaces to specify the scan class of the PI Point. Refer to your particular PI interface documentation for more details.

yes

location5

An integer parameter whose use is determined by the interface associated with a PI Point. Refer to your particular PI interface documentation for more details.

yes

squareroot

Used by some interfaces in conjunction with totalcode to scale data. Refer to your particular PI interface documentation for more details.

yes

totalcode

Used by some interfaces in conjunction with squareroot to scale data. Refer to your particular PI interface documentation for more details.

yes

userint1

User-defined integer value.

yes

userint2

User-defined integer value.

yes

userreal1

User-defined floating point value.

yes

userreal2

User-defined floating point value.

yes

clamp

yes

displaygroup

yes

eventnumb

yes

expressnumb

yes

filternumb

yes

groupsize

yes

nodenumb

yes

offset

yes

period

yes

AutoAck

Specifies whether the alarm is automatically acknowledged when it is triggered.

yes

ChartType

Indicates the type of SQC chart for which alarms are being calculated.

yes

ClearOnLimitChange

Specifies whether active SQC alarms should be cleared and alarm calculations restarted when any control limit tag (UCLTag, CLTag, LCLTag) changes.

yes

ClearOnStart

Specifies whether active SQC alarms should be cleared and alarm calculations restarted on startup or after a change to the SQC alarm point's attributes.

yes

CLTag

Name of the PI Point that is used as the center line for SQC calculations.

yes

CommentTag

Name of the PI Point where comments associated to the SQC alarm are to be stored.

yes

LCLTag

Name of the PI Point that is used as the lower control limit for SQC calculations.

yes

LSLTag

Name of the PI Point that is used as the lower specification limit for SQC calculations.

yes

Mixture

SQC pattern test that raises an SQC alarm when x of y values of the sourcetag are found on both sides of the centerline and none of these values falls within one sigma.

yes

OneSideOfCL

SQC pattern test that raises an SQC alarm when x of y values of the sourcetag are on one side of the center line.

yes

OutsideControl

SQC pattern test that raises an SQC alarm when x of y values of the sourcetag are outside the control limits.

yes

OutsideOneSigma

SQC pattern test that raises an SQC alarm when x of y values of the sourcetag are outside the one sigma limit.

yes

OutsideTwoSigma

SQC pattern test that raises an SQC alarm when x of y values of the sourcetag are outside the two sigma limit.

yes

PIProductLimits

Reserved for future use.

yes

ProductTag

Name of the PI Point that designates the current product for which the SCQ calculation is being made.

yes

ReferenceTag

For alarm PI Points, this is the name of the PI Point whose value is used in the comparisons specified in the Test1-Test5 attributes to determine whether to trigger an alarm. For SQC alarm PI Points, this attribute is present but unused.

ResetTag

Name of the PI Point that governs the execution and reset of the SQC alarm calculation.

yes

SQCAlarmPriority

Integer value that specifies the priority of the SQC alarm.

yes

scriptid

The unique PI Point id number associated with the PI Point specified in the sourcetag point attribute.

Stratification

SQC pattern test that raises an SQC alarm when x of y values of the sourcetag are within the one sigma limit.

yes

TestStatusTag

Name of the PI Point to which the SQC alarm system writes values indicating which SQC pattern tests are in alarm.

yes

Trend

SQC pattern test that raises an SQC alarm when x consecutive values of the sourcetag trend either up or down.

yes

UCLTag

Name of the PI Point that is used as the upper control limit for SQC calculations.

yes

USLTag

Name of the PI Point that is used as the upper specification limit for SQC calculations.

yes

WaitOnLimitChange

Reserved for future use.

yes

CalcMode

Used in conjunction with the function point attribute to define the primary behavior of a totalizer PI Point.

yes

CompValue

Used for comparison in the event counting functions.

yes

Conversion

Used to convert the engineering units of the rate point to proper engineering units for the totalization. The raw totalizer results is multiplied by the value of conversion.

yes

EventExpr

Performance equation expression that defines event types used by EventChange and EventTrue options of totalclosemode. It also defines the event times at which the rate point is scanned for ratesamplemode option.

yes

FilterExpr

Mathematical performance equation expression that is used to determine whether point values are to be excluded from totalization.

yes

Function

Used in conjunction with the calcmode point attribute to define the primary behavior of a totalizer PI Point.

yes

MovingCount

Used by NSampleMoving and NSampleBlock options of totalclosemode to determine the number of samples for the accumulation interval.

yes

Offset

Relative time stamp that is used by the Clock option of totalclosemode to determine when to begin the initial accumulation.

Offset2

Relative time stamp that is used by the Scan1 and Scan2 options of totalclosemode to determine when to start sampling.

yes

Options

Used to specify calculation parameters for alarm, SQC alarm, and totalizer PI Points.

PctGood

Percent of rate point values that must be good for the output of the totalizer to be marked as good.

yes

Period

Used by the Clock option of totalclosemode to specify the accumulation interval.

Period2

Used by the Scan1 and Scan2 options of ratesamplemode to specify the sampling rate.

yes

RateSampleMode

Specifies when individual values from the rate point are used in the calculation or are added to the calculation.

yes

ReportMode

Specifies the manner in which the totalizer results are sent to the PI snapshot.

yes

scriptid

The unique PI Point id number associated with the PI Point specified in the sourcetag point attribute.

TotalCloseMode

Specifies the accumulation interval of the totalizer calculation.

yes

zerobias

The value of the rate point is considered to be 0 if it is less than this value.

yes

dataaccess

Valid for Data Archive versions earlier than 3.4.380.

yes

datagroup

Valid for Data Archive versions earlier than 3.4.380.

yes

dataowner

Valid for Data Archive versions earlier than 3.4.380.

yes

ptaccess

Valid for Data Archive versions earlier than 3.4.380.

yes

ptgroup

Valid for Data Archiveversions earlier than 3.4.380.

yes

ptowner

Valid for Data Archive versions earlier than 3.4.380.

yes

datasecurity

Valid for Data Archive versions 3.4.380 and later.

yes

ptsecurity

Valid for Data Archive versions 3.4.380 and later.

yes

changedate

The read-only date and time when the PI Point was last edited.

no

changer

The read-only name of the user who last edited the PI Point.

no

creationdate

The read-only date and time when the PI Point was created.

no

creator

The read-only name of the user who created the PI Point.

no

pointid

The unique numeric identifier for the PI Point. It is read-only and may not be changed. It should not be confused with the recno PI Point attribute.

no

recno

The primary record number of the PI Point in the data archive. It is read-only and may not be changed. It should not be confused with the pointid PI Point attribute.

no