Vor dem Aufruf der Execute-Funktion (CIB job Execute) muss mindestens eine Auftragsdatei als Eingabe und ein Ausgabeziel für die Auftragsergebnisdatei über die CIB job Properties konfiguriert sein.

Anschließend führt die Execute-Funktion die in der Auftragsdatei spezifizierten Schritte in der dort angegebenen Reihenfolge aus und liefert das Ergebnis entsprechend dem Abschnitt Auftragsergebnisspezifikation zurück.

Die Auftragsdatei kann im Dateisystem vorliegen. Auch die Auftragsergebnisdatei kann im Dateisystem erzeugt werden, wobei die Mimetype-Information bei direkten Auftragsergebnisdateien dann nicht zur Verfügung steht.

Im CIB documentserver arbeitet CIB job jedoch im Speicher. Das heißt, dass der Aufrufer die Auftragsdatei über die Angabe von Speicheradressen oder Streams zur Verfügung stellt. Die Ausgabe erfolgt auf ähnliche Weise, indem CIB job an einen vom Aufrufer bereitgestellten Callback mehrere Speicheradressen übergibt.

 Dieses Kapitel gibt einen kurzen Überblick über die verfügbare API und deren Parameter. Allgemein gilt, dass man über die Funktion CibJobSetProperty seine gewünschten Parameter setzt und dann die Funktion CibJobExecute aufruft.

CIB job wird als native shared Library für die verschiedenen Betriebssysteme zur Verfügung gestellt. Die exportierten Routinen haben (bis auf individuelle Parameter) die Signatur

COMOD_BOOL COMOD_API CibJobXXX(<Parameter>);

Der Rückgabewert 0 (FALSE) zeigt an, dass ein Fehler aufgetreten ist. Fehlercode und Fehlertext werden dann über CibJobGetLastError() und CibJobGetLastErrorText() abgeholt. Bei Erfolg wird ein Wert ungleich 0 (TRUE) zurückgegeben, dessen Zahlenwert bedeutungslos ist.