Party Email 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	languageTag displayText en Base entity from which all Industry Data Model entities are derived. en The party email address(s) of the associated email type for the indicated period.	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	PartyEmail/(resolvedAttributes)/EmailAddress	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	"{1D3AEA16-459F-41CE-93D7-0208C4FCAADF}"	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 Email	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.	PartyEmail
EmailTypeId	The unique identifier of an Email Type.	PartyEmail
EmailAddress	The Party email address.	PartyEmail
PeriodStartTimestamp	The period start timestamp that the information is valid or effective as of.	PartyEmail
PeriodEndTimestamp	The period end timestamp that the information is valid or effective as of.	PartyEmail
PreferenceId	The unique identifier of a Preference.	PartyEmail
PartyEmailNote	A note, comment or additional information regarding the party email address.	PartyEmail

PartyId

The unique identifier of a Party.
First included in: PartyEmail (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	PartyEmail/(resolvedAttributes)/PartyId	attribute

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	entityReference attributeReference Party.cdm.json/Party PartyId	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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{1DA1D6DB-43F4-43D2-9D4A-2F9FB88B83B8}"	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.

EmailTypeId

The unique identifier of an Email Type.
First included in: PartyEmail (this entity)

Properties

Name	Value
displayName	Email Type ID
description	The unique identifier of an Email Type.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the EmailTypeId attribute are listed here.

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

Parameter	Value	Data type	Explanation
attribute	PartyEmail/(resolvedAttributes)/EmailTypeId	attribute

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	entityReference attributeReference EmailType.cdm.json/EmailType EmailTypeId	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 Email Type 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 an Email Type.	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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{09A34F8A-ED63-4706-B532-75E93869ABCC}"	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

EmailAddress

The Party email address.
First included in: PartyEmail (this entity)

Properties

Name	Value
displayName	Email Address
description	The Party email address.
isPrimaryKey	true
dataFormat	string
maximumLength	256

Traits

List of traits for the EmailAddress 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.

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

Parameter	Value	Data type	Explanation
attribute	PartyEmail/(resolvedAttributes)/EmailAddress	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	"{272095D1-9454-4EB7-90B6-F43DA443AA4B}"	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 Email Address	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 Party email address.	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.

PeriodStartTimestamp

The period start timestamp that the information is valid or effective as of.
First included in: PartyEmail (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.

Parameter	Value	Data type	Explanation
attribute	PartyEmail/(resolvedAttributes)/PeriodStartTimestamp	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	"{4587BE8B-32F2-45FE-B0EF-A9D426548EB5}"	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

PeriodEndTimestamp

The period end timestamp that the information is valid or effective as of.
First included in: PartyEmail (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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{2AF2BF01-BCAF-48CE-8421-A32C3F0C9F61}"	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

PreferenceId

The unique identifier of a Preference.
First included in: PartyEmail (this entity)

Properties

Name	Value
displayName	Preference ID
description	The unique identifier of a Preference.
dataFormat	int32
isNullable	true

Traits

List of traits for the PreferenceId 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	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

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	entityReference attributeReference Preference.cdm.json/Preference PreferenceId	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	"{29F9F963-A10F-4B7F-91F0-89AA6F76481E}"	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

PartyEmailNote

A note, comment or additional information regarding the party email address.
First included in: PartyEmail (this entity)

Properties

Name	Value
displayName	Party Email Note
description	A note, comment or additional information regarding the party email address.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the PartyEmailNote 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	"{0555B51F-EBE2-4597-8FBE-3309BA07A201}"	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 Party Email 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 A note, comment or additional information regarding the party email address.	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.