Skip to main content

Snapshot Debugging in Business Central


In this blog, I would like to discuss Snapshot Debugging in Business Central.
Also, I will be sharing my views on where exactly is snapshot debugging useful and how to use it efficiently.


  • Basic understanding of Debugging

Books & References: 


You need to create a snapshot debugger then you will need to initialize the debugging session, record the snapshots and then run the debugging on the snapshot that is downloaded.
Lets see each in detail below -

1. Setup the Snapshot Configuration:
Once you create a Project, you can create a Snapshot configuration in launch.json file.
    "version": "0.2.0",
    "configurations": [
            "name": "Sandbox",
            "request": "launch",
            "type": "al",
            "environmentType": "Sandbox",
            "environmentName": "sandbox",
            "startupObjectId": 22,
            "startupObjectType": "Page",
            "breakOnError": "All",
            "launchBrowser": true,
            "enableLongRunningSqlStatements": true,
            "enableSqlInformationDebugger": true
            "name": "Snapshot",
            "request": "snapshotInitialize",
            "type": "al",
            "environmentType": "Sandbox",
            "environmentName": "sandbox",
            "breakOnNext": "WebClient",
            "executionContext": "DebugAndProfile",
            "tenant": "e20094eb-a50d-4d93-9721-fc9a8834c92f"

Note the following changes in Snapshot configuration
  • Request - Tells the VS Code to Initialize a snapshot session with the configuration
  • BreakOnNext - Tells when to start the snapshot session. Basically after you have initialized the snapshot debugging from VS Code, you will have to open another sessions and then the snapshot begins.
  • ExecutionContext - Tell the BC Server whether you will be using the snapshots for Debugging or Performance Profiling or Both. In this case either Debug or DebugandProfile works
2. Start the Snapshot Session:

To start the Snapshot Session, you will need to hit F7 to Initialize Snapshot Debugging.
OR Hit Ctrl + Shift + P to get the command selection and select Initialize Snapshot Debugging.

Once the Snapshot is initialized, you need to start the session by click on SnapShot Debug icon on left corner (below)

You will need to select the Snapshot session

Now start Business Central Session for the Snapshot session to start capturing your processes.
If everything is fine then you will get a pop-up for snapshot debugging.
You can now run your process that you need to analyze for performance.

3. End the Snapshot Debugging Session:
Once you are done with running the process, you can stop the Snapshot Debugger by hitting Alt + F7 or Hit Ctrl + Shift + P and select Finish Snapshot Debugging Session.

You will need to select the Snapshot Debugging session in VS Code to finish.

After few seconds your Snapshot Debugging should stop and a ZIP file should be created in .snapshots folder.
Using this Snapshot File you can now debug. 

4. Debugging using Snapshot:
Now that you have the Snapshot, you can start the debugging. Click on the Snapshot Debugging and select the Snapshot Debugging Session.

Now wherever you have put the debugger point, the debugging session will hit there and wait for the details.

You should be now able to debug as usual.


Generally, snapshot debugging is used where the scenario is repetitive or cannot be easily debugged. For example, you can use snapshot debugging in the Production Environment. Also, you can store this snapshot and debug in front of the client where usual debugging takes time on session initializing and other activities.

Thank you for reading and hope this blog helps.



Popular posts from this blog

Something went wrong. An Error occurred - Error Resolution

Introduction: With the installation of NAV 2018 or BC On-premise, I have observed that when creating New Server Instance and New WebServer Instance, you will get the error 'Something went wrong. An Error occurred '. I referred to the community questions below but didn't find my resolution. Hence, I decided to write this blog. Pre-requisites: Microsoft Dynamics Business Central - On-Premise / NAV 2018 Understanding of Business Central Authentication  Books & References: Demonstration: 1. Creation of NAVServerInstance: In order to create NAVServerInstance, you can either add the Server Instance through Business Central Administration or Powershell command. Add Instance - Business Central Administration Add Insta

Universal Code Error and Resolution

Introduction: On Friday, May 12th, 2023, the Business Central On-Premise Production Environments started throwing universal code errors as follows. This occurred to every customer on a lower version of BC 19,20 and 21 irrespective of their localization, customization, and license. Pre-requisites:  Understanding of Technical Upgrade in Business Central On-Prem References: BC20 On prem. Universal Code requirement error after installing customer's license. - Dynamics 365 Business Central Forum Community Forum (40) Yammer : Dynamics 365 Business Central Development : View Conversation Root Cause: The certificate that signs Microsoft Base Application was expired. Errors started occurring if you Uninstalled, Installed Extensions, Restart Server Instances or for some even out of random started popping out. We first thought could be a license issue as we had fixed that before but this did not solve the issue. Resolution: Microsoft identified the issue and posted the following update The mi

How to update your Business Central to Latest CU

Introduction:  There are times when Microsoft releases the latest major version upgrade for Business Central Upgrade and you face many issues with it. As soon as the bugs are reported to Microsoft, they start to fix them and ask you to upgrade to a certain Cumulative Update. In this blog, I will be sharing my experience with Business Central v21 CU0 upgrade to Business Central v21 CU2. Pre-requisites:  Business Central DVD for Latest CU Basic Understanding of Business Central CU Updates Books & References:  List of Update Packages How to Update CU version Demonstration:  1. Check the current state of BC: As part of knowing the current state of your Business Central environment, I'm assuming that your Business Central Environment will have some data in the standard Base App also there will be customization with extended tables and newly created tables. Customization - TableExtension on Customer Table  Customization - Custom Table created Make a note of the data that is present i