Party 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
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 |
| 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | Party/(resolvedAttributes)/PartyId | attribute |
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 | "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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{1E2F9D1D-5A34-4924-B82A-9061FCD80585}" | 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 |
| 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
Name | Description | First Included in Instance |
---|---|---|
PartyId | The unique identifier of a Party. | Party |
PartyName | The name of the Party. | Party |
PartyDescription | The description of a Party. | Party |
PartyPhoneticName | The phonetic name shows the pronunciation of the Party Name using the international phonetic alphabet, which uses special signs to represent the different sounds made by the voice in speech. | Party |
PartyTypeId | The unique identifier of a Party Type. | Party |
GlobalLocationNumber | The Global Location Number (GLN) is a simple tool used to uniquely identify locations. It can be used to identify physical locations such as a warehouse, legal entities, or a function / department within a legal entity. The GLN is part of the GS1 system of standards. | Party |
PartyId
The unique identifier of a Party.
First included in: Party (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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | Party/(resolvedAttributes)/PartyId | attribute |
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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{01DFE6BB-2C96-4B81-9778-BE932055794E}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
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.
PartyName
The name of the Party.
First included in: Party (this entity)
Properties
Name | Value |
---|---|
displayName | Party Name |
description | The name of the Party. |
dataFormat | string |
maximumLength | 256 |
isNullable | true |
Traits
List of traits for the PartyName 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{025C3A97-5F5C-417C-8F2A-449898E599A5}" | 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 |
| 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 |
| 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 | "256" | 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.
PartyDescription
The description of a Party.
First included in: Party (this entity)
Properties
Name | Value |
---|---|
displayName | Party Description |
description | The description of a Party. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the PartyDescription 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{076E50C9-A3E5-4375-98FB-C263B74C3B1F}" | 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 |
| 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 |
| 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. Array of Byte is a Binary Object.
PartyPhoneticName
The phonetic name shows the pronunciation of the Party Name using the international phonetic alphabet, which uses special signs to represent the different sounds made by the voice in speech.
First included in: Party (this entity)
Properties
Name | Value |
---|---|
displayName | Party Phonetic Name |
description | The phonetic name shows the pronunciation of the Party Name using the international phonetic alphabet, which uses special signs to represent the different sounds made by the voice in speech. |
dataFormat | string |
maximumLength | 256 |
isNullable | true |
Traits
List of traits for the PartyPhoneticName 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{0F59919D-FD9D-4604-96F4-DF8486C13BF9}" | 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 |
| 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 |
| 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 | "256" | 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.
PartyTypeId
The unique identifier of a Party Type.
First included in: Party (this entity)
Properties
Name | Value |
---|---|
displayName | Party Type ID |
description | The unique identifier of a Party Type. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the PartyTypeId 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.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
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.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a 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 other identification values.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{0EE7D1F2-7495-4CA2-860D-75EB09E2AB89}" | 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
GlobalLocationNumber
The Global Location Number (GLN) is a simple tool used to uniquely identify locations. It can be used to identify physical locations such as a warehouse, legal entities, or a function / department within a legal entity. The GLN is part of the GS1 system of standards.
First included in: Party (this entity)
Properties
Name | Value |
---|---|
displayName | Global Location Number (GLN) |
description | The Global Location Number (GLN) is a simple tool used to uniquely identify locations. It can be used to identify physical locations such as a warehouse, legal entities, or a function / department within a legal entity. The GLN is part of the GS1 system of standards. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the GlobalLocationNumber attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter | Value | Data type | Explanation |
---|---|---|---|
precision | "13" | integer | the total number of significant digits |
scale | "0" | integer | the 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{0C53457E-E351-417C-91AF-2AD78D168803}" | 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 |
| 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 |
| entity | a 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