List of event frame columns
- Last UpdatedDec 13, 2024
- 4 minute read
- PI System
- PI Server 2024 R2
- PI Server
The following table lists the columns available for PI AF event frames in PI Builder.
|
Column name |
Comment |
Required in PI Builder |
Can be changed in PI AF 1 |
|---|---|---|---|
|
Selected(x) |
Enter an x to have PI Builder act on the row when you click Publish, Delete, or Retrieve. |
yes |
n/a |
|
Parent |
yes |
no2 |
|
|
Name |
To change the name, enter a new name in the NewName column. |
yes |
n/a |
|
ObjectType |
Set to EventFrame for primary objects. One of the following values may be present for children of the event frame:
|
yes |
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 |
no |
|
Description |
no |
yes |
|
|
ReferenceType |
Possible values:
|
no |
yes10 |
|
Template |
no |
no2 |
|
|
DefaultAttribute |
no |
yes4 |
|
|
Categories |
no |
yes1 |
|
|
IsAnnotated |
no |
no8 |
|
|
CreationDate |
no |
no |
|
|
ModifyDate |
no |
no |
|
|
SecurityString |
no |
yes |
|
|
NewName |
Enter a new name to change the name in PI AF. |
no |
yes |
|
UniqueID |
no |
no |
|
|
NewParent |
Enter the name of a new parent to move the object in the PI AF hierarchy. |
no |
yes |
|
PrimaryReferencedElement |
Path from the PI AF database to the event frame's primary referenced element. |
no |
yes3 |
|
IsLocked |
no |
no5 |
|
|
AreValuesCaptured |
no |
yes |
|
|
StartTime |
no |
yes |
|
|
EndTime |
no |
yes |
|
|
Severity |
Possible values:
|
no |
yes |
|
CanBeAcknowledged |
no |
yes |
|
|
IsAcknowledged |
no |
yes |
|
|
AcknowledgedBy |
no |
no9 |
|
|
AchnowledgedDate |
no |
no9 |
|
|
ExtendedPropertyType |
Possible values:
|
no |
yes |
|
ExtendedPropertyValue |
no |
yes |
|
|
AttributeIsHidden |
no |
yes 6 |
|
|
AttributeIsManualDataEntry |
no |
yes 6 |
|
|
AttributeTrait |
Possible values: For Limit traits:
|
no |
yes 6 |
|
AttributeIsConfigurationItem |
no |
yes1,4 |
|
|
AttributeIsExcluded |
no |
yes |
|
|
AttributeDefaultUOM |
no |
yes1,4 |
|
|
AttributeType |
Possible values:
|
no |
yes1,4 |
|
AttributeTypeQualifier |
If the AttributeType column contains AFEnumerationValue, then the AttibuteTypeQualifier column contains the name of an enumeration set and the AttributeValue column contains the name of an enumeration value from the specified enumeration set. |
no |
yes1,4 |
|
AttributeValue |
no |
yes7 |
|
|
AttributeDataReference |
Possible values:
|
no |
yes |
|
AttributeConfigString |
no |
yes |
|
|
AttributeDisplayDigits |
no |
yes |
1 You cannot add attributes or modify the categories when the event frame is based on a template unless the template Allow Extensions check box is selected.
2 You cannot change this property. Delete the object (the entire row in the worksheet) and then add the object back in with the property change you want.
3 You can change, but not clear, an event frame's primary referenced element in . If you set the PrimaryReferencedElement column to a blank value, does not modify the current value. The only way to clear the primary referenced element for an event frame in is to retrieve the element reference for the event frame and delete the reference.
4 You can write changes for the DefaultAttribute column only when the event frame is not derived from a template. The Allow Extensions setting in the template does not affect the behavior. Most properties of attributes cannot be changed if they are defined by the template.
5 You cannot change this value with . PI System Explorer, however, can lock and unlock event frames.
6 You can change this value only if the attribute does not have a template. If the attribute has a template, then you cannot change the value from the attribute; you must change the value from the attribute template.
7 You can change the value of an event-frame attribute if the attribute does not have a data reference. If the attribute does have a data reference and AreValuesCaptured is TRUE, then you can change the value, but writes the changed value only to the internal value cache that the attribute maintains; does not write values to the data source, such as to for data references to PI points.
8 You cannot change the value for this property since it is indirectly set or cleared in PI System Explorer or through client code when annotations are added to an event frame or all annotations are deleted from an event frame.
9 You cannot change the value for this property since it is indirectly set when users acknowledge event frames.
10 Beginning with 2018, you can change a reference type to a different one, provided that the reference type is valid and exists.