Benutzerhandbuch

5.2 Parametrierbare Korrektur erstellen

Aktualisiert am

Erfahren Sie in diesem Artikel,

  • wie Variablen in der callas pdfToolbox erstellt werden können,
  • wie Sie den Variablen einen Typ im XML zuweisen können und
  • wie Sie die XML-Datei aufbauen müssen, damit die Korrektur mit den Variablen im Workflow verwendet werden kann.

1. Einführung

Korrekturen sind im Workflow ein wesentlicher Bestandteil. Damit können Daten automatisiert korrigiert und damit für den Druck vorbereitet werden. Darüber hinaus können eigene Korrektur mit benutzerdefinierten Variablen erstellt werden, wodurch der Anwender die Möglichkeit hat, Korrekturen ganz nach seinen Vorstellungen zu erstellen und im Workflow anzuwenden.

2. Variablen in »callas pdfToolbox«

Bevor die verfügbaren XML-Typen der Variable zugewiesen werden können, muss eine Variable für die jeweilige Option der Korrektur in der callas pdfToolbox für die KFPX-Datei erzeugt werden.

Der hier definierte Key [1], wird später für die Zuweisung des Typs benötigt. Daher sollte die Benennung des Key sinnhaftig gewählt werden. Der gewünschte Typ kann in einer XML-Datei nur zugewiesen werden, wenn die in der callas pdfToolbox den jeweiligen Wertetyp dafür auch zulässt. Achten Sie darauf, dass der zugewiesene Typ im XML, mit dem Wertetyp der pdfToolBox kompatibel ist.

Abbildung 1: Dialog zur Erstellung einer Variable in der pdfToolBox, mit dem Wertetyp String

Umgang mit calas pdfToolbox

Kenntnisse im Umgang mit Callas pdfToolbox wird für die Erstellung von eigenen Korrekturen vorausgesetzt. Eine detaillierte Beschreibung zur callas pdfToolBox finden Sie im Handbuch von Callas.

Verwendung der KFXP-Datei für Versionen unter 14

Für die Erstellung der KFPX-Datei haben wir mit der callas pdfToolbox 14 gearbeitet. Beachten Sie daher, dass die KFPX-Datei von callas pdfToolBox Versionen unter 14.0 nicht importiert werden können. Versionen höher als 14.0 können die Beispiel KFPX jederzeit importieren!

Die angefügte KFPX-Datei kann nur in Workflow Versionen 1.14.0 und höher hochgeladen werden. Für alle früheren Versionen z.B: 1.13.x, 1.12.x oder 1.11.x kann die KFPX-Datei nicht verwendet werden.

3. Verfügbare XML-Typen

Nachdem eine Korrektur in der callas pdfToolbox erstellt und mit den gewünschten Variablen versehen wurde, kann den Variablen in der XML-Datei ein Typ zugewiesen werden. Mithilfe der verschiedenen Typen können verschiedene Optionen – beispielsweise ein Eingabefeld, eine Checkbox oder ein Schieberegler – in der Benutzeroberfläche angezeigt werden.

Auf folgende Typen kann der Anwender zurückgreifen:

  • String – damit kann ein Eingabefeld erzeugt werden. Erlaubte Eingaben sind Zahlen, Buchstaben und Symbole.
  • Pattern_String – ist dem Typ String gleichgestellt. Durch die Wahl dieses Typs kann ein Eingabefeld mit Variablen Inhalt – einfügen eines Platzhalters  (Datenbankfeld bzw. Benutzerdefiniertes Feld), woraus der Wert für den Inhalt entnommen werden soll – erzeugt werden.
  • Double – damit kann ein Eingabefeld erzeugt werden. Erlaubte Eingaben sind positive sowie negative Zahlen mit oder ohne Kommastellen.
  • Pattern_Double – ist dem Typ Double gleichgestellt. Durch die Wahl dieses Typs kann ein Eingabefeld mit Variablen Inhalt – einfügen eines Platzhalters  (Datenbankfeld bzw. Benutzerdefiniertes Feld), woraus der Wert für den Inhalt entnommen werden soll – erzeugt werden.
  • Integer – damit kann ein Eingabefeld erzeugt werden. Erlaubte Eingaben sind dabei positive und negative Zahlen sowie 0, allerdings ohne Kommastellen.
  • Pattern_Integer – ist dem Typ Integer gleichgestellt. Durch die Wahl dieses Typs kann ein Eingabefeld mit Variablen Inhalt – einfügen eines Platzhalters  (Datenbankfeld bzw. Benutzerdefiniertes Feld), woraus der Wert für den Inhalt entnommen werden soll – erzeugt werden.
  • Boolean – damit kann eine Checkbox erzeugt werden, um die Option zu aktivieren bzw. deaktivieren.
  • Pattern_Boolean – ist dem Typ Boolean gleichgestellt. Durch die Wahl dieses Typs kann ein Eingabefeld mit Variablen Inhalt – einfügen eines Platzhalters  (Datenbankfeld bzw. Benutzerdefiniertes Feld), woraus der Wert für den Inhalt entnommen werden soll – erzeugt werden.
  • Slider_Integer – damit kann ein Schieberegler mit Werten von 0% bis 100% angezeigt werden.
  • Color_Picker – damit wird ein Eingabebereich für die Eingabe von CMYK-Werte mit einer Farbvorschaufläche erzeugt.

3.1. Korrektur mit Variable vom Typ »String« erzeugen

