Show TOC

Function documentationDocumentation Tools

 

The IDoc interface is an open interface, which means that the structure and use of the IDoc types is transparent. To allow for this, the IDoc Interface provides tools which display the documentation in various formats. You can choose between the technical view (such as field lengths or release information) and the application view (such as the meaning of the actual application data in the segment).

Another advantage of the documentation tools is that they can also format information for automatic processing. In this way, an EDI subsystem, for example, can be supplied with information about a new IDoc type so that the IDoc type can be processed correctly in future.

Features

The following table provides an overview of what can be documented with each tool and in which format. The tools are under Start of the navigation path SAP Menu Next navigation step Tools Next navigation step IDoc Interface/ALE Next navigation step Administration Next navigation step Services Next navigation step Documentation End of the navigation path.

The parser format is a simple SAP list of fields to be documented which can be read by a parser in an external system. Associated units (segments, record types, and so on) are encapsulated by BEGIN...END commands. The list can be sent to a PC (formats: rich text, ASCII, spreadsheet) transferred or printed.

The HTML format is used for output to the screen.

The format DTD is the Document Type Definition for the Output of IDocs in XML files. It contains the XML elements which can or must appear in the IDocs of the type used.

All formats can be found under Start of the navigation path SAP Menu Next navigation step Tools Next navigation step ALE and EDI Next navigation step Development Next navigation step Generate ALE Interface Next navigation step IDoc Types (WE30) End of the navigation path.

Additional information

For more information about the documentation tools, see