Jaa


Plant Information (Pi) Point in ESG data model(PlantInformationPoint)

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"4.3"stringsemantic version number of the entity

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBase entity from which all ESG Data Model entities are derived.
enA point in a network, plant or other configurable system as defined by a plant information system, such as SCADA.
entitya reference to the constant entity holding the list of localized text

is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributePlantInformationPoint/(resolvedAttributes)/PiPointIdattribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

ParameterValueData typeExplanation
versionNumber"1.2.3"string

is.IDM.modelVersion
Semantic version number of the IDM.

ParameterValueData typeExplanation
versionNumber"2.0.0"string

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{838E4502-5692-4456-A021-1F1AD6F19B97}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nativeTo.businessArea
The name of the business area from which the entity originates.

ParameterValueData typeExplanation
name"Property & Equipment"string

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPlant Information (Pi) Point
entitya reference to the constant entity holding the list of localized text

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides, or restates parts of logical schemas to produce one resolved schema.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
PiPointId The unique identifier of a PI Point. Sustainability/esg-data-model/PlantInformationPoint
PiPointName The name of a PI Point. Sustainability/esg-data-model/PlantInformationPoint
PiPointDescription The description of a PI Point. Sustainability/esg-data-model/PlantInformationPoint
PiNode The unique identifier of the PI Point is known as the PI Node in many third party software packages. This "key" is an alphanumeric string which may or may not have meaning implied to its structure. Sustainability/esg-data-model/PlantInformationPoint
ComponentId The unique identifier of a Component. Sustainability/esg-data-model/PlantInformationPoint
ReadingTypeId The unique identifier of a Reading Type. Sustainability/esg-data-model/PlantInformationPoint

PiPointId

The unique identifier of a PI Point. First included in: Sustainability/esg-data-model/PlantInformationPoint (this entity)

Properties

NameValue
displayNamePI Point ID
descriptionThe unique identifier of a PI Point.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the PiPointId attribute are listed here.

is.dataFormat.integer
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributePlantInformationPoint/(resolvedAttributes)/PiPointIdattribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{7EE34F57-48A8-4B92-A7E9-7D4043145EC7}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPI Point ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a PI Point.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

PiPointName

The name of a PI Point. First included in: Sustainability/esg-data-model/PlantInformationPoint (this entity)

Properties

NameValue
displayNamePI Point Name
descriptionThe name of a PI Point.
dataFormatstring
maximumLength256
isNullabletrue

Traits

List of traits for the PiPointName attribute are listed here.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{17B87C50-F859-41E1-9DE8-549B5BC9959C}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPI Point Name
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe name of a PI Point.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"256"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

PiPointDescription

The description of a PI Point. First included in: Sustainability/esg-data-model/PlantInformationPoint (this entity)

Properties

NameValue
displayNamePI Point Description
descriptionThe description of a PI Point.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the PiPointDescription attribute are listed here.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{01287AAC-F761-480A-989C-B074DDA5BAAB}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPI Point Description
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe description of a PI Point.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"2048"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

PiNode

The unique identifier of the PI Point is known as the PI Node in many third party software packages. This "key" is an alphanumeric string which may or may not have meaning implied to its structure. First included in: Sustainability/esg-data-model/PlantInformationPoint (this entity)

Properties

NameValue
displayNamePI Node
descriptionThe unique identifier of the PI Point is known as the PI Node in many third party software packages. This "key" is an alphanumeric string which may or may not have meaning implied to its structure.
dataFormatstring
maximumLength20
isNullabletrue

Traits

List of traits for the PiNode attribute are listed here.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{28590117-B3E7-4351-B310-8CF87DC84C05}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPI Node
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of the PI Point is known as the PI Node in many third party software packages. This "key" is an alphanumeric string which may or may not have meaning implied to its structure.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"20"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

ComponentId

The unique identifier of a Component. First included in: Sustainability/esg-data-model/PlantInformationPoint (this entity)

Properties

NameValue
displayNameComponent ID
descriptionThe unique identifier of a Component.
dataFormatint64
isNullabletrue

Traits

List of traits for the ComponentId attribute are listed here.

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{DFA519AC-9D93-473D-BFB6-14EB01CA8970}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enComponent ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Component.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

ReadingTypeId

The unique identifier of a Reading Type. First included in: Sustainability/esg-data-model/PlantInformationPoint (this entity)

Properties

NameValue
displayNameReading Type ID
descriptionThe unique identifier of a Reading Type.
dataFormatint32
isNullabletrue

Traits

List of traits for the ReadingTypeId attribute are listed here.

is.dataFormat.integer
is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReading Type ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Reading Type.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attributes that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
ReadingType.cdm.json/ReadingTypeReadingTypeId
entitya reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{C75D984B-CE77-4A7F-A441-D4EB5933CD01}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer