Facility Related Geographic Area 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 relationship between a facility and a geographic area for a specified time interval.
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
attributeFacilityRelatedGeographicArea/(resolvedAttributes)/FacilityGeographicAreaStartTimestampattribute

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"{7934EB3A-2F1D-43F1-A595-CD3498C818D7}"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 Related Geographic Area
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/FacilityRelatedGeographicArea
GeographicAreaId The unique identifier of a Geographic Area. Sustainability/esg-data-model/FacilityRelatedGeographicArea
FacilityGeographicAreaRelationshipTypeId The unique identifier of a Facility Geographic Area Relationship Type. Sustainability/esg-data-model/FacilityRelatedGeographicArea
FacilityGeographicAreaStartTimestamp The start timestamp associated with the facility geographic area. Sustainability/esg-data-model/FacilityRelatedGeographicArea
FacilityGeographicAreaEndTimestamp The end timestamp associated with the facility geographic area. Sustainability/esg-data-model/FacilityRelatedGeographicArea
FacilityGeographicAreaRelationshipNote A note, comment, or more information regarding the facility geographic area. Sustainability/esg-data-model/FacilityRelatedGeographicArea

FacilityId

The unique identifier of a Facility. First included in: Sustainability/esg-data-model/FacilityRelatedGeographicArea (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
attributeFacilityRelatedGeographicArea/(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"{F1FF3C7D-8792-42A7-9A9D-471D14618B65}"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

GeographicAreaId

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

Properties

NameValue
displayNameGeographic Area ID
descriptionThe unique identifier of a Geographic Area.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the GeographicAreaId attribute are listed here.

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

ParameterValueData typeExplanation
attributeFacilityRelatedGeographicArea/(resolvedAttributes)/GeographicAreaIdattribute

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
GeographicArea.cdm.json/GeographicAreaGeographicAreaId
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
enGeographic Area 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 Geographic Area.
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"{DA6C9848-B68A-4F7E-A216-E5F06FCA2CD0}"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

FacilityGeographicAreaRelationshipTypeId

The unique identifier of a Facility Geographic Area Relationship Type. First included in: Sustainability/esg-data-model/FacilityRelatedGeographicArea (this entity)

Properties

NameValue
displayNameFacility Geographic Area Relationship Type ID
descriptionThe unique identifier of a Facility Geographic Area Relationship Type.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the FacilityGeographicAreaRelationshipTypeId attribute are listed here.

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

ParameterValueData typeExplanation
attributeFacilityRelatedGeographicArea/(resolvedAttributes)/FacilityGeographicAreaRelationshipTypeIdattribute

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
FacilityGeographicAreaRelationshipType.cdm.json/FacilityGeographicAreaRelationshipTypeFacilityGeographicAreaRelationshipTypeId
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 Geographic Area Relationship 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 Geographic Area Relationship 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"{3FEC450C-BDBF-45CC-B027-B5F0E88C584A}"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

FacilityGeographicAreaStartTimestamp

The start timestamp associated with the facility geographic area. First included in: Sustainability/esg-data-model/FacilityRelatedGeographicArea (this entity)

Properties

NameValue
displayNameFacility Geographic Area Start Timestamp
descriptionThe start timestamp associated with the facility geographic area.
isPrimaryKeytrue
dataFormatdateTime

Traits

List of traits for the FacilityGeographicAreaStartTimestamp 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
attributeFacilityRelatedGeographicArea/(resolvedAttributes)/FacilityGeographicAreaStartTimestampattribute

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"{F4689533-21D5-4B5A-8C58-EE096911D6AF}"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
enFacility Geographic Area 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 start timestamp associated with the facility geographic area.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

FacilityGeographicAreaEndTimestamp

The end timestamp associated with the facility geographic area. First included in: Sustainability/esg-data-model/FacilityRelatedGeographicArea (this entity)

Properties

NameValue
displayNameFacility Geographic Area End Timestamp
descriptionThe end timestamp associated with the facility geographic area.
dataFormatdateTime
isNullabletrue

Traits

List of traits for the FacilityGeographicAreaEndTimestamp 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"{3E3E75EC-0E0E-48A8-A95E-4693E51F7CDA}"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 Geographic Area 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 end timestamp associated with the facility geographic area.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

FacilityGeographicAreaRelationshipNote

A note, comment, or more information regarding the facility geographic area. First included in: Sustainability/esg-data-model/FacilityRelatedGeographicArea (this entity)

Properties

NameValue
displayNameFacility Geographic Area Relationship Note
descriptionA note, comment, or more information regarding the facility geographic area.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the FacilityGeographicAreaRelationshipNote 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"{015A183D-BF53-4817-BB53-0EE194E3C5EA}"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 Geographic Area 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 geographic area.
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.