Analyzing client action telemetry

INTRODUCED IN: Business Central 2023 release wave 1, version 22.0.

Client action telemetry gathers data about supported actions that users select on pages in the Business Central client, such as enabling or disabling analysis mode. It doesn't record every page action. Each action event tells you the type of action, on which page it was triggered, information about the user's environment, and more.

Use the data to gather statistics about usage of client features by users.

Client action invoked

Occurs when an action on a page in the client was invoked.

General dimensions

The traces table is a built-in table in Application Insights. Here are some of the fields most used in analysis of the signal:

FieldDescription or value
messageClient action invoked:{Action}
user_IdThe user telemetry ID for the user. From the user card, you can use user_Id to identify the user who triggered this telemetry event. Learn more in Assign a telemetry ID to users.

Custom dimensions

DimensionDescription or value
aadTenantIdSpecifies 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.
alObjectIdSpecifies the ID of the page object that was opened.
alObjectNameSpecifies the name of the page object that was opened.
alObjectTypePage
appIdSpecifies the Id of the app/extension that was opened.
appNameSpecifies the name of the app/extension that the page belongs to.
appPublisherSpecifies the publisher of the app/extension that the page belongs to.
appVersionSpecifies the version of the app/extension that the page belongs to.
clientActionSpecifies the type of action that was invoked in the client such as UI.AnalysisMode.Disabled or UI.AnalysisMode.Enabled.
clientTypeSpecifies the type of client that opened the session, such as Background or Web. For a list of the client types, see ClientType Option Type.
companyNameThe current company name.
environmentNameSpecifies the name of the tenant environment. Learn more in Managing Environments.
environmentTypeSpecifies the environment type for the tenant, such as Production or Sandbox. Learn more in Environment Types.
eventIdCL0003

Monitoring and Analyzing Telemetry
Enable Sending Telemetry to Application Insights