{"title":"Analyzing client control add-in exception telemetry","url":"https://jonas-paprotka.de/docs/dev-itpro/administration/telemetry-client-add-in-exceptions/","by":"JOP-AL","license":"Copyright (c) Microsoft Corporation. CC BY 4.0, https://creativecommons.org/licenses/by/4.0/; code samples MIT. From https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/telemetry-client-add-in-exceptions, MicrosoftDocs/dynamics365smb-devitpro-pb at 828b6ee (2026-11-19). Changed: includes filled in, links to this site, and for agents shortened without dropping a fact.","credit":"Microsoft Corporation, CC BY 4.0","origin":"https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/telemetry-client-add-in-exceptions","source":{"name":"Business Central developer and IT pro docs","repo":"https://github.com/MicrosoftDocs/dynamics365smb-devitpro-pb","commit":"828b6ee72fcd75755627cd6011f3d20899217ab2","date":"2026-11-19"},"checked":"2026-11-19","description":"Analyze Business Central control add-in exceptions in Application Insights to identify affected extensions, inspect error details, and troubleshoot failures.","date":"2026-11-17","meta":{"topic":"concept-article"},"outline":[{"level":1,"title":"Analyzing client control add-in exception telemetry","slug":"analyzing-client-control-add-in-exception-telemetry","at":0,"chars":6356},{"level":2,"title":"Exception raised inside a control add-in","slug":"exception-raised-inside-a-control-add-in","at":874,"chars":3777},{"level":3,"title":"General dimensions","slug":"general-dimensions","at":979,"chars":402},{"level":3,"title":"Custom dimensions","slug":"custom-dimensions","at":1381,"chars":3270},{"level":2,"title":"Sample KQL code (control add-in exceptions)","slug":"sample-kql-code-control-add-in-exceptions","at":4651,"chars":1476},{"level":2,"title":"Related information","slug":"related-information","at":6127,"chars":229}],"text":"# Analyzing client control add-in exception telemetry\n> APPLIES TO: Business Central 2025 release wave 1 (v26) and later.\nClient control add-in exception telemetry gathers data about exceptions thrown in control add-ins. Each event tells you the type of exception, in which add-in it was triggered, information about the user's environment, and more.\nUse the data to gather statistics about exceptions in control add-ins for troubleshooting and error mitigation.\n> NOTE\n> In Azure Application Insights, telemetry about client add-in exceptions is logged to the exceptions table and not the traces table like other Business Central traces. This also means that you can use the built-in pages in the Failures page of the Azure Application Insights for troubleshooting. See https://learn.microsoft.com/azure/azure-monitor/app/failures-and-performance-views?tabs=failures-view.\n## Exception raised inside a control add-in\nOccurs when an exception was raised inside a control add-in.\n### General dimensions\nThe exceptions table is a built-in table in Azure Application Insights. Here are some of the fields most used in analysis of the signal:\nField|Description or value\nuser_Id|The user telemetry ID for the user. From the user card, you can use user_Id to identify the user who triggered this telemetry event. See telemetry-enable-application-insights#assign-a-telemetry-id-to-users.\n### Custom dimensions\nDimension|Description or value\naadTenantId|Specifies the Microsoft Entra tenant ID used for Microsoft Entra authentication. For on-premises, if you aren't using Microsoft Entra authentication, this value is common.\nalObjectId|Specifies the ID of the page object that was opened.\nalObjectName|Specifies the name of the page object that was opened.\nalObjectType|ControlAddIn\nappId|Specifies the Id of the app/extension that was opened.\nappName|Specifies the name of the app/extension that the page belongs to.\nappPublisher|Specifies the publisher of the app/extension that the page belongs to.\nappVersion|Specifies the version of the app/extension that the page belongs to.\nclientType|Specifies the type of client that opened the session, such as Background or Web. For a list of the client types, see ClientType Option Type<../developer/methods-auto/clienttype/clienttype-option>.\ncompanyName|The current company name.\ncontrolAddInName|The name of the page control that hosts the control add-in from which the exception was thrown.\ndeviceScreenResolution|Specifies the display resolution of the device that opened the page. The value is given as {width}×{height}, with the units in pixels. For example, 1024×768 means the width is 1024 pixels and the height is 768 pixels.\nenvironmentName|Specifies the name of the tenant environment. See Managing Environments<tenant-admin-center-environments>.\nenvironmentType|Specifies the environment type for the tenant, such as Production or Sandbox. See tenant-admin-center-environments#types-of-environments.\neventId|CL0005\nhostType|Specifies the host that loads the page. <ul><li>Device App<br /> The page was loaded by a Business Central mobile app, from a desktop, tablet, or phone. </li><li>Office add-in<br /> The page was loaded by Office application, like Excel or Outlook.</li><li>Designer <br /> The page was loaded by the in-client designer, used for changing page layout. The designer has different modes. Each mode provides a different level of page customization, as specified in the designerLevel dimension.</li><li>Shim Browser <br /> The page was loaded by the UWP (Universal Windows Platform) application.</li><li>Browser<br /> The page was loaded by web browser, like Microsoft Edge or Google Chrome. </li></ul>\nAll error information is stored in the following properties:\nProperty|Description or value\nproblemId|The problem ID identifies where the exception was thrown in code. It's used for exceptions grouping. Typically, it's a combination of an exception type and a function from the call stack.\ntype|The type of the error that occurred.\nassembly|The web assembly where the error occurred.\nmethod|The JavaScript method where the error occurred.\nouterType|The top level error type on the stack trace.\nouterMessage|The top level error message on the stack trace.\nouterAssembly|The top level assembly on the stack trace.\nouterMethod|The top level method on the stack trace.\ninnermostType|The inner most error type on the stack trace.\ninnermostMessage|The inner most error message on the stack trace.\ninnermostAssembly|The inner most assembly on the stack trace.\ninnermostMethod|The inner most method on the stack trace.\ndetails|JSON structure with more information, such as stack traces.\n## Sample KQL code (control add-in exceptions)\nThis KQL code can help you get started analyzing client add-in exceptions:\n```kql\nexceptions\n| where timestamp > ago(60d) // adjust as needed\n| where customDimensions.eventId == 'CL0005'\n| order by timestamp desc\n| take 5\n| project timestamp\n// in which environment/company did it happen\n, aadTenantId = customDimensions.aadTenantId\n, environmentName = customDimensions.environmentName\n, environmentType = customDimensions.environmentType\n, companyName = customDimensions.companyName\n// in which extension/app\n, appId = customDimensions.appId\n, appName = customDimensions.appName\n, appPublisher = customDimensions.appPublisher\n, appVersion = customDimensions.appVersion\n// in which object\n, alObjectId = customDimensions.alObjectId\n, alObjectName = customDimensions.alObjectName\n, alObjectType = customDimensions.alObjectType\n// which add-in\n, controlAddInName = customDimensions.controlAddInName\n// which client (browser, tablet, phone, ...)\n, clientType = customDimensions.clientType\n, hostType = customDimensions.hostType\n// device info\n, deviceScreenResolution = customDimensions.deviceScreenResolution\n// error information\n, problemId\n, type\n, assembly\n, method\n, outerType\n, outerMessage\n, outerAssembly\n, outerMethod\n, innermostType\n, innermostMessage\n, innermostAssembly\n, innermostMethod\n, details // json structure with more information, such as stack traces\n// which user got the error\n, usertelemetryId = user_Id\n```\n## Related information\nControl add-in object<../developer/devenv-control-addin-object>\nMonitoring and Analyzing Telemetry<telemetry-overview>\nEnable Sending Telemetry to Application Insights<telemetry-enable-application-insights>"}