Funktionalität und Schnittstellen der API-Funktionsbausteine

Im folgenden werden die Funktionalität und Schnittstellen der Funktionsbausteine beschrieben, die Sie für die Anbindung der Anwendung bereitstellen müssen.

Für die Namensgebung gilt folgende Konvention:

Präfix _API_ Freigabeobjekt _ Methode _CB

Das Präfix sollte maximal 4 Zeichen lang sein und Ihre Anwendung kennzeichnen; verwendet wurde bereits BCA.

Sie können Funktionsbausteine für folgende Methoden bereitstellen:

DISPLAY Anzeigen

CHANGE Ändern

RELEASE Freigeben

RET Zurückgeben

RETURN Zurückgegeben

CHDOC Änderungsbelege

LOCK Sperren

REJECT Ablehnen

GET_TXT Workitem-Text übergeben

CHECK_CUST Freigabegründe prüfen

MB Drucktasten unterdrücken

FUNCTION<Präfix>_API_<Objekttyp>_DISPLAY_CB.

Anzeigefunktion für das freizugebende Objekt

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPEBCA_DTE_OBJECT_KEY

AUSNAHMEN:

NO_SUCCESS

Hinweis:

Dieser Baustein muss als remotefähig gekennzeichnet sein, da er mit dem Befehl Starting new task aufgerufen wird.

FUNCTION<Präfix>_API_<Objekttyp>_CHANGE_CB.

Änderungsfunktion für das freizugebende Objekt

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPEBCA_DTE_OBJECT_KEY

EXPORT

E_FLAG_MODIFIED TYPEBCA_REL_DTE_BOOLEAN

AUSNAHMEN:

NO_SUCCESS

FUNCTION<Präfix>_API_<Objekttyp>_RELEASE_CB.

Funktionsbaustein zum Aufruf nach der endgültigen Freigabe, d.h. nach der letzten Freigabe

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPEBCA_DTE_OBJECT_KEY

I_FLG_INUPDATETASK TYPEBCA_REL_DTE_BOOLEAN DEFAULT CON_TRUE

AUSNAHMEN:

NO_SUCCESS

Hinweis:

Der Callback-Baustein darf kein COMMIT WORK bzw. ROLLBACH WORK enthalten, da an dieser Stelle das Framework für 4-Augen-Prinzip die führende Anwendung ist und selbst ein COMMIT WORK absetzt.

FUNCTION <Präfix>_API_<Objekttyp>_REJECT_CB.

Funktionsbaustein zum Aufruf der Freigabefunktion Ablehnen

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPEBCA_DTE_OBJECT_KEY

I_FLG_INUPDATETASK TYPEBCA_REL_DTE_BOOLEAN DEFAULT CON_TRUE

AUSNAHMEN:

NO_SUCCESS

Hinweis:

Der Callback-Baustein darf kein COMMIT WORK bzw. ROLLBACK WORK enthalten, da an dieser Stelle das Framework für 4-Augen-Prinzip die führende Anwendung ist und selbst ein COMMIT WORK absetzt.

FUNCTION<Präfix>_API_REL_<Objekttyp>_CHDOC_CB.

Anzeigefunktion für Datenänderungen/Änderungsbelege

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPEBCA_DTE_OBJECT_KEY

I_CHANGED_AT TYPEBCA_REL_DTE_CHNGAT

AUSNAHMEN:

NO_SUCCESS

Hinweis:

Neben dem Objektschlüssel (I_REL_OBJECT_KEY) wird bei diesem Aufruf ein Zeitstempel (I_CHANGED_AT) mitgegeben, der den Zeitpunkt des ersten Aufrufs des Framework für 4-Augen-Prinzip angibt, so dass alle seit diesem Zeitpunkt erfolgten Änderungen angezeigt werden können.

FUNCTION<Präfix>_API_<Objekttyp>_LOCK_CB.

Funktionsbaustein zum Setzen bzw. Löschen von SAP-Sperren für dieses Objekt

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPEBCA_DTE_OBJECT_KEY

I_FLG_LOCKSET TYPEBCA_REL_DTE_BOOLEAN

AUSNAHMEN:

OBJECT_LOCKED

OBJECT_ERROR

Hinweis:

Der Parameter I_FLG_LOCKSET gibt an, ob die Sperre gesetzt (‚X’) oder gelöscht (‚ ‚) werden soll.

FUNCTION<Präfix>_API_<Objekttyp>_GET_TXT_CB.

Funktionsbaustein zum Versorgen des Workitems mit einem Text von der Anwendung

Der Baustein dient dazu, den SAP Business Workflow mit einem Text zu versorgen, der im Business Workplace als Workitem-Textangezeigt wird. Der Text sollte darüber Auskunft geben, um welches Objekt und welche Anwendung es sich genau handelt. Dieser kann z. B. eine externe Nummer enthalten.

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPEBCA_DTE_OBJECT_KEY

