SaaS CMS has officially launched! Learn more now.

Jason Masterson
Jul 13, 2018
  5107
(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
Frontend Hosting for SaaS CMS Solutions

Introduction Now that CMS SaaS Core has gone into general availability, it is a good time to start discussing where to host the head. SaaS Core is...

Minesh Shah (Netcel) | Jul 20, 2024

Optimizely London Dev Meetup 11th July 2024

On 11th July 2024 in London Niteco and Netcel along with Optimizely ran the London Developer meetup. There was an great agenda of talks that we put...

Scott Reed | Jul 19, 2024

Optimizely release SaaS CMS

Discover the future of content management with Optimizely SaaS CMS. Enjoy seamless updates, reduced costs, and enhanced flexibility for developers...

Andy Blyth | Jul 17, 2024 | Syndicated blog

A day in the life of an Optimizely Developer - London Meetup 2024

Hello and welcome to another instalment of A Day In The Life Of An Optimizely Developer. Last night (11th July 2024) I was excited to have attended...

Graham Carr | Jul 16, 2024

Creating Custom Actors for Optimizely Forms

Optimizely Forms is a powerful tool for creating web forms for various purposes such as registrations, job applications, surveys, etc. By default,...

Nahid | Jul 16, 2024

Optimizely SaaS CMS Concepts and Terminologies

Whether you're a new user of Optimizely CMS or a veteran who have been through the evolution of it, the SaaS CMS is bringing some new concepts and...

Patrick Lam | Jul 15, 2024