Dela via


Party Promotion 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 promotion(s) applicable to or being participated in by the party.
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
attributePartyPromotion/(resolvedAttributes)/PartyPromotionStartDateattribute

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"{3CDBA004-858F-4103-A31B-9269D79CA06B}"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 Promotion
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. PartyPromotion
PromotionId The unique identifier of a Promotion. PartyPromotion
PartyPromotionStartDate The period start date that the party participates in or is eligible for participation in the associated promotion. PartyPromotion
PartyPromotionEndDate The period end date that the party participates in or is eligible for participation in the associated promotion. PartyPromotion
PartyPromotionNote A note, comment or additional information regarding the promotion party relationship. PartyPromotion

PartyId

The unique identifier of a Party.
First included in: PartyPromotion (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
attributePartyPromotion/(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"{6CF35608-EE78-491C-A46F-E11B86A27540}"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.

PromotionId

The unique identifier of a Promotion.
First included in: PartyPromotion (this entity)

Properties

NameValue
displayNamePromotion ID
descriptionThe unique identifier of a Promotion.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the PromotionId attribute are listed here.

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

ParameterValueData typeExplanation
attributePartyPromotion/(resolvedAttributes)/PromotionIdattribute

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
Promotion.cdm.json/PromotionPromotionId
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
enPromotion 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 Promotion.
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"{CABF31CC-C1CD-4E6B-BE42-73057AE422CC}"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

PartyPromotionStartDate

The period start date that the party participates in or is eligible for participation in the associated promotion.
First included in: PartyPromotion (this entity)

Properties

NameValue
displayNameParty Promotion Start Date
descriptionThe period start date that the party participates in or is eligible for participation in the associated promotion.
isPrimaryKeytrue
dataFormatdate

Traits

List of traits for the PartyPromotionStartDate attribute are listed here.

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

ParameterValueData typeExplanation
attributePartyPromotion/(resolvedAttributes)/PartyPromotionStartDateattribute

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"{68F25C77-3E85-467C-867A-9BE50EE2C5D2}"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
enParty Promotion 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 that the party participates in or is eligible for participation in the associated promotion.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.date

PartyPromotionEndDate

The period end date that the party participates in or is eligible for participation in the associated promotion.
First included in: PartyPromotion (this entity)

Properties

NameValue
displayNameParty Promotion End Date
descriptionThe period end date that the party participates in or is eligible for participation in the associated promotion.
dataFormatdate
isNullabletrue

Traits

List of traits for the PartyPromotionEndDate 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"{E5E5328B-4E91-4CB4-B161-463E7C85DFB6}"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 Promotion 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 that the party participates in or is eligible for participation in the associated promotion.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.date

PartyPromotionNote

A note, comment or additional information regarding the promotion party relationship.
First included in: PartyPromotion (this entity)

Properties

NameValue
displayNameParty Promotion Note
descriptionA note, comment or additional information regarding the promotion party relationship.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the PartyPromotionNote 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"{C2F11FC6-4179-4036-A786-B3B8BDF6B4D0}"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 Promotion 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 promotion party relationship.
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.