Sidecar-Dateien und Ihre Verwendung beim Verarbeiten im Server-Job (11.0)
Sidecar-Dateien machen es möglich, dass man nur eine zusätzliche Datei neben die Eingabedatei legt innerhalb des Hotfolders vom Server-Job, welche zusätzliche Informationen in Form von Variablen enthält. Diese Informationen können verwendet und verändert werden während der Hotfolderverarbeitung. Die neuen (aktualisierten) Werte können benutzt werden um spätere Prozessschritte in der Hotfolderverarbeitung zu beeinflussen.
Verwenden von Sidecar-Dateien
- Wenn Sidecar-Dateien benutzt werden sollen, ist kein neuer Eintrag in der Konfiguration eines Jobs erforderlich - sofern eine *.sidecar-Datei existiert neben einer PDF, wird einfach der Inhalt zur Verarbeitung verwendet.
- Werte von "Variablen" in der .sidecar-Datei werden als Variablen für jeden Jobs verwendet.
- Um neue Werte (z.B. berechnet oder gesetzt in vorausgegangenen Hotfolder- Jobs) für Variablen zu benutzen zu können, müssen diese aufgenommen werden aus dem Ergebnisbereich und müssen umgeleitet werden in der JavaScript-Variable auf die Art, das Ihr Wert den existierenden Wert der Variable während der Laufzeit überschreibt.
- Eine .sidecar-Datei kann keine zusätzlichen CLI-Befehle oder Optionen enthalten.
- Eine .sidecar-Datei sollte zeitgleich wie die Eingabedatei im Eingangsverzeichnis sich befinden. Es wird empfohlen die .sidecar-file vor der Eingangsdatei in dem Ordner zu kopieren um sicherzustellen, dass der Server die Sidecar-Datei beachtet beim durchsuchen des Eingabeverzeichnisses.
Syntax von Sidecar-Dateien
Wie bereits genannt, kann eine .sidecar-Datei optional kopiert werden in das Eingangsverzeichnis neben die Eingangsdatei. Der Inhalt, der .sidecar-Datei wir dabei in Betracht gezogen zur Verarbeitung. Aber generelle Paramater von den Job-Einstellungen werden die Art kontrollieren wie eine Datei verarbeitet wird.
Die ".sidecar" Datei muss formatiert sein als JSON, und alle zusätzlichen Informationen enthalten die Datei zu verarbeiten.
Die .sidecar-Datei muss exakt denselben Namen tragen (wie die Originaldatei), z.B.:
- Inputfile.pdf
- Inputfile.pdf.sidecar
{
"type":"sidecar",
"variables":
[
{
"key":"placetext",
"value":"Some text from the initial sidecar file"
},
{
"key":"activate_fixup",
"1"
}
]
}Jedes Job-Ticket was zunächst mit dem "type" beginnt muss "sidecar" lauten.
Innerhalb des "variables" Abschnittes können neue Werte für Variablen definiert werden, welche für die Datei dann verwendet werden.
Aktualisierter Inhalt nach dem Server-Job
Der normale "Variablen"-Teil wird nicht aktualisiert, sofern eine Variable sich verändert hat während der Verarbeitung.
Dennoch werden alle veränderten Variablen, wie auch alle Details zu jedem ausgeführten Verarbeitungsschritt zu der .sidecar-Datei hinzugefügt wie im Beispiel darunter zu sehen:
{
"results" :
[
{
"command" : "< complete CLI command used >",
"folder_in" : "/Hotfolder/Job_2/In",
"jobname" : "Sidecar Job",
"returncode" : 5,
"variables" :
{
"placetext" : "Some text from the initial sidecar file",
"placetext_new" : "Some text from the initial sidecar file and some additional text",
"script" : "Some text from the initial sidecar file and some additional text"
}
}
],
"type" : "sidecar",
"variables" :
[
{
"key" : "placetext",
"value" : "Some text from the initial sidecar file"
},
{
"key":"activate_fixup",
"1"
}
]
}In diesem Beispeil wird eine neue Variable "placetext_new" erzeugt über eine JavaScript-Variable im Profil. Es benutzt die übermittelte neue "placetext"-Variable und fügt etwas zusätzlichen Text hinzu.
Sidecar-Dateien erzeugen vom Server-Job
Es ist möglich eine Sidecar-Datei, sofern diese nicht bereits existiert, durch aktivieren der entsprechenden Option innerhalb der vier Einstellungen für jede Severity erzeugen zu lassen.