Um ein Eingabefeld zu erzeugen, wo eine Zeichenfolge eingegeben werden kann, muss der Typ String verwendet werden. Buchstaben, Zahlen, Symbole oder Tabulatorenzeichen sind zulässige Zeichen, die in einem String verwendet werden dürfen. Damit können unter anderem Eingabefelder erzeugt werden, worin ein beliebiger Text eingegeben werden kann.

3.1.1. Eingabefeld »String« im KFPX

Zur Veranschaulichung stellen wir die Korrektur »PLACE_TEXT_STRING_MANUAL.kfpx« zur Verfügung. Die benutzerdefinierte Korrektur PLACE_TEXT_STRING_MANUAL beinhaltet

  • die Variable SAMPLE_String mit
  • dem Wertetyp String

Ziel der Korrektur ist, einen definierten Text mittig im Medienrahmen (MediaBox) des Motivs zu platzieren. Der Text hat eine Größe von 12 pt. Die Farbe des Textes ist 100%-CMYK-Schwarz. Im Eingabefeld, kann der zu platzierende Text von Anwender eingegeben werden.

3.1.2. Eingabefeld »String« im XML

Sobald die KFPX-Datei exportiert wurde, muss noch die XML-Datei dazu erstellt werden und darin der zuvor definierten Variable SAMPLE_String der Typ String zugewiesen werden. Nur wenn die KFPX- und XML-Datei übereinstimmen, kann die Korrektur im Workflow angewandt werden.

Abbildung 2: Links: Ausschnitt der XML-Datei, wo der Variable der Typ String zugewiesen wurde; Rechts: Dialog der selbsterstellten Korrektur im Workflow

Um ein Eingabefeld als String im XML zu definieren, gehen Sie folgendermaßen vor:

  1. Erstellen Sie zuerst den Grundaufbau der XML-Datei. Wie dieser aussehen muss, lesen Sie im Artikel Korrekturen ohne Parameter erstellen.
  2. Bauen Sie im Element <fixup></fixup> die untergeordnete Elemente <variables></variables> und darin das Element <variable></variable> ein. Wie die Struktur auszusehen hat, sehen Sie in Abbildung 2.
  3. Vergeben Sie für das Element <variable></variable> noch die Attribute. Folgende Attribute sollten für einen String vergeben werden:
    • name [3] – hier muss der Key [1] (Abbildung 1) der Variable, die in der pdfToolbox definiert wurde, eingegeben werden.
    • type [2] – weisen Sie hier Typen STRING zu, um ein Eingabefeld zu erzeugen.
    • defaultValue [5] – geben Sie hier jenen Wert ein, der standardmäßig im Eingabefeld angezeigt werden soll. Dieses Attribut ist nicht verpflichtend, sollte aber dennoch verwendet werden.
    • displayVariable [6] – geben Sie hier den Wert true ein, damit die Variable später im Dialog auch angezeigt wird.
    • description [4] – geben Sie hier die Bezeichnung für das Eingabefeld ein, damit der Anwender weiß, wofür das Eingabefeld gedacht ist. Dieser Name kann in alle Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist verpflichtend. Nur wenn diese vorhanden ist, funktioniert die Korrektur. Wird eine Sprache nicht übersetzt, wird die englische Übersetzung angezeigt.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_STRING_MANUAL.xml« zum Herunterladen bereit. Darin ist die Variable als Typ STRING definiert.

3.1.3. Eingabefeld »String« im XML mit Variablen Inhalt

Neben der Möglichkeit, ein Eingabefeld durch einen STRING zu erzeugen, kann das selbe Eingabefeld mit einem Platzhalter zur Definition eines Variablen Inhalts versehen werden. Dazu wird der Typ  PATTERN_STRING benötigt. Die Zuweisung des Typs sowie die Definition der Attribute funktionieren gleich, wie beim Typ STRING. Mit dem Eintrag PATTERN_STRING im Attribut type wird die Möglichkeit, einen Variable Inhalt im Workflow auszuwählen, angeboten.

Sie müssen dazu weder in der KFPX-Datei noch in der XML-Datei eine strukturelle Änderung vornehmen. Sie müssen lediglich in der XML-Datei die Typenbezeichnung auf PATTERN_STRING ändern.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_STRING_VARIABLE_CONTENT.xml« zum Herunterladen bereit. Darin ist die Variable als PATTERN_STRING definiert.

Abbildung 3: Dialog der selbst erstellen Korrektur mit dem Typ PATTERN_STRING

3.2. Korrektur mit Variable vom Typ »Double« erzeugen

Um ein Eingabefeld zu erzeugen, wo Ziffern bzw. Zahlen eingegeben werden können, muss der Typ Double verwendet werden. Positive und negative Zahlen sowie Zahlen mit Kommastellen sind als Zeichen zulässig und dürfen in einem Double verwendet werden. Dadurch kann unter anderem ein Eingabefeld erzeugt werden, wo Objekte um den eingegeben Werte verschoben werden können.

3.2.1. Eingabefeld »Double« im KFPX

Zur Veranschaulichung stellen wir die Korrektur »PLACE_TEXT_DOUBLE_MANUAL.kfpx« zur Verfügung. Die benutzerdefinierte Korrektur PLACE_TEXT_DOUBLE_MANUAL beinhaltet

  • die Variable SAMPLE_Double mit
  • dem Wertetyp Float

Das Ziel dieser Korrektur ist einen definierten Text mittig im Medienrahmen (MediaBox) des Motivs zu platzieren. Mithilfe des Eingabefeldes kann der Text entlang der X-Achse nach links (»–«-Werte) oder nach rechts (»+«-Werte) verschoben werden.

3.2.2. Eingabefeld »Double« im XML

