Element columns
- Last UpdatedJul 09, 2023
- 7 minute read
- PI System
- PI Server 2018
- PI Server
Elements
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 |
The name of the object owning this object. |
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 |
The object description |
no |
yes |
|
CreationDate |
Date and time the object was created. |
no |
no |
|
ModifyDate |
Date and time the object was last modified. |
no |
no |
|
SecurityString |
Represents the security descriptor's access rules for the associated object. |
no |
yes |
|
NewName |
Enter a new name to change the name as it appears in PI AF. |
no |
yes |
|
UniqueID |
The unique identifier (Guid) of the object. |
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 |
The template that the object is derived from or based on. |
no |
no2 |
|
DefaultAttribute |
Cannot be changed if element is based on a template. |
no |
no |
|
DefaultInputPort |
The default input port for the object. |
no |
yes |
|
DefaultOutputPort |
The default output port for the object. |
no |
yes |
|
DefaultUndirectedPort |
The default undirected port for the object. |
no |
yes |
|
Categories |
List of categories of which the object is a member. |
no |
yes1 |
|
IsAnnotated |
Indicates whether the object has annotations. |
no |
no7 |
|
VersionID |
Unique identifier (Guid) of the version object. |
no |
no |
|
VersionCreationDate |
The date and time when the version of the owning object was created. |
no |
no |
|
VersionModifyDate |
The date and time when the version of the owning object was last modified. |
no |
no |
|
VersionModifier |
The user who last modified the version of the owning object. |
no |
no3 |
|
VersionComment |
The comment associated with the version of the owning object. |
no |
yes |
|
VersionEffectiveDate |
The date and time when the version of the owning object goes into effect. |
no |
yes |
|
VersionObsoleteDate |
The date and time when the version of the owning object becomes obsolete. |
no |
yes |
|
ExtendedPropertyType |
Possible values:
|
no |
yes |
|
ExtendedPropertyValue |
The value of the extended property. |
no |
yes |
|
AttributeIsHidden |
Indicates if the attribute is hidden. If true, the attribute is not returned in searches and will not be visible in some applications, but it can still return a value. |
no |
yes4 |
|
AttributeIsManualDataEntry |
Indicates if the attribute is used for manual data entry. |
no |
yes 4 |
|
AttributeTrait |
Possible values: For Limit traits:
|
no |
yes 4 |
|
AttributeIsConfigurationItem |
Indicates if the attribute is a configuration item. |
no |
yes 1,5 |
|
AttributeIsExcluded |
Indicates if the attribute is excluded. If true, the attribute is not returned in searches and will not return a value. It will not be shown in most applications. |
no |
yes |
|
AttributeDefaultUOM |
The default unit of measure used for the attribute. |
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 |
Configuration string for the data reference for the attribute. |
no |
yes |
|
AttributeDisplayDigits |
DisplayDigits value of the attribute. |
no |
yes |
|
AnalysisOutputTime |
The analysis output time offset. The time is expressed in a format understood by AFTime parsing (e.g. *-3h). |
no |
yes |
|
AnalysisStatus |
To enable or disable an analysis, enter appropriate text and publish the element to PI AF. |
no |
yes |
|
AnalysisRuleDefinedByTemplate |
Indicates if the configuration of the analysis rule is defined by the analysis template. If the analysis has no template, the value will be false. |
no |
no |
|
AnalysisRule |
Name of the analysis rule. |
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 |
Indicates if the configuration of the time rule is defined fully from the analysis template. If the analysis has no template, the value will be false. |
no |
no |
|
TimeRule |
Name of the time rule. |
no |
yes |
|
TimeRuleConfigString |
Configuration string used by the time rule. |
no |
yes |
|
ResetRule |
Use this column to specify that a notification rule's properties should be reset to its default templated values. |
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 |
The interval for resending the notification. |
no |
yes9 |
|
NonrepetitionInterval |
Non-repetition interval for the notification. |
no |
yes9 |
|
Criteria |
The trigger criteria for creating a notification. |
no |
yes9 |
|
ContentExample |
Specifies the element, event frame, or element template used as a content example for the notification rule. |
no |
yes9 |
|
DefaultDeliveryFormat |
The collection of default delivery format objects for this notification. |
no |
yes |
|
DeliveryFormatDeliveryChannel |
Possible values:
|
no |
yes |
|
DeliveryFormatPropertyValue |
Value of individual delivery format properties such as subject, attachments, or body. |
no |
yes |
|
SubscriberRetryInterval |
The interval at which the system will attempt to resend a notification to a particular individual subscriber if the prior attempt was not successful. |
no |
yes9 |
|
SubscriberEscalationTimeout |
The interval at which the system will attempt to resend a notification to a particular escalation subscriber if the prior attempt was not successful. |
no |
yes9 |
|
SubscriberMaximumRetries |
The maximum number of attempts to send a notification to an individual subscriber if the prior attempts were not successful. |
no |
yes9 |
|
SubscriberNotifyOption |
Possible values:
|
no |
yes9 |
|
SubscriberConfigString |
The current configuration of the subscriber's delivery channel as a string suitable for displaying to an end-user. It contains sufficient information to be used to set the configuration of the associated delivery channel. |
no |
yes9 |
|
SubscriberDeliveryFormat |
The name of the delivery format to be used in generating notifications for the subscriber. |
no |
yes9 |
|
PortType |
Possible values:
|
no |
yes1,5 |
|
PortMaxConnections |
Specifies the maximum number of connections allowed for the port. |
no |
yes1,5 |
|
PortAllowedElementTypes |
Specifies the types of elements allowed to connect to the port. |
no |
yes1,5 |
|
PortAllowedElementTemplate |
Specifies the element template of the elements which are allowed to connect to the port. |
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.