List of element 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 elements 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 Element for primary objects. One of the following values may be present for children of the element:
|
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 |
|
|
CreationDate |
no |
no |
|
|
ModifyDate |
no |
no |
|
|
SecurityString |
no |
yes |
|
|
NewName |
Enter a new name to change the name as it appears 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 |
|
ReferenceType |
Possible values:
|
no |
yes10 |
|
Template |
no |
no2 |
|
|
DefaultAttribute |
Cannot be changed if element is based on a template. |
no |
no |
|
DefaultInputPort |
no |
yes |
|
|
DefaultOutputPort |
no |
yes |
|
|
DefaultUndirectedPort |
no |
yes |
|
|
Categories |
no |
yes1 |
|
|
IsAnnotated |
no |
no7 |
|
|
VersionID |
no |
no |
|
|
VersionCreationDate |
no |
no |
|
|
VersionModifyDate |
no |
no |
|
|
VersionModifier |
no |
no3 |
|
|
VersionComment |
no |
yes |
|
|
VersionEffectiveDate |
no |
yes |
|
|
VersionObsoleteDate |
no |
yes |
|
|
ExtendedPropertyType |
Possible values:
|
no |
yes |
|
ExtendedPropertyValue |
no |
yes |
|
|
AttributeIsHidden |
no |
yes4 |
|
|
AttributeIsManualDataEntry |
no |
yes 4 |
|
|
AttributeTrait |
Possible values: For Limit traits:
|
no |
yes 4 |
|
AttributeIsConfigurationItem |
no |
yes 1,5 |
|
|
AttributeIsExcluded |
no |
yes |
|
|
AttributeDefaultUOM |
no |
yes 1,5 |
|
|
AttributeType |
Possible values:
|
no |
yes1,5 |
|
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,5 |
|
AttributeValue |
Enter a new value to change the value as it appears in PI AF. |
no |
yes, if not linked to a data reference. |
|
AttributeDataReference |
Possible values:
|
no |
yes |
|
AttributeConfigString |
no |
yes |
|
|
AttributeDisplayDigits |
no |
yes |
|
|
AnalysisOutputTime |
no |
yes |
|
|
AnalysisStatus |
To enable or disable an analysis, enter appropriate text and publish the element to PI AF. |
no |
yes |
|
AnalysisRuleDefinedByTemplate |
no |
no |
|
|
AnalysisRule |
no |
yes6 |
|
|
AnalysisRuleConfigString |
If the analysis rule comes from a template and the Show simplified configuration strings option is selected, <Defined by template> is shown in this column. Otherwise, this column displays the expression used to perform calculations on a group of elements. |
no |
yes6 |
|
AnalysisRuleVariableMapping |
If the analysis rule comes from a template and the Show simplified configuration strings option is selected, <Defined by template> is shown. When the object type is an analysis template, this column shows the name of the mapped output where calculation history is stored. |
no |
yes6 |
|
TimeRuleDefinedByTemplate |
no |
no |
|
|
TimeRule |
no |
yes |
|
|
TimeRuleConfigString |
no |
yes |
|
|
ResetRule |
no |
yes8 |
|
|
Status |
To enable or disable a notification rule, enter appropriate text and publish the notification rule to PI AF. |
no |
yes |
|
MultiTriggerEventOption |
Possible values:
|
no |
yes9 |
|
ResendInterval |
no |
yes9 |
|
|
NonrepetitionInterval |
no |
yes9 |
|
|
Criteria |
no |
yes9 |
|
|
ContentExample |
no |
yes9 |
|
|
DefaultDeliveryFormat |
no |
yes |
|
|
DeliveryFormatDeliveryChannel |
Possible values:
|
no |
yes |
|
DeliveryFormatPropertyValue |
no |
yes |
|
|
SubscriberRetryInterval |
no |
yes9 |
|
|
SubscriberEscalationTimeout |
no |
yes9 |
|
|
SubscriberMaximumRetries |
no |
yes9 |
|
|
SubscriberNotifyOption |
Possible values:
|
no |
yes9 |
|
SubscriberConfigString |
no |
yes9 |
|
|
SubscriberDeliveryFormat |
no |
yes9 |
|
|
PortType |
Possible values:
|
no |
yes1,5 |
|
PortMaxConnections |
no |
yes1,5 |
|
|
PortAllowedElementTypes |
no |
yes1,5 |
|
|
PortAllowedElementTemplate |
no |
yes1,5 |
1 You cannot add attributes or ports, or modify the categories when the element is based on a template unless the template's Allow Extensions check box is selected.
2 You cannot change values for these properties. Delete the object (the entire row in the worksheet) and then add the object back in with the property change you want.
3 The modifier cannot be written to, although it will change to the current user if this element is modified during publication.
4 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.
5 You can write changes to values in the DefaultAttribute, DefaultInputPort, DefaultOutputPort, and DefaultUndirectedPort columns only when the element is not derived from a template. Most properties of attributes and ports cannot be changed if they are defined by the template.
6 You can write changes to values in the AnalysisRule, AnalysisRuleConfigString, and AnalysisRuleVariableMapping columns only when the analysis is not derived from a template.
7 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 element or all annotations are deleted from an element.
8 You can only change this value if a notification rule is derived from a template.
9 You can only change this value if a notification rule is not derived from a template.
10 Beginning with 2018, you can change a reference type to a different one, provided that the reference type is valid and exists.