List of transfer columns
- Last UpdatedDec 13, 2024
- 3 minute read
- PI System
- PI Server 2018
- PI Server
The following table lists the columns available for PI AF transfers 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 Transfer for primary objects. One of the following values may be present for children of the transfer:
|
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 |
|
|
Description |
no |
yes |
|
|
Template |
no |
no2 |
|
|
DefaultAttribute |
no |
yes3 |
|
|
DefaultInputPort |
no |
yes3 |
|
|
DefaultOutputPort |
no |
yes3 |
|
|
DefaultUndirectedPort |
no |
yes3 |
|
|
Categories |
no |
yes1 |
|
|
IsAnnotated |
no |
no6 |
|
|
IsLocked |
no |
no |
|
|
AreValuesCaptured |
no |
yes |
|
|
StartTime |
no |
yes |
|
|
EndTime |
no |
yes |
|
|
Source |
Enter the name of an element or model. |
no |
yes |
|
SourcePort |
This port must belong to the element in the Source column, or the model and its port type must be Output. |
no |
yes |
|
Destination |
Enter the name of an element or model. |
no |
yes |
|
DestinationPort |
This port must belong to the element in the Destination column, or the model and its port type must be Input. |
no |
yes |
|
CreationDate |
no |
no |
|
|
ModifyDate |
no |
no |
|
|
ExtendedPropertyType |
Possible values:
|
no |
yes |
|
ExtendedPropertyValue |
no |
yes |
|
|
AttributeIsHidden |
no |
yes4 |
|
|
AttributeIsManualDataEntry |
no |
yes |
|
|
AttributeTrait |
Possible values: For Limit traits:
|
no |
yes |
|
AttributeIsConfigurationItem |
no |
yes1,3 |
|
|
AttributeIsExcluded |
no |
yes |
|
|
AttributeDefaultUOM |
no |
yes1,3 |
|
|
AttributeType |
Possible values:
|
no |
yes1,3 |
|
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,3 |
|
AttributeValue |
no |
yes5 |
|
|
AttributeDataReference |
Possible values:
|
no |
yes |
|
AttributeConfigString |
no |
yes |
|
|
AttributeDisplayDigits |
no |
yes |
|
|
PortType |
Possible values:
|
no |
yes1,3 |
|
PortMaxConnections |
no |
yes1,3 |
|
|
PortAllowedElementTypes |
no |
yes1,3 |
|
|
PortAllowedElementTemplate |
no |
yes1,3 |
1 You cannot add attributes or ports, or modify the categories when the transfer is based on a template unless the template's Allow Extensions check box is selected.
2 You cannot change the values in these columns. Delete the object (the entire row in the worksheet) and then add the object back in with the value change you want.
3 You can write changes to values in the DefaultAttribute, DefaultInputPort, DefaultOutputPort, and DefaultUndirectedPort columns only when the transfer is not derived from a template. Most properties of attributes and ports cannot be changed if they are defined by the template.
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 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.
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 transfer or all annotations are deleted from a transfer.