Archivierungsprogramm entwickeln 
Einsatzmöglichkeiten
Archivierungsprogramme schreiben die Daten zu einem Archivierungsobjekt in eine Archivdatei. Diese Programme können sehr individuell gestaltet sein. Die Beschaffung der zu archivierenden Datenobjekte kann entweder direkt im Archivierungsprogramm oder aber über eine logische Datenbank stattfinden.
Eine Gemeinsamkeit haben allerdings alle Archivierungsprogramme. Sie verwenden die Funktionsbausteine des ADK (Funktionsgruppe ARCH), um ihre Daten objektweise in Archivdateien abzulegen. Alle Methoden für den Zugriff auf Archivdateien sind durch diese Funktionsbausteine abgedeckt (siehe auch
Standard-Archivierungsprogramm) .Für die Entwicklung von Archivierungsprogrammen ist es außerdem von Vorteil, wenn Archivierungsklassen vorhanden sind. Diese übernehmen die Programmlogik für den Datentransfer zwischen Datenbank und Datencontainer (siehe auch
Archivierung mit Archivierungsklassen) . Falls keine Archivierungsklassen zur Verfügung stehen, muß die Datenbeschaffung aus der Datenbank vom Archivierungsprogramm durchgeführt werden. Die Weitergabe an den Datencontainer erfolgt dann über die Standardklasse des ADK.Richtlinien

Zu allen ADK-Funktionsbausteinen ist eine ausführliche Dokumentation vorhanden.
Ablauf
Aufrufreihenfolge der Funktionsbausteine
Dieser Funktionsbaustein des Archivierungsobjekts wird für jeden Archivierungslauf (je Archivierungsobjekt) nur einmal aufgerufen und liefert einen eindeutigen Handle zurück, der für alle weiteren Operationen auf das Archiv benötigt wird. Der Funktionsbaustein übernimmt folgende Aufgaben für das übergebene Archivierungsobjekt:
– Steuerung, ob eine Archivdatei erzeugt werden soll
– Steuerung, ob das Löschprogramm im Testmodus aufgerufen werden soll
– Erzeugen eines Kopfeintrags in der Archivverwaltung
– Einbinden der statischen Archivierungsklassen
– Öffnen der ersten Archivdatei
– Schreiben des Kopfeintrags in die erste Archivdatei, z.B. Informationen zu den beteiligten Tabellen aus dem Dictionary (Nametab)
Falls Sie Archivierungsklassen verwenden wollen und diese dynamisch eingebunden werden sollen, müssen Sie diesen Funktionsbaustein mit Übergabe des Handle je Archivierungsklasse aufrufen. Der Funktionsbaustein übernimmt folgende Aufgaben:
– Schreiben der Informationen in die Archivdatei (für die Verwendung durch nachfolgende Programme)

Der Aufruf muß direkt nach dem ARCHIVE_OPEN_FOR_WRITE erfolgen.
Die folgenden Schritte (Schritt 3. bis 5.) müssen in einer Schleife für alle zu archivierenden Datenobjekte aufgerufen werden.
Diesen Funktionsbaustein rufen Sie je Datenobjekt auf. Erst danach können Sie Daten an Funktionsbausteine des Archivierungsobjekts übergeben. Der Funktionsbaustein übernimmt folgende Aufgaben:
– Initialisierung des Datencontainers
– Aufruf der Initialisierungsroutinen der Archivierungsklassen
– Übergeben Wert für ADK-Indexeintrag über OBECT_ID (falls gewünscht)
Die Zusammensetzung dieses Zeichenketten-Werts darf nicht verändert werden und jeder übergebene Wert muß eindeutig sein (siehe auch ADK-Index aufbauen und Zugreifen auf einzelne Datenobjekte im Archiv über ADK-Index).

Wenn Sie mit dem Funktionsbaustein ARCHIVE_SAVE_OBJECT ein Datenobjekt in der Archivdatei abgelegt haben und weitere Daten archivieren wollen, müssen Sie diesen Funktionsbaustein erneut aufrufen.
Hierfür rufen Sie entweder den Funktionsbaustein ARCHIVE_PUT_RECORD der Standardklasse oder Funktionsbausteine der Archivierungsklassen auf. Letztere unterliegen einer Namenskonvention, wobei "class" für den Namen der Archivierungsklasse steht: class_ARCHIVE_OBJECT.
An dieser Stelle müssen Sie entscheiden, ob die übergebenen Daten durch das Löschprogramm gelöscht werden sollen oder nicht. Die Funktionsbausteine der Archivierungsklassen stellen hierfür den Parameter OBJECT_DELETE_FLAG zur Verfügung.
Der Funktionsbaustein ARCHIVE_PUT_RECORD bietet Ihnen den Parameter RECORDS_FLAGS an, um diese Funktionalität nachzubilden.
Die Funktionsbausteine der Archivierungsklassen nehmen Ihnen die Arbeit der Datenselektion ab und optimieren die Zugriffe auf die Datenbank. Sie sammeln zuerst die Anforderungen und greifen erst dann auf die Datenbank zu, wenn der Funktionsbaustein ARCHIVE_SAVE_OBJECT aufgerufen wurde. Diese Funktionsbausteine erkennen die Zugehörigkeit der Daten zu einem Datenobjekt durch den Handle, der an die Schnittstelle der Funktionsbausteine übergeben werden muß.

Falls Sie bereits Daten übergeben haben, die Sie doch nicht archivieren wollen, rufen Sie erneut den Funktionsbaustein ARCHIVE_NEW_OBJECT. Er bewirkt, daß die übergebenen Daten der Standardklassen und der Archivierungsklassen "vergessen" werden.
Um die endgültige Archivierung eines Datenobjekts zu veranlassen, müssen Sie den Funktionsbaustein ARCHIVE_SAVE_OBJECT aufrufen. Er übernimmt folgende Aufgaben:
– Abholen der Datenpakete bei den Archivierungsklassen
– Komprimierung der Daten der Standardklasse
– Sammeln der Statistikdaten
– Fortschreiben der Verwaltungssätze in der Archivverwaltung
– Schreiben des Datenobjekts in die Archivdatei (aus dem Datencontainer, in dem die Datensätze durch die Archivierungsklassen und die Standardklasse abgelegt worden sind)
– Schließen der Archivdatei, wenn sie die spezifizierte maximale Größe bzw. die maximale Objektanzahl erreicht hat, und Öffnen einer neuen Archivdatei
– Aufruf des Löschprogramms, nachdem eine Archivdatei geschlossen wurde
– Sperren des Datencontainers, damit nach dem Schreiben eines Datenobjekts in die Archivdatei keine weiteren Daten im Datencontainer abgelegt werden können.
Ende der Schleife (Schritt 5.)
Mit diesem Funktionsbaustein können Sie am Ende der Archivierung eine Gesamtstatistik über die archivierten Daten erstellen. Für Datensätze, die mit den Standardklassen übergeben werden (ARCHIVE_PUT_RECORD), erfolgt außerdem eine Einzelauflistung der Sätze.
Die Archivierung beenden Sie mit dem Aufruf dieses Funktionsbausteins. Der übergebene Handle wird hierdurch ungültig und darf nicht mehr verwendet werden.

Dieser Aufruf darf nicht vergessen werden, da sonst die zuletzt bearbeitete (physische) Archivdatei verlorengeht und somit die Archivierung unvollständig ist. Der Funktionsbaustein übernimmt folgende Aufgaben: