Um überhaupt selbstständig eine Korrektur zu erstellen und diese im Workflow verwenden zu können, braucht es eine KFPX-Datei, worin die Korrektur bzw. die Prüfung beschrieben ist. Dafür benötigen Sie die das Programm callas pdfToolbox. Darin können Sie sich die gewünschte Korrektur nach Ihren Vorstellungen zusammenstellen und das Profil im Anschluss als kfpx-Datei exportieren.

Für diese Beschreibung haben wir bereits eine Korrektur mithilfe der callas pdfToolbox erstellt und anschließend exportiert. Das Ziel dieser Korrektur ist, die Seite um 90° im Uhrzeigersinn zu drehen.

Die Beispieldateien stehen unter 3. Beispieldateien zum Herunterladen bereit.

Nachdem die KFPX-Datei erstellt wurde, muss noch die XML-Datei dazu beschrieben werden. In der XML-Datei werden unter anderem der automationKey [4] – dieser muss im gesamten Workflow eindeutig sein – definiert. Nur wenn sowohl KFPX- als auch die dazu passende XML-Datei in den Workflow hochgeladen werden, kann die Korrektur verwendet werden.

Der Grundaufbau einer XML-Datei ist immer gleich. Dieser wird nur um die Beschreibung der einzelnen Variablen bzw. Elemente im XML erweitert. Wie Variablen sowohl in der pdfToolBox als auch in der XML-Datei eingebaut werden, lesen Sie im Artikel Parametrierbare Korrekturen erstellen.

Abbildung 1: Links: Die XML-Datei für die Korrektur Seite um 90° im Uhrzeigersinn drehen; Rechts: Dialog der Korrektur im Workflow

Folgender Grundaufbau muss in der XML-Datei vorhanden sein, damit die Korrektur, welche ohne steuerbare Variable auskommt, im Workflow funktionieren kann:

• Version und Encoding [1] – diese Zeile ist in jeder XML-Datei vorhanden und der typische Anfang einer XML-Datei. Damit wird unter anderem die Zeichenkodierung – UTF-8 – der Datei festgelegt.
• Autor, Version und modified [2] – für die Nachvollziehbarkeit, wird hier beschrieben, wer diese Datei erstellt hat (Author), um welche Version der Datei es sich handelt (Version) und wann die Datei erstellt wurde (modified).
• Variable Analyze Mode [3] – hier wird definiert, in welchen Style der Dialog der Korrektur aufgebaut werden soll. Mit der Eingabe XML_BASED_V2 wird der Dialog im Style der neuen Benutzeroberfläche (Verfügbar seit 01/2023) gestaltet. Die Dialoge sehen dadurch gleich aus, wie jene die Sie von den anderen Korrekturen bereits gewohnt sind.

• automationKey [4] – in dieser Zeile wird der automationKey, der unter anderem zum Aufruf der Korrektur über die Rest API benötigt wird, definiert. Beachten Sie, dass dieser automationKey eindeutig und einzigartig sein muss und kein zweites Mal im Workflow vorkommen darf!
• Name der Korrektur [5] – damit wird der Name der Korrektur bestimmt. Der hier eingegeben Name wird schlussendlich im Workflow in der Liste der Korrekturen angezeigt.
  Grundsätzlich kann die Korrektur in allen Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist dabei verpflichtend. Ohne die englische Beschreibung funktioniert die Korrektur nicht, selbst wenn alle anderen Sprachen übersetzt wurden. Sollte eine Sprache nicht übersetzt sein, wird die englische Übersetzung stattdessen benutzt.
• Beschreibung der Korrektur [6] – darin kann eine Beschreibung zur Korrektur vorgenommen werden. Dabei handelt es sich um den kurzen Informationstext, den Sie bei jeder Korrektur finden. Auch hier gilt: Die englische Übersetzung muss vorhanden sein, ohne diese funktioniert die Korrektur nicht.
• fixupResultMode/checkResultMode [7] – diese zwei Zeilen sind aktuell verpflichtend im XML einzubauen. Sie werden für interne Abläufe im Workflow benötigt und sind daher unumgänglich.
  • <fixupResultMode>DEFAULT_CHECKIN</fixupResultMode> – damit wird bestimmt, dass nach der Ausführung der Korrektur erneut das Check-in-Profil, welches beim Hochladen verwendet wurde, erneut angewandt wird.
  • <checkResultMode>APPEND_RESULT_ALL</checkResultMode> – damit wird bestimmt, dass alle Mitteilungen und zusätzlich Dateien, die durch die Korrektur entstehen, zum jeweiligen Artikel/Motiv geladen werden.
• Korrektur [8] – in diesem Bereich werden die einzelnen Korrekturen eingetragen. Der minimalste Eintrag für eine Korrektur ist aus der Beispiel XML-Datei zu erkennen. Bei umfangreicheren Korrekturen können darin auch noch Werte bzw. Variablen mitgegeben werden.
  Folgende Attribute müssen für eine Korrektur vergeben werden:
  • Key – definierten Sie hier den eindeutigen Schlüssel für diese Korrektur.
    • Dieser Key muss in der Korrektur eindeutig sein und darf daher nicht gleichlauten mit dem automationKey sein!
    • Beachten Sie, dass dieser Key in einer Korrekturkette ebenfalls eindeutig sein muss! Überlegen Sie sich somit eine durchgängige eigene Namenskonvention für die Benennung von Korrekturen!
  • execute – dieses Attribut gibt an, ob die Korrektur ausgeführt wird oder nicht. Daher können nur die Werte true oder false angegeben werden. true steht dabei für ausführen und false für nicht ausführen.
  • sortIndex – mit diesem Attribut gibt man die Positionierung der Korrektur innerhalb des Dialoges an. Dieser Wert kommt dann zu tragen, wenn mehrere Korrekturen aus der pdfToolbox für eine Korrektur im Workflow verwendet werden.
  • hidden – dieses Attribut gibt an, ob die Korrektur im Workflow sichtbar ist oder nicht. Daher können nur die Werte true oder false angegeben werden. true steht dabei für verbergen und false für anzeigen. Sie können damit bestimmen, ob eine Korrektur, die zwar angewandt wird, dennoch nicht angezeigt werden soll.