Jason Masterson
Jul 13, 2018
  6404
(4 votes)

Episerver Marketing Connectors

Creating multiple instances of the same connector

               There are cases where an organization has multiple logins into the same Marketing Automation system for different business units or different regions. With that in mind, the EPiServer Connect for Marketing Automation 5.0.0 package lets you configure multiple instances of a connector with different credentials that will act independently within the CMS. The initial implementation of this feature does not have a user interface so you have to configure the second instance of the same connector with code. The following example shows how to create a second instance of the same Marketing Connector.

Code:

SampleConnector connector = new SampleConnector(); 
connector.InstanceId = new Guid("C125E524-CEBF-4D5C-AC36-BDDA61647D0D"); // my static instance id
connector.Name = $"{connector.Name}_EastCoastRegion"; // set a unique name so you can distinguish it from the original

var manager = ServiceLocator.Current.GetInstance<IMarketingConnectorManager>();
var config = manager.GetConnectorCredentials(connector.Id.ToString(), connector.InstanceId.ToString());
if( config == null ) // doesnt exist, create it
{
    manager.SaveConnectorCredentials(new ConnectorCredentials()
    {
        ConnectorId = connector.Id,
        ConnectorInstanceId = connector.InstanceId,
        ConnectorName = connector.Name,
        CredentialFields = new Dictionary<string, object>() { { "CreateDate", DateTime.Now }, { "LastUpdated", DateTime.Now } }
    });
}
else
{
    config.CredentialFields.Remove("LastUpdated");
    config.CredentialFields.Add("LastUpdated", DateTime.Now);
    manager.SaveConnectorCredentials(config);
}

       The code checks for a second set of credentials with the Marketing Connector Manager class and the specified InstanceId. If the code does not find the credentials, it creates the credentials that indicate that the framework should create a second instance of the connector with the new credential values. The second set of credentials needs to have the same Connector Id guid of the Connector class that implements IMarketingConnector.

ConnectorCredentials Class

  • ConnectorId. A guid that indicates which connector the credentials should be used for
  • ConnectorInstanceId. A guid that specifies the instance of the connector. The default Admin Config pages for a connector use the ConnectorId guid as its instance guid, so a second instance for that connector should be a different value.
  • ConnectorName. The display name of the connector, used for display in dropdowns when selecting a connector in the CMS UI. Make it something that differentiates it from any other connector instance.
  • CredentialFields. A dictionary of field names and their corresponding values that are used to communicate with the connector endpoint. This varies by connector so you need to know the proper dictionary structure to create an instance that can communicate to the connector endpoint.
Jul 13, 2018

Comments

Please login to comment.
Latest blogs
📣 Build, Automate, and Scale Content Operations with CMS REST API v1 - now live!

Now available for both CMS13 and CMS SaaS We are excited to announce the  v1 release of our CMS REST API —a major milestone in delivering a stable,...

Kathy Copeland | Apr 21, 2026

Introducing AI Assistant v4 for Optimizely CMS 12 and 13

Epicweb AI Assistant v4.0 adds full support for Optimizely CMS 13 on .NET 10 while staying compatible with CMS 12 on .NET 8, plus new AI Chat tools...

Luc Gosso (MVP) | Apr 20, 2026 |

Remote Debugging in Optimizely DXP: What Is Actually Possible?

Introduction At SYZYGY Techsolutions , we support Optimizely DXP projects at scale, so continuously  identifying  the right tools and approaches fo...

Mike | Apr 20, 2026

Removing Unused Properties in Optimizely CMS 13

Learn how to remove orphaned property definitions in Optimizely CMS 13. Explore API updates for IContentTypeRepository and how to safely use...

Stuart | Apr 17, 2026 |