Displaying IDoc Type or Segment Documentation (SAP Library - IDoc Interface / Electronic Data Interchange (BC-SRV-EDI))

Displaying IDoc Type or Segment Documentation

Prerequisites

The following section assumes that you wish to display a specific IDoc type. To display the documentation for an individual segment, choose Documentation ® IDoc segments from the initial screen of the IDoc interface and continue with step 3 in the section. However, the segment documentation only supports HTML and tree display formats.

To display the documentation for a general IDoc type (IDoc record types), read the procedure in the following section - Displaying the General Structure (Record Types) of an IDoc You can display this documentation in all the formats specified below, apart from DTD.

If you wish to send the documentation as an IDoc, you must define the IDoc type SYIDOC01 with the message type SYIDOC for your partner in outbound processing. For more information see: Partner Profiles in the Standard Dialog

Procedure

To gain an overview of all the IDoc types supplied by SAP (basic types), choose in the Initial Node of the IDoc Interface and then the F4 Help for your object basic type.

A list of the basic types supplied with your release version is displayed, together with a brief description.

Choose the required IDoc type.

Choose Goto ® User settings and specify the required view. It means:

IDoc type attribute	Basic type or extension, release, version of record types: Also see important terms
Segment attributes	Frequency of use, necessity, qualified segment
Segment field attributes	Length (in bytes), data element, from which the field documentation is read.
Segment documentation	Defining text for the segment in general
Segment field documentation	Defining text for the individual segment fields = documentation of the associated data elements
Field values	For example fixed values which are attached to a domain or check tables from which the possible values are read.

The further settings affect default values for different output formats (HTML, C-header and so on).

Return to the initial screen and choose

(display tree) for a quick overview of the system.

The individual segments and their fields are displayed in a tree structure which corresponds to the parent-child segment hierarchy.

You can select within the tree structure which parameters are to be output for individual objects (for example, a particular segment field). You can switch the corresponding icon on or off by clicking on it. For an explanation of the icons, select

You can select additional formats from the initial screen.

for the IDoc format. Specify the corresponding partner (partner number and partner type).

for the HTML format. Three files are generated: One for the frame, one for the index and one for the actual documentation. Their names end correspondingly with _f, _i and _d. An HTML browser loads the frame file and places the index and documentation files in the corresponding parts of the frame. If you have made the settings in the IDoc Administration User Parameters, the browser is started automatically.

for the C-header

for the parser

Documentation ® Generate DTD for the DTD format

The C-header and HTML formats contain the information "released since release...". In fact, this applies only from Release 4.0A onwards. In releases between 3.0D and 4.0A, this information specifies the release for which the IDoc type was created (which was usually where the IDoc type was also released). This information was not implemented in releases prior to 3.0D.