Campaign Activity in crmCommon
Task performed, or to be performed, by a user for planning or running a campaign.
Latest version of the JSON entity definition is available on GitHub.
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 |
| entity |
is.ordered
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | [CampaignActivity/(resolvedAttributes)/sortDate](#sortDate) | attribute |
means.entityState
the attribute represents the current state of the entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | CampaignActivity/(resolvedAttributes)/stateCode | attribute |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 | "CampaignActivity" | string |
Attributes
| Name | Description | First Included in Instance |
|---|---|---|
| createdOn | Date and time when the record was created. | crmCommon/CampaignActivity |
| createdBy | Shows who created the record. | crmCommon/CampaignActivity |
| modifiedOn | Date and time when the record was modified. | crmCommon/CampaignActivity |
| modifiedBy | Shows who last updated the record. | crmCommon/CampaignActivity |
| createdOnBehalfBy | Shows who created the record on behalf of another user. | crmCommon/CampaignActivity |
| modifiedOnBehalfBy | Shows who last updated the record on behalf of another user. | crmCommon/CampaignActivity |
| overriddenCreatedOn | Date and time that the record was migrated. | crmCommon/CampaignActivity |
| importSequenceNumber | Unique identifier of the data import or data migration that created this record. | crmCommon/CampaignActivity |
| ownerId | Owner Id | crmCommon/CampaignActivity |
| ownerIdType | The type of owner, either User or Team. | crmCommon/CampaignActivity |
| owningBusinessUnit | Unique identifier for the business unit that owns the record | crmCommon/CampaignActivity |
| owningUser | Unique identifier of the user that owns the activity. | crmCommon/CampaignActivity |
| owningTeam | Unique identifier for the team that owns the record. | crmCommon/CampaignActivity |
| timeZoneRuleVersionNumber | For internal use only. | crmCommon/CampaignActivity |
| UTCConversionTimeZoneCode | Time zone code that was in use when the record was created. | crmCommon/CampaignActivity |
| versionNumber | Version Number | crmCommon/CampaignActivity |
| activityId | Unique identifier of the activity. | crmCommon/CampaignActivity |
| activityTypeCode | Type of activity. | crmCommon/CampaignActivity |
| isBilled | Information regarding whether the fax activity was billed as part of resolving a case. | crmCommon/CampaignActivity |
| isRegularActivity | Information regarding whether the activity is a regular activity type or event type. | crmCommon/CampaignActivity |
| isWorkflowCreated | Information regarding whether the activity was created from a workflow rule. | crmCommon/CampaignActivity |
| priorityCode | Priority of the activity. | crmCommon/CampaignActivity |
| priorityCode_display | crmCommon/CampaignActivity | |
| regardingObjectId | Unique identifier of the object with which the activity is associated. | crmCommon/CampaignActivity |
| regardingObjectTypeCode | The name of the entity linked by regardingObjectId | crmCommon/CampaignActivity |
| scheduledEnd | Scheduled end time of the activity. | crmCommon/CampaignActivity |
| scheduledStart | Scheduled start time of the activity. | crmCommon/CampaignActivity |
| sortDate | Shows the date and time by which the activities are sorted. | crmCommon/CampaignActivity |
| subject | Subject associated with the activity. | crmCommon/CampaignActivity |
| scheduledDurationMinutes | Scheduled duration of the activity, specified in minutes. | crmCommon/CampaignActivity |
| actualDurationMinutes | Actual duration of the activity in minutes. | crmCommon/CampaignActivity |
| actualEnd | Actual end time of the activity. | crmCommon/CampaignActivity |
| actualStart | Actual start time of the activity. | crmCommon/CampaignActivity |
| 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. | crmCommon/CampaignActivity |
| subcategory | Type a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function. | crmCommon/CampaignActivity |
| activityAdditionalParams | Additional information provided by the external application as JSON. For internal use only. | crmCommon/CampaignActivity |
| to | Enter the account, contact, lead, or user recipients of the phone call. | crmCommon/CampaignActivity |
| from | The sender of the activity. | crmCommon/CampaignActivity |
| instanceTypeCode | Type of instance of a recurring series. | crmCommon/CampaignActivity |
| instanceTypeCode_display | crmCommon/CampaignActivity | |
| isMapiPrivate | For internal use only. | crmCommon/CampaignActivity |
| organizer | The user who is in charge of coordinating or leading the activity. | crmCommon/CampaignActivity |
| requiredAttendees | Enter the account, contact, lead, user, or other equipment resources that are required to attend the appointment. | crmCommon/CampaignActivity |
| optionalAttendees | Enter the account, contact, lead, user, or other equipment resources that are not needed at the appointment, but can optionally attend. | crmCommon/CampaignActivity |
| seriesId | Uniqueidentifier specifying the id of recurring series of an instance. | crmCommon/CampaignActivity |
| BCC | Enter the recipients that are included on the activity distribution, but are not displayed to other recipients. | crmCommon/CampaignActivity |
| CC | Enter the recipients that should be copied on the activity. | crmCommon/CampaignActivity |
| sentOn | Date and time when the activity was sent. | crmCommon/CampaignActivity |
| senderMailboxId | Unique identifier of the mailbox associated with the sender of the email message. | crmCommon/CampaignActivity |
| deliveryPriorityCode | Priority of delivery of the activity to the email server. | crmCommon/CampaignActivity |
| deliveryPriorityCode_display | crmCommon/CampaignActivity | |
| resources | Users or facility/equipment that are required for the activity. | crmCommon/CampaignActivity |
| community | Shows how contact about the activity originated, such as from Twitter or Facebook. This field is read-only. | crmCommon/CampaignActivity |
| community_display | crmCommon/CampaignActivity | |
| leftVoiceMail | Left the voice mail | crmCommon/CampaignActivity |
| deliveryLastAttemptedOn | Date and time when the delivery of the activity was last attempted. | crmCommon/CampaignActivity |
| exchangeItemId | The message id of activity which is returned from Exchange Server. | crmCommon/CampaignActivity |
| exchangeWebLink | Shows the web link of Activity of type email. | crmCommon/CampaignActivity |
| postponeActivityProcessingUntil | For internal use only. | crmCommon/CampaignActivity |
| customers | Customer with which the activity is associated. | crmCommon/CampaignActivity |
| partners | Outsource vendor with which activity is associated. | crmCommon/CampaignActivity |
| description | Type additional information to describe the campaign activity, such as key talking points, objectives, or details about the target audience. | crmCommon/CampaignActivity |
| stateCode | Shows whether the campaign activity is open, completed, or canceled. Completed and canceled campaign activities are read-only and can't be edited. | crmCommon/CampaignActivity |
| stateCode_display | crmCommon/CampaignActivity | |
| statusCode | Select the campaign activity's status. | crmCommon/CampaignActivity |
| statusCode_display | crmCommon/CampaignActivity | |
| transactionCurrencyId | Choose the local currency for the record to make sure budgets are reported in the correct currency. | crmCommon/CampaignActivity |
| 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. | crmCommon/CampaignActivity |
| traversedPath | For internal use only. | crmCommon/CampaignActivity |
| processId | Unique identifier of the Process. | crmCommon/CampaignActivity |
| stageId | Unique identifier of the Stage. | crmCommon/CampaignActivity |
| SLAId | Choose the service level agreement (SLA) that you want to apply to the case record. | crmCommon/CampaignActivity |
| SLAInvokedId | Last SLA that was applied to this case. This field is for internal use only. | crmCommon/CampaignActivity |
| onHoldTime | Shows how long, in minutes, that the record was on hold. | crmCommon/CampaignActivity |
| lastOnHoldTime | Contains the date and time stamp of the last on hold time. | crmCommon/CampaignActivity |
| actualCost | Type the actual cost of the campaign activity. The value entered is rolled up to the related campaign in the total cost calculations. | crmCommon/CampaignActivity |
| actualCostBase | Value of the Actual Cost in base currency. | crmCommon/CampaignActivity |
| budgetedCost | Type the allocated budget of the campaign activity for estimated versus actual cost reporting. | crmCommon/CampaignActivity |
| budgetedCostBase | Value of the Budget Allocated in base currency. | crmCommon/CampaignActivity |
| channelTypeCode | Select how communications for this activity will be sent, such as phone, letter, fax, or email. | crmCommon/CampaignActivity |
| channelTypeCode_display | crmCommon/CampaignActivity | |
| doNotSendOnOptOut | Select whether to override the opt-out settings on leads, contacts, and accounts for the members of the target marketing lists of the campaign activity. If No is selected, marketing materials will be sent to members who have opted out. | crmCommon/CampaignActivity |
| excludeIfContactedInXDays | Type the minimum number of days that must be passed before a marketing list member can be contacted in a campaign again. The campaign activity will not be applied to members contacted within the specified time period. | crmCommon/CampaignActivity |
| ignoreInactiveListMembers | Select whether inactive marketing list members will be excluded from the campaign activity distribution. | crmCommon/CampaignActivity |
| typeCode | Select the type of campaign activity to indicate the purpose of the activity. | crmCommon/CampaignActivity |
| typeCode_display | crmCommon/CampaignActivity | |
| serviceId | Unique identifier of the associated service. | crmCommon/CampaignActivity |
createdOn
Date and time when the record was created.
First included in: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 | CampaignActivity/(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 |
| 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 |
| 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: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Activity Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description | Type of activity. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataFormat | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isReadOnly | true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sourceName | activitytypecode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| defaultValue |
|
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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Priority | ||||||||||||
| description | Priority of the activity. | ||||||||||||
| dataFormat | int32 | ||||||||||||
| isNullable | true | ||||||||||||
| sourceName | prioritycode | ||||||||||||
| valueConstrainedToList | true | ||||||||||||
| defaultValue |
|
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 |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 | 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 | [CampaignActivity/(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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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
activityAdditionalParams
Additional information provided by the external application as JSON. For internal use only.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Activity Additional Parameters |
| description | Additional information provided by the external application as JSON. For internal use only. |
| dataFormat | json |
| maximumLength | 8192 |
| isNullable | true |
| sourceName | activityadditionalparams |
Traits
List of traits for the activityAdditionalParams attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.content.text.JSON
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 |
| 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 |
| 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 | "activityadditionalparams" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "8192" | integer |
is.dataFormat.array
means.content.text.JSON
to
Enter the account, contact, lead, or user recipients of the phone call.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Call To |
| description | Enter the account, contact, lead, or user recipients of the phone call. |
| 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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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
instanceTypeCode
Type of instance of a recurring series.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Recurring Instance Type | ||||||||||||||||||
| description | Type of instance of a recurring series. | ||||||||||||||||||
| dataFormat | int32 | ||||||||||||||||||
| sourceName | instancetypecode | ||||||||||||||||||
| valueConstrainedToList | true | ||||||||||||||||||
| defaultValue |
|
Traits
List of traits for the instanceTypeCode attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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 | "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 |
| 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 |
| 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 | "instancetypecode" | string |
is.dataFormat.integer
instanceTypeCode_display
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the instanceTypeCode_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 | "instanceTypeCode" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
isMapiPrivate
For internal use only.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Is Private |
| description | For internal use only. |
| dataFormat | boolean |
| isNullable | true |
| sourceName | ismapiprivate |
Traits
List of traits for the isMapiPrivate 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 |
| 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 |
| 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 | "ismapiprivate" | string |
is.dataFormat.boolean
organizer
The user who is in charge of coordinating or leading the activity.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Organizer |
| description | The user who is in charge of coordinating or leading the activity. |
| dataFormat | guid |
| isNullable | true |
| sourceName | organizer |
Traits
List of traits for the organizer 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 |
| 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 |
| 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 | "organizer" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
requiredAttendees
Enter the account, contact, lead, user, or other equipment resources that are required to attend the appointment.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Required Attendees |
| description | Enter the account, contact, lead, user, or other equipment resources that are required to attend the appointment. |
| dataFormat | guid |
| isNullable | true |
| sourceName | requiredattendees |
Traits
List of traits for the requiredAttendees 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 |
| 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 |
| 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 | "requiredattendees" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
optionalAttendees
Enter the account, contact, lead, user, or other equipment resources that are not needed at the appointment, but can optionally attend.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Optional Attendees |
| description | Enter the account, contact, lead, user, or other equipment resources that are not needed at the appointment, but can optionally attend. |
| dataFormat | guid |
| isNullable | true |
| sourceName | optionalattendees |
Traits
List of traits for the optionalAttendees 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 |
| 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 |
| 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 | "optionalattendees" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
seriesId
Uniqueidentifier specifying the id of recurring series of an instance.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Series Id |
| description | Uniqueidentifier specifying the id of recurring series of an instance. |
| dataFormat | guid |
| isNullable | true |
| sourceName | seriesid |
Traits
List of traits for the seriesId 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 |
| 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 |
| 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 | "seriesid" | 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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
sentOn
Date and time when the activity was sent.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Date Sent |
| description | Date and time when the activity was sent. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | senton |
Traits
List of traits for the sentOn 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 |
| 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 |
| 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 | "senton" | string |
is.dataFormat.time
is.dataFormat.date
senderMailboxId
Unique identifier of the mailbox associated with the sender of the email message.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Sender's Mailbox |
| description | Unique identifier of the mailbox associated with the sender of the email message. |
| dataFormat | guid |
| isNullable | true |
| sourceName | sendermailboxid |
Traits
List of traits for the senderMailboxId 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 |
| 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 |
| 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 | "sendermailboxid" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
deliveryPriorityCode
Priority of delivery of the activity to the email server.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Delivery Priority | ||||||||||||
| description | Priority of delivery of the activity to the email server. | ||||||||||||
| dataFormat | int32 | ||||||||||||
| isNullable | true | ||||||||||||
| sourceName | deliveryprioritycode | ||||||||||||
| valueConstrainedToList | true | ||||||||||||
| defaultValue |
|
Traits
List of traits for the deliveryPriorityCode attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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 |
| 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 |
| 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 | "deliveryprioritycode" | string |
is.dataFormat.integer
deliveryPriorityCode_display
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the deliveryPriorityCode_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 | "deliveryPriorityCode" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
resources
Users or facility/equipment that are required for the activity.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Resources |
| description | Users or facility/equipment that are required for the activity. |
| dataFormat | guid |
| isNullable | true |
| sourceName | resources |
Traits
List of traits for the resources 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 |
| 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 |
| 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 | "resources" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
community
Shows how contact about the activity originated, such as from Twitter or Facebook. This field is read-only.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Social Channel | ||||||||||||
| description | Shows how contact about the activity originated, such as from Twitter or Facebook. This field is read-only. | ||||||||||||
| dataFormat | int32 | ||||||||||||
| isNullable | true | ||||||||||||
| sourceName | community | ||||||||||||
| valueConstrainedToList | true | ||||||||||||
| defaultValue |
|
Traits
List of traits for the community attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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 |
| 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 |
| 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 | "community" | string |
is.dataFormat.integer
community_display
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the community_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 | "community" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
leftVoiceMail
Left the voice mail
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Left Voice Mail |
| description | Left the voice mail |
| dataFormat | boolean |
| isNullable | true |
| sourceName | leftvoicemail |
Traits
List of traits for the leftVoiceMail 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 |
| 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 |
| 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 | "leftvoicemail" | string |
is.dataFormat.boolean
deliveryLastAttemptedOn
Date and time when the delivery of the activity was last attempted.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Date Delivery Last Attempted |
| description | Date and time when the delivery of the activity was last attempted. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | deliverylastattemptedon |
Traits
List of traits for the deliveryLastAttemptedOn 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 |
| 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 |
| 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 | "deliverylastattemptedon" | string |
is.dataFormat.time
is.dataFormat.date
exchangeItemId
The message id of activity which is returned from Exchange Server.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Exchange Item ID |
| description | The message id of activity which is returned from Exchange Server. |
| dataFormat | string |
| maximumLength | 200 |
| isNullable | true |
| sourceName | exchangeitemid |
Traits
List of traits for the exchangeItemId 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 |
| 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 |
| 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 | "exchangeitemid" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "200" | integer |
is.dataFormat.character
is.dataFormat.array
exchangeWebLink
Shows the web link of Activity of type email.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Exchange WebLink |
| description | Shows the web link of Activity of type email. |
| dataFormat | string |
| maximumLength | 1250 |
| isNullable | true |
| sourceName | exchangeweblink |
Traits
List of traits for the exchangeWebLink attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.URL
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 |
| 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 |
| 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 | "exchangeweblink" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "1250" | integer |
is.dataFormat.character
is.dataFormat.array
postponeActivityProcessingUntil
For internal use only.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Delay activity processing until |
| description | For internal use only. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | postponeactivityprocessinguntil |
Traits
List of traits for the postponeActivityProcessingUntil 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 |
| 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 |
| 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 | "postponeactivityprocessinguntil" | string |
is.dataFormat.time
is.dataFormat.date
customers
Customer with which the activity is associated.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Customers |
| description | Customer with which the activity is associated. |
| dataFormat | guid |
| isNullable | true |
| sourceName | customers |
Traits
List of traits for the customers 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 |
| 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 |
| 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 | "customers" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
partners
Outsource vendor with which activity is associated.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Outsource Vendors |
| description | Outsource vendor with which activity is associated. |
| dataFormat | guid |
| isNullable | true |
| sourceName | partners |
Traits
List of traits for the partners 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 |
| 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 |
| 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 | "partners" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
description
Type additional information to describe the campaign activity, such as key talking points, objectives, or details about the target audience.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Description |
| description | Type additional information to describe the campaign activity, such as key talking points, objectives, or details about the target audience. |
| 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 |
| 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 |
| 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 | "10006" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2000" | integer |
is.dataFormat.character
is.dataFormat.array
stateCode
Shows whether the campaign activity is open, completed, or canceled. Completed and canceled campaign activities are read-only and can't be edited.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status | ||||||||||||
| description | Shows whether the campaign activity is open, completed, or canceled. Completed and canceled campaign activities are read-only and can't be edited. | ||||||||||||
| dataFormat | int32 | ||||||||||||
| sourceName | statecode | ||||||||||||
| valueConstrainedToList | true | ||||||||||||
| defaultValue |
|
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 |
| 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 | CampaignActivity/(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 |
| 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 |
| 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 | "10009" | integer |
is.dataFormat.integer
stateCode_display
First included in: crmCommon/CampaignActivity (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
statusCode
Select the campaign activity's status.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status Reason | ||||||||||||||||||||||||||||||||
| description | Select the campaign activity's status. | ||||||||||||||||||||||||||||||||
| dataFormat | int32 | ||||||||||||||||||||||||||||||||
| isNullable | true | ||||||||||||||||||||||||||||||||
| sourceName | statuscode | ||||||||||||||||||||||||||||||||
| defaultValue |
|
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 |
| 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 |
| 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 |
| 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 | "10013" | integer |
is.dataFormat.integer
statusCode_display
First included in: crmCommon/CampaignActivity (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
transactionCurrencyId
Choose the local currency for the record to make sure budgets are reported in the correct currency.
First included in: crmCommon/CampaignActivity (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 |
| 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 |
| 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 |
| 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 | "10032" | 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 | "10033" | 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
traversedPath
For internal use only.
First included in: crmCommon/CampaignActivity (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 |
| 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 |
| 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 | "10036" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "1250" | integer |
is.dataFormat.character
is.dataFormat.array
processId
Unique identifier of the Process.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Process |
| description | Unique identifier 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 |
| 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 |
| 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 | "10045" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
stageId
Unique identifier of the Stage.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Process Stage |
| description | Unique identifier 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 |
| 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 |
| 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 | "10046" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
SLAId
Choose the service level agreement (SLA) that you want to apply to the case record.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | SLA |
| description | Choose the service level agreement (SLA) that you want to apply to the case 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 |
| 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 |
| 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 |
| 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 | "10048" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
SLAInvokedId
Last SLA that was applied to this case. This field is for internal use only.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Last SLA applied |
| description | Last SLA that was applied to this case. 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 |
| 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 |
| 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 |
| 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 | "10049" | 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 | "10050" | 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: crmCommon/CampaignActivity (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 |
| 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 |
| 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 | "10051" | integer |
is.dataFormat.time
is.dataFormat.date
actualCost
Type the actual cost of the campaign activity. The value entered is rolled up to the related campaign in the total cost calculations.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Actual Cost |
| description | Type the actual cost of the campaign activity. The value entered is rolled up to the related campaign in the total cost calculations. |
| dataFormat | decimal |
| maximumValue | 1000000000000 |
| minimumValue | 0 |
| isNullable | true |
| sourceName | actualcost |
Traits
List of traits for the actualCost attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "19" | integer | the total number of significant digits |
| scale | "4" | integer | the number of digits to the right of the decimal place |
means.measurement.currency
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 |
| 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 |
| 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 | "actualcost" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10101" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "0" | decimal | |
| maximumValue | "1000000000000" | decimal |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
actualCostBase
Value of the Actual Cost in base currency.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Actual Cost (Base) |
| description | Value of the Actual Cost in base currency. |
| dataFormat | decimal |
| maximumValue | 922337203685477 |
| minimumValue | -922337203685477 |
| isNullable | true |
| sourceName | actualcost_base |
Traits
List of traits for the actualCostBase attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "19" | integer | the total number of significant digits |
| scale | "4" | integer | the number of digits to the right of the decimal place |
means.measurement.currency
is.calculationOf
the attribute value is the result of a calculation on the sourceAttribute
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| sourceAttribute | "actualCost" | 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 |
| 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 |
| 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 | "actualcost_base" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10102" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-922337203685477" | decimal | |
| maximumValue | "922337203685477" | decimal |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
budgetedCost
Type the allocated budget of the campaign activity for estimated versus actual cost reporting.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Budget Allocated |
| description | Type the allocated budget of the campaign activity for estimated versus actual cost reporting. |
| dataFormat | decimal |
| maximumValue | 1000000000000 |
| minimumValue | 0 |
| isNullable | true |
| sourceName | budgetedcost |
Traits
List of traits for the budgetedCost attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "19" | integer | the total number of significant digits |
| scale | "4" | integer | the number of digits to the right of the decimal place |
means.measurement.currency
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 |
| 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 |
| 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 | "budgetedcost" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10103" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "0" | decimal | |
| maximumValue | "1000000000000" | decimal |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
budgetedCostBase
Value of the Budget Allocated in base currency.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Budget Allocated (Base) |
| description | Value of the Budget Allocated in base currency. |
| dataFormat | decimal |
| maximumValue | 922337203685477 |
| minimumValue | -922337203685477 |
| isNullable | true |
| sourceName | budgetedcost_base |
Traits
List of traits for the budgetedCostBase attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "19" | integer | the total number of significant digits |
| scale | "4" | integer | the number of digits to the right of the decimal place |
means.measurement.currency
is.calculationOf
the attribute value is the result of a calculation on the sourceAttribute
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| sourceAttribute | "budgetedCost" | 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 |
| 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 |
| 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 | "budgetedcost_base" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10104" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-922337203685477" | decimal | |
| maximumValue | "922337203685477" | decimal |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
channelTypeCode
Select how communications for this activity will be sent, such as phone, letter, fax, or email.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Channel | ||||||||||||||||||||||||||||||
| description | Select how communications for this activity will be sent, such as phone, letter, fax, or email. | ||||||||||||||||||||||||||||||
| dataFormat | int32 | ||||||||||||||||||||||||||||||
| isNullable | true | ||||||||||||||||||||||||||||||
| sourceName | channeltypecode | ||||||||||||||||||||||||||||||
| valueConstrainedToList | true | ||||||||||||||||||||||||||||||
| defaultValue |
|
Traits
List of traits for the channelTypeCode attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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 |
| 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 |
| 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 | "channeltypecode" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10106" | integer |
is.dataFormat.integer
channelTypeCode_display
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the channelTypeCode_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 | "channelTypeCode" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
doNotSendOnOptOut
Select whether to override the opt-out settings on leads, contacts, and accounts for the members of the target marketing lists of the campaign activity. If No is selected, marketing materials will be sent to members who have opted out.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Exclude Members Who Opt Out |
| description | Select whether to override the opt-out settings on leads, contacts, and accounts for the members of the target marketing lists of the campaign activity. If No is selected, marketing materials will be sent to members who have opted out. |
| dataFormat | boolean |
| isNullable | true |
| sourceName | donotsendonoptout |
Traits
List of traits for the doNotSendOnOptOut 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 |
| 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 |
| 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 | "donotsendonoptout" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10108" | integer |
is.dataFormat.boolean
excludeIfContactedInXDays
Type the minimum number of days that must be passed before a marketing list member can be contacted in a campaign again. The campaign activity will not be applied to members contacted within the specified time period.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | No. of Days |
| description | Type the minimum number of days that must be passed before a marketing list member can be contacted in a campaign again. The campaign activity will not be applied to members contacted within the specified time period. |
| dataFormat | int32 |
| maximumValue | 9999 |
| minimumValue | 0 |
| isNullable | true |
| sourceName | excludeifcontactedinxdays |
Traits
List of traits for the excludeIfContactedInXDays 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 |
| 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 |
| 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 | "excludeifcontactedinxdays" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10110" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "0" | decimal | |
| maximumValue | "9999" | decimal |
is.dataFormat.integer
ignoreInactiveListMembers
Select whether inactive marketing list members will be excluded from the campaign activity distribution.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Ignore Inactive Marketing List Members |
| description | Select whether inactive marketing list members will be excluded from the campaign activity distribution. |
| dataFormat | boolean |
| isNullable | true |
| sourceName | ignoreinactivelistmembers |
Traits
List of traits for the ignoreInactiveListMembers 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 |
| 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 |
| 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 | "ignoreinactivelistmembers" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10111" | integer |
is.dataFormat.boolean
typeCode
Select the type of campaign activity to indicate the purpose of the activity.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Type | |||||||||||||||||||||||||||
| description | Select the type of campaign activity to indicate the purpose of the activity. | |||||||||||||||||||||||||||
| dataFormat | int32 | |||||||||||||||||||||||||||
| isNullable | true | |||||||||||||||||||||||||||
| sourceName | typecode | |||||||||||||||||||||||||||
| valueConstrainedToList | true | |||||||||||||||||||||||||||
| defaultValue |
|
Traits
List of traits for the typeCode attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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 |
| 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 |
| 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 | "typecode" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10114" | integer |
is.dataFormat.integer
typeCode_display
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the typeCode_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 | "typeCode" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
serviceId
Unique identifier of the associated service.
First included in: crmCommon/CampaignActivity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Service |
| description | Unique identifier of the associated service. |
| dataFormat | guid |
| isNullable | true |
| sourceName | serviceid |
Traits
List of traits for the serviceId 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 |
| 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 |
| 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 | "serviceid" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10116" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array