Das API zur IDoc-Typ- und Segmentdefinition
Definition
Zur automatischen, dialogfreien Entwicklung von Segmenten und IDoc-Typen steht Ihnen eine Reihe von Funktionsbausteinen zur Verfügung. Diese Programmierschnittstelle (API) wird auch vom IDoc-Typ- und Segmenteditor verwendet.
Verwendung
Hinter
BAPIs stehen IDoc-Typen zur Übertragung der Geschäftsinformationen. Wenn neue BAPIs erzeugt werden, werden die entsprechenden IDocs über dieses API erzeugt.Struktur
Das API ist auf drei Funktionsgruppen verteilt: Die auf Segmenten operierenden Funktionsbausteine finden sich in der Funktionsgruppe EDIJ, die auf Basistypen und Erweiterungen operierenden Funktionsbausteine in der Funktionsgruppe EDIM. Die dritte Funktionsgruppe ist eine Gruppe RFC-fähiger Funktionsbausteine, die von externen Entwicklungsumgebungen genutzt werden können.
Funktionsbausteine aus der Gruppe EDIJ (Segmente)
Name |
Beschreibung |
SEGMENT_CREATE |
Legt ein neues Segment an. Die Segmentstruktur wird als Tabelle übergeben. Die neue (und bislang einzige) Segmentdefinition hat vorläufig die Releasekennung <SPACE>. Die erste Version ( Segmentdefinition) ist 000. |
SEGMENT_MODIFY |
Ändert ein bestehendes Segment. Abhängig vom Freigabekennzeichen wird eine neue Segmentdefinition angelegt oder eine bestehende verändert. |
SEGMENT_DELETE |
Löscht ein komplettes Segment. |
SEGMENTDEFINITION_DELETE |
Löscht eine nicht freigegebene Segmentdefinition. |
SEGMENTDEFINITION_CLOSE |
Gibt eine Segmentdefinition frei, setzt also das Freigabekennzeichen. Die freigegebene Segmentdefinition bekommt das Kennzeichen des aktuellen Releases. |
SEGMENTDEFINITION_UNCLOSE |
Nimmt die Freigabe zurück, löscht also das Freigabekennzeichen. Die betroffene Segmentdefinition bekommt <SPACE> als Releasekennung. |
SEGMENT_CHECK_EXISTENCE |
Gibt eine Tabelle mit den bereits vorhandenen Segmentdefinitionen mit Freigabe- und Releasekennzeichen zurück. |
SEGMENT_CHECK_CONSISTENCY |
Prüft u.a., ob die einzelnen Segmentfelder nahtlos zu dem Segment zusammengefügt werden können, ob das Segment in einem Transportauftrag steht, ob der letzte Änderer eines Feldes im Dictionary mit dem letzten Änderer dieses Feldes im Segment übereinstimmt etc. |
SEGMENT_TRANSPORT_INSERT |
Stellt ein Segment mit allen seinen Segmentdefinitionen in eine Transportaufgabe. ACHTUNG: Wenn keine Auftrags- und Aufgabennummer angegeben wird, werden Auftrag und Aufgabe im Dialog abgefragt! |
Funktionsbausteine aus der Gruppe EDIM (Basistypen und Erweiterungen)
<OBJEKT> steht für das Objekt, auf dem der Funktionsbaustein operiert: IDOCTYPE für Basistyp, EXTTYPE für Erweiterung. Da sich ein erweiterter Basistyp aus Basistyp und Erweiterung zusammensetzt, braucht man keine Funktionsbausteine, die auf ihm operieren.
Name |
Beschreibung |
<OBJEKT>_CREATE |
Erzeugt einen Basistyp oder eine Erweiterung anhand einer in einer Tabelle übergebenen Syntaxbeschreibung. Prüft vorher u.a., ob es das Objekt schon gibt. Das neue Objekt wird dann in einen Transportauftrag gestellt. |
<OBJEKT>_UPDATE |
Ändert einen vorhandenen Basistyp oder eine Erweiterung anhand einer in einer Tabelle übergebenen Syntaxbeschreibung. |
<OBJEKT>_READ |
Liest sämtliche Informationen zu einem Objekt: Syntax, eventuell vorhandene Erweiterungen oder Vorgänger. |
<OBJEKT>_DELETE |
Löscht einen Basistyp oder eine Erweiterung. |
<OBJEKT>_CLOSE |
Gibt ein Objekt frei, setzt also das Freigabekennzeichen. |
<OBJEKT>_UNCLOSE |
Nimmt die Freigabe eines Objektes zurück. |
<OBJEKT>_EXISTENCE_CHECK |
Prüft, ob der übergebene Basistyp oder die Erweiterung schon existiert. Wenn ja, dann liest er dessen/deren Attribute (Verknüpfung mit Basistypen, Vorgängern etc.) |
<OBJEKT>_INTEGRITY_CHECK |
Prüft die Syntax allgemein. Prüft bei Nachfolgern, ob sie vorschriftsgemäß aus Vorgängern entstanden sind. |
<OBJEKT>_TRANSPORT |
Stellt Basistyp oder Erweiterung in einen Transportauftrag. |
Funktionsbausteine aus der Gruppe EDIMEXT (API für externe Programme)
Name |
Beschreibung |
IDOCTYPES_FOR_MESTYPE_READ |
Liest alle einem Nachrichtentyp (logische Nachricht) zugeordneten IDoc-Typen. Mehrere Nachrichtentypen können Sie mit einem unvollständigen und mit * abgeschlossenen Namen abdecken. |
IDOCTYPE_READ_COMPLETE |
Liest die Struktur und Attribute (Segmente) wie auch die Segmentattribute (Felder und Festwerte) eines IDoc-Typs. Dem Funktionsbaustein werden dazu die Version der Satzarten und der Segmente übergeben. |
IDOC_RECORD_READ |
Liest zu gegebener Version die Struktur der Satzarten. |
SEGMENT_READ_COMPLETE |
Liest die Struktur und Attribute eines Segments. Dem Funktionsbaustein werden dazu die Version der Satzarten und das Release der Segmente übergeben. |
IDOCTYPES_LIST_WITH_MESSAGES |
Liefert alle zum angegebenen Release freigegebenen IDoc- und Nachrichtentypen. Wenn Sie das Release nicht angeben, sind auch die nicht freigegebenen Objekte eingeschlossen. |