Traits
Traits for this entity are listed here.
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|
| versionNumber | "4.3" | string | semantic version number of the entity |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Base entity from which all ESG Data Model entities are derived. | | en | A specific meter reading as of a timestamp.
Note: Meter Reading Type is part of key to allow for multiple readings for same timestamp. (Estimate / Actual) |
| entity | a reference to the constant entity holding the list of localized text |
is.identifiedBy
names a specific identity attribute to use with an entity
minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.
| Parameter | Value | Data type | Explanation |
|---|
| versionNumber | "1.2.3" | string | |
is.IDM.modelVersion
Semantic version number of the IDM.
| Parameter | Value | Data type | Explanation |
|---|
| 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{5B905A05-C29D-4E07-B874-5B3DDD6A18CA}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| name | "Network" | string | |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| level | "resolved" | string | Possible values: logical, composition, resolved |
Attributes
The unique identifier of a Meter.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter ID |
| description | The unique identifier of a Meter. |
| isPrimaryKey | true |
| dataFormat | int64 |
Traits
List of traits for the MeterId 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.
is.identifiedBy
names a specific identity attribute to use with an entity
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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a reference to the constant entity holding the list of entity references |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter ID |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The unique identifier of a Meter. |
| entity | a reference to the constant entity holding the list of localized text |
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{05D4364A-B93F-4E9C-8BE8-3F5C8B8C1BB8}" | string | The 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
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.
The unique identifier of a Meter Reading Type.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter Reading Type ID |
| description | The unique identifier of a Meter Reading Type. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the MeterReadingTypeId attribute are listed here.
is.dataFormat.integer
is.identifiedBy
names a specific identity attribute to use with an entity
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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a reference to the constant entity holding the list of entity references |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading Type ID |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The unique identifier of a Meter Reading Type. |
| entity | a reference to the constant entity holding the list of localized text |
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{1B521B74-09EC-4449-BAB9-6AD171B5FDD8}" | string | The 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
The start timestamp associated with the meter reading.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter Reading Start Timestamp |
| description | The start timestamp associated with the meter reading. |
| isPrimaryKey | true |
| dataFormat | dateTime |
Traits
List of traits for the MeterReadingStartTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.identifiedBy
names a specific identity attribute to use with an entity
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{097E1B12-589A-4B19-9173-AA13BAA61A90}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading Start Timestamp |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The start timestamp associated with the meter reading. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
The end timestamp associated with the meter reading.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter Reading End Timestamp |
| description | The end timestamp associated with the meter reading. |
| dataFormat | dateTime |
| isNullable | true |
Traits
List of traits for the MeterReadingEndTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{2AA3CD1D-8057-4F32-B794-B5C626A5120E}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading End Timestamp |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The end timestamp associated with the meter reading. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
The reading supplied by the meter.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter Reading |
| description | The reading supplied by the meter. |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the MeterReading attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|
| precision | "22" | integer | the total number of significant digits |
| scale | "10" | integer | the number of digits to the right of the decimal place |
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{008776EC-11B4-4C6E-8DED-5344A199EA32}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The reading supplied by the meter. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
The energy used during the meter reading period. When the value is not available directly from the meter it is calculated as the difference between the current Meter Reading and the Meter Reading whose Meter Reading End Timestamp is the same as this rows Meter Reading Start Timestamp (i.e. the previous Meter Reading).
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Energy Usage |
| description | The energy used during the meter reading period. When the value is not available directly from the meter it is calculated as the difference between the current Meter Reading and the Meter Reading whose Meter Reading End Timestamp is the same as this rows Meter Reading Start Timestamp (i.e. the previous Meter Reading). |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the EnergyUsage attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|
| precision | "22" | integer | the total number of significant digits |
| scale | "10" | integer | the number of digits to the right of the decimal place |
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{38A2F6B8-58AF-481C-A492-2E02188CDF8D}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Energy Usage |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The energy used during the meter reading period. When the value is not available directly from the meter it is calculated as the difference between the current Meter Reading and the Meter Reading whose Meter Reading End Timestamp is the same as this rows Meter Reading Start Timestamp (i.e. the previous Meter Reading). |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Indicates whether the energy measured by the meter reading is generated energy or consumed energy.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Energy Direction Indicator |
| description | Indicates whether the energy measured by the meter reading is generated energy or consumed energy. |
| dataFormat | boolean |
| isNullable | true |
Traits
List of traits for the EnergyDirectionIndicator attribute are listed here.
is.dataFormat.boolean
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{296F74E0-BAAD-42F5-94B7-F9D6C1222FF7}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Energy Direction Indicator |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Indicates whether the energy measured by the meter reading is generated energy or consumed energy. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.boolean
The unique identifier of a Unit Of Measure.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Energy Usage Unit Of Measure ID |
| description | The unique identifier of a Unit Of Measure. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the EnergyUsageUnitOfMeasureId 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Energy Usage Unit Of Measure ID |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The unique identifier of a Unit Of Measure. |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{6F3D5283-EED5-4240-99BE-36B0E23BA0C4}" | string | The 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
A note, comment, or more information regarding the Meter Reading.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter Reading Note |
| description | A note, comment, or more information regarding the Meter Reading. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
Traits
List of traits for the MeterReadingNote 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{019A88F4-4333-448A-ABA1-5953C61B218B}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading Note |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | A note, comment, or more information regarding the Meter Reading. |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|
| 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.
The unique identifier of a Meter Reading Method Type.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter Reading Method Type ID |
| description | The unique identifier of a Meter Reading Method Type. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the MeterReadingMethodTypeId attribute are listed here.
is.dataFormat.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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{2A5919A4-4852-44B7-AC97-07A13DB49797}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading Method Type ID |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The unique identifier of a Meter Reading Method Type. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
The unique identifier of a Meter Reading Cycle.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter Reading Cycle ID |
| description | The unique identifier of a Meter Reading Cycle. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the MeterReadingCycleId 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading Cycle ID |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The unique identifier of a Meter Reading Cycle. |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{17151EE8-158E-46DF-82E1-8D91C21F6DF6}" | string | The 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
The unique identifier of a Meter Reading Estimation Rule.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter Reading Estimation Rule ID |
| description | The unique identifier of a Meter Reading Estimation Rule. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the MeterReadingEstimationRuleId attribute are listed here.
is.dataFormat.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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{06E2240A-A2E8-481F-BF71-330BFE830FE7}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading Estimation Rule ID |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The unique identifier of a Meter Reading Estimation Rule. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
The unique identifier of a Meter Reading Validation Rule.
First included in: Sustainability/esg-data-model/MeterReading (this entity)
Properties
| Name | Value |
|---|
| displayName | Meter Reading Validation Rule ID |
| description | The unique identifier of a Meter Reading Validation Rule. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the MeterReadingValidationRuleId attribute are listed here.
is.dataFormat.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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{07F8AF12-C2F2-4D9C-9F34-CB221B18B5C1}" | string | The 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Meter Reading Validation Rule ID |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The unique identifier of a Meter Reading Validation Rule. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer