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 apportionment of a Facility between Parties for the 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 | "{4CADD7ED-008D-414F-A47D-B27B2A55F208}" | 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 | "Facility" | string | |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Facility Party Apportionment |
| 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 Facility.
First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)
Properties
| Name | Value |
|---|
| displayName | Facility ID |
| description | The unique identifier of a Facility. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the FacilityId 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 | Facility 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 Facility. |
| 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 | "{9965DD2B-AB41-435F-99C6-8BFFEBE36C2C}" | 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 Party.
First included in: Sustainability/esg-data-model/FacilityPartyApportionment (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 | "{7FE899FD-CB58-4A01-A42F-E4E53D67F015}" | 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 facility party apportionment type.
First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)
Properties
| Name | Value |
|---|
| displayName | Facility Party Apportionment Type ID |
| description | The unique identifier of a facility party apportionment type. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the FacilityPartyApportionmentTypeId 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 | Facility Party Apportionment 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 facility party apportionment 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 | "{30BBED19-7543-452A-8833-B933010AE541}" | 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 timestamp of the facility-party relationship.
First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)
Properties
| Name | Value |
|---|
| displayName | Period Start Timestamp |
| description | The period start timestamp of the facility-party relationship. |
| isPrimaryKey | true |
| dataFormat | dateTime |
Traits
List of traits for the PeriodStartTimestamp 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 | "{2423243C-6A50-4627-9E88-CB2D06758FCB}" | 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 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 period start timestamp of the facility-party relationship. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
The period end timestamp of the facility-party relationship.
First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)
Properties
| Name | Value |
|---|
| displayName | Period End Timestamp |
| description | The period end timestamp of the facility-party relationship. |
| dataFormat | dateTime |
| isNullable | true |
Traits
List of traits for the PeriodEndTimestamp 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 | "{499B4B97-0DEE-4B08-967B-E024CD01545E}" | 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 | Period 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 period end timestamp of the facility-party relationship. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
Parties may have joint interests in a Facility, but the proportion of that interest may not be an even split. The apportionment percentage may also differ among the same parties for a different relationship type for the same Facility. For instance, 2 parties may have 50% ownership each in a facility, but one may bear a higher percentage of certain obligations or costs (such as 60//40% sharing).
First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)
Properties
| Name | Value |
|---|
| displayName | Facility Party Apportionment Percentage |
| description | Parties may have joint interests in a Facility, but the proportion of that interest may not be an even split. The apportionment percentage may also differ among the same parties for a different relationship type for the same Facility. For instance, 2 parties may have 50% ownership each in a facility, but one may bear a higher percentage of certain obligations or costs (such as 60//40% sharing). |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the FacilityPartyApportionmentPercentage 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 | "{03B39FEC-02BE-4328-B63C-B9E26651C7E7}" | 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 | Facility Party Apportionment Percentage |
| 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 | Parties may have joint interests in a Facility, but the proportion of that interest may not be an even split. The apportionment percentage may also differ among the same parties for a different relationship type for the same Facility. For instance, 2 parties may have 50% ownership each in a facility, but one may bear a higher percentage of certain obligations or costs (such as 60//40% sharing). |
| 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
A note, comment, or more information regarding the Facility - Party relationship.
First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)
Properties
| Name | Value |
|---|
| displayName | Facility Party Relationship Note |
| description | A note, comment, or more information regarding the Facility - Party relationship. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
Traits
List of traits for the FacilityPartyRelationshipNote 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 | "{2AEEB126-BDAE-45F1-AF7B-28195FC6A079}" | 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 | Facility Party Relationship 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 Facility - Party relationship. |
| 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.