Sobald die KFPX-Datei exportiert wurde, muss noch die XML-Datei dazu erstellt werden und darin der zuvor definierten Variable SAMPLE_Double der Typ Double zugewiesen werden. Nur wenn die KFPX- und XML-Datei übereinstimmen, kann die Korrektur im Workflow angewandt werden.

Abbildung 4: Links: Ausschnitt der XML-Datei, wo der Variable der Typ Double zugewiesen wurde; Rechts: Dialog der selbsterstellten Korrektur im Workflow

Um ein Eingabefeld als Double im XML zu definieren, gehen Sie folgendermaßen vor:

  1. Erstellen Sie zuerst den Grundaufbau der XML-Datei. Wie dieser aussehen muss, lesen Sie im Artikel Korrekturen ohne Parameter erstellen.
  2. Bauen Sie im Element <fixup></fixup> die untergeordnete Elemente <variables></variables> und darin das Element <variable></variable> ein. Wie die Struktur auszusehen hat, sehen Sie in Abbildung 4.
  3. Vergeben Sie für das Element <variable></variable> noch die Attribute. Folgende Attribute sollten für einen String vergeben werden:
    • name [8] – hier muss der Key [1] (Abbildung 1) der Variable, die in der pdfToolbox definiert wurde, eingegeben werden.
    • type [7] – weisen Sie hier Typen DOUBLE zu, um ein Eingabefeld zu erzeugen.
    • min/max [10] – geben Sie hier den Wertebereich für diese Variable an. In diesem Beispiel beträgt der Wertebereich von –1000.0 bis +1000.0. Möchte ein Anwender also der Wert 1001 eingeben, wird eine Warnung angezeigt.
    • defaultValue [11] – geben Sie hier jenen Wert ein, der standardmäßig im Eingabefeld angezeigt werden soll. Dieses Attribut ist nicht verpflichtend, sollte aber dennoch verwendet werden.
    • modelUnit [13] – geben Sie hier die Maßeinheit ein, die für die Verrechnung herangezogen werden soll. In diesem Fall handelt es sich um Millimeter.
    • displayVariable [12] – geben Sie hier den Wert true ein, damit die Variable später im Dialog auch angezeigt wird.
    • description [9] – geben Sie hier die Bezeichnung für das Eingabefeld ein, damit der Anwender weiß, wofür das Eingabefeld gedacht ist. Dieser Name kann in alle Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist verpflichtend. Nur wenn diese vorhanden ist, funktioniert die Korrektur. Wird eine Sprache nicht übersetzt, wird die englische Übersetzung angezeigt.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_DOUBLE_MANUAL.xml« zum Herunterladen bereit. Darin ist die Variable als Typ DOUBLE definiert.

3.2.3. Eingabefeld »Double« im XML mit Variablen Inhalt

Neben der Möglichkeit, ein Eingabefeld durch einen DOUBLE zu erzeugen, kann das selbe Eingabefeld mit einem Platzhalter zur Definition eines Variablen Inhalts versehen werden. Dazu wird der Typ  PATTERN_DOUBLE benötigt. Die Zuweisung des Typs sowie die Definition der Attribute funktionieren gleich, wie beim Typ DOUBLE. Mit dem Eintrag PATTERN_DOUBLE im Attribut type wird die Möglichkeit einen Variable Inhalt im Workflow auszuwählen angeboten.

Sie müssen dazu weder in der KFPX-Datei noch in der XML-Datei eine strukturelle Änderung vornehmen. Sie müssen lediglich in der XML-Datei  die Typenbezeichnung auf PATTERN_DOUBLE ändern.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_DOUBLE_VARIABLE_CONTENT.xml« zum Herunterladen bereit. Darin ist die Variable als PATTERN_DOUBLE definiert.

Abbildung 5: Dialog der selbst erstellen Korrektur mit dem Typ PATTERN_DOUBLE

3.3. Korrektur mit Variable vom Typ »Integer« erzeugen

Um ein Eingabefeld zu erzeugen, wo ganze Zahlen eingegeben werden können, muss der Typ Integer verwendet werden. Erlaubte Eingaben sind positive sowie negative Zeichen. Im Unterschied zum Typ Double sind Zahlen mit Kommastellen nicht zulässig. Dadurch kann unter anderem ein Eingabefeld erzeugt werden, um ein Objekt, um den eingegeben Wert, zu verschieben.

3.3.1. Eingabefeld »Integer« im KFPX

Zur Veranschaulichung stellen wir die Korrektur »PLACE_TEXT_INTEGER_MANUAL.kfpx« erstellt. Die benutzerdefinierte Korrektur PLACE_TEXT_INTEGER_MANUAL beinhaltet:

  • die Variable SAMPLE_INTEGER mit
  • dem Wertetyp Float

Das Ziel dieser Korrektur ist einen definierten Text mittig im Medienrahmen (MediaBox) des Motives zu platzieren. Mithilfe des Eingabefeldes kann der Text entlang der Y-Achse nach unten (»-«-Werte) oder nach oben (»+«-Werte) verschoben werden.

3.3.2. Eingabefeld »Integer« im XML

Sobald die KFPX-Datei exportiert wurde, muss noch die XML-Datei dazu erstellt werden und darin der zuvor definierten Variable SAMPLE_Integer der Typ Integer zugewiesen werden. Nur wenn die KFPX- und XML-Datei übereinstimmen, kann die Korrektur im Workflow angewandt werden.

Abbildung 6: Links: Ausschnitt der XML-Datei, wo der Variable der Typ Integer zugewiesen wurde; Rechts: Dialog der selbsterstellten Korrektur im Workflow

