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.

• /foundationCommon/crmCommon/Letter

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
attribute	[Letter/(resolvedAttributes)/sortDate](#sortDate)	attribute

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

Parameter	Value	Data type	Explanation
attribute	Letter/(resolvedAttributes)/stateCode	attribute

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Letter	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Activity that tracks the delivery of a letter. The activity can contain the electronic copy of the letter.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Created On
description	Date and time when the record was created.
dataFormat	dateTime
isNullable	true
sourceName	createdon

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Created On	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Date and time when the record was created.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"createdon"	string

is.dataFormat.time
is.dataFormat.date

createdBy

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

Properties

Name	Value
displayName	Created By
description	Shows who created the record.
dataFormat	guid
isNullable	true
sourceName	createdby

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Created By	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shows who created the record.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/User.cdm.json/User systemUserId	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Modified On
description	Date and time when the record was modified.
dataFormat	dateTime
isNullable	true
sourceName	modifiedon

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Modified On	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Date and time when the record was modified.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"modifiedon"	string

is.dataFormat.time
is.dataFormat.date

modifiedBy

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

Properties

Name	Value
displayName	Modified By
description	Shows who last updated the record.
dataFormat	guid
isNullable	true
sourceName	modifiedby

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Modified By	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shows who last updated the record.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/User.cdm.json/User systemUserId	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Created By (Delegate)
description	Shows who created the record on behalf of another user.
dataFormat	guid
isNullable	true
sourceName	createdonbehalfby

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Created By (Delegate)	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shows who created the record on behalf of another user.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/User.cdm.json/User systemUserId	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Modified By (Delegate)
description	Shows who last updated the record on behalf of another user.
dataFormat	guid
isNullable	true
sourceName	modifiedonbehalfby

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Modified By (Delegate)	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shows who last updated the record on behalf of another user.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/User.cdm.json/User systemUserId	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Record Created On
description	Date and time that the record was migrated.
dataFormat	dateTime
isNullable	true
sourceName	overriddencreatedon

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Record Created On	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Date and time that the record was migrated.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Import Sequence Number
description	Unique identifier of the data import or data migration that created this record.
dataFormat	int32
maximumValue	2147483647
minimumValue	-2147483648
isNullable	true
sourceName	importsequencenumber

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Import Sequence Number	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the data import or data migration that created this record.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"importsequencenumber"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
minimumValue	"-2147483648"	decimal
maximumValue	"2147483647"	decimal

is.dataFormat.integer

ownerId

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

Properties

Name	Value
displayName	Owner
description	Owner Id
dataFormat	guid
sourceName	ownerid

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Owner	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Owner Id	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/User.cdm.json/User systemUserId /core/applicationCommon/Team.cdm.json/Team teamId	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Owner Type
description	The type of owner, either User or Team.
dataFormat	string
isReadOnly	true
sourceName	owneridtype

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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Owner Type	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The type of owner, either User or Team.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Owning Business Unit
description	Unique identifier for the business unit that owns the record
dataFormat	guid
isNullable	true
sourceName	owningbusinessunit

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Owning Business Unit	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier for the business unit that owns the record	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/BusinessUnit.cdm.json/BusinessUnit businessUnitId	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Owning User
description	Unique identifier of the user that owns the activity.
dataFormat	guid
isNullable	true
sourceName	owninguser

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Owning User	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier for the user that owns the record. en Unique identifier of the user that owns the activity.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/User.cdm.json/User systemUserId	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Owning Team
description	Unique identifier for the team that owns the record.
dataFormat	guid
isNullable	true
sourceName	owningteam

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Owning Team	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier for the team that owns the record.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/Team.cdm.json/Team teamId	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Time Zone Rule Version Number
description	For internal use only.
dataFormat	int32
maximumValue	2147483647
minimumValue	-1
isNullable	true
sourceName	timezoneruleversionnumber

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Time Zone Rule Version Number	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en For internal use only.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"timezoneruleversionnumber"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	UTC Conversion Time Zone Code
description	Time zone code that was in use when the record was created.
dataFormat	int32
maximumValue	2147483647
minimumValue	-1
isNullable	true
sourceName	utcconversiontimezonecode

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en UTC Conversion Time Zone Code	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Time zone code that was in use when the record was created.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"utcconversiontimezonecode"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
minimumValue	"-1"	decimal
maximumValue	"2147483647"	decimal

is.dataFormat.integer

versionNumber

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

Properties

Name	Value
displayName	Version Number
description	Version Number
dataFormat	int64
isNullable	true
sourceName	versionnumber

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Version Number	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Version Number	entity	a 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.

Parameter	Value	Data type	Explanation
name	"versionnumber"	string

is.dataFormat.integer
is.dataFormat.big

activityId

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

Properties

Name	Value
displayName	Activity
description	Unique identifier of the activity.
isPrimaryKey	true
dataFormat	guid
sourceName	activityid

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

Parameter	Value	Data type	Explanation
attribute	Letter/(resolvedAttributes)/activityId	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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Activity	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the activity.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	empty table	entity	a 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.

Parameter	Value	Data type	Explanation
name	"activityid"	string

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

activityTypeCode

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

Properties

Name	Value
displayName	Activity Type
description	Type of activity.
dataFormat	string
isReadOnly	true
sourceName	activitytypecode
defaultValue	languageTag displayText attributeValue en Fax null en Phone Call null en Email null en Letter null en Appointment null en Task null en Recurring Appointment null en Quick Campaign null en Campaign Activity null en Campaign Response null en Case Resolution null en Service Activity null en Opportunity Close null en Order Close null en Quote Close null en Alert Subscription null en Invite Redemption null en Portal Comment null

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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Activity Type	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Type of activity.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"activitytypecode"	string

does.haveDefault
An attribute has a default value

Parameter	Value	Data type	Explanation
default	languageTag displayText attributeValue en Fax null en Phone Call null en Email null en Letter null en Appointment null en Task null en Recurring Appointment null en Quick Campaign null en Campaign Activity null en Campaign Response null en Case Resolution null en Service Activity null en Opportunity Close null en Order Close null en Quote Close null en Alert Subscription null en Invite Redemption null en Portal Comment null	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

Name	Value
displayName	Is Billed
description	Information regarding whether the fax activity was billed as part of resolving a case.
dataFormat	boolean
isNullable	true
sourceName	isbilled

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Is Billed	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Information regarding whether the activity was billed as part of resolving a case. en Information regarding whether the fax activity was billed as part of resolving a case.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Is Regular Activity
description	Information regarding whether the activity is a regular activity type or event type.
dataFormat	boolean
sourceName	isregularactivity

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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Is Regular Activity	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Information regarding whether the activity is a regular activity type or event type.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Is Workflow Created
description	Information regarding whether the activity was created from a workflow rule.
dataFormat	boolean
isNullable	true
sourceName	isworkflowcreated

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Is Workflow Created	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Information regarding whether the activity was created from a workflow rule.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"isworkflowcreated"	string

is.dataFormat.boolean

priorityCode

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

Properties

Name	Value
displayName	Priority
description	Priority of the activity.
dataFormat	int32
isNullable	true
sourceName	prioritycode
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue en Low 0 en Normal 1 en High 2

Traits

List of traits for the priorityCode attribute are listed below.

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

Parameter	Value	Data type	Explanation
default	languageTag displayText attributeValue en Low 0 en Normal 1 en High 2	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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Priority	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Priority of the activity.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"prioritycode"	string

is.dataFormat.integer

priorityCode_display

First included in: applicationCommon/Letter (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

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

Parameter	Value	Data type	Explanation
inSupportOf	"priorityCode"	attributeName	output 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

Name	Value
displayName	Regarding
description	Unique identifier of the object with which the activity is associated.
dataFormat	guid
isNullable	true
sourceName	regardingobjectid

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Regarding	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the object with which the activity is associated.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/Contact.cdm.json/Contact contactId /core/applicationCommon/KnowledgeBaseRecord.cdm.json/KnowledgeBaseRecord knowledgeBaseRecordId /core/applicationCommon/Account.cdm.json/Account accountId /core/applicationCommon/KnowledgeArticle.cdm.json/KnowledgeArticle knowledgearticleId	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Regarding Type
description	The name of the entity linked by regardingObjectId
dataFormat	string
isReadOnly	true
sourceName	regardingobjecttypecode

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Regarding Type	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The name of the entity linked by regardingObjectId	entity	a 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.

Parameter	Value	Data type	Explanation
name	"regardingobjecttypecode"	string

is.dataFormat.character
is.dataFormat.array

scheduledEnd

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

Properties

Name	Value
displayName	Due Date
description	Scheduled end time of the activity.
dataFormat	dateTime
isNullable	true
sourceName	scheduledend

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Due Date	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Scheduled end time of the activity.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"scheduledend"	string

is.dataFormat.time
is.dataFormat.date

scheduledStart

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

Properties

Name	Value
displayName	Start Date
description	Scheduled start time of the activity.
dataFormat	dateTime
isNullable	true
sourceName	scheduledstart

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Start Date	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Scheduled start time of the activity.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Sort Date
description	Shows the date and time by which the activities are sorted.
dataFormat	dateTime
isNullable	true
sourceName	sortdate

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Sort Date	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shows the date and time by which the activities are sorted.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"sortdate"	string

is.dataFormat.time
is.dataFormat.date

subject

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

Properties

Name	Value
displayName	Subject
description	Subject associated with the activity.
dataFormat	string
maximumLength	200
isNullable	true
sourceName	subject

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

Parameter	Value	Data type	Explanation
level	"required"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Subject	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Subject associated with the activity.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"subject"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Scheduled Duration
description	Scheduled duration of the activity, specified in minutes.
dataFormat	int32
maximumValue	2147483647
minimumValue	0
isNullable	true
sourceName	scheduleddurationminutes

Traits

List of traits for the scheduledDurationMinutes attribute are listed below.

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

Parameter	Value	Data type	Explanation
dimension	"time"	string	the name of the physical dimension being measured

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

Parameter	Value	Data type	Explanation
fundamentalUnit	"second"	string	the name of the fundamental unit that is a component of some derived unit.
symbol	"s"	string	the common symbolic representation of the unit
dimension	"time"	string	dimension being measured
fundamentalExponent	"1"	double	the exponent, positive, negative, fractional (for inverse) that the component contributes to the base derived unit.
fundamentalScale	"60"	double	the constant scale factor applied to the fundamental unit (prior to application of exponent) by the derived unit
fundamentalOffset	"0"	double	the 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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Scheduled Duration	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Scheduled duration of the activity, specified in minutes.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"scheduleddurationminutes"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Actual Duration
description	Actual duration of the activity in minutes.
dataFormat	int32
maximumValue	2147483647
minimumValue	0
isNullable	true
sourceName	actualdurationminutes

Traits

List of traits for the actualDurationMinutes attribute are listed below.

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

Parameter	Value	Data type	Explanation
dimension	"time"	string	the name of the physical dimension being measured

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

Parameter	Value	Data type	Explanation
fundamentalUnit	"second"	string	the name of the fundamental unit that is a component of some derived unit.
symbol	"s"	string	the common symbolic representation of the unit
dimension	"time"	string	dimension being measured
fundamentalExponent	"1"	double	the exponent, positive, negative, fractional (for inverse) that the component contributes to the base derived unit.
fundamentalScale	"60"	double	the constant scale factor applied to the fundamental unit (prior to application of exponent) by the derived unit
fundamentalOffset	"0"	double	the 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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Actual Duration	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Actual duration of the activity in minutes.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"actualdurationminutes"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
minimumValue	"0"	decimal
maximumValue	"2147483647"	decimal

is.dataFormat.integer

actualEnd

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

Properties

Name	Value
displayName	Actual End
description	Actual end time of the activity.
dataFormat	dateTime
isNullable	true
sourceName	actualend

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Actual End	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Actual end time of the activity.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"actualend"	string

is.dataFormat.time
is.dataFormat.date

actualStart

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

Properties

Name	Value
displayName	Actual Start
description	Actual start time of the activity.
dataFormat	dateTime
isNullable	true
sourceName	actualstart

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Actual Start	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Actual start time of the activity.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Category
description	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.
dataFormat	string
maximumLength	250
isNullable	true
sourceName	category

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Category	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en 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.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"category"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Sub-Category
description	Type a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function.
dataFormat	string
maximumLength	250
isNullable	true
sourceName	subcategory

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Sub-Category	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Type a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"subcategory"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	To
description	The account, contact, lead, queue, or user recipients for the activity.
dataFormat	guid
isNullable	true
sourceName	to

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en To	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The account, contact, lead, queue, or user recipients for the activity.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	From
description	The sender of the activity.
dataFormat	guid
isNullable	true
sourceName	from

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en From	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The sender of the activity.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Bcc
description	Enter the recipients that are included on the activity distribution, but are not displayed to other recipients.
dataFormat	guid
isNullable	true
sourceName	bcc

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Bcc	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Enter the recipients that are included on the activity distribution, but are not displayed to other recipients.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Cc
description	Enter the recipients that should be copied on the activity.
dataFormat	guid
isNullable	true
sourceName	cc

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Cc	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Enter the recipients that should be copied on the activity.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Direction
description	Select the direction of the activity as incoming or outbound.
dataFormat	boolean
isNullable	true
sourceName	directioncode

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Direction	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Select the direction of the activity as incoming or outbound.	entity	a 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.

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Address
description	Type the complete recipient address for the letter to ensure timely delivery.
dataFormat	string
maximumLength	200
isNullable	true
sourceName	address

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Address	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Type the complete recipient address for the letter to ensure timely delivery.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"address"	string

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

Parameter	Value	Data type	Explanation
ordinal	"10"	integer

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"200"	integer

is.dataFormat.character
is.dataFormat.array

statusCode

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

Properties

Name	Value
displayName	Status Reason
description	Select the letter's status.
dataFormat	int32
isNullable	true
sourceName	statuscode
defaultValue	languageTag displayText attributeValue correlatedValue en Open 1 0 en Draft 2 0 en Received 3 1 en Sent 4 1 en Canceled 5 2

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

Parameter	Value	Data type	Explanation
default	languageTag displayText attributeValue correlatedValue en Open 1 0 en Draft 2 0 en Received 3 1 en Sent 4 1 en Canceled 5 2	any

is.correlatedWith
the attribute value is correlated with the sourceAttribute

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Status Reason	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Select the letter's status.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"statuscode"	string

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

Parameter	Value	Data type	Explanation
ordinal	"23"	integer

is.dataFormat.integer

statusCode_display

First included in: applicationCommon/Letter (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

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

Parameter	Value	Data type	Explanation
inSupportOf	"statusCode"	attributeName	output 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

Name	Value
displayName	Activity Status
description	Shows whether the letter is open, completed, or canceled. Completed and canceled letters are read-only and can't be edited.
dataFormat	int32
sourceName	statecode
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue en Open 0 en Completed 1 en Canceled 2

Traits

List of traits for the stateCode attribute are listed below.

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

Parameter	Value	Data type	Explanation
default	languageTag displayText attributeValue en Open 0 en Completed 1 en Canceled 2	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.

Parameter	Value	Data type	Explanation
attribute	Letter/(resolvedAttributes)/stateCode	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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Activity Status	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shows whether the letter is open, completed, or canceled. Completed and canceled letters are read-only and can't be edited.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"statecode"	string

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

Parameter	Value	Data type	Explanation
ordinal	"28"	integer

is.dataFormat.integer

stateCode_display

First included in: applicationCommon/Letter (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

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

Parameter	Value	Data type	Explanation
inSupportOf	"stateCode"	attributeName	output 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

Name	Value
displayName	Description
description	Type the letter body or additional information to describe the letter, such as the primary message or the products and services described.
dataFormat	string
maximumLength	2000
isNullable	true
sourceName	description

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Description	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Type the letter body or additional information to describe the letter, such as the primary message or the products and services described.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"description"	string

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

Parameter	Value	Data type	Explanation
ordinal	"29"	integer

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Currency
description	Choose the local currency for the record to make sure budgets are reported in the correct currency.
dataFormat	guid
isNullable	true
sourceName	transactioncurrencyid

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Currency	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Choose the local currency for the record to make sure budgets are reported in the correct currency.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/Currency.cdm.json/Currency transactionCurrencyId	entity	a 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.

Parameter	Value	Data type	Explanation
name	"transactioncurrencyid"	string

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

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Exchange Rate
description	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.
dataFormat	decimal
maximumValue	100000000000
minimumValue	1E-10
isNullable	true
sourceName	exchangerate

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Exchange Rate	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en 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.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"exchangerate"	string

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

Parameter	Value	Data type	Explanation
ordinal	"75"	integer

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Process
description	Shows the ID of the process.
dataFormat	guid
isNullable	true
sourceName	processid

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Process	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shows the ID of the process.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"processid"	string

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

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Process Stage
description	Shows the ID of the stage.
dataFormat	guid
isNullable	true
sourceName	stageid

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Process Stage	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shows the ID of the stage.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"stageid"	string

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

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Traversed Path
description	For internal use only.
dataFormat	string
maximumLength	1250
isNullable	true
sourceName	traversedpath

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Traversed Path	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en For internal use only.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"traversedpath"	string

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

Parameter	Value	Data type	Explanation
ordinal	"78"	integer

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	SLA
description	Choose the service level agreement (SLA) that you want to apply to the Letter record.
dataFormat	guid
isNullable	true
sourceName	slaid

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en SLA	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Choose the service level agreement (SLA) that you want to apply to the Letter record.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/SLA.cdm.json/SLA SLAId	entity	a 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.

Parameter	Value	Data type	Explanation
name	"slaid"	string

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

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Last SLA applied
description	Last SLA that was applied to this Letter. This field is for internal use only.
dataFormat	guid
isNullable	true
sourceName	slainvokedid

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Last SLA applied	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Last SLA that was applied to this Letter. This field is for internal use only.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/SLA.cdm.json/SLA SLAId	entity	a 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.

Parameter	Value	Data type	Explanation
name	"slainvokedid"	string

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

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	On Hold Time (Minutes)
description	Shows how long, in minutes, that the record was on hold.
dataFormat	int32
maximumValue	2147483647
minimumValue	-2147483648
isNullable	true
sourceName	onholdtime

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en On Hold Time (Minutes)	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shows how long, in minutes, that the record was on hold.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"onholdtime"	string

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

Parameter	Value	Data type	Explanation
ordinal	"81"	integer

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Name	Value
displayName	Last On Hold Time
description	Contains the date and time stamp of the last on hold time.
dataFormat	dateTime
isNullable	true
sourceName	lastonholdtime

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Last On Hold Time	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Contains the date and time stamp of the last on hold time.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"lastonholdtime"	string

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

Parameter	Value	Data type	Explanation
ordinal	"82"	integer

is.dataFormat.time
is.dataFormat.date