Registering Service Endpoint for Azure Service Bus Topic in Microsoft Dynamics 365 CE

I will be using Plugin Registration tool to register Service Endpoint for Azure Service Bus Topic in my trial Microsoft Dynamics 365 CE Instance.

Here are the steps to you need to follow:

Step 1. Login to your Microsoft Dynamics 365 CE instance using plugin registration tool.

Step 2. Once logged in, Press “Ctrl + E”, or from file menu, go to Register -> Register New Service endpoint.

Step 3. Enter your Azure Service Bus Connection String in the shown popup, and click OK.

Step 4. You will be presented Service Endpoint Registration popup, where you need to enter following details:

Name: ASB Topic Endpoint (a friendly name to your service endpoint)

Designation Type: Topic

Topic Name: test_internal (enter your ASB Topic Name here)

Message Format: JSON (can be .NET Binary, and XML as well)

User Information Sent: None (can choose to pass on User ID as well)

After entering these details, click on Save.

Step 5. The Service Endpoint will be registered and will appear on the bottom of the list.

Step 6. Now we will register step on our Service Endpoint. For this, right click on the Service Endpoint and select Register New Step Option.

Step 7. You will be presented with the Register New Step popup. This is just like the way we register step on top of our plugin assembly. You will have to select the following fields:

• message,
• primary entity,
• secondary entity,
• field attributes (for Update),
• Step Name,
• Stage of Execution,
• Execution Mode (only Asynchronous mode supported on step that is being registered on Service Endpoint) etc.

Once you have entered these values, click on Register New Step button.

Step 8. Your step will be registered and shown as a child node under your registered Service Endpoint. Click on your service endpoint and go to Properties section. Here you can get the serviceendpointid of your service endpoint. This will be required when you will be passing data to ASB from inside your plugin or workflow.

Step 9. NOTE – If you try to use Synchronous mode while registering step onto your Service Endpoint, it will throw an error when you click on the Register New Step button. This is because it only allows Asynchronous mode on the Service Endpoint. The below two screenshots demonstrate this scenario and show the error message that is thrown when we try to do this.

Hope this is helpful, Happy Coding :)