Campaign Entity Metadata

  • Article

[Applies to: Microsoft Dynamics CRM 2011]

The following information is for the campaign entity in a default, uncustomized installation of Microsoft Dynamics CRM. The schema name and early bound class name is Campaign.

To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the Metadata for Your Organization.

In This Topic

Entity Metadata

Privilege Metadata

Attribute Metadata

One-to-Many Relationships

Many-to-Many Relationships

Many-to-One Relationships

Entity Metadata

The following table shows the metadata for the campaign entity.

Entity metadata property Value

OTC

4400

EntityLogicalName

campaign

DisplayName

Campaign

DisplayCollectionName

Campaigns

IsCustomizable

True

OwnershipType

UserOwned

AutoRouteToOwnerQueue

False

CanBeInManyToMany

True

CanBePrimaryEntityInRelationship

True

CanBeRelatedEntityInRelationship

True

CanCreateAttributes

True

CanCreateCharts

True

CanCreateForms

True

CanCreateViews

True

CanModifyAdditionalSettings

True

CanTriggerWorkflow

True

IsActivity

False

IsActivityParty

True

IsAuditEnabled

False

IsAvailableOffline

True

IsChildEntity

False

IsConnectionsEnabled

canmodifyconnectionsettings

IsCustomEntity

False

IsDocumentManagementEnabled

False

IsDuplicateDetectionEnabled

True

IsEnabledForCharts

True

IsImportable

True

IsIntersect

False

IsMailMergeEnabled

False

IsManaged

True

IsMappable

True

IsReadingPaneEnabled

True

IsRenameable

True

IsValidForAdvancedFind

True

IsValidForQueue

False

IsVisibleInMobile

False

PrimaryIdAttribute

campaignid

PrimaryNameAttribute

name

ReportViewName

FilteredCampaign

Description

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.

Privilege Metadata

The following table shows the privilege metadata for the campaign entity.

PrivilegeName Id Type CanBeBasic CanBeDeep CanBeGlobal CanBeLocal

prvAppendCampaign

424922cf-2af8-4207-80f1-36e32d5161f9

Append

True

True

True

True

prvAppendToCampaign

1d75aed6-94cd-4e3b-b9ae-2a62f2c37190

AppendTo

True

True

True

True

prvAssignCampaign

c86ae72b-ef85-4e91-9bab-6680bf1ce91d

Assign

True

True

True

True

prvConfigureInternetMarketing

0452a809-ceaf-4ae9-aab5-c74d42bb5773

None

True

True

True

True

prvCreateCampaign

a31c6b1b-d2e9-4f91-82f0-4677c13b0ad6

Create

True

True

True

True

prvDeleteCampaign

6e1a5dfd-f266-401d-afea-cf8e2679e20b

Delete

True

True

True

True

prvReadCampaign

a083d738-777b-4f53-b863-018489f30d46

Read

True

True

True

True

prvShareCampaign

e828dade-817e-4fa8-81b2-aff9f491c89f

Share

True

True

True

True

prvUseInternetMarketing

3d1ddb18-3709-4a30-93de-51c95c28d00c

None

True

True

True

True

prvWriteCampaign

f775fa77-1d19-4c1d-b82b-6b32d0883f48

Write

True

True

True

True

Attribute Metadata

The following table shows the attribute metadata for the campaign entity.

LogicalName SchemaName Type RequiredLevel IsValidForCreate IsValidForRead IsValidForUpdate CanBeSecuredForCreate CanBeSecuredForRead CanBeSecuredForUpdate IsCustomizable IsAuditEnabled IsManaged IsPrimaryId IsPrimaryName IsRenameable IsSecured IsValidForAdvancedFind DisplayName DeprecatedVersion Description

actualend

ActualEnd

DateTime

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Actual End Date

Actual end date for the campaign.

actualstart

ActualStart

DateTime

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Actual Start Date

Actual start date for the campaign.

budgetedcost

BudgetedCost

Money

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Budget Allocated

