Party Language Usage 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.
enThe languages and language usages that the party identifies or are identified as appropriate for various transactions or usage.

Ex:

  • Statements/English
  • Service/Spanish/Primary Preference
  • Service/English/Secondary Preference
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
attributePartyLanguageUsage/(resolvedAttributes)/PeriodStartTimestampattribute

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"{783C8DB8-681E-4651-9154-343A17772FFB}"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 Language Usage
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. Sustainability/esg-data-model/PartyLanguageUsage
LanguageUsageId The unique identifier of the Language Usage. Sustainability/esg-data-model/PartyLanguageUsage
PreferenceId The unique identifier of a Preference. Sustainability/esg-data-model/PartyLanguageUsage
PeriodStartTimestamp The period start timestamp that the information is valid or effective as of. Sustainability/esg-data-model/PartyLanguageUsage
PeriodEndTimestamp The period end timestamp that the information is valid or effective as of. Sustainability/esg-data-model/PartyLanguageUsage
IsoLanguageId The unique identifier of an ISO Language. Sustainability/esg-data-model/PartyLanguageUsage
LanguageProficiencyId The unique identifier of a Language Proficiency. Sustainability/esg-data-model/PartyLanguageUsage
PartyLanguageUsageNote Notes or more information regarding the Party Language Usage or preferences. Sustainability/esg-data-model/PartyLanguageUsage

PartyId

The unique identifier of a Party. First included in: Sustainability/esg-data-model/PartyLanguageUsage (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
attributePartyLanguageUsage/(resolvedAttributes)/PartyIdattribute

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

ParameterValueData typeExplanation
identifier"{04656A2E-4847-4EA2-944D-1827939D5F62}"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.

LanguageUsageId

The unique identifier of the Language Usage. First included in: Sustainability/esg-data-model/PartyLanguageUsage (this entity)

Properties

NameValue
displayNameLanguage Usage ID
descriptionThe unique identifier of the Language Usage.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the LanguageUsageId attribute are listed here.

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

ParameterValueData typeExplanation
attributePartyLanguageUsage/(resolvedAttributes)/LanguageUsageIdattribute

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
LanguageUsage.cdm.json/LanguageUsageLanguageUsageId
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
enLanguage Usage 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 the Language Usage.
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 more identification values.

ParameterValueData typeExplanation
identifier"{068AD15F-D502-42C4-8B51-B51266C488BF}"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

PreferenceId

The unique identifier of a Preference. First included in: Sustainability/esg-data-model/PartyLanguageUsage (this entity)

Properties

NameValue
displayNamePreference ID
descriptionThe unique identifier of a Preference.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the PreferenceId attribute are listed here.

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

ParameterValueData typeExplanation
attributePartyLanguageUsage/(resolvedAttributes)/PreferenceIdattribute

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
Preference.cdm.json/PreferencePreferenceId
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
enPreference 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 Preference.
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 more identification values.

ParameterValueData typeExplanation
identifier"{6C41670E-1910-45B1-B49D-313945D09BE4}"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

PeriodStartTimestamp

The period start timestamp that the information is valid or effective as of. First included in: Sustainability/esg-data-model/PartyLanguageUsage (this entity)

Properties

NameValue
displayNamePeriod Start Timestamp
descriptionThe period start timestamp that the information is valid or effective as of.
isPrimaryKeytrue
dataFormatdateTime

Traits

List of traits for the PeriodStartTimestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributePartyLanguageUsage/(resolvedAttributes)/PeriodStartTimestampattribute

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"{495D2511-1132-47DD-A6A2-0AE1CA875DC4}"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 Timestamp
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 timestamp that the information is valid or effective as of.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

PeriodEndTimestamp

The period end timestamp that the information is valid or effective as of. First included in: Sustainability/esg-data-model/PartyLanguageUsage (this entity)

Properties

NameValue
displayNamePeriod End Timestamp
descriptionThe period end timestamp that the information is valid or effective as of.
dataFormatdateTime
isNullabletrue

Traits

List of traits for the PeriodEndTimestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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"{6537AA16-8BEF-4CE4-ADF9-C512B5CEB632}"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 Timestamp
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 timestamp that the information is valid or effective as of.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

IsoLanguageId

The unique identifier of an ISO Language. First included in: Sustainability/esg-data-model/PartyLanguageUsage (this entity)

Properties

NameValue
displayNameISO Language ID
descriptionThe unique identifier of an ISO Language.
dataFormatint32

Traits

List of traits for the IsoLanguageId attribute are listed here.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enISO Language 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 an ISO Language.
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
Language.cdm.json/LanguageIsoLanguageId
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"{43689C92-1F3F-43B5-AE97-302EFAE96339}"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

LanguageProficiencyId

The unique identifier of a Language Proficiency. First included in: Sustainability/esg-data-model/PartyLanguageUsage (this entity)

Properties

NameValue
displayNameLanguage Proficiency ID
descriptionThe unique identifier of a Language Proficiency.
dataFormatint32
isNullabletrue

Traits

List of traits for the LanguageProficiencyId 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
enLanguage Proficiency 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 Language Proficiency.
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
LanguageProficiency.cdm.json/LanguageProficiencyLanguageProficiencyId
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"{3D714CB5-E200-4644-BB53-EBB769C81373}"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

PartyLanguageUsageNote

Notes or more information regarding the Party Language Usage or preferences. First included in: Sustainability/esg-data-model/PartyLanguageUsage (this entity)

Properties

NameValue
displayNameParty Language Usage Note
descriptionNotes or more information regarding the Party Language Usage or preferences.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the PartyLanguageUsageNote 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"{404FD26E-00A4-4F8E-8333-D39D8DDA3164}"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 Language Usage 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
enNotes or more information regarding the Party Language Usage or preferences.
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.