Geographic Area in ESG data model

Base entity from which all Industry Data Model entities are derived.

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 Industry Data Model entities are derived. en A 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.	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.

Parameter	Value	Data type	Explanation
attribute	GeographicArea/(resolvedAttributes)/GeographicAreaId	attribute

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	"1.6.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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{08DA7E1E-DCD5-4ABA-9DB4-15E3250662E5}"	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	"Geography"	string

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Geographic Area	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

Name	Description	First Included in Instance
GeographicAreaId	The unique identifier of a Geographic Area.	GeographicArea
GeographicAreaName	The name of a Geographic Area.	GeographicArea
GeographicAreaDescription	The description of a Geographic Area.	GeographicArea
GeographicAreaTypeId	The unique identifier of a Geographic Area Type.	GeographicArea
GeographicAreaUnits	The size of the geographic area expressed in UOM.	GeographicArea
GeographicAreaUomId	The unique identifier of a Unit Of Measure.	GeographicArea
GeographicAreaGeojsonRepresentation	A pointer to a GeoJSON representation of a geographic area.	GeographicArea

GeographicAreaId

The unique identifier of a Geographic Area.
First included in: GeographicArea (this entity)

Properties

Name	Value
displayName	Geographic Area ID
description	The unique identifier of a Geographic Area.
isPrimaryKey	true
dataFormat	int32

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.

Parameter	Value	Data type	Explanation
attribute	GeographicArea/(resolvedAttributes)/GeographicAreaId	attribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{0459C565-D686-4182-823B-6A230E76CCFA}"	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 Geographic Area 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 Geographic Area.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

GeographicAreaName

The name of a Geographic Area.
First included in: GeographicArea (this entity)

Properties

Name	Value
displayName	Geographic Area Name
description	The name of a Geographic Area.
dataFormat	string
maximumLength	256
isNullable	true

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. 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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{10D69F7A-0F41-4C36-A642-EE984CC10468}"	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 Geographic Area Name	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 name of a Geographic Area.	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	"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. Array of Byte is a Binary Object.

GeographicAreaDescription

The description of a Geographic Area.
First included in: GeographicArea (this entity)

Properties

Name	Value
displayName	Geographic Area Description
description	The description of a Geographic Area.
dataFormat	string
maximumLength	2048
isNullable	true

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. 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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{1E5F6C35-325C-4023-8F49-96B5D8985170}"	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 Geographic Area Description	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 description of a Geographic Area.	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. Array of Byte is a Binary Object.

GeographicAreaTypeId

The unique identifier of a Geographic Area Type.
First included in: GeographicArea (this entity)

Properties

Name	Value
displayName	Geographic Area Type ID
description	The unique identifier of a Geographic Area Type.
dataFormat	int32
isNullable	true

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Geographic Area 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 Geographic Area Type.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) 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	entityReference attributeReference GeographicAreaType.cdm.json/GeographicAreaType GeographicAreaTypeId	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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{3DFEE547-DA0A-4EB4-B74C-02A236F5F08A}"	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

GeographicAreaUnits

The size of the geographic area expressed in UOM.
First included in: GeographicArea (this entity)

Properties

Name	Value
displayName	Geographic Area Units
description	The size of the geographic area expressed in UOM.
dataFormat	int32
isNullable	true

Traits

List of traits for the GeographicAreaUnits 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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{2E5467D5-7C8C-452D-AC8F-B9ADC3693BA7}"	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 Geographic Area Units	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 size of the geographic area expressed in UOM.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

GeographicAreaUomId

The unique identifier of a Unit Of Measure.
First included in: GeographicArea (this entity)

Properties

Name	Value
displayName	Geographic Area UOM ID
description	The unique identifier of a Unit Of Measure.
dataFormat	int32
isNullable	true

Traits

List of traits for the GeographicAreaUomId 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 Geographic Area UOM 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 attribute(s) 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	entityReference attributeReference UnitOfMeasure.cdm.json/UnitOfMeasure UnitOfMeasureId	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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{14355A39-1587-418C-AB09-33F73B289988}"	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

GeographicAreaGeojsonRepresentation

A pointer to a GeoJSON representation of a geographic area.
First included in: GeographicArea (this entity)

Properties

Name	Value
displayName	Geographic Area GeoJSON Representation
description	A pointer to a GeoJSON representation of a geographic area.
dataFormat	int32
isNullable	true

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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{38D8FF72-A48E-4EC8-AD6F-E023DD5264FF}"	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 Geographic Area GeoJSON Representation	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 pointer to a GeoJSON representation of a geographic area.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer