MyQ X Server
10.3 10.2 8.2 EoL Print Server Central Server English French German Italian Portuguese Spanish
10.3 10.2 8.2 EoL Print Server Central Server English French German Italian Portuguese Spanish

Skripting für Benutzerinteraktionen

Ein Benutzerinteraktionsskript ermöglicht es, eine Interaktion mit dem Auftragseigentümer zu programmieren und den Druckauftrag basierend auf der Antwort des Benutzers anzupassen. Konkret ermöglicht es die Anzeige einer Reihe von UI-Dialogfeldern mit Fragen und Aktionsschaltflächen (JA/NEIN, DRUCKEN/NEIN, JA/NEIN/ABBRECHEN). Je nach Auswahl des Benutzers können weitere Dialogfelder angezeigt und Aktionen ausgeführt werden. Sobald der letzte Dialogfeld verarbeitet wurde, ist das Skript beendet und der Druckauftrag wird auf ready und kann freigegeben werden.

Ist ein Benutzerinteraktionsskript vorhanden, muss es zunächst erfolgreich ausgeführt werden, bevor der Druckauftrag freigegeben werden kann. Bis dahin bleibt der Druckauftrag zwangsweise im pause Zustand versetzt.

Es können grundlegende PHP-Funktionen sowie fast alle in der Referenz zu Druckaufträgen beschriebenen Funktionen verwendet werden. Die einzigen beiden Methoden, die von dieser Funktion nicht unterstützt werden, sind $this->job->setPrinted() und $this->job->pause(). Neben den gängigen Klassen, Methoden und Eigenschaften können Sie mehrere zusätzliche Funktionen nutzen, um mit der MyQ Desktop Client-Anwendung zu kommunizieren.

So schreiben Sie ein Benutzerinteraktionsskript

Fügen Sie auf der Registerkarte „MyQ Desktop Client“ einer Warteschlange im Abschnitt Benutzerinteraktion das Skript in das Feld ein und klicken Sie auf Speichern.

Zunächst müssen Sie die main(). Diese Funktion legt fest, ob das Dialogfeld geöffnet werden soll (unter welchen Bedingungen) und welches Dialogfeld angezeigt werden soll.

Anschließend können Sie Klickfunktionen definieren, die auf die ausgewählte Option reagieren: onYes(), onNo(), onPrint(), onCancel().

Öffentliche Eigenschaften bleiben zwischen den Aufrufen erhalten. Tatsächlich werden sie an den Client gesendet und wieder zurück.

Skriptstruktur

Siehe das folgende Skript:

PHP
public $hasMoreThan10pages;
 
// script entry point
function main() {
    /** Job object */
    $job = $this->job;
    $this->hasMoreThan10pages = $job->pageCount > 10;
    // Show dialog if the job has more than 10 pages
    if ($this->hasMoreThan10pages === true) {
        $this->dialogYesNo("Job has more than 10 pages. Do you want to print in duplex?");
    }
}
 
// If yes clicked
function onYes() {
    // $this->hasMoreThan10pages is available also here
    $this->job->duplex = 'longEdge';
}
 
// If no clicked
function onNo() {
    // nothing. Job will be released.
}


Mit dem obigen Skript wird dieser Dialog im MyQ Desktop Client angezeigt:

Desktop Client script interaction dialog asking whether to print a job with more than 10 pages in duplex

Wenn Sie mit der Programmiersprache PHP vertraut sind: Das Skript entspricht dem Hauptteil einer class UserScript {...} Anweisung.

Sie können Eigenschaften wie $hasMoreThan10pages. Eigenschaften bleiben über mehrere Skriptaufrufe für denselben Druckauftrag hinweg erhalten. Verwenden Sie sie, um einen Zustand zwischen mehreren Dialogen zu speichern.

Es gibt die main Funktion. Sie wird einmal beim Start des Skripts aufgerufen. Verwenden Sie sie, um den ersten Dialog anzuzeigen.

Dann gibt es die onXXX Funktionen. Dabei handelt es sich um Aktionshandler, die aufgerufen werden, wenn eine XXX Schaltfläche gedrückt wird. Beispielsweise wird die Yes Schaltfläche wird über die onYes Funktion.

