Dela via


Communication 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.
enA communication to/from one or more party(s).

A communication may consist of one or more sources.

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
attributeCommunication/(resolvedAttributes)/CommunicationIdattribute

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"{0297C78C-1803-4373-9135-E7B89ACD1500}"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"Customer Service & Contact Management"string

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCommunication
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
CommunicationId The unique identifier of a Communication. Communication
CommunicationStartTimestamp The timestamp when the communication started. Communication
CommunicationEndTimestamp The timestamp when the communication ended. Communication
CommunicationDescription A description regarding the communication. Communication
CommunicationNote A note, comment or additional information regarding the communication. Communication
CommunicationQueueTime The amount of time that the Inbound Communicator waited in a queue. Communication
CommunicationHoldTime Total amount of time a person is placed on hold during a communication after first being connected to a person. Does not include initial queue time which may have occurred before the initial connection to a person. Communication
InboundOutboundCommunicationIndicator Indicates whether the communication is received from the party or sent to the party. Communication
CommunicationText The text of the communication. Depending on the communication type this would be the:- text of the email or letter- recorded text conversation of a call Communication
CommunicationMethodId The unique identifier of a Communication Method. Communication
CommunicationTypeId The unique identifier of a communication type. Communication
CommunicationPriorityId The unique identifier of a Communication Priority. Communication
IsoLanguageId The unique identifier of an ISO Language. Communication

CommunicationId

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

Properties

NameValue
displayNameCommunication ID
descriptionThe unique identifier of a Communication.
isPrimaryKeytrue
dataFormatint64

Traits

List of traits for the CommunicationId 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
attributeCommunication/(resolvedAttributes)/CommunicationIdattribute

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"{34D1C431-7989-4EF5-AF2B-3ABB55A83B61}"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
enCommunication 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 Communication.
entitya 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.

CommunicationStartTimestamp

The timestamp when the communication started.
First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication Start Timestamp
descriptionThe timestamp when the communication started.
dataFormatdateTime
isNullabletrue

Traits

List of traits for the CommunicationStartTimestamp 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"{09DA1699-0338-4A2A-9FC9-886CC01C08EB}"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
enCommunication 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 timestamp when the communication started.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

CommunicationEndTimestamp

The timestamp when the communication ended.
First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication End Timestamp
descriptionThe timestamp when the communication ended.
dataFormatdateTime
isNullabletrue

Traits

List of traits for the CommunicationEndTimestamp 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"{0E8738B1-19F3-4B92-9258-4EBFDDCD2EEE}"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
enCommunication 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 timestamp when the communication ended.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

CommunicationDescription

A description regarding the communication.
First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication Description
descriptionA description regarding the communication.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the CommunicationDescription 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"{0F9EFC48-0A28-4051-A9D7-0E8B50851DE2}"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
enCommunication Description
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 description regarding the communication.
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.

CommunicationNote

A note, comment or additional information regarding the communication.
First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication Note
descriptionA note, comment or additional information regarding the communication.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the CommunicationNote 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"{0FA0363B-C32E-4F88-A9C6-469DFE8EAAF1}"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
enCommunication 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 communication.
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.

CommunicationQueueTime

The amount of time that the Inbound Communicator waited in a queue.
First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication Queue Time
descriptionThe amount of time that the Inbound Communicator waited in a queue.
dataFormattime
isNullabletrue

Traits

List of traits for the CommunicationQueueTime attribute are listed here.

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"{103DA54F-DB8E-479D-8DA8-F6F5EED206CE}"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
enCommunication Queue Time
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 amount of time that the Inbound Communicator waited in a queue.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time

CommunicationHoldTime

Total amount of time a person is placed on hold during a communication after first being connected to a person. Does not include initial queue time which may have occurred before the initial connection to a person.
First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication Hold Time
descriptionTotal amount of time a person is placed on hold during a communication after first being connected to a person. Does not include initial queue time which may have occurred before the initial connection to a person.
dataFormattime
isNullabletrue

Traits

List of traits for the CommunicationHoldTime attribute are listed here.

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"{1B200DC4-9EBE-4DA5-B9AB-A1E447ED4B93}"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
enCommunication Hold Time
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
enTotal amount of time a person is placed on hold during a communication after first being connected to a person. Does not include initial queue time which may have occurred before the initial connection to a person.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time

InboundOutboundCommunicationIndicator

Indicates whether the communication is received from the party or sent to the party.
First included in: Communication (this entity)

Properties

NameValue
displayNameInbound/Outbound Communication Indicator
descriptionIndicates whether the communication is received from the party or sent to the party.
dataFormatboolean
isNullabletrue

Traits

List of traits for the InboundOutboundCommunicationIndicator attribute are listed here.

is.dataFormat.boolean
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"{6511E1C5-A948-4485-ACFB-2E72A91D5B2E}"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
enInbound/Outbound Communication Indicator
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
enIndicates whether the communication is received from the party or sent to the party.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

CommunicationText

The text of the communication.

Depending on the communication type this would be the:

  • text of the email or letter
  • recorded text conversation of a call
    First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication Text
descriptionThe text of the communication.

Depending on the communication type this would be the:

  • text of the email or letter
  • recorded text conversation of a call
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the CommunicationText 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"{01158EB1-A36E-48D2-9627-D286F72708BA}"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
enCommunication Text
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 text of the communication.

Depending on the communication type this would be the:

  • text of the email or letter
  • recorded text conversation of a call
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.

CommunicationMethodId

The unique identifier of a Communication Method.
First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication Method ID
descriptionThe unique identifier of a Communication Method.
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCommunication Method 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 Communication Method.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
CommunicationMethod.cdm.json/CommunicationMethodCommunicationMethodId
entitya 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.

ParameterValueData typeExplanation
identifier"{53EB2C0F-4896-4E4D-A88D-1C5BE03A828B}"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

CommunicationTypeId

The unique identifier of a communication type.
First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication Type ID
descriptionThe unique identifier of a communication type.
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCommunication Type 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 communication type.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
CommunicationType.cdm.json/CommunicationTypeCommunicationTypeId
entitya 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.

ParameterValueData typeExplanation
identifier"{2942D19B-4B0F-4FAF-9254-2EE50DD24105}"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

CommunicationPriorityId

The unique identifier of a Communication Priority.
First included in: Communication (this entity)

Properties

NameValue
displayNameCommunication Priority ID
descriptionThe unique identifier of a Communication Priority.
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCommunication Priority 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 Communication Priority.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
CommunicationPriority.cdm.json/CommunicationPriorityCommunicationPriorityId
entitya 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.

ParameterValueData typeExplanation
identifier"{3584D7CC-4A71-452C-AB74-81C7C418FD91}"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

IsoLanguageId

The unique identifier of an ISO Language.
First included in: Communication (this entity)

Properties

NameValue
displayNameISO Language ID
descriptionThe unique identifier of an ISO Language.
dataFormatint32
isNullabletrue

Traits

List of traits for the IsoLanguageId attribute are listed here.

is.dataFormat.integer
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"{16E7B830-746F-4DEB-9003-1C5199104A5B}"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
enISO Language 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 an ISO Language.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer