Show TOC

Function documentationIDoc Structure Generation and Interface Definition

 

The Generate IDoc Structure and Interface Definition report (transaction code /AIF/IDOC_GEN) enables you to create a structure for an IDoc basic type. The report provides optional functionality to create a corresponding SAP Application Interface Framework interface that uses the newly created structure. The report also enables you to specify multiple IDoc basic types. In this case, for each IDoc basic type, a new structure is created and, optionally, an interface can be created.

The structure generated by the report consists of the control record and the basic type’s segments. It can be used in the SAP Application Interface Framework interface definition as a raw data structure for the following:

  • Displaying existing IDocs in the Monitoring and Error Handling transaction

  • IDoc processing using the runtime of the SAP Application Interface Framework, calling the IDoc standard process function module in an action

  • IDoc processing with ALE runtime, writing index tables with the AIF enabler

In the above scenarios, the generated structure is used as raw data structure and SAP data structure.

The structure generated by the report can also be used as the raw data structure for IDoc processing using the runtime of the SAP Application Interface Framework, calling any other function module or BAPI in an action. In this scenario, the SAP structure has to be defined in a way that it accommodates the structure of the function modules or BAPIs you want to call.

Integration

In those cases where the raw data structure created by the report and the SAP data structure are identical structures, the Move Corresponding checkbox is selected automatically by the report in Customizing for SAP Application Interface Framework (transaction code /AIF/CUST) under Start of the navigation path Interface Development Next navigation step Define Interfaces End of the navigation path to map the source to the destination structure during the runtime of the SAP Application Interface Framework.

If the raw and SAP data structures are not the same, you must enter the SAP data structure in Customizing for SAP Application Interface Framework under Start of the navigation path Interface Development Next navigation step Define Interfaces End of the navigation path and you have to define a structure mapping under Start of the navigation path Interface Development Next navigation step Define Structure Mappings End of the navigation path.

Features

The report enables you to create one structure per basic type. If you created a structure once for a specific basic type, it is possible to recreate the structure. However, the report does not allow you to create a structure with the same basic type but a different structure name.

The report gives you the option of creating a corresponding SAP Application Interface Framework interface definition together with the structure. The report allows you to create a new interface for a structure that has already been created.

The report also enables you to transport the created objects.

After you enter your selection on the Generate IDoc Structure and Interface Definition screen and choose Execute (Execute), the report displays a table with the data for raw structure generation and interface definition. The report uses the prefixes specified on the selection screen to generate structure names and interface names. You can change or enhance either the name of the structure or the data of the interface creation in the displayed table.

Activities

You can access Generate IDoc Structure and Interface Definition from the SAP Easy Access menu by choosing Start of the navigation path Cross-Application Components Next navigation step SAP Application Interface Framework Next navigation step Interface Development Next navigation step IDoc Structure Generator End of the navigation path.

SAP Structure

To create structures, you specify the following data:

  • The name of an IDoc basic type

  • A prefix for use as a prefix for the structure names

  • Update the structures with IDoc extensions by selecting the corresponding checkbox

Interface Definition

To create a corresponding SAP Application Interface Framework interface definition for newly created structures, you specify the following data:

  • The name of the interface namespace

  • A prefix

    Used as a prefix for the interface names that are created

  • The interface version

  • The variant ID

    Decides if the created structure is used as the raw and SAP data structure and that the Move Corresponding checkbox is selected in Customizing for SAP Application Interface Framework under Start of the navigation path Interface Development Next navigation step Define Interfaces End of the navigation path. Furthermore, the variant ID decides which Logging Engine, Selection Engine, Application Engine, and Persistence Engine should be used.

Transport

To transport data, you specify the following data:

  • A package where the created structures are to be stored

  • A workbench task where the created structures are to be stored

  • A Customizing task where the Customizing data is to be stored, for example, the interface definition

  • The name of the RFC destination for Customizing handling in another system client

Note Note

If you enter a local package, it is not necessary to specify other transport information.

End of the note.