Ansicht
Dokumentation

RPY_DOCU_WRITE - Schreiben der Dokumentation von Entwicklungsobjekten in die EU

ABAP Short Reference   CL_GUI_FRONTEND_SERVICES - Frontend Services  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Funktionalität

Der Funktionsbaustein schreibt Dokumentation zu Objekten der R/3-EU in die dafür vorgesehenen Tabellen.

Folgende Objekttypen sind bisher unterstützt:
'DE' Datenelementdokumentation
'TB' Tabellendokumentation
'DM' Datenmodelldokumentation
'ET' Entitätsdokumentation
'DO' Domänendokumentation
'CL' Bereichsdokumentation
'NA' Nachrichtendokumentation

Die Dokumentation wird entweder in der Tabelle RPY_DOCU_USER oder in RPY_DOCU_TECH abhängig vom Parameter DOCUTYPE ('U' oder 'T') erwartet.

Wird die Dokumentation mit DOCUTYPE 'U' bereitgestellt, so wird ist sie in Tabelle RPY_DOCU_USER in folgender Form abzulegen:

KEY_ID Kennzeichen für Zeilenart bei komplexen Objekten
(1 Zeichen)
OBJLINE Textzeile/Datenbeschreibung
(72 Zeichen)

Hat KEY_ID einen Wert ungleich Leerzeichen, so ist die zugehörige Zeile eine Beschreibung der folgenden Dokumentationszeilen in folgender Form:

LENGTH Zahl der Dokumentationszeilen zum Objekt
DOKU_ID 4 Zeichen lange Identifikation der Dokumentation
OBJECTNAM1 Name des Objekts, zu dem Doku abgelegt ist
OBJECTNAM2 Identifikation Entität (nur für Entitäten)
VARIANT Variante (nur für Entitäten)
SPECID Spezialisierungsart (nur für Entitäten)
ROLNR Beziehungsrolle (nur für Entitäten)
LANGUAGE Sprache, in der Dokumentation abgelegt ist

Wird die Dokumentation mit DOCUTYPE 'T' bereitgestellt, so ist sie in Tabelle RPY_DOCU_TECH im SAPScript-Format in folgender Form abzulegen:

TDFORMAT Formatspalte (2 Zeichen)
TDLINE Textzeile (132 Zeichen)

Jede Objektdokumentation beginnt mit einer Steuerzeile, die ebenfalls SAPScript-Format hat. TDFORMAT ist mit 'AS' belegt und TDLINE hat folgenden Aufbau:

KEY_ID '§'
LENGTH Zahl der Dokumentationszeilen zum Objekt
DOKU_ID 4 Zeichen lange Identifikation der Dokumentation
OBJECTNAM1 Name des Objekts, zu dem Doku abgelegt ist
OBJECTNAM2 Identifikation Entität (nur für Entitäten)
VARIANT Variante (nur für Entitäten)
SPECID Spezialisierungsart (nur für Entitäten)
ROLNR Beziehungsrolle (nur für Entitäten)
LANGUAGE Sprache, in der Dokumentation abgelegt ist

Die folgenden Dokumentationszeilen sind reine SAPScript-Texte mit entsprechenden Formatkennzeichen im Feld TDFORMAT.

Beispiel

CALL FUNCTION 'RPY_DOCU_WRITE'
EXPORTING
LANGUAGE = SY-LANGU
OBJECTNAME = 'TESTELEM'
OBJECTTYPE = 'DE'
DOCUTYPE = 'T'
TABLES
DOCU_TABLE_TECH = DOCUTAB
EXCEPTIONS
CANCELLED = 01
NOT_FOUND = 02
PERMISSION_ERROR = 03.
IF SY_SUBRC NE 0.
...
ENDIF.

Hinweise

Weiterführende Informationen

Dokumentation zu SAPScript

Parameter

DOCUTYPE
DOCU_TABLE_TECH
DOCU_TABLE_USER
LANGUAGE
OBJECTNAME
OBJECTTYPE

Ausnahmen

CANCELLED
NOT_FOUND
PERMISSION_ERROR

Funktionsgruppe

SIFD

rdisp/max_wprun_time - Maximum work process run time   rdisp/max_wprun_time - Maximum work process run time  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 4214 Date: 20240523 Time: 110121     sap01-206 ( 42 ms )