Skip to main content

Sitecore EXM 9.1 here we go.

By
It is time to start diving deeper into Sitecore Email Experience Manager (EXM) and really getting to know it. I am working a project that is going to require some fairly advanced customizations with EXM and with the help of SitecoreHacker we will get through it.

First on this list is to make sure we understand how the EXM pipelines are set up. Both Sitecore docs and SitecoreHacker have some good information on this. I am a visual learner so I created this diagram to help me see the pipelines.


It is important to notice that the Newsletter pipeline is different between the CM and the Dedicated Dispatch Server (DDS). The config on the CM manages the process so, it has some additional processes in the pipeline in runs. The send email pipeline is where the real work is done of getting the email and sending it.

The next thing to get into is what happens when SendEmail is called? If you are just using Sitecore EmailCloud or the standard OOTB CustomSMTP you may not care about these details. But when the time comes to customize your email provider you will need to get into these details.

Again, as a visual learner, I put this into a sequence diagram to help visualize what classes were being used and how. It is a fair amount of abstraction layers so keep tracking of what class is used where can be a little hard without some visualization.

Sitecore Dependency Injection

Before we get too far into the breakdown of these classes and methods we need to understand how Sitecore is doing dependency injection.

Let's look at the connection pool manager configuration node.

1
2
3
4
5
6
7
8
9
<connectionPool type="Sitecore.EDS.Core.Net.Smtp.ChilkatConnectionPool, Sitecore.EDS.Core" singleInstance="true" patch:source="Sitecore.EDS.Providers.CustomSMTP.config">

   <param ref="exm/eds/connectionPoolSettings"/>

    <param ref="exm/eds/smtpSettings"/>

    <param ref="exmLogger"/>

</connectionPool>

You will see in this example the connectionPool node has a few child nodes of <param ref="" />. This tells Sitecore what parameter objects it must create and inject as parameters. The Sitecore framework is responsiblef or taking those parameter reference items and searching the Sitecore XML config for the needed notes. So for the first one is searches the XML configuration to find the connectionPoolSettings node (below) and uses that configuration to build out the ConnectionPoolSettings object for ChilkatConnectionPool.


<connectionPoolSettings type="Sitecore.EDS.Core.Net.Smtp.ConnectionPoolSettings, Sitecore.EDS.Core" singleInstance="true" patch:source="Foundation.EXM.Providers.Momentum.config">
  <maxPoolSize ref="settings/setting[@name='NumberThreads']/@value"/>
  <delayBetweenConnectionRetries>00:00:10.000</delayBetweenConnectionRetries>
  <maxConnectionWaitTime>00:00:30.000</maxConnectionWaitTime>
  <maxConnectionIdleTime>00:10:00.000</maxConnectionIdleTime>
  <maxConnectionRetries>3</maxConnectionRetries>
</connectionPoolSettings>

The ChikatConnectionPool class looks like this. Notice the ConnectionPoolSettings class that is passed in and from which the Sitecore framework created it from the configration section above.


public ChilkatConnectionPool(
      ConnectionPoolSettings settings,
      ISmtpSettings smtpSettings,
      ILogger logger)
    {
      ...
    }

SendEmail

SendEmail class looks like this.

public SendEmail(ILogger logger)
            : this(logger, 
              Factory.CreateObject("exm/eds/dispatchManager", true) as IDispatchManager, 
               ServiceLocator.ServiceProvider.GetService<EcmSettings>())
        {
        }

The key learning here is the frameworks ability to create an instance of a class based on a config path. If you look at the showconfig.aspx you will find a node in the configuration like this:

<exm>
  <eds>
     ...
      <dispatchManager type="Sitecore.EDS.Core.Dispatch.DispatchManager, Sitecore.EDS.Core" singleInstance="true"/>
     ...
   </eds>
</exm>

This `Factory.CreateObject` method takes in a configuration path and then creates the object based on that path.So we have seen how the framework has a way to create an object in code or through configration.

Dispatch Manager and Provider

This is a pretty simple class that just makes this call this._providerHelper = new ProviderInitializer<DispatchProviderBase>("exm/eds/dispatchProvider");  Just like the SendEmail class it looks at the configuration to initialize a dispatchProvider that is configured and then calls SendAsync. SendAsync is actually a method on DispatchProviderBase. DispatchProviderBase is an abstract class whose's SendAsync method calls the SendEmailAsync method of that class that implements DispatchProviderBase. The SendEmailAsync method triggers two things. First, it creates the MessageTransport object and hands it the EXM message object. It then uses the connection pool manager that was passed in via dependency injection to get a connection on the transport client.

MessageTransport

This class is responsible for taking the EXM message object and transforming the object into the shape needed for the Mail Transfer Agent (MTA). So in the case of the OOTB options shaping it for SparkPost or a standard SMTP object type. If you are connecting to your own custom MTA you will need to override this class and provide your logic here.

