Schreibprogramme entwickeln (SAP-Bibliothek

Schreibprogramme entwickeln

Verwendung

Schreibprogramme schreiben die zu archivierenden Daten in Archivdateien.

Vorgehensweise

Wichtige Informationen

Zur Vermeidung von Datenverlust darf das Schreibprogramm keine Daten in der Datenbank löschen. Die Daten werden von einem separaten Löschprogramm gelöscht.

Das Schreibprogramm kann aber Änderungen in der Datenbank vornehmen, indem es z.B. eine Archivvormerkung setzt. Diese kann dazu verwendet werden, anderen Programmen zu signalisieren, daß dieses Datenobjekt nicht mehr geändert werden darf. Diese Möglichkeit sollte aber nur genutzt werden, wenn dies absolut notwendig ist, da jede Änderung die Datenbanklast erhöht und die Laufzeit der Archivierung verlängert.

Da Schreibprogramme im Onlinemodus laufen, sollte die Datenselektion die Performance des SAP-Systems nicht über Gebühr belasten.

Um die Verwaltungsdaten des Archive Development Kit (ADK) zu aktualisieren, sendet dieses während des Archivierungsprozesses mehrere Male ein COMMIT (nicht zu verwechseln mit dem ABAP-Befehl COMMIT WORK ) an die Datenbank.

Der Funktionsbaustein ARCHIVE_GIVE_STATISTICS darf in Schreibprogrammen nicht aufgerufen werden. Die Sammlung der Statistikdaten wird vom ADK automatisch vorgenommen.

Programmablauf

Archivierung beginnen – ARCHIVE_OPEN_FOR_WRITE

Dieser Funktionsbaustein wird pro Archivierungslauf (und Archivierungsobjekt) nur einmal aufgerufen und liefert ein eindeutiges Archiv-Handle zurück, das für alle weiteren Archivoperationen benötigt wird. Mit Aufruf dieses Funktionsbausteins beginnt die Initialisierungsphase.

Der Funktionsbaustein führt die folgenden Aufgaben für das übergebene Archivierungsobjekt durch. ARCHIVE_OPEN_FOR_WRITE:

steuert, ob das Schreibprogramm im Test- oder im Produktivmodus läuft
steuert, ob das Schreibprogramm im Testmodus aufgerufen werden soll
erzeugt in der Archivverwaltung einen neuen Archivierungslauf
bindet die in der AOBJ angegebenen Archivierungsklassen ein

Achtung

Die folgenden drei Funktionsbausteine müssen, falls verwendet, direkt nach ARCHIVE_OPEN_FOR_WRITE und vor dem ersten Aufruf von ARCHIVE_NEW_OBJECT aufgerufen werden.

(optional) Archivierungsklassen dynamisch einbinden – ARCHIVE_REGISTER_CLASS

Wenn Sie Archivierungsklassen verwenden möchten, und wenn diese dynamisch eingebunden werden sollen, müssen Sie diesen Funktionsbaustein aufrufen und das Handle für jede Archivierungsklasse übergeben.

(optional) Strukturen und Tabellen dynamisch einbinden – ARCHIVE_REGISTER_STRUCTURES

Ab SAP Web Application Server 6.10 können Sie diesen Funktionsbaustein verwenden, um das ADK über zusätzlich zu archivierende Strukturen und Tabellen zu unterrichten. Dies ist für solche Tabellen und Strukturen nützlich, die bis zur Laufzeit unbekannt sind und nur benutzt werden sollten, wenn dies absolut notwendig ist.

(optional) Initialisierungsdaten in Archivdateien speichern – ARCHIVE_PUT_INIT_DATA

Ab SAP Web Application Server 6.10 können Sie diesen Funktionsbaustein zum Speichern von Initialisierungsdaten in Archivdateien verwenden. Die Anwendung benötigt diese Daten - die beliebige Informationen wie z.B. Customizing- oder Statusinformationen umfassen können -, um später die archivierten Daten interpretieren zu können.

Um diese Daten in Lösch-, Lese- und Rückladeprogrammen zu lesen, rufen Sie den Funktionsbaustein ARCHIVE_GET_INIT_DATA auf. Weitere Informationen dazu finden Sie weiter unten in diesem Dokument und in der Dokumentation zum Funktionsbaustein.

Die folgenden Schritte (5 - 8) müssen in einer Schleife für alle zu archivierenden Datenobjekte durchgeführt werden.

Neues Datenobjekt öffnen – ARCHIVE_NEW_OBJECT

Dieser Funktionsbaustein wird pro Datenobjekt aufgerufen. Nur dann werden die Daten an die ADK-Funktionsbausteine übergeben. Der Funktionsbaustein führt die im folgenden genannten Aufgaben durch. ARCHIVE_NEW_OBJECT:

initialisiert den Datencontainer

ruft die Initialisierungssubroutinen der Archivierungsklasse auf

übergibt die Datenobjekt-ID an OBJECT_ID (falls erforderlich)
Die Zusammensetzung von OBJECT_ID darf nicht geändert werden; jeder übergebene Wert muß eindeutig sein. OBJECT_ID muß syntaktisch vom Typ CHAR sein (siehe auch ADK-Indizes erzeugen und für den Archivzugriff verwenden).

Archivierungsobjektdaten an den Datencontainer übergeben – ARCHIVE_PUT_RECORD/ARCHIVE_PUT_TABLE

Rufen Sie für jede zu archivierende Tabelle oder Struktur den ADK-Funktionsbaustein ARCHIVE_PUT_RECORD bzw. ARCHIVE_PUT_TABLE auf.

Sie müssen entscheiden, ob die übergebenen Daten vom Löschprogramm gelöscht werden sollen oder nicht. Über den Parameter RECORD_FLAGS des Funktionsbausteins ARCHIVE_PUT_RECORD können Sie ein Löschkennzeichen an das Löschprogramm übergeben, so daß es weiß, welche Daten es löschen soll. ARCHIVE_PUT_TABLE hat zu diesem Zweck die Parameter RECORD_FLAGS und RECORD_FLAGS_TABLE.

Hinweis

Um auf mögliche Probleme mit den zur Archivierung selektierten Daten reagieren zu können, haben Sie die Möglichkeit, eine IF "Fehler"-Anweisung einzufügen, die mit der nächsten Schleife fortfährt, bevor ARCHIVE_SAVE_OBJECT ausgeführt wird. ARCHIVE_NEW_OBJECT wird erneut aufgerufen; die bereits übergebenen Daten werden verworfen.

Archivierungsklassen mitteilen, welche Daten zu archivieren sind – <CLASS>_ARCHIVE_OBJECT

Sie müssen entscheiden, ob die übergebenen Daten vom Löschprogramm gelöscht werden sollen oder nicht. Zu diesem Zweck stellt der Funktionsbaustein der Archivierungsklasse den Parameter OBJECT_DELETE_FLAG zur Verfügung. Der Funktionsbaustein <CLASS>_ARCHIVE_OBJECT selektiert die Daten und optimiert den Datenbankzugriff. Zuerst sammelt er die Schlüssel für die angeforderten Daten und greift nur dann auf die Datenbank zu, wenn der Funktionsbaustein ARCHIVE_SAVE_OBJECT aufgerufen wird. Dieser Funktionsbaustein erkennt das Datenobjekt, zu dem die Daten gehören, anhand des Handles. Dieses muß dazu an die Funktionsbausteinschnittstelle übergeben werden.

Datenobjekt in die Archivdatei sichern – ARCHIVE_SAVE_OBJECT

Zum eigentlichen Sichern des Datenobjekts in einer Archivdatei müssen Sie den Funktionsbaustein ARCHIVE_SAVE_OBJECT aufrufen. ARCHIVE_SAVE_OBJECT:

besorgt die Archivierungsklassendaten und führt sie mit denen des Archivierungsobjekts zusammen
sammelt automatisch die Statistikdaten, sowohl im Produktiv- als auch im Testmodus
sperrt den Datencontainer, so daß keine Daten mehr hinein geschrieben werden können

Im Produktivmodus übernimmt der Funktionsbaustein ARCHIVE_SAVE_OBJECT darüber hinaus weitere Aufgaben. ARCHIVE_SAVE_OBJECT:

schreibt das Datenobjekt aus dem Datencontainer, in dem die Datensätze gespeichert wurden, in die Archivdatei
schließt die Archivdatei, nachdem die im Customizing festgelegte maximale Dateigröße bzw. maximale Anzahl der Objekte erreicht wurde, und öffnet eine neue Archivdatei
übergibt die Archivdateien an die SAP Content Management Infrastructure (falls im Customizing Ablage vor Löschphase eingestellt ist)
ruft das Löschprogramm nach dem Schließen einer Archivdatei auf (falls im Customizing eingetragen wurde, daß das Löschprogramm automatisch nach dem Schließen einer Archivdatei aufgerufen wird)

Achtung

Ab SAP Web Application Server 6.10 können Sie Archivierungsläufe unterbrechen und fortsetzen (siehe Archivierungsläufe unterbrechen und fortsetzen). Dazu muß Ihr Schreibprogramm in der Lage sein, Unterbrechungsanforderungen des ADK über die Ausnahme TERMINATION_REQUESTED zu verarbeiten.

Ende der Schleife

(optional) Statistikdaten vom ADK besorgen – ARCHIVE_GET_STATISTICS

Mit diesem Funktionsbaustein rufen Sie die vom ADK gesammelten Statistikdaten ab. Diese Daten können Sie dann zur Erstellung eines eigenen, spezifischen Protokolls verwenden.

(optional) Standard-Statistikprotokoll ausgeben – ARCHIVE_WRITE_STATISTICS

Mit diesem Funktionsbaustein steuern Sie die Ausgabe des Standardprotokolls für Archivierungsstatistikdaten am Ende der Schreibphase. Der Aufruf dieses Funktionsbausteins muß direkt vor ARCHIVE_CLOSE_FILE erfolgen.

Schreibphase beenden – ARCHIVE_CLOSE_FILE

Sie beenden die Schreibphase, indem Sie diesen Funktionsbaustein aufrufen. Dadurch wird das Archiv-Handle ungültig und kann nicht mehr benutzt werden.

Achtung

Dieser Funktionsbaustein muß aufgerufen werden, sonst geht die letzte zu verarbeitende (physische) Archivdatei verloren, und die Schreibphase ist unvollständig.

ARCHIVE_CLOSE_FILE:

gibt die eingebundenen Archivierungsklassen frei
verwirft das aktuelle Handle
übernimmt darüber hinaus im Produktivmodus weitere Aufgaben. ARCHIVE_CLOSE_FILE:

aktualisiert die Archivverwaltungsdaten
schließt die aktuelle Archivdatei
übergibt die Archivdateien an die SAP Content Management Infrastructure für die letzte Archivdatei (falls im Customizing Ablage vor Löschphase eingestellt ist)
ruft das Löschprogramm für die letzte Archivdatei auf (falls im Customizing Start automatisch eingestellt ist und keine Ereignisse eingestellt sind)

Ergebnis

Nachdem Sie die Entwicklung Ihres Schreibprogramms abgeschlossen haben, tragen Sie es für Ihr Archivierungsobjekt in der Transaktion AOBJ ein.

Beispiel

Beispiele für Schreibprogramme bieten die Programme SBOOKA und SFLIGHTA (Beispiel zur Verwendung von Archivierungsklassen).