DYNAMICS 365 HOW TO DEBUG A PLUGIN USING PLUGIN PROFILER

Often, you might face issue that it is not clear and you are not able to solve it due an error being raised in your plugins triggered. Therefore, you are obliged to debug the plugin in order to troubleshoot and solve the problem.

In this post, you will learn how to debug your plugin of Dynamics 365 environment using Plugin Profiler in the Plugin Registration Tool.

Below are the needed Step by Step procedure to debug a plugin

  1. Installing Plugin Profiler
    • Open the Plugin Registration Tool
    • From the menu, click Install Profiler to install it
    • Once the installation is done, you will get a notification
    debug plugin 1

  2. Start profiling
    • In the Plugin Registration Tool, select the step you want to debug
    • Click Start Profiling from the menu
    debug plugin 2

  3. Setting the Profiler
    • Select Exception (the profiler will start execution if the plugin throws an exception which is our case, but you can change the options as per your needs)
    • Enter the number of executions needed (1 is default value)
    • Check if you want to include the secure configuration
    • After the settings are entered, click OK
    • The step will be marked as Profiled
    debug plugin 3

  4. Throwing exception
    • Open Dynamics 365 environment
    • Perform the operation on which the above step has been registered (Update of Relationship Type of an Account in our case)
    debug plugin 4

  5. Downloading Log File
    • In the UI, when the exception is thrown, the Business Process Error dialog will be displayed
    • Click Download Log File to save it on your local machine (it'll be used in step 7)
    debug plugin 5

  6. Attaching to process the plugin in Visual Studio
    • Open your plugin project in Visual Studio
    • Open the plugin class
    • Add a breakpoint in the beginning of your code
    • Click Debug > Attach to Process
    • Scroll down and select the process named PluginRegistration.exe
    debug plugin 6

  7. Replaying the plugin execution
    • In the Plugin Registration Tool, click Debug from the menu
    • In the Profile section, select the log file you saved in step 5
    • In the Assembly Location section, select the dll of your assembly project
    • In the Plugin section, make sure that the profiled plugin step is selected
    • Click Start Execution
    debug plugin 7

    debug plugin 8

  8. Debugging the plugin
    • As soon as you click on Start Execution, the debugger will stop at the breakpoint inserted in your code
    • You can now debug the code line by line by pressing F10 and validate the reason of the exception thrown
    debug plugin 9

  9. Stopping profiler
    • After you are done, open the Plugin Registration Tool
    • From the menu, click Stop Profiling to stop profiling of the step

Bonus Tips:
  • Plugin profiler is a very nice tool to debug plugins for Online environments; however, it will not give us a real-time state of the Dynamics 365 database we are working on because it will replay the execution from the log file we saved locally
  • Another downside is that you cannot debug Custom Workflow Activities
  • Previously, for on-premise environments, we were able to debug the plugins and workflow activities instantly while we are working in the CRM UI using Visual Studio IDE Remote Debugger that gives us real-time state of our CRM database
  • For the ones who are interested to know how to debug the plugins using VS IDE tool, this link is very helpful


Hope This Helps!

Comments

Post a Comment

Popular posts from this blog

DYNAMICS 365 FILTER LOOKUP FIELD BASED ON N:N RELATIONSHIP

Image
How to filter a Lookup field based on a N:N relationship of a parent entity using JavaScript . To show you this, I will use the Account entity, the Contact entity, and a custom entity Conference . The contact entity has a N:1 relation with the account entity (lookup field) The contact entity has a N:1 relation with the conference entity (lookup field) The account entity has a N:N relation with the conference entity (sub-grid) I need to filter the conference lookup of the contact entity to list The conference records that are related to the contact parent account or The conference records that are not related to any account Based on the above conditions, the users will not be able to ch...
Read more

DYNAMICS 365 LEVEL UP BROWSER EXTENSION - PART 1 - FORMS

Image
Level up for Dynamics 365/Power Apps is a browser extension in Edge, Google Chrome, and Firefox that can help users to perform advanced actions related to Dynamics 365. It is a free and very useful tool that can be downloaded from the browser extension web store. It contains a bunch of features that we will be listing and explaining them in a series of posts around the Level up extension In this post, we will see a brief summary about the Forms actions that can be done in the Level up for Dynamics 365/Power Apps . LOGICAL NAMES This option will show logical names for fields, tabs, web resources and sub-grids on the form CLEAR LOGICAL NAMES This option will remove the logical names of fields, tab...
Read more

DYNAMICS 365 REFERENCE PANEL

Image
Dynamics 365 product team is always working to improve and give the best user experience. Therefore, the continuous evolutions of the different areas and possibilities are one of the most critical things to bring. In this post, I will talk about one of these user experience improvements which is Reference Panel that was introduced with the Dynamics 365 V9. So what is exactly a Reference Panel? The Reference Panel is a type of section that can be added to the form that allows users to move across different types of sub grids and quick view controls in a single place without scrolling down or up. Let's take the example of the account form, where many quick view forms and sub grids exist inside (contacts, recent cases and opportunities...). When the users enter the form, they have to scroll up and down through the form in order to check the sub grids and their data which is sometimes annoying for them. ...
Read more