Budgeted cost for the campaign.

budgetedcost_base

BudgetedCost_Base

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Budget Allocated (Base)

Base currency equivalent of the budgeted cost for the campaign.

campaignid

CampaignId

Uniqueidentifier

SystemRequired

True

True

False

False

False

False

True

False

True

True

False

True

False

True

Campaign

Unique identifier of the campaign.

codename

CodeName

String

None

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Campaign Code

Unique code name that identifies the campaign.

createdby

CreatedBy

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Created By

Unique identifier of the user who created the campaign.

createdon

CreatedOn

DateTime

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Created On

Date and time when the campaign was created.

createdonbehalfby

CreatedOnBehalfBy

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Created By (Delegate)

Unique identifier of the delegate user who created the campaign.

description

Description

Memo

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Description

Description of the campaign.

exchangerate

ExchangeRate

Decimal

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Exchange Rate

Exchange rate for the currency associated with the campaign with respect to the base currency.

expectedresponse

ExpectedResponse

Integer

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Expected Response Percentage

Percent expected response for the campaign.

expectedrevenue

ExpectedRevenue

Money

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Estimated Revenue

Expected revenue from the campaign.

expectedrevenue_base

ExpectedRevenue_Base

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Expected Revenue (Base)

Base currency equivalent of the expected revenue from the campaign.

importsequencenumber

ImportSequenceNumber

Integer

None

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Import Sequence Number

Unique identifier of the data import or data migration that created this record.

istemplate

IsTemplate

Boolean

None

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Template

Indication of whether the campaign is a template.

message

Message

String

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Message

Promotional message for the campaign.

modifiedby

ModifiedBy

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Modified By

Unique identifier of the user who last modified the campaign.

modifiedon

ModifiedOn

DateTime

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Modified On

Date and time when the campaign was last modified.

modifiedonbehalfby

ModifiedOnBehalfBy

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Modified By (Delegate)

Unique identifier of the delegate user who last modified the campaign.

name

Name

String

SystemRequired

True

True

True

False

False

False

True

True

True

False

True

True

False

True

Name

Name of the campaign.

objective

Objective

Memo

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Offer

Objective of the campaign.

othercost

OtherCost

Money

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Miscellaneous Costs

Other miscellaneous costs of the campaign.

othercost_base

OtherCost_Base

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Miscellaneous Costs (Base)

Base currency equivalent of the other miscellaneous costs of the campaign.

overriddencreatedon

OverriddenCreatedOn

DateTime

None

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Record Created On

Date and time that the record was migrated.

ownerid

OwnerId

Owner

SystemRequired

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Owner

Unique identifier of the user or team who owns the campaign.

owningbusinessunit

OwningBusinessUnit

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

False

False

False

Owning Business Unit

Unique identifier of the business unit that owns the campaign.

owningteam

OwningTeam

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

False

False

False

Owning Team

Unique identifier of the team who owns the campaign.

owninguser

OwningUser

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

False

False

False

Owning User

Unique identifier of the user who owns the campaign.

pricelistid

PriceListId

Lookup

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Price List

Unique identifier of the price list for the campaign.

promotioncodename

PromotionCodeName

String

None

True

True

True

False

False

False

True

True

True

False

False

True

False

False

Promotion Code

Promotion code for the campaign.

proposedend

ProposedEnd

DateTime

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Proposed End Date

Proposed end date for the campaign.

proposedstart

ProposedStart

DateTime

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Proposed Start Date

Proposed start date for the campaign.

statecode

StateCode

State

SystemRequired

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Status

Status of the campaign.

statuscode

StatusCode

Status

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Status Reason

Reason for the status of the campaign.

timezoneruleversionnumber

TimeZoneRuleVersionNumber

Integer

None

True

True

True

False

False

False

True

False

True

False

False

False

False

False

Time Zone Rule Version Number

For internal use only.

totalactualcost

TotalActualCost

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Total Cost of Campaign

Total actual cost of the campaign.

totalactualcost_base

