RTC debugging

RTC debugging

  • Comments 4

Create a page        Activate debugging        Debug        Other useful information when debugging

 For this example we will be using Microsoft Dynamics NAV 2009 R2 and Microsoft Visual Studio 2010 Professional.

Create a page

To use as an example for debugging, let's create an empty page (for example 50000 RTCDebugTest) with a new action called “Messages”. In code of this action, we create two local variables:

 Name

 DataType

 Subtype

 Length

 n

 Integer

 str

 Text

 

 30

And write the following code lines in “Messages - OnAction()”: 

  n := 21;

  MESSAGE('%1', n);

  str := 'Hello  World!';

  MESSAGE('%1', str);

 Just to access the actions a little faster, we will change these properties of the action:

  Promoted=Yes;

  PromotedIsBig=Yes;

  Image=Start;


Save and compile.

  

Activate debugging

For this we need to go to CustomSettings.config of the Service folder (“%PROGRAMFILES(X86)%\Microsoft Dynamics NAV\60\Service\CustomSettings.config” on x64, or “%PROGRAMFILES%\Microsoft Dynamics NAV\60\Service\CustomSettings.config” on x86) and set this to “true”:

<add key="EnableDebugging" value="true" />

Once we restart the NAV service (by default “MicrosoftDynamicsNavServer”) and run the RTC, we will see that in “%PROGRAMDATA%\Microsoft\Microsoft Dynamics NAV\60\Server\MicrosoftDynamicsNavServer\source” it has created a single .cs file for each object that we have on the RTC:

 

Remember to change the value of “EnableDebugging” back to false, and to restart the NAV service, whenever we are done debugging, since if we forget it will continue to generate the .cs files in the background and the RTC will take longer to load.

 

Debugging

Now we open Visual Studio (right click and “Run as Administrator”). Now we need to open the source code of our page, so we go to “File -> Open -> File” (Ctrl + O) and from all the generated .cs files we open the page that we have just created (50000 RTCDebugTest):

Now we can see our C/AL (commented) and its equivalent in C# for each line:

In this case we have set a breakpoint for the C# line that equals our C/AL “n := 21;”, by doing double click on the left margin or by going to “Debug -> Toggle Breakpoint”. The next step will be to go to “Tools -> Attach to Process” (Ctrl + Alt + P). From the list of processes we select our NAV service and click on “Attach” (if you can’t see the NAV service in the list, check that it is running, and mark “Show processes from all users”:

Now if we run the page on the RTC, and click on the “Messages” action:

We will see that Visual Studio will stop right on our breakpoint:

 And we can continue to debug using F10 (Step Over) and F11 (Step Into):


This is all that you need to know in order to start debugging your RTC code. The following information contains important details and also extra information in case you need to debug a little deeper.

  

Other useful information when debugging

 If we make a change in our page in NAV

In this case, after saving and compiling our page in the Classic Client and running the page again, Visual Studio will show us this message box indicating that the source code has changed and we if would like to Update it:


After accepting it, we will see the page code now reflects the changes we did to the page.

Variables

We can analyze the behavior of our variables during execution, either by setting the mouse over the variable that we are interested in:

Or by pinning it if we want to monitor its value through execution:

Or we can also add the variables that we would like to monitor to a “Watch” (double click over the variable, and drag it to the “Watch”:

We can also monitor our local variables in the “Locals” tab. In this example, we can see how our “str” or type Text in C/AL creates an object of type “NavText” in C#. For these cases in which our variables are objects, we can also see the values of any attributes of the class, like for example “MaxLength”, which we had left by default in 30. 

 Breakpoints

In the breakpoints panel we can see all the breakpoints that we have defined (for this and other .cs):

Sometimes we might want to stop at a breakpoint only if a certain condition is true. For this we can create a conditional breakpoint by right clicking on the breakpoint and selecting “Condition…”, and we will see a window where we can set the condition:

In this case we set it to stop only when “n” is different than “2” (which obviously always happens, so it will always stop, but this is just a silly example). The conditions we set will all appear in the breakpoints panel marked with a white cross and with the condition.

 Calls

In the Call Stack panel (Debug -> Windows -> Call Stack) we can see the calls that happened up to the breakpoint or line in which we have stopped. For example, if we modify the code of the page so that in “OnAction” we call a function “Funcion1” and from this one we call another function called “Funcion2”, and set a breakpoint on “Function2” we will get the following call stack:

 Registers, Memory and Dissasembler

If for whatever reason we need to analyze at a lower level what is happening underneath, we can also check the state of the registers (Debug -> Windows -> Registers), where we will see in red any values which have changed in the last executed line:

Or check the value that was loaded in a certain memory address (Debug -> Windows -> Memory). You can also see the disassembly code (Debug -> Windows -> Disassembly) and debug from here instruction by instruction:

 

 

Juliet R. Moreiro Bockhop

Microsoft Dynamics NAV Support Engineer

“Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to,  the implied warranties of merchantability or fitness for a particular purpose. This mail message assumes that you are familiar with the programming language that is being demonstrated and the tools that are used to create and debug procedures.”

 

Leave a Comment
  • Please add 5 and 3 and type the answer here:
  • Post
  • What is the minimum Visual studio installation required to be able to debug NAV RTC code?

    Is this minimum visual studio available for free for NAV partners?

  • Hello!

    The "attach to process" option is available on all Visual Studio editions except on Visual Studio Express: msdn.microsoft.com/.../c6wf8e4z.aspx

  • Hi,

    I tried your instructions but I could not debug the RTC, after I attached the process the break point turns yellow with warning triangle and I can see the message in the link bellow

    dl.dropbox.com/.../RTC_Debug.jpg

    can you help?

    thanks

    NS

  • Thanks for the link Juliet.

    Then the answer is that we need to have at least VS Pro for all of our NAV developers to be able to debug code in RTC? This creates an extra cost for us as a partner since NAV developers could do just fine without the Visual studio before...

Page 1 of 1 (4 items)