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 | The water utilization by a party for a process type during an associated period. |
| 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 | "{98AE83A9-9A4B-4B98-82A6-08E2F3FF5F2E}" | 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 | "Sustainability" | string | |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Party Process Type Water Utilization |
| 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 Party.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Party ID |
| description | The unique identifier of a Party. |
| isPrimaryKey | true |
| dataFormat | int64 |
Traits
List of traits for the PartyId 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 | Party 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 Party. |
| 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 | "{D452A3DD-2604-4205-B193-4324253F5522}" | 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 Process Type.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Process Type ID |
| description | The unique identifier of a Process Type. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the ProcessTypeId 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 | Process 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 Process 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 | "{0760130C-3537-4D59-A048-BC5176CEA0C6}" | 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 Water Utilization Type.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Water Utilization Type ID |
| description | The unique identifier of a Water Utilization Type. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the WaterUtilizationTypeId 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 | Water Utilization 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 Water Utilization 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 | "{4304BA5B-4663-4A98-A990-13AF616534FB}" | 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 water source type.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Water Source Type ID |
| description | The unique identifier of a water source type. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the WaterSourceTypeId 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 | Water Source 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 water source 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 | "{07F6FFD5-D831-45B2-B97E-39DBB51DADB3}" | 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 water type.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Water Type ID |
| description | The unique identifier of a water type. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the WaterTypeId 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 | Water 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 water 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 | "{D3809105-D2BC-4352-9340-0181F2F14CE4}" | 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 Metric Purpose.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Metric Purpose ID |
| description | The unique identifier of a Metric Purpose. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the MetricPurposeId 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 | Metric Purpose 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 Metric Purpose. |
| 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 | "{0D10F78E-C3DD-486B-8C51-B1AA2CD5B606}" | 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 calculation algorithm.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Calculation Algorithm ID |
| description | The unique identifier of a calculation algorithm. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the CalculationAlgorithmId 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 | Calculation Algorithm 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 calculation algorithm. |
| 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 | "{D0124D51-A303-42FE-862B-87EC07EC3C17}" | 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 period start date.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Period Start Date |
| description | The period start date. |
| isPrimaryKey | true |
| dataFormat | date |
Traits
List of traits for the PeriodStartDate attribute are listed here.
is.dataFormat.date
means.measurement.date
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 | "{DA2A2EF1-25E9-4776-B2E7-A45FC7E95043}" | 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 | Period Start Date |
| 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 period start date. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.date
The period end date.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Period End Date |
| description | The period end date. |
| isPrimaryKey | true |
| dataFormat | date |
Traits
List of traits for the PeriodEndDate attribute are listed here.
is.dataFormat.date
means.measurement.date
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 | "{51A7D330-3B4C-435E-A8AC-EAFF217E17D2}" | 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 | Period End Date |
| 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 period end date. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.date
The units of water utilization.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Water Utilization |
| description | The units of water utilization. |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the WaterUtilization 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 | "{A204C79A-D85D-435C-A90F-4D10499C7119}" | 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 | Water Utilization |
| 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 units of water utilization. |
| 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 unique identifier of a Unit Of Measure.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Water Utilization Unit Of Measure ID |
| description | The unique identifier of a Unit Of Measure. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the WaterUtilizationUnitOfMeasureId 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 | Water Utilization 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 | "{16D06F0C-3826-4BE9-AC40-A5B2810A06D6}" | 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 Party Process Type Water Utilization.
First included in: Sustainability/esg-data-model/PartyProcessTypeWaterUtilization (this entity)
Properties
| Name | Value |
|---|
| displayName | Party Process Type Water Utilization Note |
| description | A note, comment, or more information regarding the Party Process Type Water Utilization. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
Traits
List of traits for the PartyProcessTypeWaterUtilizationNote 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 | "{36BB28B3-546B-48D5-8432-6BA3FB84E096}" | 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 | Party Process Type Water Utilization 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 Party Process Type Water Utilization. |
| 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.