Um ein Eingabefeld als Integer im XML zu definieren, gehen Sie folgendermaßen vor:

  1. Erstellen Sie zuerst den Grundaufbau der XML-Datei. Wie dieser aussehen muss, lesen Sie im Artikel Korrekturen ohne Parameter erstellen.
  2. Bauen Sie im Element <fixup></fixup> die untergeordnete Elemente <variables></variables> und darin das Element <variable></variable> ein. Wie die Struktur auszusehen hat, sehen Sie in Abbildung 6.
  3. Vergeben Sie für das Element <variable></variable> noch die Attribute. Folgende Attribute sollten für einen String vergeben werden:
    • name [15] – hier muss der Key [1] (Abbildung 1) der Variable, die in der pdfToolbox definiert wurde, eingegeben werden.
    • type [14] – weisen Sie hier Typen INTEGER zu, um ein Eingabefeld zu erzeugen.
    • min/max [17] – geben Sie hier den Wertebereich für diese Variable an. In diesem Beispiel beträgt der Wertebereich von –1000 bis +1000. Möchte ein Anwender also der Wert 1001 eingeben, wird eine Warnung angezeigt.
    • defaultValue [18] –  geben Sie hier jenen Wert ein, der standardmäßig im Eingabefeld angezeigt werden soll. Dieses Attribut ist nicht verpflichtend, sollte aber dennoch verwendet werden.
    • modelUnit [20] – geben Sie hier die Maßeinheit ein, die für die Verrechnung standardmäßig benötigt wird. In diesem Fall handelt es sich um Millimeter.
    • displayVariable [19] – geben Sie hier den Wert true ein, damit die Variable später im Dialog auch angezeigt wird.
    • description [16] – geben Sie hier die Bezeichnung für das Eingabefeld ein, damit der Anwender weiß, wofür das Eingabefeld gedacht ist. Dieser Name kann in alle Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist verpflichtend. Nur wenn diese vorhanden ist, funktioniert die Korrektur. Wird eine Sprache nicht übersetzt, wird die englische Übersetzung angezeigt.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_INTEGER_MANUAL.xml« zum Herunterladen bereit. Darin ist die Variable als Typ INTEGER definiert.

3.3.3. Eingabefeld durch Integer mit Variablen Inhalt

Neben der Möglichkeit, ein Eingabefeld durch einen INTEGER zu erzeugen, kann das selbe Eingabefeld mit einem Platzhalter zur Definition eines Variablen Inhalts versehen werden. Dazu wird der Typ PATTERN_INTEGER benötigt. Die Zuweisung des Typs sowie die Definition der Attribute funktionieren gleich, wie beim Typ INTEGER. Mit dem Eintrag PATTERN_INTEGER im Attribut type wird die Möglichkeit einen Variable Inhalt im Workflow auszuwählen angeboten.

Sie müssen dazu weder in der KFPX-Datei noch in der XML-Datei eine strukturelle Änderung vornehmen. Sie müssen lediglich in der XML-Datei  die Typenbezeichnung auf PATTERN_INTEGER ändern.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_INTEGER_VARIABLE_CONTENT.xml« zum Herunterladen bereit. Darin ist die Variable als PATTERN_INTEGER definiert.

Abbildung 7:Dialog der selbst erstellen Korrektur mit dem Typ PATTERN_INTEGER

3.4. Korrektur mit Checkbox erstellen

Um eine Checkbox zu erzeugen, wodurch Optionen aktiviert bzw. deaktiviert werden können, muss der Typ BOOLEAN verwendet werden. Der Anwender kann dadurch eine Checkbox aktivieren bzw. deaktivieren und damit die Option ausführen bzw. nicht ausführen.

3.4.1. Checkbox im KFPX

Zur Veranschaulichung stellen wir die Korrektur »PLACE_TEXT_BOOLEAN_MANUAL.kfpx« zur Verfügung. Die benutzerdefinierte Korrektur PLACE_TEXT_BOOLEAN_MANUAL beinhaltet

  • die Variable SAMPLE_Boolean mit
  • dem Wertetyp Boolean

Ziel der Korrektur ist, einen definierten Text mittig im Medienrahmen (MediaBox) des Motivs zu platzieren. Der Text hat eine Größe von 12 pt. Die Farbe des Textes ist 100%-CMYK-Schwarz. Mithilfe der Checkbox wird dem Anwender die Möglichkeit geboten, optional einen weißen Hintergrund für den Text hinzuzufügen.

3.4.2. Checkbox im XML

Sobald die KFPX-Datei exportiert wurde, muss noch die XML-Datei dazu erstellt werden und darin der zuvor definierten Variable SAMPLE_Boolean der Typ Boolean zugewiesen werden. Nur wenn die KFPX- und XML-Datei übereinstimmen, kann die Korrektur im Workflow angewandt werden.

Abbildung 8: Links: Ausschnitt der XML-Datei, wo der Variable der Typ Boolean zugewiesen wurde; Rechts: Dialog der selbsterstellten Korrektur im Workflow

