Analyzing client action telemetry
INTRODUCED IN: Business Central 2023 release wave 1, version 22.0.
Client action telemetry gathers data about actions that users select on pages in the Business Central client. 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 pageViews table is a built-in table in Application Insights. Here are some of the fields most used in analysis of the signal:
| Field | Description or value |
|---|---|
| message | Client action invoked: {Action} |
| user_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. Learn more in Assign a telemetry ID to users. Data in user_Id from the User card was introduced in version 24 for page view telemetry. |
Custom dimensions
| Dimension | Description or value |
|---|---|
| aadTenantId |
Note Azure Active Directory is now Microsoft Entra ID. Learn more |
| alObjectId | Specifies the ID of the page object that was opened. |
| alObjectName | Specifies the name of the page object that was opened. |
| alObjectType | Page |
| appId | Specifies the Id of the app/extension that was opened. |
| appName | Specifies the name of the app/extension that the page belongs to. |
| appPublisher | Specifies the publisher of the app/extension that the page belongs to. |
| appVersion | Specifies the version of the app/extension that the page belongs to. |
| clientAction | Specifies the type of action that was invoked in the client such as UI.AnalysisMode.Disabled or UI.AnalysisMode.Enabled. |
| clientType | 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. |
| companyName | The current company name. |
| environmentName | Specifies the name of the tenant environment. Learn more in Managing Environments. |
| environmentType | Specifies the environment type for the tenant, such as Production or Sandbox. Learn more in Environment Types. |
| eventId | CL0003 |
See also
Monitoring and Analyzing Telemetry
Enable Sending Telemetry to Application Insights