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 | | languageTag | displayText |
|---|
| en | Base entity from which all ESG Data Model entities are derived. | | en | The Currencys and currency usages that the party identifies or are identified as appropriate for various transactions or usage.
Ex:
- Statements/US dollars
- Invoice/US dollars
- ADR Equity Investments/Euros/Primary Preference
- ADR Equity Investments/US dollars/Alternate Preference
|
| 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
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 | "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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{CD3F0F34-15D6-4AD2-94A6-930378A8D35E}" | 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 | | languageTag | displayText |
|---|
| en | Party Currency Usage |
| 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
The unique identifier of a Party.
First included in: Sustainability/esg-data-model/PartyCurrencyUsage (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
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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Party ID |
| 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 | | languageTag | displayText |
|---|
| en | The unique identifier of a Party. |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{03CC7DD8-3BD0-481B-8852-CA79B811C82A}" | 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
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.
The unique identifier of the Currency Usage.
First included in: Sustainability/esg-data-model/PartyCurrencyUsage (this entity)
Properties
| Name | Value |
|---|
| displayName | Currency Usage ID |
| description | The unique identifier of the Currency Usage. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the CurrencyUsageId attribute are listed here.
is.dataFormat.integer
is.identifiedBy
names a specific identity attribute to use with an entity
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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Currency Usage ID |
| 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 | | languageTag | displayText |
|---|
| en | The unique identifier of the Currency Usage. |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{67DE9D4B-95B4-485F-9D9E-727C647CC3E9}" | 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
The unique identifier of a Preference.
First included in: Sustainability/esg-data-model/PartyCurrencyUsage (this entity)
Properties
| Name | Value |
|---|
| displayName | Preference ID |
| description | The unique identifier of a Preference. |
| isPrimaryKey | true |
| dataFormat | int32 |
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
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.
| Parameter | Value | Data type | Explanation |
|---|
| entityReferences | | entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Preference ID |
| 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 | | languageTag | displayText |
|---|
| en | The unique identifier of a Preference. |
| entity | a 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{CF7A1EEF-7D95-499C-9181-D4775579414F}" | 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
The period start timestamp that the information is valid or effective as of.
First included in: Sustainability/esg-data-model/PartyCurrencyUsage (this entity)
Properties
| Name | Value |
|---|
| displayName | Period Start Timestamp |
| description | The period start timestamp that the information is valid or effective as of. |
| isPrimaryKey | true |
| dataFormat | dateTime |
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
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{28671103-973D-4DF0-A892-DBAD9A804401}" | 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 | | languageTag | displayText |
|---|
| en | Period Start Timestamp |
| 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 | | languageTag | displayText |
|---|
| en | The period start timestamp that the information is valid or effective as of. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
The period end timestamp that the information is valid or effective as of.
First included in: Sustainability/esg-data-model/PartyCurrencyUsage (this entity)
Properties
| Name | Value |
|---|
| displayName | Period End Timestamp |
| description | The period end timestamp that the information is valid or effective as of. |
| dataFormat | dateTime |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{10D133AB-136B-45FA-91EF-FA31FBEE94B7}" | 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 | | languageTag | displayText |
|---|
| en | Period End Timestamp |
| 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 | | languageTag | displayText |
|---|
| en | The period end timestamp that the information is valid or effective as of. |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
The ISO 4217 currency code.
First included in: Sustainability/esg-data-model/PartyCurrencyUsage (this entity)
Properties
| Name | Value |
|---|
| displayName | ISO Currency Code |
| description | The ISO 4217 currency code. |
| dataFormat | string |
| maximumLength | 3 |
Traits
List of traits for the IsoCurrencyCode 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.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | ISO Currency Code |
| 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 | | languageTag | displayText |
|---|
| en | The ISO 4217 currency code. |
| 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 | "3" | integer | |
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.
| 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 more identification values.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{4704F355-ED7B-4E93-BE91-5C2D38F8F4F6}" | 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.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.
Notes or more information regarding the Party Currency Usage and preferences.
First included in: Sustainability/esg-data-model/PartyCurrencyUsage (this entity)
Properties
| Name | Value |
|---|
| displayName | Currency Usage Note |
| description | Notes or more information regarding the Party Currency Usage and preferences. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
Traits
List of traits for the CurrencyUsageNote 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.
| Parameter | Value | Data type | Explanation |
|---|
| identifier | "{F97CA1D7-8F75-4FA6-A1C1-286AB714E93D}" | 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 | | languageTag | displayText |
|---|
| en | Currency Usage Note |
| 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 | | languageTag | displayText |
|---|
| en | Notes or more information regarding the Party Currency Usage and preferences. |
| 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, and Array of Byte is a Binary Object.