Um eine Checkbox durch einen Boolean im XML zu definieren, gehen Sie wie folgt vor:

  1. Erstellen Sie zuerst den Grundaufbau der XML-Datei. Wie dieser aussehen muss, lesen Sie im Artikel »Korrekturen ohne Parameter erstellen«.
  2. Bauen Sie im Element <fixup></fixup> die untergeordnete Elemente <variables></variables> und darin das Element <variable></variable> ein. Wie die Struktur auszusehen hat, sehen Sie in Abbildung 8.
  3. Vergeben Sie für das Element <variable></variable> noch die Attribute. Folgende Attribute sollten für einen String vergeben werden:
    • name [21] – hier muss der Key [1] (Abbildung 1) der Variable, die in der pdfToolBox definiert wurde eingegeben werden.
    • type [21] – weisen Sie hier den Typen BOOLEAN zu, um eine Checkbox zu erzeugen.
    • defaultValue [24] – geben Sie hier den Wert true ein, wenn die Checkbox standardmäßig aktiviert sein soll. Dieses Attribut ist nicht verpflichtend, sollte aber dennoch verwendet werden.
    • displayVariable [25] – geben Sie hier den Wert true ein, damit die Variable später im Dialog auch angezeigt wird.
    • description [23] – gebe hier den Name für die Checkbox ein, damit der Anwender weiß, wofür die Checkbox gedacht ist. Dieser Name kann in alle Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist verpflichtend. Nur wenn diese vorhanden ist, funktioniert die Korrektur. Wird eine Sprache nicht übersetzt, wird die englische Übersetzung angezeigt.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_BOOLEAN_MANUAL.xml« zum Herunterladen bereit. Darin ist die Variable als Typ BOOLEAN definiert.

3.4.3. Checkbox mit Variablen Inhalt

Neben der Möglichkeit, eine Checkbox durch einen BOOLEAN zu erzeugen, kann die selbe Checkbox mit einem Platzhalter zur Definition eines Variablen Inhalts versehen werden. Dazu wird der Typ  PATTERN_BOOLEAN benötigt. Die Zuweisung des Typs sowie die Definition der Attribute funktionieren gleich, wie beim Typ BOOLEAN. Mit dem Eintrag PATTERN_BOOLEAN im Attribut type wird die Möglichkeit, einen Variable Inhalt im Workflow auszuwählen, angeboten.

Sie müssen dazu weder in der KFPX-Datei noch in der XML-Datei eine strukturelle Änderung vornehmen. Sie müssen lediglich in der XML-Datei die Typenbezeichnung auf PATTERN_BOOLEAN ändern.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_BOOLEAN_VARIABLE_CONTENT.xml« zum Herunterlanden. Darin ist die Variable als PATTERN_BOOLEAN definiert.

Abbildung 9: Dialog der selbst erstellen Korrektur mit dem Typ PATTERN_BOOLEAN

3.5. Korrektur mit Dropdown-Menü erstellen

Um ein Dropdown-Menü bzw. ein Auswahlmenü zu erzeugen, wo vorgegebene Optionen ausgewählt werden können, muss der Typ String verwendet werden. Zusätzlich muss aber das Element <options layoutType="dropdown"> eingebaut werden. Darin werden die einzelnen Optionen, die im Auswahlmenü angezeigt werden, definiert.  Der Anwender kann dadurch zwischen den vordefinierten Optionen wählen.

Im Gegensatz zu den bereits beschriebenen Typen, muss für ein Dropdown-Menü in der pdfToolBox die Eingabewerte auf bestimmte Wert begrenzt werden. Eine genauere Beschreibung dazu finden Sie hier.

Zur Veranschaulichung stellen wir die Korrektur »PLACE_TEXT_DROPDOWN_MANUAL.kfpx« zur Verfügung. Die benutzerdefinierte Korrektur PLACE_TEXT_DROPDOWN_MANUAL beinhaltet

  • die Variable SAMPLE_Dropdown mit
  • dem Wertetyp PopUp

Die Eingabe wurde auf folgende Werte begrenzt:

  • Bottom
  • Left
  • Right
  • Top
  • Center

Ziel der Korrektur ist, einen definierten Text af das Motiv zu platzieren. Der Text hat eine Größe von 12 pt. Die Farbe des Textes ist 100%-CMYK-Schwarz. Mithilfe des Auswahlmenüs kann der Anwender entscheiden, wo der Text platziert werden soll. Zur Auswahl stehen mittig, oben mittig, rechts mittig, unten mittig und links mittig.

Sobald die KFPX-Datei exportiert wurde, muss noch die XML-Datei dazu erstellt werden und darin der zuvor definierten Variable SAMPLE_Dropdown der Typ String und der Layouttyp dropdown zugewiesen werden. Nur wenn die KFPX- und XML-Datei übereinstimmen, kann die Korrektur im Workflow angewandt werden.

Abbildung 10: Links: Ausschnitt der XML-Datei, wo der Variable der Typ String und der Layouttyp dropdown zugewiesen wurde; Rechts: Dialog der selbsterstellten Korrektur im Workflow