TotalActualCost_Base

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Total Cost of Campaign (Base)

Base currency equivalent of the total actual cost of the campaign.

totalcampaignactivityactualcost

TotalCampaignActivityActualCost

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Total Cost of Campaign Activities

Sum of all the actual costs of the campaign activities for this campaign.

totalcampaignactivityactualcost_base

TotalCampaignActivityActualCost_Base

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Total Cost of Campaign Activities (Base)

Base currency equivalent of the sum of all the actual costs of the campaign activities for this campaign.

transactioncurrencyid

TransactionCurrencyId

Lookup

ApplicationRequired

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Currency

Unique identifier of the currency associated with the campaign.

typecode

TypeCode

Picklist

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Campaign Type

Type of the campaign.

utcconversiontimezonecode

UTCConversionTimeZoneCode

Integer

None

True

True

True

False

False

False

True

False

True

False

False

False

False

False

UTC Conversion Time Zone Code

Time zone code that was in use when the record was created.

versionnumber

VersionNumber

BigInt

None

False

True

False

False

False

False

False

False

True

False

False

False

False

False

Version Number

Version number of the campaign.

One-to-Many Relationships

The following table shows the entities that are the referencing entity in a one-to-many relationship with the campaign entity.

Relationship schema name Referencing entity

campaign_activity_parties

activityparty

Campaign_ActivityPointers

activitypointer

Campaign_Annotation

annotation

Campaign_Appointments

appointment

Campaign_AsyncOperations

asyncoperation

Campaign_BulkDeleteFailures

bulkdeletefailure

Campaign_CampaignActivities

campaignactivity

Campaign_CampaignResponses

campaignresponse

campaign_connections1

connection

campaign_connections2

connection

Campaign_DuplicateMatchingRecord

duplicaterecord

Campaign_DuplicateBaseRecord

duplicaterecord

Campaign_Emails

email

Campaign_Faxes

fax

campaign_leads

lead

Campaign_Letters

letter

campaign_opportunities

opportunity

Campaign_Phonecalls

phonecall

campaign_principalobjectattributeaccess

principalobjectattributeaccess

Campaign_ProcessSessions

processsession

campaign_quotes

quote

Campaign_RecurringAppointmentMasters

recurringappointmentmaster

campaign_orders

salesorder

Campaign_ServiceAppointments

serviceappointment

Campaign_Tasks

task

userentityinstancedata_campaign

userentityinstancedata

Many-to-Many Relationships

The following table shows the many-to-many relationships for the campaign entity.

Relationship schema name Entity 1 Entity 2 Intersect entity Early bound entity

campaignproduct_association

campaign

Product

campaignitem

.CampaignItem

campaigncampaign_association

campaign

Campaign

campaignitem

.CampaignItem

campaignsalesliterature_association

campaign

Salesliterature

campaignitem

.CampaignItem

campaignlist_association

campaign

List

campaignitem

CampaignItem

For information about using intersect entities, see Retrieve Records for Many-To-Many Relationships Using Intersect Entities.

Many-to-One Relationships

The following table shows the entities that are the referenced entity in a many-to-one relationship with the campaign entity.

Relationship schema name Referenced entity

BusinessUnit_Campaigns

businessunit

owner_campaigns

owner

PriceList_Campaigns

pricelevel

lk_campaign_createdby

systemuser

SystemUser_Campaigns

systemuser

lk_campaign_modifiedonbehalfby

systemuser

lk_campaign_createdonbehalfby

systemuser

lk_campaign_modifiedby

systemuser

team_Campaigns

team

transactioncurrency_campaign

transactioncurrency

See Also

Reference

EntityMetadata
AttributeMetadata
OneToManyRelationshipMetadata
ManyToManyRelationshipMetadata

Concepts

Campaign Entities
Campaign Entity Messages and Methods
Campaign Entity OptionSet Attribute Metadata
Campaign Entity Privileges
CampaignItem Intersect Entity Metadata

Microsoft Dynamics CRM 2011
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.