Im Wesentlichen enthält ein Auftrag Jobs, von denen jeder aus mehreren Schritten (Steps) besteht.

Jobs
Schritte
Kommando
Einstellungen
Einstellungen mit Schrittnamen als Dateinamen
Standardeinstellungen
Einstellungen für den Auftragsmanager
Konfigurationseinstellungen
Zusatzeinstellungen für asynchron ausgeführte Aufträge

---

Jobs

Die Jobs sind voneinander unabhängig und werden nacheinander in der in der Auftragsdatei angegebenen Reihenfolge abgearbeitet.

Welche Zwischen- oder Endergebnisse die Ausgaben eines Jobs darstellen, kann über die Verknüpfung der Schritte untereinander oder über eine direkte Angabe festgelegt werden.

Alle Ausgaben aller Jobs stellen die Ausgabe des Auftrags dar.

Sie werden im synchronen Fall miteinander als eingebettete Ergebnisdokumente in einer einzigen Auftragsergebnis­datei zurückgeliefert.

Schlägt ein Schritt eines Jobs fehl, so gilt dieser Job als fehlgeschlagen und es werden in der Auftragsergebnisdatei keine Ergebnisdokumente für diesen Job geliefert.

Zu jedem Job können Einstellungen (CIB job Properties) bezüglich der Job-Bearbeitung angegeben werden.

Schritte

Die einzelnen Schritte eines Jobs werden in der Reihenfolge abgearbeitet, in der sie in der Auftragsdatei angegeben sind.

Bei jedem Schritt werden das aufgerufene Modul und dessen spezifische Eingaben und Einstellungen (Properties) angegeben. Es ist nicht möglich einer Property mehrere verschiedene Werte zuzuordnen. Sind mehrere Werte für dieselbe Property angegeben, so gilt der zuletzt angegebene Wert.

Ein Schritt hat keine, eine oder mehrere Eingaben (Inputs), die entweder in der Auftragsdatei selbst enthalten sind, oder die durch vorhergehende Schritte erzeugt wurden.

Jeder Schritt hat keine, eine oder mehrere Ausgaben, die nachfolgenden Schritten als Eingabe dienen können oder die die Ergebnisdokumente des zugehörigen Jobs darstellen. Wenn ein Schritt keine Ausgabe hat, dann bedeutet das, dass nur ein Zahlenwert (Fehlercode, ggf. mit Fehlertext), aber kein Ergebnisdokument geliefert wird.

Die Schritte sind hierzu standardmäßig in der Reihenfolge miteinander verknüpft, in der sie in der Auftragsdatei angegeben sind. Das heißt die Ausgaben eines Schritts sind immer die Eingaben des nächsten Schritts. Die Ausgaben des letzten Schritts sind die Ausgaben des Jobs und somit dessen Ergebnisdateien.

Diese Standardverknüpfung kann durch explizite Benennung von Ein- und Ausgaben bei jedem Schritt angepasst werden, etwa dass erst der dritte Schritt die Ausgaben der beiden vorhergehenden Schritte als Eingabe erhält. Auf ähnliche Weise können auch die Ausgaben des Jobs frei ausgewählt werden.

Es ist darauf zu achten, dass die Reihenfolge der Schritte in der Auftragsdatei so angegeben ist, dass die benötigten Eingaben bei allen Schritten bereits erzeugt worden sind.

Kommando

Bei jedem Schritt wird durch die Angabe eines Kommandonamens das aufzurufende Modul ausgewählt, etwa „merge“ für CIB merge und „pdfmerge“ für die CIB pdf toolbox.

Die Liste der unterstützten Kommandos finden Sie im Abschnitt Kommandos.

Über die Konfigurationsdatei von CIB job können außerdem benutzerdefinierte Kommandos (etwa Archiv- oder Datenbankzugriffe) eingeführt werden. Hierzu erstellen Sie ein natives Modul, das eine vorgegebene Schnittstelle bereitstellt.

Einstellungen

Bei jedem Schritt werden die anzuwendenden Einstellungen explizit als Property-Elemente angegeben.

Die jeweiligen Properties entnehmen Sie bitte den Technischen Leitfäden zu den entsprechenden Modulen.

Einstellungen mit Schrittnamen als Dateinamen

Bei bestimmten Kommandos sind darüber hinaus bei bestimmten Einstellungen Schrittnamen anstatt Dateinamen angebbar. CIB job wird die Schrittnamen so verarbeiten, dass die entsprechenden Dateien im Speicher an das jeweilige Modul übergeben werden. Diese werden als $(schrittname) angegeben.

Standardeinstellungen

Außerdem können im Auftrag Einstellungen für die Kommandos vordefiniert werden, die dann für alle Schritte in diesem Auftrag gelten, die das entsprechende Kommando ausführen.

Diese Standardeinstellungen werden von gleichnamigen Einstellungen, die bei einem Schritt angegeben sind überschrieben.

Einstellungen für den Auftragsmanager

Im Auftrag können in den Standardeinstellungen auch Einstellungen für den Auftragsmanager CIB job selbst enthalten sein (Properties).

Konfigurationseinstellungen

Noch grundlegendere Einstellungen, etwa Lizenz- und Verzeichnisinformationen werden auf analoge Weise in der Konfiguration von CIB job hinterlegt und gelten damit für sämtliche Aufträge.

Dies gilt sowohl für die Einstellungen von CIB job selbst als auch für Einstellungen der Einzelmodule.

Gleichnamige Angaben für Einstellungen im Auftrag überschreiben die in der Konfiguration getroffenen Einstellungen.

Siehe Abschnitt Konfiguration.

Zusatzeinstellungen für asynchron ausgeführte Aufträge

Für die asynchrone Ausführung ist der CIB documentserver erforderlich. Das CIB documentserver client framework erlaubt die asynchrone Ausführung von Aufträgen.

Das auf dem Server hergestellte Ergebnis kann mit einem "Poll-Request" abgeholt werden. Dieser enthält als zusätzliche Angabe die async-id, unter der der CIB documentserver den eigentlichen Auftrag entgegen genommen hat.

Beispiel für einen Poll-Request:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<root>
<Comod>
<!--
Generated poll request for asynchronously started request -->
   <producer>CIB documentserver Java Framework 1.5.23</producer>
   <version>1.3</version>
   <async-id>129916347222219596</async-id>
   <defaults/>
   <jobs/>
</Comod>
</root>

Ab Version 1.5.x mit Schemaversion 1.3.