Um ein Dropdown-Menü im XML zu definieren, gehen Sie wie folgt vor:

  1. Erstellen Sie zuerst den Grundaufbau der XML-Datei. Wie dieser aussehen muss, lesen Sie im Artikel Korrekturen ohne Parameter erstellen.
  2. Bauen Sie im Element <fixup></fixup> die untergeordnete Elemente <variables></variables> und darin das Element <variable></variable> ein. Wie die Struktur auszusehen hat, sehen Sie in Abbildung 10.
  3. Vergeben Sie für das Element <variable></variable> noch die Attribute. Folgende Attribute sollten für einen String vergeben werden:
    • name [27] – hier muss der Key [1] (Abbildung 1) der Variable, die in der pdfToolBox definiert wurde eingegeben werden.
    • type [26] – weisen Sie hier den Typen STRING zu, um ein Eingabefeld und damit auch das Auswahlmenü zu erstellen.
    • defaultValue [32] – geben Sie hier jenen Wert ein, der standardmäßig im Auswahlmenü ausgewählt sein soll.
    • displayVariable [33] – geben Sie hier den Wert true ein, damit die Variable später im Dialog auch angezeigt wird.
    • description [28] – gebe hier den Name für das Dropdown-Menü ein, damit der Anwender weiß, wofür das Menü gedacht ist. Dieser Name kann in alle Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist verpflichtend. Nur wenn diese vorhanden ist, funktioniert die Korrektur. Wird eine Sprache nicht übersetzt, wird die englische Übersetzung angezeigt.
  4. Bauen Sie im Element <variable></variable> das untergeordneten Elemente <options></options> ein.
  5. Vergeben Sie für das Element <options><options> das Attribut layoutType="dropdown". Damit wird das Dropdown-Menü erzeugt.
  6. Bauen Sie im Element <options></options> das untergeordneten Elemente <option></option> ein.
  7. Vergeben Sie für das Element <option></option> noch die Attribute. Folgende Attribute sollten für ein Dropdown vergeben werden:
    • name [30] – geben Sie hier den Namen der Option ein. Dieser muss mit dem jeweiligen Wert der pdfToolBox übereinstimmen.
    • description [31] – vergeben Sie hier den Namen für die jeweilige Option. Dieser Name kann in alle Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist verpflichtend. Nur wenn diese vorhanden ist, funktioniert die Korrektur. Wird eine Sprache nicht übersetzt, wird die englische Übersetzung angezeigt.
  8. Wiederholen Sie Schritt 6 und 7 solange, bis alle Optionen beschrieben wurden. Wie die Struktur dafür auszusehen hat, sehen Sie in Abbildung 10.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_DROPDOWN_MANUAL.xml« zum Herunterladen bereit. Darin ist die Variable als Typ STRING mit dem Layouttyp dropdown definiert.

3.6. Korrektur mit Auswahlmenü durch Radiobuttons

Um Radiobuttons zu erzeugen, wo vorgegebene Optionen ausgewählt werden können, muss der Typ String verwendet werden. Zusätzlich muss aber das Element <options layoutType="radio"> eingebaut werden. Darin werden die einzelnen Optionen, die angezeigt werden, definiert. Der Anwender kann dadurch zwischen vordefinierten Optionen wählen.

3.6.1. Radiobuttons im KFPX

Wie bei dem Layouttyp Dropdown, muss für Radiobuttons in der pdfToolBox die Eingabewerte auf bestimmte Wert begrenzt werden. Eine genauere Beschreibung dazu finden Sie hier.

Zur Veranschaulichung stellen wir die Korrektur »PLACE_TEXT_RADIO_MANUAL.kfpx« zur Verfügung. Die benutzerdefinierte Korrektur PLACE_TEXT_DROPDOWN_MANUAL beinhaltet

  • die Variable SAMPLE_Radio mit
  • dem Wertetyp PopUp

Ziel der Korrektur ist, einen definierten Text mittig im Medienrahmen (MediaBox) des Motivs zu platzieren. Der Text hat eine Größe von 12 pt. Die Farbe des Textes ist 100%-CMYK-Schwarz. Mithilfe der Radiobuttons kann der Anwender entscheiden, ob der Text überdruckend oder aussparend sein soll.

3.6.2. Radiobutton im XML

Sobald die KFPX-Datei exportiert wurde, muss noch die XML-Datei dazu erstellt werden und darin der zuvor definierten Variable SAMPLE_Radio der Typ String und der Layouttyp radio zugewiesen werden. Nur wenn die KFPX- und XML-Datei übereinstimmen, kann die Korrektur im Workflow angewandt werden

Abbildung 11: Ausschnitt der XML-Datei, wo für die Variable Radiobuttons erzeugt wurde

Um Radiobuttons im XML zu definieren, gehen Sie wie folgt vor:

  1. Erstellen Sie zuerst den Grundaufbau der XML-Datei. Wie dieser aussehen muss, lesen Sie im Artikel Korrekturen ohne Parameter erstellen.
  2. Bauen Sie im Element <fixup></fixup> die untergeordnete Elemente <variables></variables> und darin das Element <variable></variable> ein. Wie die Struktur auszusehen hat, sehen Sie in Abbildung 10.
  3. Vergeben Sie für das Element <variable></variable> noch die Attribute. Folgende Attribute sollten für einen String vergeben werden:
    • name [35] – hier muss der Key [1] (Abbildung 1) der Variable, die in der pdfToolBox definiert wurde eingegeben werden.
    • type [34] – weisen Sie hier den Typen STRING zu, um ein Eingabefeld und damit auch das Auswahlmenü zu erstellen.
    • defaultValue [40] – geben Sie hier jenen Wert ein, der standardmäßig im Auswahlmenü ausgewählt sein soll.
    • displayVariable [41] –  geben Sie hier den Wert true ein, damit die Variable später im Dialog auch angezeigt wird.
    • description [36] – gebe hier den Name für das Dropdown-Menü ein, damit der Anwender weiß, wofür das Menü gedacht ist. Dieser Name kann in alle Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist verpflichtend. Nur wenn diese vorhanden ist, funktioniert die Korrektur. Wird eine Sprache nicht übersetzt, wird die englische Übersetzung angezeigt.
  4. Bauen Sie im Element <variable></variable> das untergeordneten Elemente <options></options> ein.
  5. Vergeben Sie für das Element <options><options> das Attribut layoutType="radio". Damit werden die Radiobuttons erzeugt.
  6. Bauen Sie im Element <options></options> das untergeordneten Elemente <option></option> ein.
  7. Vergeben Sie für das Element <option></option> noch die Attribute. Folgende Attribute sollten für ein Dropdown vergeben werden:
    • name [38] – geben Sie hier den Namen der Option ein. Dieser muss mit dem jeweiligen Wert der pdfToolBox übereinstimmen.
    • description [39] – vergeben Sie hier den Namen für die jeweilige Option. Dieser Name kann in alle Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist verpflichtend. Nur wenn diese vorhanden ist, funktioniert die Korrektur. Wird eine Sprache nicht übersetzt, wird die englische Übersetzung angezeigt.
  8. Wiederholen Sie Schritt 6 und 7 solange, bis alle Optionen beschrieben wurden. Wie die Struktur dafür auszusehen hat, sehen Sie in Abbildung 11.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_RADIO_MANUAL.xml« zum Herunterladen bereit. Darin ist die Variable als Typ STRING mit dem Layouttyp radio definiert.

