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

Setting up OAuth Authentication for Business Central Web Services / APIs

Introduction: After upgrading Business Central to version 17 (Wave2 2020), I found that there was an error telling me that WebService Key is going to be deprecated soon. Web Service Access Key is deprecated. Hence, I decided to explore and probably make it easier through this blog. Pre- requisites : Admin Access to Office 365 Admin Access to Azure Demonstration: 1. App Registration on Azure Portal: To enable OAuth authentication for any apps in Azure Active Directory, you will need to perform App Registration and set up the permissions and security details. i.) Register the App: Search for 'App Registration' on the Azure Portal. Click on New Registration Type in the App Names, Account Types and Redirect URI. Registering Application ii.) Setup API Permissions: Go to API Permissions > Add Permissions > Business Central App > Select Delegated Permissions > Select Other Permissions and Financials > Add Permissions Button. Setup API Permissions iii.) Setup Client Secr

How to Upgrade Data from Microsoft Dynamics NAV to Microsoft Dynamics Business Central On Premise - Part 2

 Introduction: Now that the first step of the problem preprocessing of the NAV Database to make it ready to be migrated to BC is done(refer Part 1 ), we can now proceed further with connecting the database in Business Central On-Premise. Pre- requisites : Microsoft Dynamics 365 Business Central Microsoft Dynamics for NAV Microsoft SQL Server Management Studio (SSMS) Powershell ISE Understand NAV to BC Upgrade Considerations -  Click here Understand Upgrade Path -  Click here Books & References: Demonstration: 1. Install Business