Dela via


Geographic Criteria 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

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 Industry Data Model entities are derived.
enGeographic Criteria Type is a means of classifying, grouping or categorizing specific Geographic Criteria at a higher level for analysis and presentation.

The Geographic Criteria Type is the larger classification to which the Geographic Criteria belongs.

Example: Geographic Criteria Type: US Region Geographic Criteria: Southwest

Geographic Criteria Type: ABCD County Type Geographic Criteria: ABCD County Type A

Geographic Criteria Type: City Size Geographic Criteria: 50,000-100,000

Geographic Criteria Type: Area Density Geographic Criteria: Urban

Geographic Criteria Type: Climate Geographic Criteria: Tropical

Geographic Criteria Type: Topology Geographic Criteria: Desert

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
attributeGeographicCriteria/(resolvedAttributes)/GeographicCriteriaIdattribute

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"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.

ParameterValueData typeExplanation
identifier"{0B1CAEB4-22B2-4EC9-A3F4-A9E9E3B1448D}"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 Criteria
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
GeographicCriteriaId The unique identifier of a Geographic Criteria. GeographicCriteria
GeographicCriteriaName The name of the Geographic Criteria. GeographicCriteria
GeographicCriteriaDescription The description of the Geographic Criteria. GeographicCriteria
GeographicCriteriaTypeId The unique identifier of a Geographic Criteria Type. GeographicCriteria

GeographicCriteriaId

The unique identifier of a Geographic Criteria.
First included in: GeographicCriteria (this entity)

Properties

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

Traits

List of traits for the GeographicCriteriaId attribute are listed here.

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

ParameterValueData typeExplanation
attributeGeographicCriteria/(resolvedAttributes)/GeographicCriteriaIdattribute

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.

ParameterValueData typeExplanation
identifier"{42111B63-71AE-4427-BD6A-8C406088542A}"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 Criteria 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 Criteria.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

GeographicCriteriaName

The name of the Geographic Criteria.
First included in: GeographicCriteria (this entity)

Properties

NameValue
displayNameGeographic Criteria Name
descriptionThe name of the Geographic Criteria.
dataFormatstring
maximumLength256
isNullabletrue

Traits

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

ParameterValueData typeExplanation
identifier"{2DB25D01-962F-4494-82FE-9A44F95C4D43}"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 Criteria 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 the Geographic Criteria.
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. Array of Byte is a Binary Object.

GeographicCriteriaDescription

The description of the Geographic Criteria.
First included in: GeographicCriteria (this entity)

Properties

NameValue
displayNameGeographic Criteria Description
descriptionThe description of the Geographic Criteria.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

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

ParameterValueData typeExplanation
identifier"{44D85429-67F1-4445-9B65-D44306DD0023}"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 Criteria 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 the Geographic Criteria.
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. Array of Byte is a Binary Object.

GeographicCriteriaTypeId

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

Properties

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

Traits

List of traits for the GeographicCriteriaTypeId 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 Criteria 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 Criteria Type.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
GeographicCriteriaType.cdm.json/GeographicCriteriaTypeGeographicCriteriaTypeId
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 other identification values.

ParameterValueData typeExplanation
identifier"{1CC623A4-BBE8-4F5C-B3C2-A28849666926}"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