Dela via


Party Role 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 Role(s) performed by a party during the associated period.

Example: PARTY 1 = Bill Smith ROLE 1 = Customer PERIOD START DATE = 04/15/92 PERIOD START DATE = 06/21/99 PARTY ROLE NOTE = Bill Smith was an active customer during the above period.

PARTY 1 = Bill Smith ROLE 1 = Father PERIOD START DATE = 04/15/92 PERIOD START DATE =
PARTY ROLE NOTE = Bill Smith is a father for the period shown.

PARTY 1 = Bill Smith ROLE 1 = Spouse PERIOD START DATE = 04/15/92 PERIOD START DATE = 10/20/04 PARTY ROLE NOTE = Bill Smith was married during the period indicated.

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
attributePartyRole/(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"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"{CC25BECF-8FA7-4322-B596-8C1D22931395}"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 Role
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. PartyRole
RoleId The unique identifier of a Role. PartyRole
PeriodStartTimestamp The period start timestamp that the associated role is valid for performed by the associated Party. PartyRole
PeriodEndTimestamp The period end timestamp that the associated role is valid for performed by the associated Party. PartyRole
GlobalServiceRelationshipNumber The Global Service Relationship Number (GSRN) is part of the GS1 system of standards. It's used to identify the relationship between a service provider and a service recipient. PartyRole
PartyRoleNote A note, comment or additional information regarding the Party Role. PartyRole

PartyId

The unique identifier of a Party.
First included in: PartyRole (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
attributePartyRole/(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"{A2DD65B5-C542-4753-870F-9FF97EDB6AB1}"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.

RoleId

The unique identifier of a Role.
First included in: PartyRole (this entity)

Properties

NameValue
displayNameRole ID
descriptionThe unique identifier of a Role.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the RoleId attribute are listed here.

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

ParameterValueData typeExplanation
attributePartyRole/(resolvedAttributes)/RoleIdattribute

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
Role.cdm.json/RoleRoleId
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
enRole 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 Role.
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"{C45B3A04-AB93-40DD-839F-340FA18236CE}"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 associated role is valid for performed by the associated Party.
First included in: PartyRole (this entity)

Properties

NameValue
displayNamePeriod Start Timestamp
descriptionThe period start timestamp that the associated role is valid for performed by the associated Party.
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
attributePartyRole/(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 other identification values.

ParameterValueData typeExplanation
identifier"{75EB1DA2-DE16-46D9-88AA-12853C6BF0F7}"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 associated role is valid for performed by the associated Party.
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 associated role is valid for performed by the associated Party.
First included in: PartyRole (this entity)

Properties

NameValue
displayNamePeriod End Timestamp
descriptionThe period end timestamp that the associated role is valid for performed by the associated Party.
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 other identification values.

ParameterValueData typeExplanation
identifier"{92D51CFC-3D8F-4222-86FC-36B1A400727B}"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 associated role is valid for performed by the associated Party.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

GlobalServiceRelationshipNumber

The Global Service Relationship Number (GSRN) is part of the GS1 system of standards. It's used to identify the relationship between a service provider and a service recipient.
First included in: PartyRole (this entity)

Properties

NameValue
displayNameGlobal Service Relationship Number (GSRN)
descriptionThe Global Service Relationship Number (GSRN) is part of the GS1 system of standards. It's used to identify the relationship between a service provider and a service recipient.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the GlobalServiceRelationshipNumber attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"0"integerthe number of digits to the right of the decimal place

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"{B67246CB-DDBF-486C-B65B-E97CC34BD18C}"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
enGlobal Service Relationship Number (GSRN)
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 Global Service Relationship Number (GSRN) is part of the GS1 system of standards. It's used to identify the relationship between a service provider and a service recipient.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

PartyRoleNote

A note, comment or additional information regarding the Party Role.
First included in: PartyRole (this entity)

Properties

NameValue
displayNameParty Role Note
descriptionA note, comment or additional information regarding the Party Role.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the PartyRoleNote 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"{014EC7F0-BCE4-4C91-BE88-A94E03DE74B0}"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 Role 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 regarding the Party Role.
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.