Wenn Sie keinen Dialog anzeigen, ist das Skript beendet.


API-Referenz

Informationen zum Anpassen der Druckaufträge sowie zu vielen weiteren möglichen Vorgängen finden Sie in der Referenz zu Druckaufträgen.

Das Benutzerinteraktionsskript wird im Kontext der Klasse „User“ ausgeführt. Auf den gesendeten Druckauftrag kann als $this->job.

Auf Objekte aller Klassen – mit Ausnahme der „Session“-Klasse – kann über das Job-Objekt zugegriffen werden, zum Beispiel auf die owner $this->job->owner. Auf Objekte der Klasse „Session“ kann über die MyQ() globale Funktion; zum Beispiel: MyQ()->logInfo("This message appears in the MyQ log.");.

UserScript-Klasse

Das Benutzerinteraktionsskript bildet den Hauptteil der UserScript Klasse, wie oben beschrieben. MyQ stellt zusätzlich zu Ihren eigenen Methoden auch mehrere integrierte Methoden der User-Klasse zur Verfügung.

Methoden zur Erstellung von Dialogen

Funktion

Beschreibung

void dialogYesNo(string $text)

Erstellt ein Dialogfeld mit dem $text als Inhalt und den Schaltflächen „Ja“ und „Nein“.

void dialogPrintNo(string $text)

Erstellt ein Dialogfeld mit dem $text als Inhalt und den Schaltflächen „Drucken“ und „Nein“.

void dialogYesNoCancel(string $text)

Erstellt ein Dialogfeld mit dem $text als Inhalt und den Schaltflächen „Ja“, „Nein“ und „Abbrechen“.

void dialog(string $text, Field[] $fields)

Erstellt ein Dialogfeld mit dem $text als Inhalt und einem Array benutzerdefinierter Felder. Ein Feld kann eine Schaltfläche oder ein beliebiger anderer Feldtyp sein, wie zum Beispiel eine Liste. Schaltflächen werden immer unterhalb anderer Felder angezeigt.

FieldButton button(string $title, string $id)

Erstellt eine benutzerdefinierte Schaltfläche, die in der dialog() Funktion verwendet werden kann. $title ist der Text, der auf der Schaltfläche angezeigt wird. Die Schaltfläche $id wird bei der Ausführung des Schaltflächen-Handlers verwendet. MyQ sucht nach einem onXXX Handler, bei dem XXX ist die $id. 

FieldList singleSelectList(string $name, array $items)

Erstellt eine Liste von Optionen, aus der der Benutzer nur eine auswählen kann (Radio-Gruppe). Sie kann in der dialog() Funktion verwendet werden. Das $items ist ein assoziatives Array, bei dem der Schlüssel die Referenz eines Elements und der Wert der in der Benutzeroberfläche sichtbare Anzeigename des Elements ist.

FieldMultiSelectList multiSelectList(string $name, array $items)

Erstellt eine Liste mit Optionen, aus der der Benutzer mehrere auswählen kann (Kontrollkästchen). Sie kann in der dialog() Funktion verwendet werden. Das $items ist ein assoziatives Array, bei dem der Schlüssel die Referenz eines Elements und der Wert der in der Benutzeroberfläche sichtbare Anzeigename des Elements ist.

onCancel-Methode

onCancel bearbeitet die „Abbrechen“-Schaltfläche und wird standardmäßig bereitgestellt. Sie ruft terminate(). Sie können eine eigene Implementierung bereitstellen, um das Verhalten zu ändern.

Weitere Methoden

Funktion

Beschreibung

void terminate()

Beendet die Skriptverarbeitung. Das Skript wurde nicht erfolgreich ausgeführt und der Druckauftrag verbleibt im pause Status. Der Benutzer muss das Skript erneut ausführen.

mixed getField(string $name)

Ruft den Wert des Feldes mit dem $name , nachdem der Benutzer mit dem Dialog interagiert hat. Das Feld muss mit den Methoden singleSelectList (das Ergebnis ist ein Skalarwert) oder multiSelectList (das Ergebnis ist ein Array von Werten, das auch ein leeres Array sein kann).