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

Scripts d’interaction utilisateur

Un script d’interaction utilisateur permet de programmer une interaction avec le propriétaire du travail et de modifier celui-ci en fonction de la réponse de l’utilisateur. Plus précisément, il permet d’afficher une série de boîtes de dialogue comportant des questions et des boutons d’action (OUI/NON, IMPRIMER/NON, OUI/NON/ANNULER). En fonction du choix de l’utilisateur, d’autres boîtes de dialogue peuvent s’afficher et des actions peuvent être effectuées. Enfin, lorsque la dernière boîte de dialogue a été traitée, le script s’achève et le travail est défini comme ready et peut être validé.

Si un script d’interaction utilisateur est présent, il doit d’abord être exécuté avec succès avant que le travail puisse être lancé. Jusqu’à ce moment-là, le travail est maintenu de force à l’ pause jusqu’à ce moment-là.

Les fonctions PHP de base peuvent être utilisées, ainsi que la quasi-totalité de celles décrites dans le Guide de référence sur les scripts de tâches. Les deux seules méthodes non prises en charge par cette fonctionnalité sont $this->job->setPrinted() et $this->job->pause(). Outre les classes, méthodes et propriétés courantes, vous pouvez utiliser plusieurs fonctions supplémentaires pour communiquer avec l’application Client MyQ Desktop.

Comment rédiger un script d’interaction utilisateur

Dans l’onglet « Client MyQ Desktop » d’une file d’attente, dans la section Interaction utilisateur, ajoutez le script dans le champ prévu à cet effet, puis cliquez sur Enregistrer.

Vous devez d’abord définir la main(). Cette fonction détermine si la boîte de dialogue doit s’ouvrir (dans quelles conditions) et quelle boîte de dialogue doit s’afficher.

Vous pouvez ensuite définir des fonctions de clic avec des réactions à l’option sélectionnée : onYes(), onNo(), onPrint(), onCancel().

Les propriétés publiques sont conservées d'un appel à l'autre. En effet, elles sont envoyées au client puis renvoyées.

Structure du script

Consultez le script suivant :

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.
}


À l’aide du script ci-dessus, cette boîte de dialogue s’affiche dans le Client MyQ Desktop :

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

Si vous connaissez le langage PHP, ce script correspond en réalité au corps de l'instruction class UserScript {...} instruction.

Vous pouvez définir des propriétés telles que $hasMoreThan10pages. Les propriétés sont conservées d’un appel de script à l’autre pour un même travail. Utilisez-les pour stocker un état entre plusieurs boîtes de dialogue.

Il existe la main . Elle est appelée une seule fois au démarrage du script. Utilisez-la pour afficher la première boîte de dialogue.

Il y a ensuite les onXXX fonctions. Il s’agit des gestionnaires d’action appelés lorsqu’un XXX bouton est actionné. Par exemple, le Yes bouton est géré par la onYes fonction.

Si aucune boîte de dialogue n’est affichée, le script est terminé.


Référence de l'API

Consultez la référence sur les scripts de travail pour savoir comment modifier le travail et découvrir les nombreuses autres opérations que vous pouvez effectuer.

Le script d’interaction utilisateur s’exécute dans le contexte de la classe User. Le travail envoyé est accessible en tant que $this->job.

Les objets de toutes les classes, à l’exception de la classe « Session », sont accessibles via l’objet de travail, par exemple la classe owner $this->job->owner. Les objets de la classe Session sont accessibles via la MyQ() fonction globale ; par exemple : MyQ()->logInfo("This message appears in the MyQ log.");.

Classe UserScript

Le script d’interaction utilisateur constitue le corps de la UserScript classe, comme décrit ci-dessus. MyQ fournit également plusieurs méthodes embarquées de la classe User, en plus de vos propres méthodes.

Méthodes de création de boîtes de dialogue

Fonction

Description

void dialogYesNo(string $text)

Crée une boîte de dialogue avec le $text comme contenu et des boutons « Oui » et « Non ».

void dialogPrintNo(string $text)

Crée une boîte de dialogue dont le $text comme contenu et les boutons « Imprimer » et « Non ».

void dialogYesNoCancel(string $text)

Crée une boîte de dialogue dont le $text comme contenu et les boutons « Oui », « Non » et « Annuler ».

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

Crée une boîte de dialogue dont le $text comme contenu et d’un tableau de champs personnalisés. Un champ peut être un bouton ou tout autre type de champ, comme une liste, par exemple. Les boutons s’affichent toujours en dessous des autres champs.

FieldButton button(string $title, string $id)

Crée un bouton personnalisé pouvant être utilisé dans la dialog() fonction. $title est le texte affiché sur le bouton. Le bouton $id est utilisé lors de l’exécution du gestionnaire de bouton. MyQ recherche un onXXX gestionnaire où XXX est la $id. 

FieldList singleSelectList(string $name, array $items)

Crée une liste d’options parmi lesquelles l’utilisateur ne peut en choisir qu’une seule (groupe de boutons radio). Elle peut être utilisée dans la dialog() fonction. Le $items est un tableau associatif où la clé est la référence d’un élément et la valeur est le nom d’affichage de cet élément visible dans l’interface utilisateur.

FieldMultiSelectList multiSelectList(string $name, array $items)

Crée une liste d’options parmi lesquelles l’utilisateur peut en sélectionner plusieurs (cases à cocher). Elle peut être utilisée dans la dialog() fonction. Le $items est un tableau associatif où la clé correspond à la référence d’un élément et la valeur au nom d’affichage de cet élément visible dans l’interface utilisateur.

Méthode onCancel

onCancel gère le bouton « Annuler » et est fournie par défaut. Elle appelle terminate(). Vous pouvez fournir votre propre implémentation pour modifier le comportement.

Autres méthodes

Fonction

Description

void terminate()

Mette fin au traitement du script. Le script n’a pas été exécuté avec succès et le travail reste à l’ pause . L'utilisateur doit réexécuter le script.

mixed getField(string $name)

Récupère la valeur du champ portant le $name après que l’utilisateur a interagi avec la boîte de dialogue. Le champ doit avoir été créé par les méthodes singleSelectList (le résultat est une valeur scalaire) ou multiSelectList (le résultat est un tableau de valeurs, qui peut être un tableau vide).