EXPORT

E_STR_ITEMTXT TYPEBCA_STR_REL_ITEMTXT_DATA

Hinweis:

In diesem Baustein darf nicht auf Daten zurückgegriffen werden, die eventuell erst nach dem Aufruf des Framework für 4-Augen-Prinzip auf die Datenbank geschrieben werden, da dies sonst zu Abbrüchen in der Verbuchung führt.

FUNCTION<Präfix>_API_<Objekttyp>_RET_CB.

Funktionsbaustein zum Aufruf der Freigabefunktion Zurückgeben : Information, dass das Workitem zurückgegeben wurde

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPEBCA_DTE_OBJECT_KEY

I_FLG_INUPDATETASK TYPEBCA_REL_DTE_BOOLEAN DEFAULT CON_TRUE

AUSNAHMEN:

NO_SUCCESS

Hinweis:

Der Callback-Baustein darf kein COMMIT WORK bzw. ROLLBACK WORK enthalten, da an dieser Stelle das Framework für 4-Augen-Prinzip die führende Anwendung ist und den Befehl COMMIT WORK selbst absetzt.

FUNCTION<Präfix>_API_<Objekttyp>_ RETURN_CB.

Funktionsbaustein nach Aufruf der Freigabefunktion Zurückgeben : Bearbeitung des zurückgegebenen Workitem

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

EXPORT

E_FLAG_MODIFIED TYPEBCA_REL_DTE_BOOLEAN

AUSNAHMEN:

NO_SUCCESS

Hinweis:

Zu Release 4.6C und Release 6.20 werden bei diesem CallBack-Funktionsbaustein sowohl der Parameter E_FLG_MODIFIED als auch der Parameter E_ORDERMODIFIED unterstützt. Ab Release 6.40 wird nur noch der Parameter E_FLG_MODIFIED unterstützt.

FUNCTION<Präfix>_API_<Objekttyp>_BUTTON_CB.

Funktionsbaustein, mit dem die Anwendung für einzelne Funktionen des Framework für 4-Augen-Prinzip Drucktasten im Business Workplace unterdrücken kann

Über diesen Baustein können Sie für einzelne Callback-Funktionsbausteine das Kennzeichen FUNCTIONFLAG in der übergebenen Tabelle (C_TAH_REL_FM) für das gerade bearbeitete Objekt modifizieren. Ist dieses Kennzeichen gesetzt, erscheint die entsprechende Drucktaste auf der Oberfläche, andernfalls wird sie unterdrückt.

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPEBCA_DTE_OBJECT_KEY

CHANGING

C_TAH_REL_FM TYPEBCA_TAH_REL_FM

FUNCTION<Präfix>_API_<Objekttyp>_CHECK_CUST.

Funktionsbaustein zum Überprüfen der Einstellungen in der IMG Aktivität Freigabeobjekt Freigabeverfahren zuordnen nach der Eingabe und vor dem Sichern

Der Funktionsbaustein wird bei der Eingabe eines neuen Freigabegrundes und der Änderung oder Löschung eines existierenden Freigabegrundes und beim Sichern gerufen. Sie haben die Möglichkeit, Prüfungen auf die Konsistenz durchzuführen und ggf. einen Dialog mit auftretenden Meldungen einzubinden.

Dazu werden in der Schnittstelle des CallBack-Funktionsbausteins folgende Daten übergeben:

Vor dem Sichern: Eine Tabelle mit den aktuellen Customizingeinträgen zu diesem Freigabeobjekt
Beim Einfügen eines neuen Eintrags: Eine Tabelle mit den gesamten Einträgen zu diesem Freigabeobjekt in der aktuellen Version. Diese kann schon innerhalb dieser LUW vorgenommene und als konsistent klassifizierte Änderungen enthalten! Zudem wird eine Tabelle mit den neuen Einträgen übergeben.
Beim Ändern eines Eintrags: Eine Tabelle mit den gesamten Einträgen zu diesem Freigabeobjekt in der aktuellen Version. Diese kann schon innerhalb dieser LUW vorgenommenen und als konsistent klassifizierte Änderungen enthalten! Zudem eine wird eine Tabelle mit geänderten Einträgen übergeben.
Beim Löschen eines Eintrags ist die Tabelle mit zu ändernden Einträgen leer.

PARAMETER:

IMPORT

I_TAB_EXPR TYPEBCA_TAB_RELPROC_EXP

I_TAB_EXPR_NEWTYPEBCA_TAB_RELPROC_EXP

I_TAB_EXPR_CHGTYPEBCA_TAB_RELPROC_EXP

AUSNAHMEN:

INCONSISTENT

Hinweis:

Der Callback-Baustein darf kein COMMIT WORK bzw. ROLLBACK WORK enthalten, da an dieser Stelle das Framework für 4-Augen-Prinzip die führende Anwendung ist und den Befehl COMMIT WORK selbst absetzt.