Configuring Monitoring and Error Handling Features

Objective

After completing this lesson, you will be able to use additional features for simplified monitoring and error handling by managing custom objects like functions, hints, data links, and messages.

Introduction and Types

Custom objects are special user-defined elements that enhance the error handling and monitoring process. They make it easier to manage errors by adding user-specific functions, hints, data links, and messages in the monitoring and error handling transaction.

Types of Custom Objects

  • Custom functions: Allow users to navigate to other transactions directly.
  • Custom hints: Provide more user-specific information.
  • Custom data links: Link log messages to corresponding data fields.
  • Custom message texts: Replace standard log messages with user-defined texts.
Representation of custom objects including function, hint, data links and message texts. Each custom object includes a message class and number.

Identification and Maintenance of Custom Objects

  • Identification: Custom objects are identified by a message class and message number.
  • Definition: Custom objects can be defined in the log messages view of monitoring and error handling. Alternatively, defined in respective maintenance dialogs (for example,/AIF/CUST_FUNC for custom functions).
  • Linking: A custom object is linked to a specific log message and an interface. You can have multiple custom objects linked to one log message.
  • Visibility and scope: By default, the custom object is only available for the user who created the custom object. But the visibility and the scope of custom objects can be changed.

Visibility and Scope

The visibility of a custom object can be changed in the maintenance transaction for this object type. If the visibility of a custom object has been changed, you can no longer edit it in the monitoring and error handling transaction. To change the custom object, use the maintenance transaction for this object type.

Visibility Options:

  • (Default) Only for current user: Only the creator can see it.

  • A list of users: Specific users can see it.

  • For all: All users can see it.

Scope of Custom Objects

The scope of a custom object can be changed in the corresponding SAP Application Interface Framework maintenance transaction.

Scope Options:

  • (Default) Visible for selected message in this interface: Only for the created message in its interface.
  • Visible for all messages in this interface: For all messages in its interface.
  • Visible for selected message in all interfaces: For the specific message across all interfaces.
  • Visible for all messages in all interfaces: For all messages across all interfaces.

Once scope or visibility changes, maintenance must be performed via the respective maintenance transactions. You can find the following transactions to change custom objects in the SAP Menu under Cross-Application Components → SAP Application Interface Framework → → Administration:

  • Custom functions: /AIF/CUST_FUNC
  • Custom hints: /AIF/CUST_HINTS
  • Custom data links:/AIF/CUST_LINK
  • Custom message texts: /AIF/CUST_TEXT

Application of Custom Object

Custom Functions

Purpose: Allow users to jump to another transaction directly from the monitoring and error handling transaction, facilitating swift navigation and problem resolution.

Configuration: Define in/AIF/CUST_FUNC. Various parameters can be used:

Manual Values: Directly enter the value for the parameter.

Message Variables: Select a message variable from the message details.

Offset Message Variables: Maintain an offset if needed.

Value Mapping: Set value mappings for the parameters.

Best Practices:
  • Clearly label custom functions for ease of recognition.
  • Ensure parameters are correctly identified and mapped to avoid incorrect navigation.
  • Regularly review and update custom functions as system processes change.
Visual of custom object function, including a screenshot or error handling showing how it can allow users to jump to another transaction as described.

Custom Hints

Purpose: Provide detailed user-specific information, such as instructions, next steps, or context for handling specific errors.

Configuration: Define in /AIF/CUST_HINTS. Custom hints can be created and maintained within the transaction but must be updated in the maintenance dialog once their scope or visibility changes.

Best Practices:
  • Keep hints concise yet informative.
  • Regularly update hints to reflect changes in procedures or additional insights.
  • Use clear, standardized language to ensure uniform understanding across users.
Additional Use Cases:
  • Adding troubleshooting steps for common errors.
  • Providing links to relevant documentation or knowledge base articles.
  • Offering escalation protocols if the error cannot be resolved.
Visual of custom object hint, including a screenshot showing the text information that can be added as a hint.

Custom Data Links

Purpose: Facilitate quick navigation from log messages to corresponding data fields, enhancing data traceability and error investigation.

Configuration: Define in/AIF/CUST_LINKS. Data links can be created for log messages and related data fields, making it possible to quickly identify the source of an issue.

Best Practices:
  • Prioritize creating links for critical data fields that frequently encounter errors.
  • Use consistent naming conventions for easier maintenance and updates.
  • Verify data links regularly to prevent navigation errors.
Additional Use Cases:
  • Linking errors to the specific transaction data that triggered them.
  • Providing quick access to data required for resolving complex issues.
  • Highlighting important data fields that need regular monitoring.
Visual Representation of Custom Data Links including a screenshot that of error handling to show how to enable quick navigation.

Custom Message Text

Purpose: Replace standard log messages with user-specific texts for better clarity, context, and understanding of the issues at hand.

Configuration: Define in /AIF/CUST_TEXTS. You can maintain multiple custom message texts for a single log message, with the most recent one displayed by default.

Best Practices:
  • Use precise language to convey the error clearly.
  • Avoid jargon or overly technical terms unless necessary.
  • Regularly review message texts for accuracy and relevance.
Additional Use Cases:
  • Simplifying technical error messages for non-technical users.
  • Providing direct suggestions or resolutions within the error message.
  • Differentiating between similar error messages with specific details.
Visual Representation of Custom Message showing examples of the texts before and after.

How to Use Additional Features for Simplified Error Handling

Watch this demonstration showcasing streamlined error handling and enhanced user interface features for monitoring materials in real-time. Users can directly access created materials and receive detailed error messages, providing insights into field locations and customized user guidance. Key tasks include creating custom display functions, refining error messages, configuring error identification hints, and setting up specialized data links for user support.

Log in to track your progress & complete quizzes

Learning

SAP FacebookSAP YoutubeSAP LinkedIn