Properties keywords reference

isindex

Yes

Controls which property is used for __indexProperty. Hidden attribute template used to store OMF specific information.

When an asset is created from a template, the property with this set to True is used to identify the asset.

• Only one property can have this set to True.

• UOM for this property is ignored.

• The property must have a type of String.

• If it is a dynamic type, it must also have a format of Date-Time.

isname

Yes

Controls which property is used for __nameProperty hidden attribute template used to store OMF specific information.

When an asset is created from a template, the property with this set to True keyword is used as the name of the asset.

• Only one property can have this set to True.

• UOM for this property is ignored.

• If True, the Name value is used as the default value for the attribute template. Otherwise, the indexer is used.

• If it is a dynamic type, the property that has this set to True will be ignored.

name

Yes

Becomes the name of the attribute template.

If name is not specified, the property's indexer is used as the name of the attribute template.

type

Partially

Combined with format to determine the Value Type on the attribute template.

For example, if the type is number, then the format needs to be a number format, such as float32.

You can also specify nullability for the property. For details, see Nullability.

type cannot be used in conjunction with reftypeid.

format

Partially

Combined with type to determine the Value Type on the attribute template.

format cannot be used in conjunction with reftypeid.

reftypeid

Partially

Indicates the OMF Type associated with a specific property. Currently in use only for enumeration types.

reftypeid cannot be used in conjunction with type, format, or uom.

description

Yes

Stored in the description of the attribute template in a format depending on the classification.

• If the classification is Static, the description is: Static\NULLABILITY\PROPERTY_KEY\DESCRIPTION.

• If the classification is Dynamic, the description is: Dynamic\NULLABILITY\CONTAINER_ID\PROPERTY_KEY\DESCRIPTION.

uom

Yes

Defines the default unit of measure for the attribute template.

• The value must be an existing unit of measure in PI AF.

• The unit of measure name must be spelled out. Do not use the abbreviation.

• Can only be used with properties of type number or integer.

isquality

Partially

Controls which property is used for the __qualityProperty hidden attribute template used to store OMF information.

The property with this keyword set to True is used to determine the overall quality of each data value.

Only one property can have this set to true.

If a quality mapping is associated with the dynamic type, the value associated with the property will be used to determine the quality of the data message; otherwise, it does nothing.

For more information on how to specify a quality mapping for a type, see Quality mapping.

minimum

Yes

Adds a child attribute template __minimum to the property's attribute template. The child attribute template will be marked with the Minimum trait.

Can only be used with properties of type number or integer.

maximum

Yes

Adds a child attribute template __maximum to the property's attribute template. The child attribute template will be marked with the Maximum trait.

Can only be used with properties of type number or integer.

interpolation

Yes

Adds a child attribute template __interpolation to the property's attribute template.

Supported values are:

• continuous

• discrete

• stepwisecontinuousleading

• stepwisecontinuousfollowing