Bearbeiten

Freigeben über


Letter in applicationCommon

Activity that tracks the delivery of a letter. The activity can contain the electronic copy of the letter.

Latest version of the JSON entity definition is available on GitHub.

Instances

Entities that inherit from the currently viewed entity are listed below.

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.

ParameterValueData typeExplanation
groupList
attributeGroupReference
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsCreationModificationDatesAndIds
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsOwnershipInfo
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsTimeZoneInfo
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsVersionTracking
/core/wellKnownCDSAttributeGroups.cdm.json
/activityCommon
/core/applicationCommon/Letter.cdm.json/Letter
/hasAttributes/attributesAddedAtThisScope
entity

is.ordered

ParameterValueData typeExplanation
attribute[Letter/(resolvedAttributes)/sortDate](#sortDate)attribute

means.entityState
the attribute represents the current state of the entity.

ParameterValueData typeExplanation
attributeLetter/(resolvedAttributes)/stateCodeattribute

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLetter
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
enActivity that tracks the delivery of a letter. The activity can contain the electronic copy of the letter.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"Letter"string

Attributes

Name Description First Included in Instance
createdOn Date and time when the record was created. applicationCommon/Letter
createdBy Shows who created the record. applicationCommon/Letter
modifiedOn Date and time when the record was modified. applicationCommon/Letter
modifiedBy Shows who last updated the record. applicationCommon/Letter
createdOnBehalfBy Shows who created the record on behalf of another user. applicationCommon/Letter
modifiedOnBehalfBy Shows who last updated the record on behalf of another user. applicationCommon/Letter
overriddenCreatedOn Date and time that the record was migrated. applicationCommon/Letter
importSequenceNumber Unique identifier of the data import or data migration that created this record. applicationCommon/Letter
ownerId Owner Id applicationCommon/Letter
ownerIdType The type of owner, either User or Team. applicationCommon/Letter
owningBusinessUnit Unique identifier for the business unit that owns the record applicationCommon/Letter
owningUser Unique identifier of the user that owns the activity. applicationCommon/Letter
owningTeam Unique identifier for the team that owns the record. applicationCommon/Letter
timeZoneRuleVersionNumber For internal use only. applicationCommon/Letter
UTCConversionTimeZoneCode Time zone code that was in use when the record was created. applicationCommon/Letter
versionNumber Version Number applicationCommon/Letter
activityId Unique identifier of the activity. applicationCommon/Letter
activityTypeCode Type of activity. applicationCommon/Letter
isBilled Information regarding whether the fax activity was billed as part of resolving a case. applicationCommon/Letter
isRegularActivity Information regarding whether the activity is a regular activity type or event type. applicationCommon/Letter
isWorkflowCreated Information regarding whether the activity was created from a workflow rule. applicationCommon/Letter
priorityCode Priority of the activity. applicationCommon/Letter
priorityCode_display applicationCommon/Letter
regardingObjectId Unique identifier of the object with which the activity is associated. applicationCommon/Letter
regardingObjectTypeCode The name of the entity linked by regardingObjectId applicationCommon/Letter
scheduledEnd Scheduled end time of the activity. applicationCommon/Letter
scheduledStart Scheduled start time of the activity. applicationCommon/Letter
sortDate Shows the date and time by which the activities are sorted. applicationCommon/Letter
subject Subject associated with the activity. applicationCommon/Letter
scheduledDurationMinutes Scheduled duration of the activity, specified in minutes. applicationCommon/Letter
actualDurationMinutes Actual duration of the activity in minutes. applicationCommon/Letter
actualEnd Actual end time of the activity. applicationCommon/Letter
actualStart Actual start time of the activity. applicationCommon/Letter
category Type a category to identify the activity type, such as lead outreach, customer follow-up, or service alert, to tie the eactivity to a business group or function. applicationCommon/Letter
subcategory Type a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function. applicationCommon/Letter
to The account, contact, lead, queue, or user recipients for the activity. applicationCommon/Letter
from The sender of the activity. applicationCommon/Letter
BCC Enter the recipients that are included on the activity distribution, but are not displayed to other recipients. applicationCommon/Letter
CC Enter the recipients that should be copied on the activity. applicationCommon/Letter
directionCode Select the direction of the activity as incoming or outbound. applicationCommon/Letter
address Type the complete recipient address for the letter to ensure timely delivery. applicationCommon/Letter
statusCode Select the letter's status. applicationCommon/Letter
statusCode_display applicationCommon/Letter
stateCode Shows whether the letter is open, completed, or canceled. Completed and canceled letters are read-only and can't be edited. applicationCommon/Letter
stateCode_display applicationCommon/Letter
description Type the letter body or additional information to describe the letter, such as the primary message or the products and services described. applicationCommon/Letter
transactionCurrencyId Choose the local currency for the record to make sure budgets are reported in the correct currency. applicationCommon/Letter
exchangeRate Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency. applicationCommon/Letter
processId Shows the ID of the process. applicationCommon/Letter
stageId Shows the ID of the stage. applicationCommon/Letter
traversedPath For internal use only. applicationCommon/Letter
SLAId Choose the service level agreement (SLA) that you want to apply to the Letter record. applicationCommon/Letter
SLAInvokedId Last SLA that was applied to this Letter. This field is for internal use only. applicationCommon/Letter
onHoldTime Shows how long, in minutes, that the record was on hold. applicationCommon/Letter
lastOnHoldTime Contains the date and time stamp of the last on hold time. applicationCommon/Letter

createdOn

Date and time when the record was created.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameCreated On
descriptionDate and time when the record was created.
dataFormatdateTime
isNullabletrue
sourceNamecreatedon

Traits

List of traits for the createdOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated On
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
enDate and time when the record was created.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdon"string

is.dataFormat.time
is.dataFormat.date

createdBy

Shows who created the record.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameCreated By
descriptionShows who created the record.
dataFormatguid
isNullabletrue
sourceNamecreatedby

Traits

List of traits for the createdBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By
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
enShows who created the record.
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
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

modifiedOn

Date and time when the record was modified.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameModified On
descriptionDate and time when the record was modified.
dataFormatdateTime
isNullabletrue
sourceNamemodifiedon

Traits

List of traits for the modifiedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.modify
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified On
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
enDate and time when the record was modified.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedon"string

is.dataFormat.time
is.dataFormat.date

modifiedBy

Shows who last updated the record.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameModified By
descriptionShows who last updated the record.
dataFormatguid
isNullabletrue
sourceNamemodifiedby

Traits

List of traits for the modifiedBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By
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
enShows who last updated the record.
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
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

createdOnBehalfBy

Shows who created the record on behalf of another user.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameCreated By (Delegate)
descriptionShows who created the record on behalf of another user.
dataFormatguid
isNullabletrue
sourceNamecreatedonbehalfby

Traits

List of traits for the createdOnBehalfBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By (Delegate)
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
enShows who created the record on behalf of another user.
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
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdonbehalfby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

modifiedOnBehalfBy

Shows who last updated the record on behalf of another user.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameModified By (Delegate)
descriptionShows who last updated the record on behalf of another user.
dataFormatguid
isNullabletrue
sourceNamemodifiedonbehalfby

Traits

List of traits for the modifiedOnBehalfBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By (Delegate)
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
enShows who last updated the record on behalf of another user.
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
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedonbehalfby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

overriddenCreatedOn

Date and time that the record was migrated.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameRecord Created On
descriptionDate and time that the record was migrated.
dataFormatdateTime
isNullabletrue
sourceNameoverriddencreatedon

Traits

List of traits for the overriddenCreatedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecord Created On
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
enDate and time that the record was migrated.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"overriddencreatedon"string

is.dataFormat.time
is.dataFormat.date

importSequenceNumber

Unique identifier of the data import or data migration that created this record.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameImport Sequence Number
descriptionUnique identifier of the data import or data migration that created this record.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameimportsequencenumber

Traits

List of traits for the importSequenceNumber attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enImport Sequence Number
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
enUnique identifier of the data import or data migration that created this record.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"importsequencenumber"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-2147483648"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

ownerId

Owner Id
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameOwner
descriptionOwner Id
dataFormatguid
sourceNameownerid

Traits

List of traits for the ownerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwner
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
enOwner Id
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
/core/applicationCommon/User.cdm.json/UsersystemUserId
/core/applicationCommon/Team.cdm.json/TeamteamId
entitya reference to the constant entity holding the list of entity references

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"ownerid"string

is.CDS.owner
contains a User or Team ID

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

ownerIdType

The type of owner, either User or Team.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameOwner Type
descriptionThe type of owner, either User or Team.
dataFormatstring
isReadOnlytrue
sourceNameowneridtype

Traits

List of traits for the ownerIdType attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.

means.entityName
a string value is the name of a CDM entity.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwner Type
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 type of owner, either User or Team.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.

is.readOnly
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"owneridtype"string

is.CDS.owner
contains a User or Team ID

is.dataFormat.character
is.dataFormat.array

owningBusinessUnit

Unique identifier for the business unit that owns the record
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameOwning Business Unit
descriptionUnique identifier for the business unit that owns the record
dataFormatguid
isNullabletrue
sourceNameowningbusinessunit

Traits

List of traits for the owningBusinessUnit attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwning Business Unit
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
enUnique identifier for the business unit that owns the record
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
/core/applicationCommon/BusinessUnit.cdm.json/BusinessUnitbusinessUnitId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"owningbusinessunit"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

owningUser

Unique identifier of the user that owns the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameOwning User
descriptionUnique identifier of the user that owns the activity.
dataFormatguid
isNullabletrue
sourceNameowninguser

Traits

List of traits for the owningUser attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwning User
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
enUnique identifier for the user that owns the record.
enUnique identifier of the user that owns the activity.
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
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"owninguser"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

owningTeam

Unique identifier for the team that owns the record.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameOwning Team
descriptionUnique identifier for the team that owns the record.
dataFormatguid
isNullabletrue
sourceNameowningteam

Traits

List of traits for the owningTeam attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwning Team
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
enUnique identifier for the team that owns the record.
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
/core/applicationCommon/Team.cdm.json/TeamteamId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"owningteam"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

timeZoneRuleVersionNumber

For internal use only.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameTime Zone Rule Version Number
descriptionFor internal use only.
dataFormatint32
maximumValue2147483647
minimumValue-1
isNullabletrue
sourceNametimezoneruleversionnumber

Traits

List of traits for the timeZoneRuleVersionNumber attribute are listed below.

is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTime Zone Rule Version Number
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
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"timezoneruleversionnumber"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-1"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

UTCConversionTimeZoneCode

Time zone code that was in use when the record was created.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameUTC Conversion Time Zone Code
descriptionTime zone code that was in use when the record was created.
dataFormatint32
maximumValue2147483647
minimumValue-1
isNullabletrue
sourceNameutcconversiontimezonecode

Traits

List of traits for the UTCConversionTimeZoneCode attribute are listed below.

is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUTC Conversion Time Zone Code
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
enTime zone code that was in use when the record was created.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"utcconversiontimezonecode"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-1"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

versionNumber

Version Number
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameVersion Number
descriptionVersion Number
dataFormatint64
isNullabletrue
sourceNameversionnumber

Traits

List of traits for the versionNumber attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
means.measurement.version
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVersion Number
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
enVersion Number
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"versionnumber"string

is.dataFormat.integer
is.dataFormat.big

activityId

Unique identifier of the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameActivity
descriptionUnique identifier of the activity.
isPrimaryKeytrue
dataFormatguid
sourceNameactivityid

Traits

List of traits for the activityId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.identifiedBy
names a specifc identity attribute to use with an entity

ParameterValueData typeExplanation
attributeLetter/(resolvedAttributes)/activityIdattribute

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActivity
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
enUnique identifier of the activity.
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
entityReferencesempty tableentitya reference to the constant entity holding the list of entity references

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"activityid"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

activityTypeCode

Type of activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameActivity Type
descriptionType of activity.
dataFormatstring
isReadOnlytrue
sourceNameactivitytypecode
defaultValue
languageTagdisplayTextattributeValue
enFaxnull
enPhone Callnull
enEmailnull
enLetternull
enAppointmentnull
enTasknull
enRecurring Appointmentnull
enQuick Campaignnull
enCampaign Activitynull
enCampaign Responsenull
enCase Resolutionnull
enService Activitynull
enOpportunity Closenull
enOrder Closenull
enQuote Closenull
enAlert Subscriptionnull
enInvite Redemptionnull
enPortal Commentnull

Traits

List of traits for the activityTypeCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.

means.entityName
a string value is the name of a CDM entity.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActivity Type
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
enType of activity.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.

is.readOnly
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"activitytypecode"string

does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enFaxnull
enPhone Callnull
enEmailnull
enLetternull
enAppointmentnull
enTasknull
enRecurring Appointmentnull
enQuick Campaignnull
enCampaign Activitynull
enCampaign Responsenull
enCase Resolutionnull
enService Activitynull
enOpportunity Closenull
enOrder Closenull
enQuote Closenull
enAlert Subscriptionnull
enInvite Redemptionnull
enPortal Commentnull
any

is.dataFormat.character
is.dataFormat.array

isBilled

Information regarding whether the fax activity was billed as part of resolving a case.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameIs Billed
descriptionInformation regarding whether the fax activity was billed as part of resolving a case.
dataFormatboolean
isNullabletrue
sourceNameisbilled

Traits

List of traits for the isBilled attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIs Billed
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
enInformation regarding whether the activity was billed as part of resolving a case.
enInformation regarding whether the fax activity was billed as part of resolving a case.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isbilled"string

is.dataFormat.boolean

isRegularActivity

Information regarding whether the activity is a regular activity type or event type.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameIs Regular Activity
descriptionInformation regarding whether the activity is a regular activity type or event type.
dataFormatboolean
sourceNameisregularactivity

Traits

List of traits for the isRegularActivity attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIs Regular Activity
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
enInformation regarding whether the activity is a regular activity type or event type.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isregularactivity"string

is.dataFormat.boolean

isWorkflowCreated

Information regarding whether the activity was created from a workflow rule.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameIs Workflow Created
descriptionInformation regarding whether the activity was created from a workflow rule.
dataFormatboolean
isNullabletrue
sourceNameisworkflowcreated

Traits

List of traits for the isWorkflowCreated attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIs Workflow Created
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
enInformation regarding whether the activity was created from a workflow rule.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isworkflowcreated"string

is.dataFormat.boolean

priorityCode

Priority of the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNamePriority
descriptionPriority of the activity.
dataFormatint32
isNullabletrue
sourceNameprioritycode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enLow0
enNormal1
enHigh2

Traits

List of traits for the priorityCode attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enLow0
enNormal1
enHigh2
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPriority
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
enPriority of the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"prioritycode"string

is.dataFormat.integer

priorityCode_display

First included in: applicationCommon/Letter (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the priorityCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"priorityCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

regardingObjectId

Unique identifier of the object with which the activity is associated.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameRegarding
descriptionUnique identifier of the object with which the activity is associated.
dataFormatguid
isNullabletrue
sourceNameregardingobjectid

Traits

List of traits for the regardingObjectId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRegarding
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
enUnique identifier of the object with which the activity is associated.
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
/core/applicationCommon/Contact.cdm.json/ContactcontactId
/core/applicationCommon/KnowledgeBaseRecord.cdm.json/KnowledgeBaseRecordknowledgeBaseRecordId
/core/applicationCommon/Account.cdm.json/AccountaccountId
/core/applicationCommon/KnowledgeArticle.cdm.json/KnowledgeArticleknowledgearticleId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"regardingobjectid"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

regardingObjectTypeCode

The name of the entity linked by regardingObjectId
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameRegarding Type
descriptionThe name of the entity linked by regardingObjectId
dataFormatstring
isReadOnlytrue
sourceNameregardingobjecttypecode

Traits

List of traits for the regardingObjectTypeCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.

means.entityName
a string value is the name of a CDM entity.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRegarding Type
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 name of the entity linked by regardingObjectId
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.

is.readOnly
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"regardingobjecttypecode"string

is.dataFormat.character
is.dataFormat.array

scheduledEnd

Scheduled end time of the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameDue Date
descriptionScheduled end time of the activity.
dataFormatdateTime
isNullabletrue
sourceNamescheduledend

Traits

List of traits for the scheduledEnd attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDue 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
enScheduled end time of the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"scheduledend"string

is.dataFormat.time
is.dataFormat.date

scheduledStart

Scheduled start time of the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameStart Date
descriptionScheduled start time of the activity.
dataFormatdateTime
isNullabletrue
sourceNamescheduledstart

Traits

List of traits for the scheduledStart attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStart 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
enScheduled start time of the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"scheduledstart"string

is.dataFormat.time
is.dataFormat.date

sortDate

Shows the date and time by which the activities are sorted.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameSort Date
descriptionShows the date and time by which the activities are sorted.
dataFormatdateTime
isNullabletrue
sourceNamesortdate

Traits

List of traits for the sortDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.ordered

ParameterValueData typeExplanation
attribute[Letter/(resolvedAttributes)/sortDate](#sortDate)attribute

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSort 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
enShows the date and time by which the activities are sorted.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"sortdate"string

is.dataFormat.time
is.dataFormat.date

subject

Subject associated with the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameSubject
descriptionSubject associated with the activity.
dataFormatstring
maximumLength200
isNullabletrue
sourceNamesubject

Traits

List of traits for the subject attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"required"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSubject
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
enSubject associated with the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"subject"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"200"integer

is.dataFormat.character
is.dataFormat.array

scheduledDurationMinutes

Scheduled duration of the activity, specified in minutes.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameScheduled Duration
descriptionScheduled duration of the activity, specified in minutes.
dataFormatint32
maximumValue2147483647
minimumValue0
isNullabletrue
sourceNamescheduleddurationminutes

Traits

List of traits for the scheduledDurationMinutes attribute are listed below.

is.dataFormat.integer
means.measurement.dimension.time
measurement of time

ParameterValueData typeExplanation
dimension"time"stringthe name of the physical dimension being measured

means.measurement.duration.minutes
has.measurement.fundamentalComponent.second
a fundamental component expressing time in seconds

ParameterValueData typeExplanation
fundamentalUnit"second"stringthe name of the fundamental unit that is a component of some derived unit.
symbol"s"stringthe common symbolic representation of the unit
dimension"time"stringdimension being measured
fundamentalExponent"1"doublethe exponent, positive, negative, fractional (for inverse) that the component contributes to the base derived unit.
fundamentalScale"60"doublethe constant scale factor applied to the fundamental unit (prior to application of exponent) by the derived unit
fundamentalOffset"0"doublethe constant offset applied to the scaled fundamental unit (prior to application of exponent) by the derived unit

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enScheduled Duration
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
enScheduled duration of the activity, specified in minutes.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"scheduleddurationminutes"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

actualDurationMinutes

Actual duration of the activity in minutes.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameActual Duration
descriptionActual duration of the activity in minutes.
dataFormatint32
maximumValue2147483647
minimumValue0
isNullabletrue
sourceNameactualdurationminutes

Traits

List of traits for the actualDurationMinutes attribute are listed below.

is.dataFormat.integer
means.measurement.dimension.time
measurement of time

ParameterValueData typeExplanation
dimension"time"stringthe name of the physical dimension being measured

means.measurement.duration.minutes
has.measurement.fundamentalComponent.second
a fundamental component expressing time in seconds

ParameterValueData typeExplanation
fundamentalUnit"second"stringthe name of the fundamental unit that is a component of some derived unit.
symbol"s"stringthe common symbolic representation of the unit
dimension"time"stringdimension being measured
fundamentalExponent"1"doublethe exponent, positive, negative, fractional (for inverse) that the component contributes to the base derived unit.
fundamentalScale"60"doublethe constant scale factor applied to the fundamental unit (prior to application of exponent) by the derived unit
fundamentalOffset"0"doublethe constant offset applied to the scaled fundamental unit (prior to application of exponent) by the derived unit

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActual Duration
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
enActual duration of the activity in minutes.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"actualdurationminutes"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

actualEnd

Actual end time of the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameActual End
descriptionActual end time of the activity.
dataFormatdateTime
isNullabletrue
sourceNameactualend

Traits

List of traits for the actualEnd attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.end
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActual End
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
enActual end time of the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"actualend"string

is.dataFormat.time
is.dataFormat.date

actualStart

Actual start time of the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameActual Start
descriptionActual start time of the activity.
dataFormatdateTime
isNullabletrue
sourceNameactualstart

Traits

List of traits for the actualStart attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.start
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActual Start
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
enActual start time of the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"actualstart"string

is.dataFormat.time
is.dataFormat.date

category

Type a category to identify the activity type, such as lead outreach, customer follow-up, or service alert, to tie the eactivity to a business group or function.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameCategory
descriptionType a category to identify the activity type, such as lead outreach, customer follow-up, or service alert, to tie the eactivity to a business group or function.
dataFormatstring
maximumLength250
isNullabletrue
sourceNamecategory

Traits

List of traits for the category attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.category
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCategory
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
enType a category to identify the activity type, such as lead outreach, customer follow-up, or service alert, to tie the eactivity to a business group or function.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"category"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"250"integer

is.dataFormat.character
is.dataFormat.array

subcategory

Type a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameSub-Category
descriptionType a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function.
dataFormatstring
maximumLength250
isNullabletrue
sourceNamesubcategory

Traits

List of traits for the subcategory attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSub-Category
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
enType a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"subcategory"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"250"integer

is.dataFormat.character
is.dataFormat.array

to

The account, contact, lead, queue, or user recipients for the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameTo
descriptionThe account, contact, lead, queue, or user recipients for the activity.
dataFormatguid
isNullabletrue
sourceNameto

Traits

List of traits for the to attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.CDS.partyList
contains a link to ActivityParty to identify the set of party members

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"multi"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTo
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 account, contact, lead, queue, or user recipients for the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"to"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

from

The sender of the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameFrom
descriptionThe sender of the activity.
dataFormatguid
isNullabletrue
sourceNamefrom

Traits

List of traits for the from attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.CDS.partyList
contains a link to ActivityParty to identify the set of party members

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFrom
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 sender of the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"from"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

BCC

Enter the recipients that are included on the activity distribution, but are not displayed to other recipients.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameBcc
descriptionEnter the recipients that are included on the activity distribution, but are not displayed to other recipients.
dataFormatguid
isNullabletrue
sourceNamebcc

Traits

List of traits for the BCC attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.CDS.partyList
contains a link to ActivityParty to identify the set of party members

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"multi"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBcc
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
enEnter the recipients that are included on the activity distribution, but are not displayed to other recipients.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"bcc"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

CC

Enter the recipients that should be copied on the activity.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameCc
descriptionEnter the recipients that should be copied on the activity.
dataFormatguid
isNullabletrue
sourceNamecc

Traits

List of traits for the CC attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.CDS.partyList
contains a link to ActivityParty to identify the set of party members

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"multi"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCc
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
enEnter the recipients that should be copied on the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"cc"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

directionCode

Select the direction of the activity as incoming or outbound.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameDirection
descriptionSelect the direction of the activity as incoming or outbound.
dataFormatboolean
isNullabletrue
sourceNamedirectioncode

Traits

List of traits for the directionCode attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDirection
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
enSelect the direction of the activity as incoming or outbound.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"directioncode"string

is.dataFormat.boolean

address

Type the complete recipient address for the letter to ensure timely delivery.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameAddress
descriptionType the complete recipient address for the letter to ensure timely delivery.
dataFormatstring
maximumLength200
isNullabletrue
sourceNameaddress

Traits

List of traits for the address attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAddress
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
enType the complete recipient address for the letter to ensure timely delivery.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"address"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"10"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"200"integer

is.dataFormat.character
is.dataFormat.array

statusCode

Select the letter's status.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameStatus Reason
descriptionSelect the letter's status.
dataFormatint32
isNullabletrue
sourceNamestatuscode
defaultValue
languageTagdisplayTextattributeValuecorrelatedValue
enOpen10
enDraft20
enReceived31
enSent41
enCanceled52

Traits

List of traits for the statusCode attribute are listed below.

is.dataFormat.integer
is.constrainedList.correlated
the values of an attribute are taken from or looked up from a fixed list of possibilities that represent correlated status

does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValuecorrelatedValue
enOpen10
enDraft20
enReceived31
enSent41
enCanceled52
any

is.correlatedWith
the attribute value is correlated with the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"stateCode"attributeName

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus Reason
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
enSelect the letter's status.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"statuscode"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"23"integer

is.dataFormat.integer

statusCode_display

First included in: applicationCommon/Letter (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the statusCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"statusCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

stateCode

Shows whether the letter is open, completed, or canceled. Completed and canceled letters are read-only and can't be edited.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameActivity Status
descriptionShows whether the letter is open, completed, or canceled. Completed and canceled letters are read-only and can't be edited.
dataFormatint32
sourceNamestatecode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enOpen0
enCompleted1
enCanceled2

Traits

List of traits for the stateCode attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enOpen0
enCompleted1
enCanceled2
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

means.entityState
the attribute represents the current state of the entity.

ParameterValueData typeExplanation
attributeLetter/(resolvedAttributes)/stateCodeattribute

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActivity Status
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
enShows whether the letter is open, completed, or canceled. Completed and canceled letters are read-only and can't be edited.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"statecode"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"28"integer

is.dataFormat.integer

stateCode_display

First included in: applicationCommon/Letter (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the stateCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"stateCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

description

Type the letter body or additional information to describe the letter, such as the primary message or the products and services described.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameDescription
descriptionType the letter body or additional information to describe the letter, such as the primary message or the products and services described.
dataFormatstring
maximumLength2000
isNullabletrue
sourceNamedescription

Traits

List of traits for the description attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescription
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
enType the letter body or additional information to describe the letter, such as the primary message or the products and services described.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"description"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"29"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"2000"integer

is.dataFormat.character
is.dataFormat.array

transactionCurrencyId

Choose the local currency for the record to make sure budgets are reported in the correct currency.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameCurrency
descriptionChoose the local currency for the record to make sure budgets are reported in the correct currency.
dataFormatguid
isNullabletrue
sourceNametransactioncurrencyid

Traits

List of traits for the transactionCurrencyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCurrency
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
enChoose the local currency for the record to make sure budgets are reported in the correct currency.
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
/core/applicationCommon/Currency.cdm.json/CurrencytransactionCurrencyId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"transactioncurrencyid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"73"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

exchangeRate

Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameExchange Rate
descriptionShows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
dataFormatdecimal
maximumValue100000000000
minimumValue1E-10
isNullabletrue
sourceNameexchangerate

Traits

List of traits for the exchangeRate attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enExchange Rate
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
enShows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"exchangerate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"75"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"1E-10"decimal
maximumValue"100000000000"decimal

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

processId

Shows the ID of the process.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameProcess
descriptionShows the ID of the process.
dataFormatguid
isNullabletrue
sourceNameprocessid

Traits

List of traits for the processId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enProcess
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
enShows the ID of the process.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"processid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"76"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

stageId

Shows the ID of the stage.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameProcess Stage
descriptionShows the ID of the stage.
dataFormatguid
isNullabletrue
sourceNamestageid

Traits

List of traits for the stageId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enProcess Stage
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
enShows the ID of the stage.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"stageid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"77"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

traversedPath

For internal use only.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameTraversed Path
descriptionFor internal use only.
dataFormatstring
maximumLength1250
isNullabletrue
sourceNametraversedpath

Traits

List of traits for the traversedPath attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTraversed Path
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
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"traversedpath"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"78"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"1250"integer

is.dataFormat.character
is.dataFormat.array

SLAId

Choose the service level agreement (SLA) that you want to apply to the Letter record.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameSLA
descriptionChoose the service level agreement (SLA) that you want to apply to the Letter record.
dataFormatguid
isNullabletrue
sourceNameslaid

Traits

List of traits for the SLAId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSLA
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
enChoose the service level agreement (SLA) that you want to apply to the Letter record.
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
/core/applicationCommon/SLA.cdm.json/SLASLAId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"slaid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"79"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

SLAInvokedId

Last SLA that was applied to this Letter. This field is for internal use only.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameLast SLA applied
descriptionLast SLA that was applied to this Letter. This field is for internal use only.
dataFormatguid
isNullabletrue
sourceNameslainvokedid

Traits

List of traits for the SLAInvokedId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLast SLA applied
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
enLast SLA that was applied to this Letter. This field is for internal use only.
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
/core/applicationCommon/SLA.cdm.json/SLASLAId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"slainvokedid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"80"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

onHoldTime

Shows how long, in minutes, that the record was on hold.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameOn Hold Time (Minutes)
descriptionShows how long, in minutes, that the record was on hold.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameonholdtime

Traits

List of traits for the onHoldTime attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOn Hold Time (Minutes)
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
enShows how long, in minutes, that the record was on hold.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"onholdtime"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"81"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-2147483648"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

lastOnHoldTime

Contains the date and time stamp of the last on hold time.
First included in: applicationCommon/Letter (this entity)

Properties

NameValue
displayNameLast On Hold Time
descriptionContains the date and time stamp of the last on hold time.
dataFormatdateTime
isNullabletrue
sourceNamelastonholdtime

Traits

List of traits for the lastOnHoldTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLast On 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
enContains the date and time stamp of the last on hold time.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"lastonholdtime"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"82"integer

is.dataFormat.time
is.dataFormat.date