3.7. Korrektur mit Schieberegler erstellen

Um einen Schieberegler zu erzeugen, um die Eingabe von 0% bis 100% zu regeln, muss der Typ Slider_Integer verwendet werden. Beachten Sie, dass der Einsatz eines Schiebereglers nur Sinn macht, wenn es sich um die Begrenzung von Prozentwerten handelt. Damit kann unter anderem der Tonwert oder die Deckkraft einer Farbe auf den gewünschten Prozentsatz verschoben werden.

3.7.1. Schieberegler im KFPX

Zur Veranschaulichung stellen wir die Korrektur »CREATE_WHITE_SEPARATION_SLIDER_MANUAL.kfpx« zur Verfügung. Die benutzerdefinierte Korrektur CREATE_WHITE_SEPARATION_SLIDER_MANUAL beinhaltet

  • die Variable SAMPLE_Slider mit
  • dem Wertetyp Integer

Das Ziel dieser Korrektur ist, eine überdruckende Schmuckfarb-Weiß-Separation in der Größe des Endformatrahmens zu erzeugen. Mithilfe des Schiebereglers kann die Deckkraft der Weiß-Separation beeinflusst werden.

3.7.2. Schieberegler im XML

Sobald die KFPX-Datei exportiert wurde, muss noch die XML-Datei dazu erstellt werden und darin der zuvor definierten Variable SAMPLE_Slider der Typ Slider_Integer zugewiesen werden. Nur wenn die KFPX- und XML-Datei übereinstimmen, kann die Korrektur im Workflow angewandt werden.

Abbildung 12: Links: Ausschnitt der XML-Datei, wo der Variable der Typ Slider_Integer zugewiesen wurde; Rechts: Dialog der selbsterstellten Korrektur im Workflow

Um ein Eingabefeld durch ein Integer im XML zu definieren, gehen Sie wie folgt vor:

  1. Erstellen Sie zuerst den Grundaufbau der XML-Datei. Wie dieser aussehen muss, lesen Sie im Artikel Korrekturen ohne Parameter erstellen.
  2. Bauen Sie im Element <fixup></fixup> die untergeordnete Elemente <variables></variables> und darin das Element <variable></variable> ein. Wie die Struktur auszusehen hat, sehen Sie in Abbildung 12.
  3. Vergeben Sie für das Element <variable></variable> noch die Attribute. Folgende Attribute sollten für einen String vergeben werden:
    • name [43] – hier muss der Key [1] (Abbildung 1) der Variable, die in der pdfToolBox definiert wurde eingegeben werden.
    • type [42] – weisen Sie hier Typen SLIDER_INTEGER zu, um einen Schieberegler zu erzeugen.
    • defaultValue [45] –  geben Sie hier jenen Wert ein, der standardmäßig im Eingabefeld angezeigt werden soll. Dieses Attribut ist nicht verpflichtend, sollte aber dennoch verwendet werden.
    • modelUnit [46] – geben Sie hier die Maßeinheit ein, die für die Verrechnung standardmäßig benötigt wird. In diesem Fall handelt es sich um Prozent.
    • viewUnit [47] – geben Sie hier die Maßeinheit ein, die im Dialog für diesen Wert angezeigt werden soll. Sollte sich dieser von der modelUnit unterscheiden, wird er intern umgerechnet. Ein typisch Beispiels dafür wäre die Umrechnung von mm in inch.
    • displayVariable [48] – geben Sie hier den Wert »true« ein, damit die Variable später im Dialog auch angezeigt wird.
    • description [44] – gebe hier den Name für den Schieberegler ein, damit der Anwender weiß, wofür der Schieberegler gedacht ist. Dieser Name kann in alle Sprachen, die im Workflow angeboten werden, übersetzt werden. Die englische Übersetzung ist verpflichtend. Nur wenn diese vorhanden ist, funktioniert die Korrektur. Wird eine Sprache nicht übersetzt, wird die englische Übersetzung angezeigt.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »CREATE_WHITE_SEPARATION_SLIDER_MANUAL.xml« zum Herunterladen bereit. Darin ist die Variable als Typ SLIDER_INTEGER definiert.

3.8. Korrektur mit Farbwerten (Color Picker) erstellen

Um eine Farbauswahl mithilfe eines Color Pickers zu erzeugen, um damit die gewünschten CMYK-Werte selbst zu definieren, muss der Typ Color_Picker verwendet werden. So kann der Anwender beispielsweise die CMYK-Werte für einen Text selbst eingeben und damit die gewünschte Farbe erzielen.

3.8.1. Color Picker (Farbauswahl) im KFPX

In der pdfToolBox muss für jeden Farbkanal – also Cyan, Magenta, Yellow und Black – eine eigene Variable erstellt werden. Der erste Teil des Keys müssen dabei immer gleich sein. So werden aus vier Variablen ein Color Picker. In Abbildung 13 sehen Sie ein praktischen Beispiel dafür.

