Campaign Class |
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.
Inheritance HierarchyNamespace: Novalys.VisualGuard.Security.CRM.Sdk
Assembly: Novalys.VisualGuard.Security.CRM (in Novalys.VisualGuard.Security.CRM.dll) Version: 2019.0.101.19 (2019.0.0101.19)
SyntaxThe Campaign type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | ActualEnd |
Enter the date when the campaign was closed or completed.
|
| ActualStart |
Enter the actual start date and time for the campaign.
|
| Attributes | (Inherited from Entity.) |
| BudgetedCost |
Type the amount budgeted for the campaign to define a limit for how much you can spend.
|
| BudgetedCost_Base |
Shows the Budget Allocated field converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area.
|
| BusinessUnit_Campaigns |
N:1 BusinessUnit_Campaigns
|
| campaign_activity_parties |
1:N campaign_activity_parties
|
| Campaign_ActivityPointers |
1:N Campaign_ActivityPointers
|
| Campaign_Annotation |
1:N Campaign_Annotation
|
| Campaign_Appointments |
1:N Campaign_Appointments
|
| Campaign_AsyncOperations |
1:N Campaign_AsyncOperations
|
| Campaign_BulkDeleteFailures |
1:N Campaign_BulkDeleteFailures
|
| Campaign_CampaignActivities |
1:N Campaign_CampaignActivities
|
| Campaign_CampaignResponses |
1:N Campaign_CampaignResponses
|
| campaign_connections1 |
1:N campaign_connections1
|
| campaign_connections2 |
1:N campaign_connections2
|
| Campaign_DuplicateBaseRecord |
1:N Campaign_DuplicateBaseRecord
|
| Campaign_DuplicateMatchingRecord |
1:N Campaign_DuplicateMatchingRecord
|
| Campaign_Emails |
1:N Campaign_Emails
|
| Campaign_Faxes |
1:N Campaign_Faxes
|
| campaign_leads |
1:N campaign_leads
|
| Campaign_Letters |
1:N Campaign_Letters
|
| campaign_opportunities |
1:N campaign_opportunities
|
| campaign_orders |
1:N campaign_orders
|
| Campaign_Phonecalls |
1:N Campaign_Phonecalls
|
| campaign_principalobjectattributeaccess |
1:N campaign_principalobjectattributeaccess
|
| Campaign_ProcessSessions |
1:N Campaign_ProcessSessions
|
| campaign_quotes |
1:N campaign_quotes
|
| Campaign_RecurringAppointmentMasters |
1:N Campaign_RecurringAppointmentMasters
|
| Campaign_ServiceAppointments |
1:N Campaign_ServiceAppointments
|
| Campaign_Tasks |
1:N Campaign_Tasks
|
| CampaignId |
Unique identifier of the campaign.
|
| campaignlist_association |
N:N campaignlist_association
|
| campaignproduct_association |
N:N campaignproduct_association
|
| campaignsalesliterature_association |
N:N campaignsalesliterature_association
|
| CodeName |
Type a number or other tracking code to identify the campaign. If no value is entered, a code will be generated automatically.
|
| CreatedBy |
Shows who created the record.
|
| CreatedOn |
Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
|
| CreatedOnBehalfBy |
Shows who created the record on behalf of another user.
|
| Description |
Type additional information to describe the campaign, such as the products or services offered or the targeted audience.
|
| EntityImage |
The default image for the entity.
|
| EntityImage_Timestamp | |
| EntityImage_URL | |
| EntityImageId |
For internal use only.
|
| EntityState | (Inherited from Entity.) |
| 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.
|
| ExpectedResponse |
Type the expected response rate for the campaign as a full number between 0 and 100.
|
| ExpectedRevenue |
Type the expected revenue for the campaign for return on investment projections and post-campaign reporting.
|
| ExpectedRevenue_Base |
Shows the estimated revenue converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area.
|
| ExtensionData | (Inherited from Entity.) |
| FormattedValues | (Inherited from Entity.) |
| Id | (Overrides Entity.Id.) |
| ImportSequenceNumber |
Unique identifier of the data import or data migration that created this record.
|
| IsTemplate |
Select whether the campaign is a template that can be copied when you create future campaigns.
|
| Item | (Inherited from Entity.) |
| lk_campaign_createdby |
N:1 lk_campaign_createdby
|
| lk_campaign_createdonbehalfby |
N:1 lk_campaign_createdonbehalfby
|
| lk_campaign_modifiedby |
N:1 lk_campaign_modifiedby
|
| lk_campaign_modifiedonbehalfby |
N:1 lk_campaign_modifiedonbehalfby
|
| LogicalName | (Inherited from Entity.) |
| Message |
Type the promotional message or marketing copy for the campaign.
|
| ModifiedBy |
Shows who last updated the record.
|
| ModifiedOn |
Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
|
| ModifiedOnBehalfBy |
Shows who created the record on behalf of another user.
|
| Name |
Type a name for the campaign so that it is identified correctly in lists.
|
| Objective |
Type the objective of the campaign, including products, services, discounts, and pricing.
|
| 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.
|
| OtherCost_Base |
Shows the Miscellaneous Costs field converted to the system's default base currency for reporting purposes. The calculations use the exchange rate specified in the Currencies area.
|
| OverriddenCreatedOn |
Date and time that the record was migrated.
|
| OwnerId |
Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
|
| OwningBusinessUnit |
Shows the business unit that the record owner belongs to.
|
| OwningTeam |
Unique identifier of the team who owns the campaign.
|
| OwningUser |
Unique identifier of the user who owns the campaign.
|
| PriceList_Campaigns |
N:1 PriceList_Campaigns
|
| PriceListId |
Choose the price list associated with this item to make sure the products associated with the campaign are offered at the correct prices.
|
| ProcessId |
Shows the ID of the process.
|
| processstage_campaigns |
N:1 processstage_campaigns
|
| PromotionCodeName |
Type a promotional code to track sales related to the campaign or allow customers to redeem a discount offer.
|
| ProposedEnd |
Enter the date when the campaign is scheduled to end.
|
| ProposedStart |
Enter the date when the campaign is scheduled to start.
|
| Referencedcampaigncampaign_association |
N:N campaigncampaign_association
|
| Referencingcampaigncampaign_association |
N:N campaigncampaign_association
|
| RelatedEntities | (Inherited from Entity.) |
| StageId |
Shows the ID of the stage.
|
| StateCode |
Shows the status of the campaign. By default, campaigns are active and can't be deactivated.
|
| StatusCode |
Select the campaign's status.
|
| SystemUser_Campaigns |
N:1 SystemUser_Campaigns
|
| team_Campaigns |
N:1 team_Campaigns
|
| TimeZoneRuleVersionNumber |
For internal use only.
|
| TotalActualCost |
Shows the sum of the amounts entered in the Total Cost of Campaign Activities and Miscellaneous Costs fields.
|
| TotalActualCost_Base |
Shows the Total Cost of Campaign field converted to the system's default base currency for reporting purposes. The calculations use the exchange rate specified in the Currencies area.
|
| TotalCampaignActivityActualCost |
Shows the sum of the values entered in the Actual Cost field on all campaign activities related to the campaign.
|
| TotalCampaignActivityActualCost_Base |
Shows the Total Cost of Campaign Activities field converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area.
|
| transactioncurrency_campaign |
N:1 transactioncurrency_campaign
|
| TransactionCurrencyId |
Choose the local currency for the record to make sure budgets are reported in the correct currency.
|
| TypeCode |
Select the type of the campaign.
|
| userentityinstancedata_campaign |
1:N userentityinstancedata_campaign
|
| UTCConversionTimeZoneCode |
Time zone code that was in use when the record was created.
|
| VersionNumber |
Version number of the campaign.
|
Methods| Name | Description | |
|---|---|---|
 | Contains | (Inherited from Entity.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetAttributeValue``1 | (Inherited from Entity.) |
| GetFormattedAttributeValue | (Inherited from Entity.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetRelatedEntities``1 | (Inherited from Entity.) |
| GetRelatedEntity``1 | (Inherited from Entity.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetAttributeValue | (Inherited from Entity.) |
| SetRelatedEntities``1 | (Inherited from Entity.) |
| SetRelatedEntity``1 | (Inherited from Entity.) |
| ToEntity``1 | (Inherited from Entity.) |
| ToEntityReference | (Inherited from Entity.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | PropertyChanged | |
| PropertyChanging |
Fields| Name | Description | |
|---|---|---|
  | EntityLogicalName | |
| EntityTypeCode |
See Also