DYNAMICS 365 HOW TO DEBUG PLUGINS USING REMOTE DEBUGGER

In another post, we saw how to debug a plugin using Profiler and highlighted a downside of this method which will not give you a real-time state of the Dynamics 365 database you are working on.

However, in this post, I will show you how to debug a plugin in real-time of the execution of the plugin itself using the Visual Studio remote debugger tool.
This method will only work for On-premises environments since you should install and run the tool on the CRM server.

The below steps will teach you how to debug the plugins
  1. First things first, you have to download the remote debugger tool using this link based on the Visual Studio version you are working with
  2. Once the download is done, copy the installer on the CRM server and double click to install it
  3. When the installation is done, right click > Run as administrator
  4. In the remote debugger popup that is opened, you can notice the server name with a port number. Copy these information because they will be used in the next step within the Visual Studio
    debug plugins

  5. In Visual Studio, build your plugin project and go to the Debug folder found under the project folder
  6. Copy the .pdb file of your plugin and paste it in the following folder of the CRM server C:\Program Files\Microsoft Dynamics CRM\Server\bin\assembly
  7. Register your plugin using the Plugin Registration Tool so the latest changes are applied to the CRM
  8. Return to Visual Studio and from the menu select Debug > Attach to Process
  9. In the pop up window, for the Connection target option, enter the server name and port number you copied earlier from the remote debugger
  10. Select the checkbox Show processes from all users and click Refresh button. Scroll down to the end and select the process w3wp.exe and click Attach
    debug plugins 2

  11. Finally, set a breakpoint on the line of code where you want the debugger to stop and go to CRM and execute the action that will trigger the plugin to be executed... Few seconds and the debugger will stop on your breakpoint
    debug plugins 3

Bonus Tips:
  • Work with the .dll and .pdb files generated from the same build action of the plugin project. Use the .dll in the Plugin Registration Tool and copy the .pdb to the CRM server
  • In the attach process pop up window, select all the w3wp.exe in case of many processes
  • You can debug the asynchronous plugin by attaching to the processes named CrmAsyncService.exe


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