Documentation Tools 

Use

The IDoc interface is open, 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 in such a way that it is suitable 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 processed correctly in future.

Features

The following table provides an overview of what can be documented with each tool and in which format. You can call the tools from the Initial Node of the IDoc Interface.

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, etc.) are encapsulated by BEGIN...END commands. The list can be sent to a PC (formats: Rich text, ASCII, spreadsheet) transferred or printed.

The tree display format is used for output to the screen. The data can only be stored externally (for example, on a PC) in the other formats.

The format DTD is the Document Type Declaration 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.

Documentation of...

Supported formats

Access via...

General IDoc (record types)

HTML, C-header, IDoc, tree display (screen), parser

Documentation ® IDoc record types

Specific IDoc type (for example ORDERS01)

HTML, C-header, IDoc, tree display (screen), DTD, parser

Documentation ® IDoc types or

Segment

HTML, tree display (screen)

Documentation ® IDoc segments

Activities

Displaying the General Structure (Record Types) of an IDoc

Displaying IDoc Type Documentation

Documentation translation