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 ESG Data Model entities are derived. | | en | The one or more geographic criteria that are assigned or linked to a Party Location and by which they are identified or qualified from a geographic perspective.
These criteria can change over a period of time and are represented with 'period start date/period end date' qualifications, which represented the best case for knowing this information. If the data is only randomly sampled or recorded then you could use a single 'date' to identify its recording or effective as-of date.
Geographic market segmentation is a technique for segmenting a market based upon common geographic variables.
Specific Geographic Criteria are then assigned to parties in order to identify common characteristics that can be used for planning and analysis of the market segment.
Examples of Geographic Criteria include urban, rural, Southwest and East Europe.
The business organization identifies a finite number of Geographic Criteria that are used to identify parties. These criteria will be unique to each business organization and focus upon that organizations specific information requirements.
The Geographic Criteria Type is the larger classification to which the Geographic Criteria belongs.
Geographic Criteria Type is a means of classifying, grouping or categorizing specific Geographic Criteria at a higher level for analysis and presentation.
Ex:
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 |
| 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
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 | "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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{185EB544-1D81-4A31-B893-55E35EC8DC56}" | 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 | "Party" | string | |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Party Location Geographic Criteria |
| 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
The unique identifier of a Party.
First included in: Sustainability/esg-data-model/PartyLocationGeographicCriteria (this entity)
Properties
| Name | Value |
|---|
| displayName | Party ID |
| description | The unique identifier of a Party. |
| isPrimaryKey | true |
| dataFormat | int64 |
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
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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Party 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 Party. |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{135A345B-9FA9-47A2-91A3-CB72D15730C4}" | 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
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.
The unique identifier of a Location.
First included in: Sustainability/esg-data-model/PartyLocationGeographicCriteria (this entity)
Properties
| Name | Value |
|---|
| displayName | Location ID |
| description | The unique identifier of a Location. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the LocationId attribute are listed here.
is.dataFormat.integer
is.identifiedBy
names a specific identity attribute to use with an entity
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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Location 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 Location. |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{0EB9DC27-E3D8-41B7-880D-54BAE436EA20}" | 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
The unique identifier of a Geographic Criteria.
First included in: Sustainability/esg-data-model/PartyLocationGeographicCriteria (this entity)
Properties
| Name | Value |
|---|
| displayName | Geographic Criteria ID |
| description | The unique identifier of a Geographic Criteria. |
| isPrimaryKey | true |
| dataFormat | int32 |
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
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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Geographic Criteria 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 Criteria. |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{5F593112-51EE-4F79-931F-8CAEF46A8C5C}" | 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
The period start date for which the associated data is effective or 'as-of'.
First included in: Sustainability/esg-data-model/PartyLocationGeographicCriteria (this entity)
Properties
| Name | Value |
|---|
| displayName | Period Start Date |
| description | The period start date for which the associated data is effective or 'as-of'. |
| isPrimaryKey | true |
| dataFormat | date |
Traits
List of traits for the PeriodStartDate attribute are listed here.
is.dataFormat.date
means.measurement.date
is.identifiedBy
names a specific identity attribute to use with an entity
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{1117FA94-3FD6-4480-A495-ACA90394C769}" | 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 | Period Start Date |
| 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 period start date for which the associated data is effective or 'as-of'. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.date
The period end date for which the associated data is effective or 'as-of'.
First included in: Sustainability/esg-data-model/PartyLocationGeographicCriteria (this entity)
Properties
| Name | Value |
|---|
| displayName | Period End Date |
| description | The period end date for which the associated data is effective or 'as-of'. |
| dataFormat | date |
| isNullable | true |
Traits
List of traits for the PeriodEndDate attribute are listed here.
is.dataFormat.date
means.measurement.date
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{5D7BDBCD-9B11-433C-BC65-B0A478D3587C}" | 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 | Period End Date |
| 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 period end date for which the associated data is effective or 'as-of'. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.date
A note, comment, or more information related to Party Location Geographic Criteria.
First included in: Sustainability/esg-data-model/PartyLocationGeographicCriteria (this entity)
Properties
| Name | Value |
|---|
| displayName | Party Location Geographic Criteria Note |
| description | A note, comment, or more information related to Party Location Geographic Criteria. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
Traits
List of traits for the PartyLocationGeographicCriteriaNote 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{52BA30C0-DFCA-4ABB-A937-E94C71022C27}" | 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 | Party Location Geographic Criteria Note |
| 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 note, comment, or more information related to Party Location Geographic Criteria. |
| 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, and Array of Byte is a Binary Object.