Identifying the functionalities of Index Tables in SAP Application Interface Framework

Objective

After completing this lesson, you will be able to understand and differentiate between single and multi-index tables, and comprehend their connection to interfaces used in SAP Application Interface Framework.

Index Tables

If you choose the selection engine index tables, messages processed in SAP Application Interface Framework are recorded in a single index table. By default, the messages are stored in the standard single index table. In Monitoring and Error Handling, by default, you can select messages by namespace, interface name, interface version, time, status, and so on. The data displayed in Monitoring and Error Handling is selected from the index tables.

Visual representation of single index table.

The standard selection fields are not enough for every interface. In some cases, it's required to search for specific fields. This can be enabled with the use of an interface-specific single index table.

Single and Multi Index Tables

Single Index Table

A single index table should be created for a key field that appears exactly once in the data structure used for the interface, such as monitoring invoices. Additionally, the messages should be grouped by the company that issued the data.

Visual representation of a single index table.

Single Index Table Overview:

  • All messages processed by the SAP Application Interface Framework are recorded in a single index table.

  • Each message can be identified by its message GUID.

  • The values of key fields are saved into the single index table during runtime of the SAP Application Interface Framework.

  • If you want to use additional key fields, you need to define them in your own single index table.

  • To use a self-defined single index table in an interface, it needs to be connected to the interface. You do this in the Namespace-Specific Features activity in SAP Application Interface Framework Customizing. Under Define Namespace-Specific Features, enter the name of the single index table in the Message Index Table Name field.

  • A single index table can be used for multiple interfaces that have the same single key fields. However, especially if many messages are processed by an interface, it makes sense to create your own index table for every interface for performance reasons.

Multi Index Table

If you want to have access to fields that appear more than once in a message like the material in the example, you can create additional multi index tables. There can be more than one multi index table per interface.

If you want to use raw fields and SAP fields, you have to have at least two multi index tables because the structures cannot be mixed inside one table.

Visual representation of a multiindex table.

Multi Index Table Overview:

  • A multi index table is required if the defined key field is part of a table.

  • The key fields defined in a multi index table are not used for grouping in Monitoring and Error Handling.

  • To use the self-defined multi index table in an interface, it needs to be connected to the interface. You to do this in the Interface-Specific Features activity in AIF Customizing. Under Define Key Fields for Multi. Search, you need to create an entry for the key field. The Multi. Selection Type has to be Multiple selection. You can enter the name of the multi index table in the Message Index Table Name field after the selection type is changed to multiple.

How to Create Index Tables

Explore the process of creating single and multi-index tables tailored to your interface needs in this demonstration. Learn how to define and set up these tables efficiently to enhance data storage and retrieval capabilities within your system.

Connection of Index Tables to the Interfaces

In SAP Systems, the Plant is a field that quite often has a key status for searching messages as well as for finding the right person for the error handling.

Visual showing the plant field and how it forms the connection as described in the text.

When using a custom single index table and additional multi index tables, it's necessary to specify the location of the fields within the message that correspond to the entries in the index table. This is done by using the transaction /AIF/CUST and then Define Interface Specific Features → Define Key Fields for Multi Search

In the monitoring and error tool, it's possible to also search by fields of the single and muti index tables. To display the key fields as selection fields for the user, a selection screen is required. The selection screen has to be added to the interface.

You can do this in the Define Namespace-Specific Features activity in Application Interface Framework Customizing. You have to enter the selection screen in the Program Name field; you also have to fill the Screen Number field.

The selection screen program needs to be defined as module pool. The selection screen has to be defined as a subscreen containing the relevant fields as select options.

Steps necessary for using custom index table:

  1. Identify relevant key fields from source and destination structure.

  2. Create single and multi index tables.

  3. Create an interface-specific selection screen.

  4. Maintain key fields: Assign field from message structure, index table, and selection screen.

Note

The program you create for the additional selection screen has to be of type Module-Pool and the screen has to be programmed with the selection-screen commands instead of the screen painter. As the screen is added to the standard Error Handling Screen, you have to create it as a subscreen.

How to Use /AIF/ERR with Index Tables

Discover how to integrate /AIF/ERR functionality with index tables for effective error handling and monitoring in this demo. Learn how to implement and leverage index tables alongside error management tools to streamline the error handling process.

How to Use Custom Index Tables and Selection Screens for an Interface

Learn to integrate custom index tables and selection screens for interfaces to facilitate search functionality for specific message content in this informative demo. Explore the creation and implementation of customized screens and tables to enhance user experience and data accessibility.

Log in to track your progress & complete quizzes

Learning

SAP FacebookSAP YoutubeSAP LinkedIn