APPLIES TO: Business Central 2023 release wave 1, update 22.1, and later
Onboarding telemetry gathers data about the following operations:
- An onboarding signal is registered for a company
- A registered onboarding signal meets its completion criteria
These events use normal verbosity (severityLevel 1) and TelemetryScope::All.
Onboarding started
Occurs when a new onboarding signal is registered for a company and signal type. Registering an existing signal doesn't emit another event.
General dimensions
| Dimension | Description or value |
|---|---|
| message | Onboarding Signal Started: {signal type} |
| user_Id | The user telemetry ID for the user. On the user card, you can use the user_Id to look up the user who triggered this telemetry event. |
Custom dimensions
| Dimension | Description or value |
|---|---|
| aadTenantId | 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. |
| alCountryCode | Specifies the localization for the environment, such as US or DK. |
| alCriteriaName | The name of the registered onboarding signal type. |
| alCriteriaId | The numeric ID of the onboarding signal type. |
| alStartDate | The date when the signal was registered, in XML date format. |
| alCompleteDate | The completion date, which isn't set when the signal is registered. |
| alRegisterExtensionId | The ID of the extension that registered the signal. |
| alUserRole | Specifies the current role center for the user, such as ACCOUNTANT, ORDER PROCESSOR or BUSINESS MANAGER. |
| alIsAdmin | Specifies if the user is an administrator. |
| alIsEvaluationCompany | Whether the current company is an evaluation company. |
| alTenantLicenseState | The license state of the tenant, such as Paid, Trial, Suspended, or Warning. |
| 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. |
| componentVersion | The version of the Business Central Server component that emits telemetry. |
| eventId | AL0000EIW |
Onboarding criteria completed
Occurs when a registered onboarding signal's provider reports that its criteria are met. The completion check runs during daily telemetry collection. It skips evaluation companies and sandbox environments.
General dimensions
| Dimension | Description or value |
|---|---|
| message | Onboarding Signal Completed: {signal type} |
| user_Id | The user telemetry ID for the user. On the user card, you can use the user_Id to look up the user who triggered this telemetry event. |
Custom dimensions
| Dimension | Description or value |
|---|---|
| aadTenantId | 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. |
| alCountryCode | Specifies the localization for the environment, such as US or DK. |
| alCriteriaName | The name of the completed onboarding signal type. |
| alCriteriaId | The numeric ID of the onboarding signal type. |
| alStartDate | The date when the signal was registered, in XML date format. |
| alCompleteDate | The date when the completion check detected that the criteria were met, in XML date format. |
| alRegisterExtensionId | The ID of the extension that registered the signal. |
| alUserRole | Specifies the current role center for the user, such as ACCOUNTANT, ORDER PROCESSOR or BUSINESS MANAGER. |
| alIsAdmin | Specifies if the user is an administrator. |
| alIsEvaluationCompany | Whether the current company is an evaluation company. |
| alTenantLicenseState | The license state of the tenant, such as Paid, Trial, Suspended, or Warning. |
| 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. |
| componentVersion | The version of the Business Central Server component that emits telemetry. |
| eventId | AL0000EIV |
Related information
Measure onboarding progress using telemetry Monitoring and Analyzing Telemetry
Enable Sending Telemetry to Application Insights