Jason Masterson
Jul 13, 2018
  6354
(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
Optimizely Commerce vs Composable Commerce: What Should You Do with CMS 13?

As organizations modernize their digital experience platforms, a common architectural question emerges: Should we continue using Optimizely Commerc...

Aniket | Mar 12, 2026

Missing Properties tool for Optimizely CMS

If you have been working with Optimizely CMS for a while you have probably accumulated some technical debt in your property definitions. When you...

Per Nergård (MVP) | Mar 10, 2026

AI Generated Optimizely Developer Newsletter

Updates in the Optimizely ecosystem are everywhere: blog posts, forums, release notes, NuGet packages, and documentation changes. This newsletter...

Allan Thraen | Mar 10, 2026 |

Lessons from Building Production-Ready Opal Tools

AI tools are becoming a normal part of modern digital platforms. With  Optimizely Opal , teams can build tools that automate real tasks across the...

Praful Jangid | Mar 7, 2026

My Takeaway from Optimizely Opal Agents in Action 2026 - What Agentic AI Means for the Future of Digital Marketing

I would like to share with you what stayed in my head after this amazing virtual event organized by Optimizely. Agents in Action 2026 , a live...

Augusto Davalos | Mar 6, 2026

From Vision to Velocity: Introducing the Optimizely MVP Technical Roundtable

Digital transformation is a two-sided coin. On one side, you have the high-level strategy, the business cases, the customer journeys, and the...

Patrick Lam | Mar 6, 2026