Campaign in crmCommon
Container for campaign activities and responses, sales literature, products, and lists to create, plan, execute, and track the results of a specific marketing campaign through its life.
Latest version of the JSON entity definition is available on GitHub.
Instances
Entities that inherit from the currently viewed entity are listed below.
Traits
Traits for this entity are listed below.
is.CDM.entityVersion
| 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.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | Campaign/(resolvedAttributes)/campaignId | attribute |
means.entityState
the attribute represents the current state of the entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | Campaign/(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 | "Campaign" | string |
Attributes
| Name | Description | First Included in Instance |
|---|---|---|
| createdOn | Date and time when the record was created. | crmCommon/Campaign |
| createdBy | Shows who created the record. | crmCommon/Campaign |
| modifiedOn | Date and time when the record was modified. | crmCommon/Campaign |
| modifiedBy | Shows who last updated the record. | crmCommon/Campaign |
| createdOnBehalfBy | Shows who created the record on behalf of another user. | crmCommon/Campaign |
| modifiedOnBehalfBy | Shows who last updated the record on behalf of another user. | crmCommon/Campaign |
| overriddenCreatedOn | Date and time that the record was migrated. | crmCommon/Campaign |
| importSequenceNumber | Unique identifier of the data import or data migration that created this record. | crmCommon/Campaign |
| ownerId | Owner Id | crmCommon/Campaign |
| ownerIdType | The type of owner, either User or Team. | crmCommon/Campaign |
| owningBusinessUnit | Unique identifier for the business unit that owns the record | crmCommon/Campaign |
| owningUser | Unique identifier of the user that owns the activity. | crmCommon/Campaign |
| owningTeam | Unique identifier for the team that owns the record. | crmCommon/Campaign |
| timeZoneRuleVersionNumber | For internal use only. | crmCommon/Campaign |
| UTCConversionTimeZoneCode | Time zone code that was in use when the record was created. | crmCommon/Campaign |
| versionNumber | Version Number | crmCommon/Campaign |
| campaignId | Unique identifier of the campaign. | crmCommon/Campaign |
| emailAddress | The primary email address for the entity. | crmCommon/Campaign |
| name | Type a name for the campaign so that it is identified correctly in lists. | crmCommon/Campaign |
| processId | Contains the id of the process associated with the entity. | crmCommon/Campaign |
| stageId | Contains the id of the stage where the entity is located. | crmCommon/Campaign |
| traversedPath | A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur. | crmCommon/Campaign |
| actualEnd | Enter the date when the campaign was closed or completed. | crmCommon/Campaign |
| actualStart | Enter the actual start date and time for the campaign. | crmCommon/Campaign |
| budgetedCost | Type the amount budgeted for the campaign to define a limit for how much you can spend. | crmCommon/Campaign |
| transactionCurrencyId | Choose the local currency for the record to make sure budgets are reported in the correct currency. | crmCommon/Campaign |
| 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/Campaign |
| budgetedCostBase | Value of the Budget Allocated in base currency. | crmCommon/Campaign |
| codeName | Type a number or other tracking code to identify the campaign. If no value is entered, a code will be generated automatically. | crmCommon/Campaign |
| description | Type additional information to describe the campaign, such as the products or services offered or the targeted audience. | crmCommon/Campaign |
| expectedResponse | Type the expected response rate for the campaign as a full number between 0 and 100. | crmCommon/Campaign |
| expectedRevenue | Type the expected revenue for the campaign for return on investment projections and post-campaign reporting. | crmCommon/Campaign |
| expectedRevenueBase | Value of the Estimated Revenue in base currency. | crmCommon/Campaign |
| isTemplate | Select whether the campaign is a template that can be copied when you create future campaigns. | crmCommon/Campaign |
| message | Type the promotional message or marketing copy for the campaign. | crmCommon/Campaign |
| objective | Type the objective of the campaign, including products, services, discounts, and pricing. | crmCommon/Campaign |
| otherCost | Type the sum of any miscellaneous campaign costs not included in the campaign activities to make sure the actual cost of the campaign is calculated correctly. | crmCommon/Campaign |
| otherCostBase | Value of the Miscellaneous Costs in base currency. | crmCommon/Campaign |
| promotionCodeName | Type a promotional code to track sales related to the campaign or allow customers to redeem a discount offer. | crmCommon/Campaign |
| proposedEnd | Enter the date when the campaign is scheduled to end. | crmCommon/Campaign |
| proposedStart | Enter the date when the campaign is scheduled to start. | crmCommon/Campaign |
| stateCode | Shows the status of the campaign. By default, campaigns are active and can't be deactivated. | crmCommon/Campaign |
| stateCode_display | crmCommon/Campaign | |
| statusCode | Select the campaign's status. | crmCommon/Campaign |
| statusCode_display | crmCommon/Campaign | |
| totalActualCost | Shows the sum of the amounts entered in the Total Cost of Campaign Activities and Miscellaneous Costs fields. | crmCommon/Campaign |
| totalActualCostBase | Value of the Total Cost of Campaign in base currency. | crmCommon/Campaign |
| totalCampaignActivityActualCost | Shows the sum of the values entered in the Actual Cost field on all campaign activities related to the campaign. | crmCommon/Campaign |
| totalCampaignActivityActualCostBase | Value of the Total Cost of Campaign Activities in base currency. | crmCommon/Campaign |
| typeCode | Select the type of the campaign. | crmCommon/Campaign |
| typeCode_display | crmCommon/Campaign | |
| priceListId | Choose the price list associated with this item to make sure the products associated with the campaign are offered at the correct prices. | crmCommon/Campaign |
| entityImageId | crmCommon/Campaign |
createdOn
Date and time when the record was created.
First included in: crmCommon/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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/Campaign (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
campaignId
Unique identifier of the campaign.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Campaign |
| description | Unique identifier of the campaign. |
| isPrimaryKey | true |
| dataFormat | guid |
| sourceName | campaignid |
Traits
List of traits for the campaignId 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 | Campaign/(resolvedAttributes)/campaignId | 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 | "campaignid" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10000" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
emailAddress
The primary email address for the entity.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Email Address |
| description | The primary email address for the entity. |
| dataFormat | string |
| maximumLength | 100 |
| isNullable | true |
| sourceName | emailaddress |
Traits
List of traits for the emailAddress attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.identity.service.email
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 | "emailaddress" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10024" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "100" | integer |
is.dataFormat.character
is.dataFormat.array
name
Type a name for the campaign so that it is identified correctly in lists.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Name |
| description | Type a name for the campaign so that it is identified correctly in lists. |
| dataFormat | string |
| maximumLength | 128 |
| sourceName | name |
Traits
List of traits for the name attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.identity.name
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 | "name" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10029" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "128" | integer |
is.dataFormat.character
is.dataFormat.array
processId
Contains the id of the process associated with the entity.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Process Id |
| description | Contains the id of the process associated with the entity. |
| 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 | "10030" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
stageId
Contains the id of the stage where the entity is located.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Stage Id |
| description | Contains the id of the stage where the entity is located. |
| 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 | "10031" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
traversedPath
A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Traversed Path |
| description | A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur. |
| 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 | "10032" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "1250" | integer |
is.dataFormat.character
is.dataFormat.array
actualEnd
Enter the date when the campaign was closed or completed.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Actual End Date |
| description | Enter the date when the campaign was closed or completed. |
| 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
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.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10033" | integer |
is.dataFormat.time
is.dataFormat.date
actualStart
Enter the actual start date and time for the campaign.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Actual Start Date |
| description | Enter the actual start date and time for the campaign. |
| 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
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.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10034" | integer |
is.dataFormat.time
is.dataFormat.date
budgetedCost
Type the amount budgeted for the campaign to define a limit for how much you can spend.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Budget Allocated |
| description | Type the amount budgeted for the campaign to define a limit for how much you can spend. |
| 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 | "10035" | 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
transactionCurrencyId
Choose the local currency for the record to make sure budgets are reported in the correct currency.
First included in: crmCommon/Campaign (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 | "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.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 | "10036" | 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/Campaign (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 | "10038" | 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
budgetedCostBase
Value of the Budget Allocated in base currency.
First included in: crmCommon/Campaign (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 | "10039" | 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
codeName
Type a number or other tracking code to identify the campaign. If no value is entered, a code will be generated automatically.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Campaign Code |
| description | Type a number or other tracking code to identify the campaign. If no value is entered, a code will be generated automatically. |
| dataFormat | string |
| maximumLength | 32 |
| isNullable | true |
| sourceName | codename |
Traits
List of traits for the codeName attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.identity.name
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 | "codename" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10040" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "32" | integer |
is.dataFormat.character
is.dataFormat.array
description
Type additional information to describe the campaign, such as the products or services offered or the targeted audience.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Description |
| description | Type additional information to describe the campaign, such as the products or services offered or the targeted 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 | "10041" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2000" | integer |
is.dataFormat.character
is.dataFormat.array
expectedResponse
Type the expected response rate for the campaign as a full number between 0 and 100.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Expected Response Percentage |
| description | Type the expected response rate for the campaign as a full number between 0 and 100. |
| dataFormat | int32 |
| maximumValue | 100 |
| minimumValue | 0 |
| isNullable | true |
| sourceName | expectedresponse |
Traits
List of traits for the expectedResponse 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 | "expectedresponse" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10042" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "0" | decimal | |
| maximumValue | "100" | decimal |
is.dataFormat.integer
expectedRevenue
Type the expected revenue for the campaign for return on investment projections and post-campaign reporting.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Estimated Revenue |
| description | Type the expected revenue for the campaign for return on investment projections and post-campaign reporting. |
| dataFormat | decimal |
| maximumValue | 1000000000000 |
| minimumValue | 0 |
| isNullable | true |
| sourceName | expectedrevenue |
Traits
List of traits for the expectedRevenue 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 | "expectedrevenue" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10043" | 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
expectedRevenueBase
Value of the Estimated Revenue in base currency.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Estimated Revenue (Base) |
| description | Value of the Estimated Revenue in base currency. |
| dataFormat | decimal |
| maximumValue | 922337203685477 |
| minimumValue | -922337203685477 |
| isNullable | true |
| sourceName | expectedrevenue_base |
Traits
List of traits for the expectedRevenueBase 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 | "expectedRevenue" | 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 | "expectedrevenue_base" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10044" | 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
isTemplate
Select whether the campaign is a template that can be copied when you create future campaigns.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Template |
| description | Select whether the campaign is a template that can be copied when you create future campaigns. |
| dataFormat | boolean |
| isNullable | true |
| sourceName | istemplate |
Traits
List of traits for the isTemplate 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 | "istemplate" | 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.boolean
message
Type the promotional message or marketing copy for the campaign.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Message |
| description | Type the promotional message or marketing copy for the campaign. |
| dataFormat | string |
| maximumLength | 256 |
| isNullable | true |
| sourceName | message |
Traits
List of traits for the message 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 | "message" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10047" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "256" | integer |
is.dataFormat.character
is.dataFormat.array
objective
Type the objective of the campaign, including products, services, discounts, and pricing.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Offer |
| description | Type the objective of the campaign, including products, services, discounts, and pricing. |
| dataFormat | string |
| maximumLength | 2000 |
| isNullable | true |
| sourceName | objective |
Traits
List of traits for the objective 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 | "objective" | 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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2000" | integer |
is.dataFormat.character
is.dataFormat.array
otherCost
Type the sum of any miscellaneous campaign costs not included in the campaign activities to make sure the actual cost of the campaign is calculated correctly.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Miscellaneous Costs |
| description | Type the sum of any miscellaneous campaign costs not included in the campaign activities to make sure the actual cost of the campaign is calculated correctly. |
| dataFormat | decimal |
| maximumValue | 1000000000000 |
| minimumValue | 0 |
| isNullable | true |
| sourceName | othercost |
Traits
List of traits for the otherCost 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 | "othercost" | 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.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
otherCostBase
Value of the Miscellaneous Costs in base currency.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Miscellaneous Costs (Base) |
| description | Value of the Miscellaneous Costs in base currency. |
| dataFormat | decimal |
| maximumValue | 922337203685477 |
| minimumValue | -922337203685477 |
| isNullable | true |
| sourceName | othercost_base |
Traits
List of traits for the otherCostBase 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 | "otherCost" | 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 | "othercost_base" | 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 | "-922337203685477" | decimal | |
| maximumValue | "922337203685477" | decimal |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
promotionCodeName
Type a promotional code to track sales related to the campaign or allow customers to redeem a discount offer.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Promotion Code |
| description | Type a promotional code to track sales related to the campaign or allow customers to redeem a discount offer. |
| dataFormat | string |
| maximumLength | 128 |
| isNullable | true |
| sourceName | promotioncodename |
Traits
List of traits for the promotionCodeName attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.identity.name
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 | "promotioncodename" | 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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "128" | integer |
is.dataFormat.character
is.dataFormat.array
proposedEnd
Enter the date when the campaign is scheduled to end.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Proposed End Date |
| description | Enter the date when the campaign is scheduled to end. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | proposedend |
Traits
List of traits for the proposedEnd 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 | "proposedend" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10052" | integer |
is.dataFormat.time
is.dataFormat.date
proposedStart
Enter the date when the campaign is scheduled to start.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Proposed Start Date |
| description | Enter the date when the campaign is scheduled to start. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | proposedstart |
Traits
List of traits for the proposedStart 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 | "proposedstart" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10053" | integer |
is.dataFormat.time
is.dataFormat.date
stateCode
Shows the status of the campaign. By default, campaigns are active and can't be deactivated.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status | |||||||||
| description | Shows the status of the campaign. By default, campaigns are active and can't be deactivated. | |||||||||
| 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 | Campaign/(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 | "10054" | integer |
is.dataFormat.integer
stateCode_display
First included in: crmCommon/Campaign (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's status.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status Reason | ||||||||||||||||||||||||||||||||
| description | Select the campaign'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 | "10056" | integer |
is.dataFormat.integer
statusCode_display
First included in: crmCommon/Campaign (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
totalActualCost
Shows the sum of the amounts entered in the Total Cost of Campaign Activities and Miscellaneous Costs fields.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total Cost of Campaign |
| description | Shows the sum of the amounts entered in the Total Cost of Campaign Activities and Miscellaneous Costs fields. |
| dataFormat | decimal |
| maximumValue | 1000000000000 |
| minimumValue | 0 |
| isNullable | true |
| sourceName | totalactualcost |
Traits
List of traits for the totalActualCost 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 | "totalactualcost" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10058" | 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
totalActualCostBase
Value of the Total Cost of Campaign in base currency.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total Cost of Campaign (Base) |
| description | Value of the Total Cost of Campaign in base currency. |
| dataFormat | decimal |
| maximumValue | 922337203685477 |
| minimumValue | -922337203685477 |
| isNullable | true |
| sourceName | totalactualcost_base |
Traits
List of traits for the totalActualCostBase 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 | "totalActualCost" | 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 | "totalactualcost_base" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10059" | 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
totalCampaignActivityActualCost
Shows the sum of the values entered in the Actual Cost field on all campaign activities related to the campaign.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total Cost of Campaign Activities |
| description | Shows the sum of the values entered in the Actual Cost field on all campaign activities related to the campaign. |
| dataFormat | decimal |
| maximumValue | 1000000000000 |
| minimumValue | 0 |
| isNullable | true |
| sourceName | totalcampaignactivityactualcost |
Traits
List of traits for the totalCampaignActivityActualCost 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 | "totalcampaignactivityactualcost" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10060" | 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
totalCampaignActivityActualCostBase
Value of the Total Cost of Campaign Activities in base currency.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total Cost of Campaign Activities (Base) |
| description | Value of the Total Cost of Campaign Activities in base currency. |
| dataFormat | decimal |
| maximumValue | 922337203685477 |
| minimumValue | -922337203685477 |
| isNullable | true |
| sourceName | totalcampaignactivityactualcost_base |
Traits
List of traits for the totalCampaignActivityActualCostBase 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 | "totalCampaignActivityActualCost" | 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 | "totalcampaignactivityactualcost_base" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10061" | 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
typeCode
Select the type of the campaign.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Campaign Type | ||||||||||||||||||
| description | Select the type of the campaign. | ||||||||||||||||||
| 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 | "10062" | integer |
is.dataFormat.integer
typeCode_display
First included in: crmCommon/Campaign (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
priceListId
Choose the price list associated with this item to make sure the products associated with the campaign are offered at the correct prices.
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Price List |
| description | Choose the price list associated with this item to make sure the products associated with the campaign are offered at the correct prices. |
| dataFormat | guid |
| isNullable | true |
| sourceName | pricelistid |
Traits
List of traits for the priceListId 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 | "pricelistid" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10064" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
entityImageId
First included in: crmCommon/Campaign (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | guid |
| isNullable | true |
| sourceName | entityimageid |
Traits
List of traits for the entityImageId 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.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 | "entityimageid" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "10065" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for