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.
enA geographic area is a geographic formation, area or body that is bounded by location points and has an area.

The geographic area is defined by a series of ordered vertices that form the corners of the polygon.

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
attributeGeographicArea/(resolvedAttributes)/GeographicAreaIdattribute

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"{08DA7E1E-DCD5-4ABA-9DB4-15E3250662E5}"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"Geography"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enGeographic 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
GeographicAreaId The unique identifier of a Geographic Area. Sustainability/esg-data-model/GeographicArea
GeographicAreaName The name of a Geographic Area. Sustainability/esg-data-model/GeographicArea
GeographicAreaDescription The description of a Geographic Area. Sustainability/esg-data-model/GeographicArea
GeographicAreaTypeId The unique identifier of a Geographic Area Type. Sustainability/esg-data-model/GeographicArea
GeographicArea The size of the geographic area expressed in unit of measure. Sustainability/esg-data-model/GeographicArea
GeographicAreaUnitOfMeasureId The unique identifier of a Unit Of Measure. Sustainability/esg-data-model/GeographicArea
GeographicAreaGeojsonRepresentation A pointer to a GeoJSON representation of a geographic area. Sustainability/esg-data-model/GeographicArea

GeographicAreaId

The unique identifier of a Geographic Area. First included in: Sustainability/esg-data-model/GeographicArea (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
attributeGeographicArea/(resolvedAttributes)/GeographicAreaIdattribute

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"{0459C565-D686-4182-823B-6A230E76CCFA}"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
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

is.dataFormat.integer

GeographicAreaName

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

Properties

NameValue
displayNameGeographic Area Name
descriptionThe name of a Geographic Area.
dataFormatstring
maximumLength256
isNullabletrue

Traits

List of traits for the GeographicAreaName 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"{10D69F7A-0F41-4C36-A642-EE984CC10468}"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
enGeographic Area Name
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 name of a Geographic Area.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"256"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.

GeographicAreaDescription

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

Properties

NameValue
displayNameGeographic Area Description
descriptionThe description of a Geographic Area.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the GeographicAreaDescription 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"{1E5F6C35-325C-4023-8F49-96B5D8985170}"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
enGeographic Area Description
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 description of a 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.

GeographicAreaTypeId

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

Properties

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

Traits

List of traits for the GeographicAreaTypeId 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enGeographic Area 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 Geographic Area Type.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
GeographicAreaType.cdm.json/GeographicAreaTypeGeographicAreaTypeId
entitya 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.

ParameterValueData typeExplanation
identifier"{3DFEE547-DA0A-4EB4-B74C-02A236F5F08A}"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

GeographicArea

The size of the geographic area expressed in unit of measure. First included in: Sustainability/esg-data-model/GeographicArea (this entity)

Properties

NameValue
displayNameGeographic Area
descriptionThe size of the geographic area expressed in unit of measure.
dataFormatint32
isNullabletrue

Traits

List of traits for the GeographicArea 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.

ParameterValueData typeExplanation
identifier"{2E5467D5-7C8C-452D-AC8F-B9ADC3693BA7}"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
enGeographic Area
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 size of the geographic area expressed in unit of measure.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

GeographicAreaUnitOfMeasureId

The unique identifier of a Unit Of Measure. First included in: Sustainability/esg-data-model/GeographicArea (this entity)

Properties

NameValue
displayNameGeographic Area Unit Of Measure ID
descriptionThe unique identifier of a Unit Of Measure.
dataFormatint32
isNullabletrue

Traits

List of traits for the GeographicAreaUnitOfMeasureId 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enGeographic Area Unit Of Measure 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 Unit Of Measure.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
UnitOfMeasure.cdm.json/UnitOfMeasureUnitOfMeasureId
entitya 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.

ParameterValueData typeExplanation
identifier"{14355A39-1587-418C-AB09-33F73B289988}"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

GeographicAreaGeojsonRepresentation

A pointer to a GeoJSON representation of a geographic area. First included in: Sustainability/esg-data-model/GeographicArea (this entity)

Properties

NameValue
displayNameGeographic Area GeoJSON Representation
descriptionA pointer to a GeoJSON representation of a geographic area.
dataFormatint32
isNullabletrue

Traits

List of traits for the GeographicAreaGeojsonRepresentation 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.

ParameterValueData typeExplanation
identifier"{38D8FF72-A48E-4EC8-AD6F-E023DD5264FF}"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
enGeographic Area GeoJSON Representation
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 pointer to a GeoJSON representation of a geographic area.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer