List of model 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 models 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 Model for primary objects. One of the following values may be present for children of the model:
|
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 |
|
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 |
|
Description |
no |
yes |
|
|
Layers |
no |
yes |
|
|
ReferenceType |
Possible values:
|
no |
yes |
|
Template |
no |
no2 |
|
|
DefaultAttribute |
Cannot be changed if model is based on a template. |
no |
no |
|
DefaultInputPort |
no |
yes |
|
|
DefaultOutputPort |
no |
yes |
|
|
DefaultUndirectedPort |
no |
yes |
|
|
Categories |
no |
yes1 |
|
|
IsAnnotated |
no |
no6 |
|
|
VersionID |
no |
no |
|
|
VersionCreationDate |
no |
no |
|
|
VersionModifyDate |
no |
no |
|
|
VersionModifier |
no |
no3 |
|
|
VersionComment |
no |
yes |
|
|
VersionEffectiveDate |
no |
yes |
|
|
VersionObsoleteDate |
no |
yes |
|
|
CreationDate |
no |
no |
|
|
ModifyDate |
no |
no |
|
|
SecurityString |
no |
yes |
|
|
ExtendedPropertyType |
Possible values:
|
no |
yes |
|
ExtendedPropertyValue |
no |
yes |
|
|
AttributeIsHidden |
no |
yes 4 |
|
|
AttributeIsManualDataEntry |
no |
yes 4 |
|
|
AttributeTrait |
Possible values: For Limit traits:
|
no |
yes 4 |
|
AttributeIsConfigurationItem |
no |
yes1,5 |
|
|
AttributeIsExcluded |
no |
yes |
|
|
AttributeDefaultUOM |
no |
yes1,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 in PI AF. |
no |
yes if not linked to a data reference. |
|
AttributeDataReference |
Possible values:
|
no |
yes |
|
AttributeConfigString |
no |
yes |
|
|
AttributeDisplayDigits |
no |
yes |
|
|
PortType |
Possible values:
|
no |
yes1,5 |
|
PortMaxConnections |
no |
yes1,5 |
|
|
PortAllowedElementTypes |
Possible values:
|
no |
yes1,5 |
|
PortAllowedElementTemplate |
no |
yes1,5 |
|
|
ConnectionSource |
Enter the name of an element or model that is referenced by or is a child of this model. |
no |
no2 |
|
ConnectionSourcePort |
This port must belong to the element or model specified in the ConnectionSource column. The port type of this port must be Output or Undirected. If it is Undirected, then the port type specified in the ConnectionDestinationPort columns must also be Undirected. |
no |
no2 |
|
ConnectionDestination |
Enter the name of an element or model that is referenced by or is a child of this model. |
no |
no2 |
|
ConnectionDestinationPort |
This port must belong to the element or model specified in the ConnectionDestination column. The port type of this port must be Input or Undirected. If it is Undirected, the port type of the ConnectionSourcePort must also be Undirected. |
no |
no2 |
1 You cannot add attributes or ports, or modify the categories when the model is based on a template unless the template's Allow Extensions check box is selected.
2 You cannot change the values of these columns. Delete the object (the entire row in the worksheet) and then add the object back in with the changed value. If you do not do this, you might add new connections rather than change existing connections.
3 The modifier cannot be written to, although it will change to the current user if this model is modified during publication to .
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 of the DefaultAttribute, DefaultInputPort, DefaultOutputPort, and DefaultUndirectedPort columns only when the model is not derived from a template. Most properties of attributes and ports cannot be changed if they are defined by the template.
6 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 a model or all annotations are deleted from a model.