HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Connect for Campaign

The Optimizely Connect for Campaign add-on is part of Optimizely Connect for Marketing Automation, which connects Optimizely CMS, Optimizely Forms, and Optimizely Campaign.

With this add-on, marketers can collect visitor data and pass that on to Optimizely Campaign, for usage in campaign mailings.

Prerequisites

An Optimizely CMS installation with Optimizely Forms, Optimizely Campaign, and the required MA connectors.

Installation

The Connect for Campaign MA connector is installed through the NuGet package EPiServer.ConnectForCampaign. See Platform integration compatibility for supported Optimizely versions.

Configuration

Authenticating Connect for Campaign

Prerequisites

  • The user being used for the connector must have API privileges. If your user does not have API access privileges, you will need to submit a support ticket to create a user specifically for API access. Include the name of the client for whom you want the user created, and which API access is needed. In the case of the Connector, request SOAP API access. For security purposes, the user being granted access cannot be the same as a user that has general access rights to the client.
  • To find the Mandator ID (Client ID), access your Campaign client at the location below:
14411441

To connect Optimizely CMS with Optimizely Campaign, enter your authentication details  - Username, Password, Mandator ID (provided with your Optimizely Campaign setup) and a unique Connector Name, in the CMS admin view under CMS > Admin > Config > Optimizely Campaign.

975975

📘

Note

You can have multiple instances of the Campaign connector. Click Add Connector to add another instance.

Connecting Optimizely Forms with Optimizely Campaign

When the Optimizely Forms add-on is installed on the Optimizely CMS website, you need to connect form fields with Optimizely Campaign, so that data from the specified fields can be sent to Campaign.

Autofill

When a website visitor submits a form, a tracking cookie is generated which can be used to identify the visitor. If the visitor opens the form again in the same web browser (assuming it still has the cookie and it is valid), the system automatically gets the visitor's data based on the cookie and fills in the data in the form.

This autofill feature can be  enabled and disabled in the CMS admin view, under Config > Tool SettingsMarketing Connectors > Global Settings > Enable Auto-fill on forms:

745745

Clearing the cache

Information, such as Session Token and Recipient Lists, is stored in the cache to improve performance.

To clear the cache, go to the Config tab > Optimizely Campaign in the CMS admin view and click Clear cache. You can also set the Cache timeout value and click Save.

975975

Storing tracking cookie

When a website visitor submits a form, a tracking cookie is generated which can be used to identify the visitor.

Breaking changes (Connect for Campaign 2)

The new EPiServer.ConnectForCampaign package (2.0.0) depends on:

  • EPiServer.CMS.UI.Core version >= 11.2.4 and < 12
  • EPiServer.Marketing.Automation.Forms version >= 2.1.0 and < 3
  • EPiServer.ConnectForMarketingAutomation version >= 5.2.0 and < 6
  • EPiServer.Forms.UI version >= 4.16 and < 5

Interfaces and classes removed:

  • EPiServer.ConnectForCampaign.Core.Implementation.IRecipientListIdMapper.cs
  • EPiServer.ConnectForCampaign.Core.Implementation.RecipientListIdMapper.cs
  • EPiServer.ConnectForCampaign.Core.Implementation.IVisitorIdentifyProvider.cs
  • EPiServer.ConnectForCampaign.Core.Implementation.VisitorIdentifyProvider.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.CampaignDataSubmissionService.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.CampaignFormValidationService.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.CampaignMenuAssembler.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.CampaignProviderService.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.CampaignSettingsRepository.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.
  • CampaignXFormMarketingAutomationInterception.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.ListService.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.ProfileService.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.ProgramService.cs
  • EPiServer.ConnectForCampaign.Implementation.Services.ScoringService.cs
  • EPiServer.ConnectForCampaign.Implementation.CampaignProvider.cs
  • EPiServer.ConnectForCampaign.Implementation.ProviderRepository.cs

Properties, methods, constants removed/changed:

  • EPiServer.ConnectForCampaign.Core.Configuration.ICampaignConfig.CacheTimeout
  • EPiServer.ConnectForCampaign.Implementation.Configuration.CampaignConfig.CacheTimeout
  • EPiServer.ConnectForCampaign.Core.Models.CampaignDataList.ParentName
  • EPiServer.ConnectForCampaign.Core.Models.CampaignDataList.FeatureSupport
  • EPiServer.ConnectForCampaign.Implementation.Configuration.CampaignSettings.Id
  • EPiServer.ConnectForCampaign.Implementation.Helpers.FullFormSubmissionData
  • EPiServer.ConnectForCampaign.Implementation.Helpers.ActiveExternalFieldMappingTable
  • EPiServer.ConnectForCampaign.Implementation.Helpers.ServiceValidationMessage
  • EPiServer.ConnectForCampaign.Implementation.Helpers.RecipientIdentification
  • EPiServer.ConnectForCampaign.Implementation.Helpers.RecipientListId
  • EPiServer.ConnectForCampaign.Implementation.Helpers.OptInProcessId
  • EPiServer.ConnectForCampaign.Services.Implementation.AuthenticationService.ctor()
  • EPiServer.ConnectForCampaign.Services.Implementation.OptinProcessService.ctor()
  • EPiServer.ConnectForCampaign.Services.Implementation.RecipientListService.ctor()
  • EPiServer.ConnectForCampaign.Services.Implementation.RecipientService.ctor()

Other

  • Change the type of the Id property in EPiServer.ConnectForCampaign.Core.Models.CampaignDataList.cs from "int" to "long".
  • Change return type of EPiServer.ConnectForCampaign.Services.Implementation.GetAllRecipientLists() to IEnumerable<CampaignDataList>.

Breaking changes (Connect for Campaign 3)

The new EPiServer.ConnectForCampaign package (3.0.0) depends on:

  • EPiServer.CMS.UI.Core version >= 11.2.4 and < 12
  • Optimizely.Marketing.Automation.Forms version >= 2.1.0 and < 3
  • EPiServer.ConnectForMarketingAutomation version >= 5.5.3 and < 5.7
  • EPiServer.Forms.UI version >= 4.20 and < 5

Properties, methods, constants removed/changed:

  • EPiServer.ConnectForCampaign.Core.Configuration.ICampaignConfig. TrackingCookieTimeout
  • EPiServer.ConnectForCampaign.Implementation.Configuration.CampaignConfig. TrackingCookieTimeout
  • EPiServer.ConnectForCampaign.Core.Configuration. ICampaignSettings. UserName
  • EPiServer.ConnectForCampaign.Core.Configuration.ICampaignSettings.Password
  • EPiServer.ConnectForCampaign.Core.Configuration.ICampaignSettings.MandatorId
  • EPiServer.ConnectForCampaign.Implementation.Configuration.CampaignSettings.UserName
  • EPiServer.ConnectForCampaign.Implementation.Configuration.CampaignSettings.Password
  • EPiServer.ConnectForCampaign.Implementation.Configuration.CampaignSettings.MandatorId

Related blog post: Configuring the Episerver (Optimizely) Campaign connector through code by David Knipe


Did this page help you?