Abbildung 13: Dialog der pdfToolBox, wo die Variablen für CMYK definiert wurden

Zur Veranschaulichung stellen wir die Korrektur »PLACE_TEXT_COLOR_PICKER_MANUAL.kfpx« zur Verfügung. Die benutzerdefinierte Korrektur PLACE_TEXT_STRING_MANUAL beinhaltet

  • die Variable SAMPLE_Color_Picker_CYAN für Cyan,
  • die Variable SAMPLE_Color_Picker_MAGENTA für Magenta,
  • die Variable SAMPLE_Color_Picker_YELLOW für Gelb,
  • die Variable SAMPLE_Color_Picker_BLACK für Schwarz mit
  • dem Wertetypen Float

Ziel der Korrektur ist, einen definierten Text mittig im Medienrahmen (MediaBox) des Motivs zu platzieren. Der Text hat eine Größe von 12 pt. Mithilfe der Farbauswahl kann der Anwender selbst bestimmen, welchen CMYK-Wert der vordefinierte Text haben soll.

3.8.2. Color Picker (Farbauswahl) im XML

Sobald die KFPX-Datei exportiert wurde, muss noch die XML-Datei dazu erstellt werden und darin der zuvor definierten Variable SAMPLE_Color_Picker der Typ Color_Picker zugewiesen werden. Nur wenn die KFPX- und XML-Datei übereinstimmen, kann die Korrektur im Workflow angewandt werden.

Abbildung 13: Rechts: Ausschnitt der XML-Datei, wo der Variable der Typ Color_Picker zugewiesen wurde, Links: Dialog der Korrektur im Workflow

Um eine Farbauswahl durch einen Color Picker im XML zu definieren, gehen Sie wie folgt vor:

  1. Erstellen Sie zuerst den Grundaufbau der XML-Datei. Wie dieser aussehen muss, lesen Sie im Artikel Korrekturen ohne Parameter erstellen.
  2. Bauen Sie im Element <fixup></fixup> die untergeordnete Elemente <variables></variables> und darin das Element <variable></variable> ein. Wie die Struktur auszusehen hat, sehen Sie in Abbildung 13.
  3. Vergeben Sie für das Element <variable></variable> noch die Attribute. Folgende Attribute sollten für einen Color Picker vergeben werden:
    • name [50] – hier muss der Key [1] (Abbildung 1) der Variablen, die in der pdfToolBox definiert wurde eingegeben werden. In diesem Fall wird der Teil des Keys verwendet, der sich bei allen vier definierten Variablen überschneidet.
    • type [49] – weisen Sie hier Typen Color_Picker zu, um ein Farbauswahl zu erzeugen.
    • defaultValue [52] –  geben Sie hier den Wert ein, der standardmäßig ausgewählt werden soll. Mithilfe von Sonderzeichen im XML wird hier definiert, welcher Farbraum und welche Werte eingegeben werden müssen.
    • displayVariable [53] – geben Sie hier den Wert  true ein, damit die Variable später im Dialog auch angezeigt wird.
    • description [51] – für eine Farbauswahl (Color Picker) braucht man grundsätzlich keine Beschreibung. Für die interne Verwaltung wird trotzdem eine Beschreibung vergeben, die im Workflow allerdings nicht angezeigt wird. Dieser Beschreibung muss vorhanden sein, damit die Korrektur funktionieren kann.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT_COLOR_PICKER_MANUAL.xml« zum Herunterladen bereit. Darin ist die Variable als Typ COLOR_PICKER definiert.

3.9. Korrektur mit verschieden Typen kombinieren

In den meisten Fällen reicht es nicht aus, nur eine Variable zu erstellt, den Typen zuweisen und mit der Korrektur zu arbeiten. Vor allem, wenn es um das automatisierte Korrigieren geht, müssen vom Anwender mehrere Optionen parametiert werden können. Die zuvor beschriebenen Typen können in einer Korrektur kombiniert werden. Es erklärt sich von selbst, dass dafür auch die jeweiligen Typen in der pdfToolBox definiert werden müssen.

Zur Veranschaulichung stellen wir die Korrektur »PLACE_TEXT.kfpx« zur Verfügung. Die benutzerdefinierte Korrektur PLACE_TEXT beinhaltet:

  • alle Variablen, die zuvor beschrieben worden sind und
  • alle Typen, die zuvor beschrieben worden sind.

Sobald die KFPX-Datei exportiert wurde, muss noch die XML-Datei dazu erstellt werden und darin der zuvor definierten Variablen der jeweiligen Typ zugewiesen werden. Nur wenn die KFPX- und XML-Datei übereinstimmen, kann die Korrektur im Workflow angewandt werden.

Zur Veranschaulichung stellen wir die dazu passende XML-Datei »PLACE_TEXT.xml« zum Herunterladen bereit. Darin sind alle zuvor beschriebenen Typen enthalten.

Abbildung 14: Dialog der benutzerdefinierten Korrektur, mit mehreren Variablen und verschiedenen Typen

Reihenfolge der Variablen

Die Variablen werden im Dialog in jener Reihenfolge angezeigt, wie Sie im XML auch beschrieben wurde. Wird daher zuerst die Variable SAMPLE_String und anschließend die Variable SAMPLE_Slider beschrieben, wird im Dialog im Workflow zuerst die Variable SAMPLE_String und danach die Variable SAMPLE_Slider abgebildet.

Artikel Update: Workflow 1.18.0 – 09/2024

Previous Artikel 5.1 Korrektur ohne Variable erstellen
Next Artikel 5.3 Korrektur hochladen und anwenden
Noch Fragen? Kontaktieren Sie uns!