AI-Assisted Error Explanation
Discover / SAP Products / SAP S/4HANA Only / AI-Assisted Error Explanation
Intro
AI-assisted error explanation helps users understand and resolve the errors or warnings that they encounter when working on an object page in an application developed with SAP Fiori Elements.
Issue explanation
When to Use
Use AI-assisted error explanation in workflows where the user encounters errors or warnings via the message popover on an object page, and requires more details, and recommendations for resolving them.
Do
Use AI-assisted error explanation
- To provide users with a more detailed explanation for the errors or warnings that they encounter in workflows on the object page
- To recommend how to resolve the error or warning
- To speed up the users’ workflow
Don't
Don’t use AI-assisted error explanation:
- To display any system-related information
- To immediately display an explanation for an error or warning. Always let the user control when to generate an explanation with the Explain button.
- To explain simple errors that the user may already know how to resolve
Anatomy
AI-assisted error explanation extends the dialog component to enable new AI-specific interactions.
Structure of AI assisted error explanation dialog
- Dialog Container
- Short description of the error
- Understanding the Issue – an AI-generated explanation of the error
- “Show more” button – For progressive disclosure of a lengthy description.
- Resolving the issue – AI-generated recommendations on resolving the issue
- AI Notice [internal_only]– See Local AI Notice.[/internal_only]
- Feedback icons
- Footer – with Copy All and Close buttons
Behavior & Interaction
When the user encounters an error or warning on the object page in edit mode, it appears in the message popover. The user can navigate to the message and trigger an AI-generated explanation with the Explain button.
Message popover with ‘Explain’ button
During Generation
Busy indicator: The Issue Explanation dialog shows a busy indicator to inform the user that AI is generating the explanation.
Generating an error explanation (generation)
After generation
When generation is complete, the error explanation text is displayed in the dialog. The text headings ensure easy readability, and consistency. The user can share the explanation with the Copy All button.
Generation of error explanation completed
Responsive Behavior
The AI-assisted error explanation builds on the foundation of the dialog and its responsive behavior. For more on the responsive behavior of the AI-assisted error explanation dialog, see Dialog.
Related Links
Elements and Controls
- Dialog (guidelines)
- Message Popover (guidelines)
Implementation
- Dialog (SAPUI5 samples
- Message Popover (SAPUI5 samples)