Quick Check als Schritt in einem Prozessplan nutzen
Wenn man eine Prozessplan erstellt oder editiert, kann man einen Quick Check-Schritt im Prozessplan einfügen.
Zur Veranschaulichung wird ein neuer Prozessplan erstellt:
Wählen Sie „Quick Check“ aus der „Sequenz“-Liste rechts und ziehen diesen Schritt auf die Fläche für den Prozessplan. Im Feld oben links können Sie einen passenden Namen für den neuen Prozessplan eingeben:
Löschen Sie die voreingestellten Verbindungstyp zwischen „Start“ und „Ende“ (gestrichelte Linie) und verbinden Sie „Start“ mit „Quick Check“ und Quick Check wiederum mit „Ende“.
Der Quick Check-Schritt wird als Element in den Prozessplan eingefügt.
- Um einzurichten, was der Quick Check-Schritt als Ergebnis beitragen soll, wird entweder eine passende Quick Check-JavaScript-Variable aus dem Aufklappmenü „Name“ gewählt,
- oder eine neue Quick Check-JavaScript-Variable über das „+“-Symbol erstellt.
Wenn eine neue Quick Check-JavaScript-Variable erstellt wird, öffnet sich das Fenster „Quick Check editieren“.
Passende Werte müssen für „Key“ eingegeben werden (damit kann die Variable im app.vars
Objekt referenziert werden), sowie die „Bezeichnung“ (für die spätere Anzeige in der Bedienoberfläche, wenn die Referenz für die Variable angezeigt wird) und schließlich das tatsächliche „Script“.
Im unten gezeigten Beispiel wird eine sehr einfache Konfiguration genutzt, die anstößt, dass die TrimBox aller Seiten zurückgegeben wird.
Klicken Sie „OK“, um die Quick Check-JavaScript-Variable zu sichern sowie nochmals „OK“, um den neuen Prozessplan zu sichern.
Immer, wenn dieser Prozessplan ausgeführt wird, wird die TrimBox aller Seiten im app.vars
Objekt unter my_quick_check_example
abgelegt.
Diese einfache Form eines Prozessplans ist natürlich nicht besonders nützlich. Der nächste Abschnitt dieses Artikels zeigt eine leicht erweitere Variante dieses Prozessplans, der tatsächlich einen interessanten Nutzen aus den abgerufenen Informationen des Quick Check-Schritts zieht.
Wie man Informationen aus einer Quick Check-Abfrage in einem Prozessplan nutzt
Um den nachfolgenden Prozessplan auszuprobieren, können Sie ihn hier herunterladen:
Nachdem Sie die heruntergeladene Datei „Quick_Check_example.kfpx“ in pdfToolbox Desktop importiert haben, sollte folgendes zu sehen sein:
Um zu untersuchen, wie dieser Prozessplan aufgebaut ist, klicken Sie auf die „Bearbeiten…“-Schaltfläche neben dem Eintrag „Quick Check example“.
Es öffnet sich der Dialog „Prozessplan bearbeiten“. Dieser umfasst zwei Schritte:
1. Einen Quick Check-Schritt, der eine Variable namens „quick_check_sample_JavaScript_variable“ nutzt, welche Informationen aus dem aktuellen PDF einsammelt.
2. Einen Korrekturen-Schritt „Put file name + file path on upper left of all pages“, der die gesammelten Informationen aufnimmt und diese dazu verwendet, Text auf jeder Seite des aktuellen PDFS zu platzieren.
Um zu sehen, wie die JavaScript-Variable zusammengesetzt ist,
3. klicken Sie auf die Schaltfläche mit dem Stiftsymbol.
Das Fenster „Variable editieren“ öffnet sich und zeigt die Einrichtung der Variable „quick_check_sample_JavaScript_variable“.
Der relevante Teil der Konfiguration sind diese beiden Zeilen:
"$.aggregated.file.name: true ",
"$.aggregated.file.filepath: true ",
welche anfordern, dass Quick Check Informationen über den Dateinamen und den Dateipfad des aktuellen PDFs abruft. Für eine detaillierte Beschreibung der Konfigurationseinrichtung lesen Sie bitte den Artikel „Quick Check Konfigurationssyntax“.
Schließen Sie das Fenster „Variable bearbeiten“ und gehen Sie zurück zum Fenster für den Prozessplan.
- Klicken Sie auf das Bearbeiten-Symbol (Stift).
Es öffnet sich das Fenster „Korrektur bearbeiten“ für die Korrektur „Put file path + name on upper left of all pages“.
In den zahlreichen Felder dieser Korrektur stehen Werte, die dafür sorgen, dass die Inhalte des Feldes „Text“ oben links auf allen Seiten in der Schrift Courier und in einer Schmuckfarbe Pink platziert werden.
Der interessantere Teil dieser Korrektur (jedenfalls in diesem Kontext) ist, wie die Inhalte von „Text“ definiert werden.
- Klicken Sie auf das orangefarbene Dreieck-Popup rechts neben dem Feld „Text“.
Nun wird eine Liste mit bereits definierten Variablen angezeigt, plus zahlreicher Optionen für bestehenden oder neue Variablen.
- Klicken Sie auf ‚Edit "place_filepath_text (JS)"...‘
Es öffnet sich das Fenster „Variable bearbeiten“ für die Variable „place_filepath_text“.
Wichtig: Dies ist nicht dieselbe Variable wie die JavaScript-Variable, die im Quick Check-Schritt definiert ist (die diesen Quick Check-Schritt konfiguriert). Es ist eher eine separate JavaScript-Variable, welche die Informationen nutzt, die mit diesem Quick Check-Schritt abgefragt werden.
Diese Informationen sind nur dann verfügbar, wenn die Korrektur als Teil eines Prozessplans ausgeführt wird, wo in einem vorangegangenen Schritt ein passender Quick Check-Schritt ausgeführt wurde.
Für den Fall, dass die Korrektur nur auf sich selbst oder in einem abweichenden Prozessplan ausgeführt wird, wurden Vorkehrungen getroffen: Der JavaScript-Code gibt die Fehlmeldung „filename @ filepath: WARNING: required variables undefined“ zurück.
Dies wird von der folgenden if
Branch des JavaScript-Codes bewerkstelligt:
if (
typeof app.vars.my_quickcheck_example == 'undefined' ||
typeof app.vars.my_quickcheck_example.aggregated == 'undefined' ||
typeof app.vars.my_quickcheck_example.aggregated.file == 'undefined' ||
typeof app.vars.my_quickcheck_example.aggregated.file.filepath == 'undefined' ||
typeof app.vars.my_quickcheck_example.aggregated.file.name == 'undefined'
)
{
var myvar = "filename @ filepath: WARNING: required variables undefined";
}
Der beabsichtigte, hauptsächliche Teil der JavaScript-Variable ist im else
Branch enthalten:
else {
var myvar = "filename: «"
+ app.vars.my_quickcheck_example.aggregated.file.name
+ "»<br/>filepath: «"
+ app.vars.my_quickcheck_example.aggregated.file.filepath
+ "»" ;
}
Dieser else
Branch erstellt einen String, der über zwei Variablen app.vars.my_quickcheck_example.aggregated.file.name
und app.vars.my_quickcheck_example.aggregated.file.filepath
aufgebaut wird, verknüpft mit anderen Textschnipseln in einen wohlformatierten String.
Nachdem dieses Fenster „Variable bearbeiten“ sowie das Fenster „Korrektur bearbeiten“ geschlossen wurde, wird erneut das Fenster „Prozessplan bearbeiten“ eingeblendet. Anstatt nun auch diese Fenster zu schließen und den Prozessplan an einem vorliegenden Dokument auszuprobieren,
- verwenden Sie die „Test“-Funktion, indem Sie auf die Schaltfläche „Test“ klicken
Dies öffnet das Fenster „Profil testen“ – eine sehr komfortable Umgebung, mit der sich Prozesspläne (oder Profile, Korrekturen oder Prüfungen) auf eine Kopie des aktuell geöffneten PDF-Dokuments ausprobieren lassen. Das Ganze ohne das Risiko, unbeabsichtigt Dateien zu verlieren (eine „Test“-Verarbeitung wird immer auf temporären Kopien Ihrer Dateien ausgeführt) und ohne die lästigen Öffnen/Bearbeiten/Schließen/Anwenden-Routinen und ohne jegliche Anforderung, anschließend die Kopien der verarbeiteten Dateien aufräumen zu müssen.
Wie Sie im Screenshot sehen können, wird ein Text oben links in der hier verwendeten Beispieldatei eingeblendet (Ein leeres PDF in A4-Größe, was auch dementsprechend benannt wurde).