Dela via


Party Location 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.
enThe 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.

The following are examples:

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
attributePartyLocationGeographicCriteria/(resolvedAttributes)/PeriodStartDateattribute

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"{185EB544-1D81-4A31-B893-55E35EC8DC56}"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"Party"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enParty Location Geographic 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
PartyId The unique identifier of a Party. PartyLocationGeographicCriteria
LocationId The unique identifier of a Location. PartyLocationGeographicCriteria
GeographicCriteriaId The unique identifier of a Geographic Criteria. PartyLocationGeographicCriteria
PeriodStartDate The period start date for which the associated data is effective or 'as-of'. PartyLocationGeographicCriteria
PeriodEndDate The period end date for which the associated data is effective or 'as-of'. PartyLocationGeographicCriteria
PartyLocationGeographicCriteriaNote A note, comment or additional information related to Party Location Geographic Criteria. PartyLocationGeographicCriteria

PartyId

The unique identifier of a Party.
First included in: PartyLocationGeographicCriteria (this entity)

Properties

NameValue
displayNameParty ID
descriptionThe unique identifier of a Party.
isPrimaryKeytrue
dataFormatint64

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.

ParameterValueData typeExplanation
attributePartyLocationGeographicCriteria/(resolvedAttributes)/PartyIdattribute

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
Party.cdm.json/PartyPartyId
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
enParty 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 Party.
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 other identification values.

ParameterValueData typeExplanation
identifier"{135A345B-9FA9-47A2-91A3-CB72D15730C4}"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
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.

LocationId

The unique identifier of a Location.
First included in: PartyLocationGeographicCriteria (this entity)

Properties

NameValue
displayNameLocation ID
descriptionThe unique identifier of a Location.
isPrimaryKeytrue
dataFormatint32

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.

ParameterValueData typeExplanation
attributePartyLocationGeographicCriteria/(resolvedAttributes)/LocationIdattribute

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
Location.cdm.json/LocationLocationId
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
enLocation 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 Location.
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 other identification values.

ParameterValueData typeExplanation
identifier"{0EB9DC27-E3D8-41B7-880D-54BAE436EA20}"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

GeographicCriteriaId

The unique identifier of a Geographic Criteria.
First included in: PartyLocationGeographicCriteria (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
attributePartyLocationGeographicCriteria/(resolvedAttributes)/GeographicCriteriaIdattribute

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
GeographicCriteria.cdm.json/GeographicCriteriaGeographicCriteriaId
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 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

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"{5F593112-51EE-4F79-931F-8CAEF46A8C5C}"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

PeriodStartDate

The period start date for which the associated data is effective or 'as-of'.
First included in: PartyLocationGeographicCriteria (this entity)

Properties

NameValue
displayNamePeriod Start Date
descriptionThe period start date for which the associated data is effective or 'as-of'.
isPrimaryKeytrue
dataFormatdate

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.

ParameterValueData typeExplanation
attributePartyLocationGeographicCriteria/(resolvedAttributes)/PeriodStartDateattribute

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"{1117FA94-3FD6-4480-A495-ACA90394C769}"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
enPeriod Start Date
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 period start date for which the associated data is effective or 'as-of'.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.date

PeriodEndDate

The period end date for which the associated data is effective or 'as-of'.
First included in: PartyLocationGeographicCriteria (this entity)

Properties

NameValue
displayNamePeriod End Date
descriptionThe period end date for which the associated data is effective or 'as-of'.
dataFormatdate
isNullabletrue

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

ParameterValueData typeExplanation
identifier"{5D7BDBCD-9B11-433C-BC65-B0A478D3587C}"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
enPeriod End Date
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 period end date for which the associated data is effective or 'as-of'.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.date

PartyLocationGeographicCriteriaNote

A note, comment or additional information related to Party Location Geographic Criteria.
First included in: PartyLocationGeographicCriteria (this entity)

Properties

NameValue
displayNameParty Location Geographic Criteria Note
descriptionA note, comment or additional information related to Party Location Geographic Criteria.
dataFormatstring
maximumLength2048
isNullabletrue

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. 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"{52BA30C0-DFCA-4ABB-A937-E94C71022C27}"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
enParty Location Geographic Criteria 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 additional information related to Party Location 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.