Facility Party Apportionment in ESG data model

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.
enThe apportionment of a Facility between Parties for the associated period.
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
attributeFacilityPartyApportionment/(resolvedAttributes)/PeriodStartTimestampattribute

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"{4CADD7ED-008D-414F-A47D-B27B2A55F208}"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"Facility"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFacility Party Apportionment
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
FacilityId The unique identifier of a Facility. Sustainability/esg-data-model/FacilityPartyApportionment
PartyId The unique identifier of a Party. Sustainability/esg-data-model/FacilityPartyApportionment
FacilityPartyApportionmentTypeId The unique identifier of a facility party apportionment type. Sustainability/esg-data-model/FacilityPartyApportionment
PeriodStartTimestamp The period start timestamp of the facility-party relationship. Sustainability/esg-data-model/FacilityPartyApportionment
PeriodEndTimestamp The period end timestamp of the facility-party relationship. Sustainability/esg-data-model/FacilityPartyApportionment
FacilityPartyApportionmentPercentage 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). Sustainability/esg-data-model/FacilityPartyApportionment
FacilityPartyRelationshipNote A note, comment, or more information regarding the Facility - Party relationship. Sustainability/esg-data-model/FacilityPartyApportionment

FacilityId

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

Properties

NameValue
displayNameFacility ID
descriptionThe unique identifier of a Facility.
isPrimaryKeytrue
dataFormatint32

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

ParameterValueData typeExplanation
attributeFacilityPartyApportionment/(resolvedAttributes)/FacilityIdattribute

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
Facility.cdm.json/FacilityFacilityId
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFacility 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 Facility.
entitya 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.

ParameterValueData typeExplanation
identifier"{9965DD2B-AB41-435F-99C6-8BFFEBE36C2C}"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

PartyId

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

Properties

NameValue
displayNameParty ID
descriptionThe unique identifier of a Party.
isPrimaryKeytrue
dataFormatint64

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

ParameterValueData typeExplanation
attributeFacilityPartyApportionment/(resolvedAttributes)/PartyIdattribute

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
Party.cdm.json/PartyPartyId
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enParty 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 Party.
entitya 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.

ParameterValueData typeExplanation
identifier"{7FE899FD-CB58-4A01-A42F-E4E53D67F015}"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
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.

FacilityPartyApportionmentTypeId

The unique identifier of a facility party apportionment type. First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)

Properties

NameValue
displayNameFacility Party Apportionment Type ID
descriptionThe unique identifier of a facility party apportionment type.
isPrimaryKeytrue
dataFormatint32

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

ParameterValueData typeExplanation
attributeFacilityPartyApportionment/(resolvedAttributes)/FacilityPartyApportionmentTypeIdattribute

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
FacilityPartyApportionmentType.cdm.json/FacilityPartyApportionmentTypeFacilityPartyApportionmentTypeId
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFacility Party Apportionment 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 facility party apportionment type.
entitya 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.

ParameterValueData typeExplanation
identifier"{30BBED19-7543-452A-8833-B933010AE541}"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

PeriodStartTimestamp

The period start timestamp of the facility-party relationship. First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)

Properties

NameValue
displayNamePeriod Start Timestamp
descriptionThe period start timestamp of the facility-party relationship.
isPrimaryKeytrue
dataFormatdateTime

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

ParameterValueData typeExplanation
attributeFacilityPartyApportionment/(resolvedAttributes)/PeriodStartTimestampattribute

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"{2423243C-6A50-4627-9E88-CB2D06758FCB}"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
enPeriod Start Timestamp
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 period start timestamp of the facility-party relationship.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

PeriodEndTimestamp

The period end timestamp of the facility-party relationship. First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)

Properties

NameValue
displayNamePeriod End Timestamp
descriptionThe period end timestamp of the facility-party relationship.
dataFormatdateTime
isNullabletrue

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.

ParameterValueData typeExplanation
identifier"{499B4B97-0DEE-4B08-967B-E024CD01545E}"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
enPeriod End Timestamp
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 period end timestamp of the facility-party relationship.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

FacilityPartyApportionmentPercentage

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

NameValue
displayNameFacility Party Apportionment Percentage
descriptionParties 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).
dataFormatdecimal
isNullabletrue

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

ParameterValueData typeExplanation
precision"22"integerthe total number of significant digits
scale"10"integerthe 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.

ParameterValueData typeExplanation
identifier"{03B39FEC-02BE-4328-B63C-B9E26651C7E7}"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
enFacility Party Apportionment Percentage
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
enParties 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).
entitya 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

FacilityPartyRelationshipNote

A note, comment, or more information regarding the Facility - Party relationship. First included in: Sustainability/esg-data-model/FacilityPartyApportionment (this entity)

Properties

NameValue
displayNameFacility Party Relationship Note
descriptionA note, comment, or more information regarding the Facility - Party relationship.
dataFormatstring
maximumLength2048
isNullabletrue

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.

ParameterValueData typeExplanation
identifier"{2AEEB126-BDAE-45F1-AF7B-28195FC6A079}"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
enFacility Party Relationship Note
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
enA note, comment, or more information regarding the Facility - Party relationship.
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.