Take the community feedback survey now.

Jason Masterson
Jul 13, 2018
  6014
(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
Trigger DXP Warmup Locally to Catch Bugs & Performance Issues Early

Here’s our documentation on warmup in DXP : 🔗 https://docs.developers.optimizely.com/digital-experience-platform/docs/warming-up-sites What I didn...

dada | Sep 29, 2025

Creating Opal Tools for Stott Robots Handler

This summer, the Netcel Development team and I took part in Optimizely’s Opal Hackathon. The challenge from Optimizely was to extend Opal’s abiliti...

Mark Stott | Sep 28, 2025

Integrating Commerce Search v3 (Vertex AI) with Optimizely Configured Commerce

Introduction This blog provides a technical guide for integrating Commerce Search v3, which leverages Google Cloud's Vertex AI Search, into an...

Vaibhav | Sep 27, 2025

A day in the life of an Optimizely MVP - Opti Graph Extensions add-on v1.0.0 released

I am pleased to announce that the official v1.0.0 of the Opti Graph Extensions add-on has now been released and is generally available. Refer to my...

Graham Carr | Sep 25, 2025