Connection Pool Manager and Connection Pool

The connection pool manager is really just an access point to the connection pool. The connection pools GetConnectionAsync method is used to return a connection for the transport client that should be used. The idea here is that the connection pool class is responsible for managing the state of the connections, how it should retry, how many connections it should allow and the state of the connections.

Transport Client

At this point, we are left with just the transport client. This client is responsible for knowing how to communicate with the MTA. This can be via an SDK from the MTA or a custom client you create. Its SendAsync method is given a message object already shaped by the MessageTransport class for the MTA.

This class also has access to the APISettings classes that is injected and allows the transport client to setup any calls based on configuration data provided in configuration files.

Now you are ready to start building and overrideing areas of EXM sending processes. 
Labels:

Comments

Post a Comment

Popular posts from this blog

Experience Profile Anonymous, Unknown and Known contacts

By
When you first get started with Sitecore's experience profile the reporting for contacts can cause a little confusion. There are 3 terms that are thrown around, 1) Anonymous 2) Unknown 3) Known. When you read the docs they can bleed into each other a little. First, have a read through the Sitecore tracking documentation to get a feel for what Sitecore is trying to do. There are a couple key things here to first understand: Unless you call " IdentifyAs() " for request the contact is always anonymous.  Tracking of anonymous contacts is off by default.  Even if you call "IdentifyAs()" if you don't set facet values for the contact (like first name and email) the contact will still show up in your experience profile as "unknown" (because it has no facet data to display).  Enabled Anonymous contacts Notice in the picture I have two contacts marked in a red box. Those are my "known" contacts that I called "IdentifyAs"
1 comment
Read more

Uniting Testing Expression Predicate with Moq

By
I recently was setting up a repository in a project with an interface on all repositories that took a predicate. As part of this I needed to mock out this call so I could unit test my code. The vast majority of samples out there for mocking an expression predicate just is It.IsAny<> which is not very helpful as it does not test anything other then verify it got a predicate. What if you actually want to test that you got a certain predicate though? It is actually pretty easy to do but not very straight forward. Here is what you do for the It.IsAny<> approach in case someone is looking for that. this .bindingRepository.Setup(c => c.Get(It.IsAny<Expression<Func<UserBinding, bool >>>())) .Returns( new List<UserBinding>() { defaultBinding }.AsQueryable()); This example just says to always return a collection of UserBindings that contain “defaultBinding” (which is an object I setup previously). Here is what it looks like when you want to pass in an exp
2 comments
Read more

Excel XIRR and C#

By
I have spend that last couple days trying to figure out how to run and Excel XIRR function in a C# application. This process has been more painful that I thought it would have been when started. To save others (or myself the pain in the future if I have to do it again) I thought I would right a post about this (as post about XIRR in C# have been hard to come by). Lets start with the easy part first. In order to make this call you need to use the Microsoft.Office.Interop.Excel dll. When you use this dll take note of what version of the dll you are using. If you are using a version less then 12 (at the time of this writing 12 was the highest version) you will not have an XIRR function call. This does not mean you cannot still do XIRR though. As of version 12 (a.k.a Office 2007) the XIRR function is a built in function to Excel. Prior version need an add-in to use this function. Even if you have version 12 of the interop though it does not mean you will be able to use the function. The
14 comments
Read more

Security Config in IIS Express

By
I have gotten tired of always having to look this up or remember where it is at. That means it is time to post to my blog so I can find it easier and hopefully others can too. If you are having issues with IIS Express authentication errors (like the Unauthorized 401.2 error I always get) here is some help. I can never remember what the last setting was I had IIS Express set to for authorization. To change IIS Express for windows auth or anonymous auth you want to work with the applicationhost.config file. It can be found here …Documents\IISExpress\config. You want to change the settings in the following area of the config file. < authentication > < anonymousAuthentication enabled ="true" userName ="" /> < basicAuthentication enabled ="false" /> < clientCertificateMappingAuthentication enabled ="false" /> < digestAuthentication enabled ="false" />
2 comments
Read more

WPF Localization - RESX Option

By
About a year ago I was building a WPF project in .Net 3.0 and Visual Studio 2005. I wanted to revisit this subject and see what has changed in .Net 3.5 and Visual Studio 2008. I will make a few of these posts to try and cover all the different options (RESX option, LocBaml option, Resource Dictionary Option). In this blog I will focus on using a resx file to localize an application. To show how the resx option is done I created a WPF form with three labels on it. The first label has is text set inline in XAML, the second has it text set via code behind from the resx file and the third has its text set via XAML accessing the resx file. The first thing that needs to happen to setup a project for localization is a small change to the project file. To make this change you will need to open the project file in notepad (or some other generic editor). In the first PropertyGroup section you need to add the follow XML node <UICulture>en-US</UICulture>. So the project file node w
6 comments
Read more