PL 400 : implement a Dataverse listener for an Azure solution (Publish and consume events)

Microsoft Dataverse is a tremendous product in the cloud market as it provides a business database with many features of applications that can consume software as a service (SaaS). We have already discussed about many features regarding this product, but it also integrates easily with external systems. Azure Bus Service provides the ability to work as asynchronous with the message broker and also facilitates to develop listener applications that can receive these events and processes as per the business requirements.

Microsoft Dataverse events trigger the execution of a remote code component called the listener.

These integrations are intended to provide an easy way to use additional extensibility outside the Dataverse platform. An Azure Solution Listener application that can read and process Microsoft Dataverse messages posted to the Azure Service Bus. A message queue is a store of messages on a service bus endpoint and a queue listener is an application that reads and processes these queued messages. Microsoft Dataverse supports a variety of methods to consume Azure Messaging Service Bus queue messages; queue, one-way, two ways, or REST. if using two way and REST, we are able to return a string of information back to Dataverse.

Write a queue listener:


  • Create a C# Console Application in Visual Studio that targets .NET 4.6.2 or higher.

  • Add the following NuGet packages:
    • Azure.Messaging.ServiceBus
    • Microsoft.CrmSdk.CoreAssemblies
  • In the application's Main method, paste the following code. Replace the Endpoint URL with your Azure Service Bus Namespace's Endpoint URL and the queue name if it differs:
string connectionString =@"[ENDPOINT URL]";
string queueName = "mslearnsamplequeue";
QueueClient queueClient = QueueClient.CreateFromConnectionString(connectionString, queueName, ReceiveMode.PeekLock);

  • To consume your message, use the "OnMessage" method, which provides the ability to process a Service Bus queue message in an event-driven message pump. 

queueClient.OnMessage(message =>
            {
                //get RemoteExecutionContext based on Message Format
                RemoteExecutionContext context = null;

                if (message.ContentType == "application/msbin1") //.NETBinary Message Format
                {
                    context = message.GetBody<RemoteExecutionContext>();
                }
                else if (message.ContentType == "application/json") //JSON Message Format
                {
                    context = message.GetBody<RemoteExecutionContext>(
                                      new DataContractJsonSerializer(typeof(RemoteExecutionContext)));
                }
                else if (message.ContentType == "application/xml") //XML Message Format
                {
                    context = message.GetBody<RemoteExecutionContext>(
                        new DataContractSerializer(typeof(RemoteExecutionContext)));
                }
                try
                {
//serialize the entire context leveraging the SerializeContext extension method
                    Console.WriteLine(context.SerializeContext());
                }
                catch (Exception ex)
                {
                    Console.WriteLine(ex.ToString());
                }
            });
  • At last we need to add Console.ReadLine() to our main method to allow for multiple messages to be processed.
  • run the application

Courtesy:


Comments

Post a Comment

Popular posts from this blog

Exploring the Differences: Managed vs. Unmanaged Solutions in Dynamics CRM/Dataverse

Image
In Dynamics CRM/Dataverse, solutions are central to Application Lifecycle Management (ALM) , providing a structured way to manage, package, and distribute customizations across environments. Microsoft uses solutions to transfer apps and customizations by exporting them from one Dataverse environment and importing them into another.  Each solution is authored and maintained by a publisher and includes components like Power Apps (canvas and model-driven), flows, entities, forms, connectors, web resources, and configurations—excluding business data. Solutions streamline ALM practices within Microsoft Power Platform. In Dynamics CRM/Dataverse, there are two types of solutions: Managed and Unmanaged . When planning an implementation, it’s important to understand the advantages and disadvantages of each to make an informed decision. Let’s explore both types to determine the best approach for development and deployment. In Dynamics 365 CRM, a managed solution is a fully packaged solution ...
Read more

PCF vs. Web Resources: Choosing the Right Extensibility Tool for Dataverse

Image
Extensibility refers to the ability to be extended or augmented beyond the default capabilities of the platform. This involves customization but also includes more advanced techniques, such as coding, integration with external services, and the use of custom components. In the context of Power Platform and Dynamics CRM, the term "extend behavior" refers to the ability to customize and extend the functionality of the platform to meet specific business needs. Extensibility often requires technical skills, such as coding in JavaScript, C#, or using tools like Azure Logic Apps and Power Automate for complex integrations. Customization  is a subset of extensibility. Customization involves configuring and modifying existing elements within the platform to suit specific business needs. Extensibility, on the other hand, covers a wide range of functions and techniques, including customization and more advanced development and integration tasks, to extend the capabilities of the Power ...
Read more

Effective Strategies for Debugging Plugins in Dynamics CRM

Image
In a recent interview, I was asked about debugging plugins in Dynamics CRM. The interviewer specifically wanted to know my approach to plugin debugging. In response, I mentioned using the Plugin Registration Tool profiler. However, I later realized there are multiple methods to debug plugins in Dynamics CRM/Dataverse, each essential for efficient troubleshooting. Debugging plays a crucial role in development, and having a solid understanding of various debugging approaches can help streamline issue resolution in Dynamics 365. Here, I'll explore different techniques for debugging plugin code. There are below options to use in the plugin in Dynamics CRM/Dataverse ITracingService : In Dynamics CRM plugin development, ITracingService is a service provided within the plugin's execution context that logs information for tracing and debugging. It allows developers to capture real-time. Plugin Profiler : A plugin profiler in Dynamics CRM (or Dataverse) is a debugging tool in the Plugi...
Read more