In the previous post I talked about sending messages to another system via a message queue. This is the design pattern Microsoft recommends when you want to use Dynamics CRM Online to update systems that are on-premise. They recommend using Azure Service Bus and the integration is built into the Online version by creating a Service Endpoint. This is also available for the on-premise version.
The plugin registration tool for Dynamics CRM offers the ability to register a Service EndPoint when you are connected to CRM Online. What is not clear though is that there are two ways you can configure it.
First though there are two gotchas when setting up the Azure Service Bus.
GOTCHA #1: You set up the Azure Service Bus Namespace using the Portal. Wrong.
Doing it that way you no longer have the option to use ACS authentication and that is what the Plugin Registration tool uses. Delete it. Download the PowerShell Azure Commands add-in and run this command:
New-AzureSBNamespace -Name yourservice -Location "West Europe" -CreateACSNamespace $true -NamespaceType Messaging
The response you get returned is
You need to use the DefaultKey when the Plugin Registration tool prompts you for the Management Key!
GOTCHA #2: You create the Queue (or whatever) using the Portal or PowerShell. Wrong.
You need to leave this for the Plugin Registration tool to do.
I won't give the rest of the details for configuring the endpoint because that is covered in other blogs.
Once you have the Service EndPoint registered there are two ways forward.
The first and seemingly the most attractive option is you can register steps and images right there under the endpoint just as you would do with a plugin. The advantage is that this is a zero code solution. Just by configuring an Entity with the appropriate step and image you can get messages in your queue (or whatever). The thing is though is this method only supports Asynchronous operations. That may be fine if you have a very simple CRM solution and want to configure only one or two entities. In more real world scenarios this is not going to work for you because it won't guarantee ordered delivery. That is what I covered in my previous post. To maintain Ordered Delivery you must use synchronous plugins steps.
The second route is to create an Azure-aware plugin. There is sample code in the SDK for doing this and out there in blogosphere. In this case you just create the service endpoint and copy the Id that it creates. Create your Azure-aware plugin and paste the Id into the Unsecure Configuration section. Register your plugin steps and images as usual. The plugin uses an instance of the IServiceEndpointNotificationService and essentially posts the context (using the Execute method) to the Service Bus endpoint. The point here though is that you have full choice over how to register your steps, so if you need Ordered Delivery you can choose Synchronous.
Personally I find the whole method of configuring a Service EndPoint sucks. What about when I want to deploy this to other environments? I am going to have to repeat the manual steps for each environment and when I deploy my Azure aware plugin I am going to have to amend the Id each time. Now you might argue this will be a one off process and its no big deal. But I prefer my deployments not to involve manual steps so I'm inclined to post messages to the Azure Service Bus using code and have the connection string stored in a configuration entity along with other environment settings. Remember though that you have to use the REST API to post messages because the plugin runs in Sandbox mode.