IDoc-Typ- oder Segmentdokumentation anzeigen 

Voraussetzungen

Um sich die Dokumentation eines IDoc-Typs allgemein anzeigen zu lassen (IDoc-Satzarten), lesen Sie die Vorgehensweise im Abschnitt Allgemeinen Aufbau (Satzarten) eines IDocs anzeigen. Diese Dokumentation können Sie in allen unten angegebenen Formaten ausgeben, außer als DTD.

Vorgehensweise

  1. Um sich einen Überblick über alle von SAP ausgelieferten IDoc-Typen (der Basistypen) zu verschaffen, wählen Sie im Einstiegsmenü der IDoc-Schnittstelle und dann die F4-Hilfe für Ihr Objekt Basistyp.

    2. Sie erhalten eine Liste der Basistypen zu Ihrem Release nebst Kurzbeschreibung.

  2. Wählen Sie den Sie interessierenden IDoc-Typ aus.
  3. Wählen Sie Springen ® Benutzereinstellungen und bestimmen Sie die gewünschte Sicht. Es bedeuten:

    4. Attribute des IDoc-Typs

    Basistyp oder Erweiterung, Freigabe, Version der Satzarten: Siehe auch Wichtige Begriffe

    Attribute der Segmente

    Wiederholbarkeit, Erforderlichkeit, qualifiziertes Segment

    Attribute der Segmentfelder

    Länge (in Bytes), Datenelement, aus dem die Felddokumentation gelesen wird

    Dokumentation der Segmente

    Beschreibender Text für das Segment allgemein

    Dokumentation der Segmentfelder

    Beschreibender Text für die einzelnen Felder des Segments = Dokumentation der zugehörigen Datenelemente

    Feldwerte

    z.B. Festwerte, die an einer Domäne hängen, oder Prüftabellen, aus denen die möglichen Werte gelesen werden

     

    Die weiteren Einstellungen betreffen Vorschlagswerte für verschiedene Ausgabeformate (HTML, C-Header etc.).

  4. Kehren Sie zum Einstiegsbild zurück und wählen Sie (Baumanzeige), um eine schnelle Übersicht im System zu erhalten.

    5. Die einzelnen Segmente und deren Felder werden in einer Baumstruktur dargestellt, wie sie der Eltern-Kind-Segmenthierarchie entspricht.

  5. Innerhalb der Baumdarstellung können Sie für einzelne Objekte (z.B. ein bestimmtes Segmentfeld) auswählen, welche Parameter ausgegeben werden sollen. Dazu schalten Sie die entsprechenden Symbole durch Mausklick ein oder aus. Zur Erläuterung der Symbole wählen Sie .
  6. Für die weiteren Formate wählen Sie im Einstiegsbild

  für das IDoc-Format. Geben Sie den entsprechenden Partner an (Partnernummer und -art).

  für das HTML-Format. Es werden drei Dateien erzeugt: Eine für den Rahmen (frame), eine für den Index und eine für die eigentliche Dokumentation. Ihre Namen enden entsprechend mit _f, _i und _d. Ein HTML-Browser lädt die Rahmendatei und setzt dann Index- und Dokumentationsdatei in die entsprechenden Teile des Rahmens. Wenn Sie es in den Anwenderparametern der IDoc-Administration so eingestellt haben, wird der Browser automatisch gestartet.

für den C-Header

für den Parser

Dokumentation ® DTD erzeugen für das DTD-Format

Im C-Header und im HTML-Format findet sich die Information "freigegeben seit Release...". Genaugenommen stimmt das erst ab Release 4.0A. Vor 4.0A bis 3.0D gibt diese Information das Release an, zu dem der IDoc-Typ angelegt wurde (was freilich meist auch das Freigaberelease war). Vor Release 3.0D gab es diese Information noch nicht.