Bewerken

Delen via

Understanding the error dialog

  • Artikel

The AL language has many error handling features, which can help you deal with unexpected situations that occur when code is run. Whenever an error is surfaced to the user, the Business Central client displays an error dialog, similar to the figure later in this article. In this article, you can learn more about the different parts of the error dialog so you can more effectively help users mitigate any issues they might encounter.

Visual elements of the error dialog (2022 release wave 2 and earlier)

In versions 21 and earlier, the error dialog consists of the following four parts:

  1. A title (optionally)
  2. A message directed to the user
  3. A How to report this issue part that includes a Copy information to clipboard action
  4. A yes or no question as to whether the message was helpful

The following figure shows an example of an error dialog in the 2022 release wave 2.

Show an example of an error dialog in Business Central version 21.

Visual elements of the error dialog (2023 release wave 1 and later)

Starting in version 22, the error dialog consists of the following four parts:

  1. A title (optionally)
  2. A message directed to the user
  3. A Copy Details action.
  4. A yes or no question as to whether the message was helpful

The following figure shows an example and example error dialog in the 2023 release wave 1 or later.

Show an example of an error dialog in the latest Business Central version.

Information in Copy details section

The information provided in Copy details section is meant for troubleshooting.

Here's an example of the content of Copy details:

If requesting support, please provide the following details to help troubleshooting:

The report couldn’t be generated, because it was empty. Adjust your filters and try again.

Internal session ID: 
23fa3850-ea3c-4529-81c8-fc36d3324676

Application Insights session ID: 
2637787e-7dfc-4139-9f83-2b16883b626e

Client activity id: 
9ca384ba-c4a0-eed4-d6df-267a2a40ae5f

Time stamp on error: 
2023-10-04T09:05:40.7201590Z

User telemetry id: 
7979ab03-7b75-455e-beed-505c7b2649fb

AL call stack: 
Report1(Report 50101).OnPostReport(Trigger) line 2 - ReportErrors by Default publisher

The error messages supplied to the user are listed below the line If requesting support, please provide the following details to help troubleshooting:. Optionally, messages are in DetailedMessage if the AL developer used the ErrorInfo version of the Error method.

After the error messages, the platform adds more sections that can be useful when troubleshooting. The following table explains these additional sections in Copy details.

Section Description
Internal session ID An internal session ID that is used by the Azure Application Insights support team in case the issue needs to be reported as support case.
Application Insights session ID The session ID. This ID is recorded in the operationId field in the telemetry logged to Azure Application Insights
Client activity ID An internal session ID that is used by the Azure Application Insights support team in case the issue needs to be reported as support case.
Time stamp on error The date and time (in UTC timezone) for when the error occurred.
User telemetry 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.
AL call stack The AL stack trace in the session when the error occurred.

There are three pieces of information that help you better understand the error that the user experienced:

  1. The error messages
  2. Application Insights session ID (if telemetry is enabled in the environment/app)
  3. The AL stack trace

Sample KQL code (troubleshoot further with telemetry)

In telemetry, use this KQL code to help you understand what happened in the session prior to the error.

traces
| where timestamp > ago(1d) // adjust as needed
| where operation_Id == '<insert Application Insights session ID here>'
| project timestamp
, message
, eventId = customDimensions.eventId 
, customDimensions
| order by timestamp asc

Understanding the AL stack trace

Whenever an operation in AL is started, the operation is added to a data structure called the AL stack. When the operation completes, it's removed from the AL stack. This way, the AL stack trace is then showing what AL was currently running in the session. For each operation, the object the operation comes from and details about the app are also logged.

Example

Consider the following AL stack trace:

"Payment Application Proposal"(Table 1293).ValidateEntryNotApplied line 12 - Base Application by Microsoft
"Payment Application Proposal"(Table 1293)."Applied - OnValidate"(Trigger) line 17 - Base Application by Microsoft
"Bank Acc. Reconciliation Line"(Table 274).DisplayApplication line 27 - Base Application by Microsoft
"Payment Application Review"(Page 1287)."ApplyEntries - OnAction"(Trigger) line 3 - Base Application by Microsoft
"Payment Reconciliation Journal"(Page 1290)."Match Confidence - OnDrillDown"(Trigger) line 8 - Base Application by Microsoft

The first operation in the stack is found in the bottom line: the Match Confidence - OnDrillDown"(Trigger) from the "Payment Reconciliation Journal" page (object ID 1290) residing in the app Base Application by the publisher Microsoft. This line is where execution started. The error happened in the operation in the top of the stack: ValidateEntryNotApplied in the "Payment Application Proposal" table (object 1293) residing in the app Base Application by the publisher Microsoft.

You can then use the stack trace to identify:

  1. What the user was doing (the bottom of the stack trace)
  2. Where the error happened (the top of the stack trace)

Error message telemetry

When a user gets an error dialog while working in Business Central, a telemetry signal is also emitted, which can be logged in an Azure Application Insights resource. This telemetry data let's you identify and analyze calls to the Error method from AL code. You can also set up alerts in Azure Application Insights to get notified if many users experience errors.

For more information, see Error method trace telemetry.

The error dialog also includes a yes or no question as to whether the message was helpful, similar to the following illustration:

Shows the error dialog and the voting actions, Yes and No, about the helpfulness of the message.

If a user selects either Yes or No, a signal is emitted and recorded in Azure Application Insights. This information can help partners and developers get insight into error messages that users find hard to understand. They can then follow up with the customer to help out.

For more information, see Analyzing Error Message Quality Telemetry.

Failure modeling and robust coding practices
Error message quality telemetry
Error method telemetry
Permission error telemetry
AL error handling
AL Control Statements
AL Development Environment