Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Builder (PI Server 2018)

List of element template columns

  • Last UpdatedDec 13, 2024
  • 3 minute read

The following table lists the columns available for PI AF element templates in PI Builder.

Column name

Comment

Required in PI Builder

Can be changed in PI AF

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

n/a

Name

To change the name, enter a new name in the NewName column.

yes

n/a

ObjectType

Set to ElementTemplate for primary objects. One of the following values may be present for children of the element template:

  • AttributeTemplate

  • TemplateExtendedProperty

  • AnalysisTemplate

  • AnalysisTemplateExtendedProperty

  • TemplateAnalysisRule

  • NotificationRuleTemplate

  • DeliveryFormat

  • DeliveryFormatProperty

  • NotificationRuleSubscriber

  • TemplatePort

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

BaseTemplate

no

yes

Type

Possible values:

  • None

  • Boundary

  • Flow

  • Measurement

  • Node

  • Other

no

yes

AllowElementToExtend

no

yes

DefaultAttribute

no

yes

NamingPattern

no

yes

DefaultInputPort

no

yes

DefaultOutputPort

no

yes

DefaultUndirectedPort

no

yes

Categories

no

yes

CreationDate

no

no

ModifyDate

no

no

SecurityString

no

yes

BaseTemplateOnly

Possible values:

  • True

  • False

    Only users with an Administrators PI AF Identity can set the value to True. Indicates if the object is a Base Template Only template. This template type serves as a base template for derived templates. It cannot be used to create objects directly.

no

yes

NewName

Enter a new name to change the name as it appears in PI AF.

no

yes

UniqueID

no

no

ExtendedPropertyType

Possible values:

  • Boolean / Boolean[]

  • Byte / Byte[]

  • DateTime / DateTime[]

  • Double / Double[]

  • Guid / Guid[]

  • Int16 / Int16[]

  • Int32 / Int32[]

  • Int64 / Int64[]

  • Single / Single[]

  • String / String[]

  • AFAttribute

  • AFElement

  • AFFile

no

yes

ExtendedPropertyValue

no

yes

AttributeIsHidden

no

yes

AttributeIsManualDataEntry

no

yes

AttributeTrait

Possible values:

For Limit traits:

  • Minimum

  • LoLo

  • Lo

  • Target

  • Hi

  • HiHi

  • Maximum

    For Location traits:

  • Latitude

  • Longitude

  • Altitude

  • Forecast

    For Health traits:

  • HealthScore

  • HealthStatus

no

yes

AttributeIsConfigurationItem

no

yes

AttributeIsExcluded

no

yes

AttributeDefaultUOM

no

yes

AttributeType

Possible values:

  • Boolean / Boolean[]

  • Byte / Byte[]

  • DateTime / DateTime[]

  • Double / Double[]

  • Guid / Guid[]

  • Int16 / Int16[]

  • Int32 / Int32[]

  • Int64 / Int64[]

  • Single / Single[]

  • String / String[]

  • AFAttribute

  • AFElement

  • AFFile

  • AFEnumerationValue (AttributeTypeQualifier contains the enumeration set from which values are to be selected)

  • Object

no

yes

AttributeTypeQualifier

If the AttributeType column contains AFEnumerationValue, then the AttibuteTypeQualifier column contains the name of an enumeration set and the AttributeDefaultValue column contains the name of an enumeration value from the specified enumeration set.

no

yes

AttributeDataReference

Possible values:

  • Formula

  • PI Point

  • PI Point Array

  • String Builder

  • Table Lookup

  • URI Builder

  • Name of a custom data reference

no

yes

AttributeConfigString

no

yes

AttributeDisplayDigits

no

yes

AttributeNewParent

Enter the name of a new parent to move the object in the PI AF hierarchy.

no

yes

AttributeIsIndexed

no

yes

AttributeDefaultValue

no

yes

AnalysisOutputTime

no

yes

AnalysisRule

no

yes

AnalysisRuleConfigString

When the object type is an analysis template, this column displays the expression used to perform calculations on a group of elements.

no

yes

AnalysisRuleVariableMapping

When the object type is an analysis template, this column shows the name of the mapped output where calculation history is stored.

If the analysis rule comes from a template and the Show simplified configuration strings option is selected, <Defined by template> is shown.

no

yes

TimeRule

no

yes

TimeRuleConfigString

no

yes

CreateEnabled

Use this column to specify whether notification rules created from this template will be automatically enabled when they are created.

no

yes

MultiTriggerEventOption

Possible values:

  • HighestSeverity

  • HigherSeverity

  • Any

no

yes

ResendInterval

no

yes

NonrepetitionInterval

no

yes

Criteria

no

yes

ContentExample

no

yes

DefaultDeliveryFormat

no

yes

DeliveryFormatDeliveryChannel

Possible values:

  • Email

  • WebService

no

yes

DeliveryFormatPropertyValue

no

yes

SubscriberRetryInterval

no

yes

SubscriberEscalationTimeout

no

yes

SubscriberMaximumRetries

no

yes

SubscriberNotifyOption

Possible values:

  • EventStart

  • EventEnd

  • EventStartAndEnd

no

yes

SubscriberConfigString

no

yes

SubscriberDeliveryFormat

no

yes

PortType

Possible values:

  • Undirected

  • Input

  • Output

no

yes

PortMaxConnections

no

yes

PortAllowedElementTypes

no

yes1

PortAllowedElementTemplate

no

yes

1 If the object is used in a model, then the value in this column cannot be changed.

TitleResults for “How to create a CRG?”Also Available in