Show TOC

Function documentationInterface Documentation Maintenance

 

In the SAP Application Interface Framework, the interface is implemented in a structured way. You can use this structured information to generate documentation that describes the interface structure and contents. In Customizing for SAP Application Interface Framework (transaction code /AIF/CUST), under individual Customizing activities for interface creation, you can maintain documentation related to an interface object, for example, an interface or a value mapping.

The Interface Documentation Tool (transaction code /AIF/DOCU) enables you to write documentation for an interface or for a Customizing object in the language of your choice.

Features

Maintaining Interface Documentation

During interface implementation, interface developers can enter texts to describe an interface object. The structure of the interface and the texts are used to generate an interface documentation.

In Customizing for SAP Application Interface Framework, under individual Customizing activities related to interface creation, there is a Documentation pushbutton with a traffic light showing one of the following statuses:

  • Green (Green)

    Documentation is maintained and released

  • Red (Red)

    No documentation is maintained

  • Yellow (Yellow)

    Documentation is maintained but not yet released

Choose Documentation to maintain and release texts.

A Not Saved (Not Saved ) warning is displayed if you do not save your documentation.

Interface Documentation Tool

In the Interface Documentation Tool, if you select Interface and execute the report, you get an overview of all objects belonging to the specified interface for the specified namespace. You can see if documentation is available and if any such documentation is available in the selected target language. Selecting a line enables you to create, edit, and release documentation.

If you select Customizing Object, the Customizing objects that fit the selection criteria are displayed. The following is a list of the possible Customizing objects:

  • Interface definition

  • Structure mapping

  • Fix value

  • Value mapping

  • Action

  • Check

  • Field mapping

  • Condition

You can export the documentation, for example, to a Microsoft Office Excel file.

Activities

You can access the Interface Documentation Tool 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 Interface Documentation Tool End of the navigation path.