Les principaux menus d'administration

==Introduction==

[[Fichier:OX S admin connect.png|centré|sans_cadre|733x733px]]

Ce menu de la page d’accueil donne accès :

• à l’ensemble du paramétrage de la solution, 

• à la création et l’administration des points d’entrée dans Onyx Server (robots Scanfolder, serveur d’écoute, files d’attente de traitements), 

• à des règles d’exécution et de routage (Workflows), des points de sorties et de diffusion des documents.

Les principaux écrans sont abordés dans cette première partie, les autres menus d’administration sont traités dans des parties spécifiques.


[[Fichier:OX S Menu AdminCnct.png|centré|sans_cadre|739x739px]]

==Gestion de la configuration==



[[Fichier:OX S gestConf.png|centré|sans_cadre|857x857px]]



Cette interface présente l’ensemble des paramètres d’environnement qui décrivent la solution, depuis son installation jusqu’à sa configuration générale. La plupart des valeurs sont données à titre informatif et ne doivent être modifiées qu’avec précaution par un utilisateur avancé ou un administrateur de la solution.
L’information est organisée en différentes sections, chacune identifiant les contextes d’influence des paramètres.

[[Fichier:OX S edt Conf.png|centré|sans_cadre|712x712px]]


Les sections sont affichées en mode condensé par défaut, pour ouvrir une section et visualiser les paramètres correspondants, il faut alors cliquer sur l’icône "plus" . Pour chaque paramètre, une zone de saisie permet d’en modifier la valeur, en cliquant sur "enregistrer" pour sauvegarder. Il est également possible d’effectuer plusieurs modifications en une seule fois, chaque paramètre modifié apparaissant en rouge jusqu’à validation.

L’ensemble des paramètres présentés dans ces différentes sections sont des paramètres d’environnement d'Onyx Server. Ils sont utilisables en tant que tel dans le moteur d’exécution (Workflows), ainsi que dans les scripts utilisateurs lancés depuis le moteur.

Exemple : utilisation du paramètre <code>PATH_TEMP</code> pour la construction d’un chemin de fichier temporaire

La section Custom est disponible en bas de page pour créer de nouveau paramètres si besoin, qui seront eux aussi utilisables dans le moteur.


Pour créer un nouveau paramètre :

- Donner un nom au paramètre : caractères alphanumériques sans espace, sensibles à la casse (les crochets encadrants ne sont pas requis, ils ne sont rajoutés que pour l’affichage),

- Préciser une valeur,

- Sauvegarder.

La majeure partie des différentes sections sera détaillée au travers de ce Guide, dans les contextes d’utilisation correspondants.

==Gestion des Robots==

[[Fichier:OX S GestionRBT.png|centré|sans_cadre|824x824px]]


Cette interface permet d’administrer l’ensemble des robots configurés dans la solution, de type Scanfolder ou Serveur d’écoute. 

La liste est vierge sur une première installation mais donne accès aux écrans de création / modification de nouveaux points d’entrée dans ONYX Server :


[[Fichier:OX S gestRBT1.png|centré|sans_cadre|590x590px]]


Un robot, du point de vue ONYX Server, est un point d’entrée dans la solution c’est-à-dire un moyen pour une application tierce d’envoyer une requête d’exécution. Les robots sont des programmes exécutés en tâche de fond (en mode Service sous Windows) pour scruter l’arrivée de données, dans un répertoire pour les robots Scanfolder, sur un port réseau pour les Serveurs d’écoute. Chaque fichier reçu est soumis séquentiellement au moteur d’exécution de Workflows, afin d’effectuer le traitement adéquat.


===Robots scanfolder===


====Introduction====

*Un robot de type <FONT color="blue">Scanfolder</FONT> scrute un répertoire du système de fichiers, en attente de dépôts de fichiers (par copies ou transferts FTP/SFTP). Les fichiers détectés dans le répertoire sont envoyés séquentiellement (les uns après les autres) au moteur d’exécution pour être traités, suivant les règles définies dans les Workflows.

*Un robot configuré dans ONYX Server ne peut scruter qu’un seul et unique répertoire, de même qu’un répertoire du système de fichiers ne peut être scruté que par un seul et unique robot Scanfolder. Autant de robots Scanfolder qu’il y a de répertoires différents à scruter devront donc être créés et configurés. Chaque robot sera indépendant des autres ce qui sous-entend que plusieurs fichiers pourront ainsi être traités en parallèle par des robots différents.


====Création/Modification/Suppression====

Grâce à l’icône [[Fichier:Ox s icone edtRBT.png|frameless|120px]] , il est possible de créer ou modifier des robots déjà configurés (s’il n’est pas en cours d’exécution). 
 
Les paramètres à renseigner pour configurer un robot sont :

Nom = permet de donner un nom au robot.

*Ce paramètre est facultatif mais vivement conseillé. Le nom de chaque robot est une variable d’environnement qui sera accessible et pourra donc être utilisée dans les Workflows.
*ONYX Server contrôle l’unicité des noms utilisés pour les différents robots.


Répertoire à scanner = le chemin complet du répertoire scruté par le robot.

*Ce paramètre est requis.
*Il peut pointer sur un lecteur réseau ou un chemin UNC (sous Windows) pour lequel il faudra faire attention aux droits d’accès.
*ONYX Server contrôle l’unicité des répertoires scrutés par les différents robots.
*ONYX Server peut créer le répertoire renseigné si celui-ci n’existe pas.


CMD = action exécutée sur chaque fichier détecté après qu’il ait été traité correctement par le moteur d’exécution.

*Ce paramètre est requis.
*Supprimer : les fichiers détectés et traités seront supprimés du répertoire scruté.
*Déplacer : les fichiers détectés et traités seront déplacés dans un autre répertoire, pour historique par exemple.


Répertoire de Destination = chemin de destination des fichiers traités.

*Ce paramètre est requis si la commande de déplacement a été choisie précédemment.
*ONYX Server contrôle que le répertoire de destination est bien différent du répertoire scruté.
*ONYX Server peut créer le répertoire renseigné si celui-ci n’existe pas.


Temporisation = intervalle d’attente entre deux scrutations de répertoire. Il est exprimé en secondes.

*Ce paramètre est requis.


On Error = définit le comportement du robot lorsqu’une erreur de traitement est remontée sur un fichier détecté.

*Ce paramètre est requis.
*Stop : le robot s’arrête et le fichier en erreur reste dans le répertoire scruté.
*Continue : le robot continue de traiter les fichiers suivants alors que le fichier en erreur reste dans le répertoire scruté et il sera renommé avec le suffixe _FAILED (mot clé parametré par Mapping évitant que le robot ne traite à nouveau ce fichier à la prochaine scrutation du répertoire).
*Retry : le robot continue de traiter les fichiers suivants et le fichier en erreur reste dans le répertoire scruté. A la prochaine scrutation, le robot réessaiera de traiter à nouveau ce fichier.


Workflow = nom du Workflow à exécuter.

*Ce paramètre est optionnel. S’il n’est pas renseigné, c’est le Workflow root qui sera exécuté par défaut.


Filter = permet d’exclure des fichiers des scrutations du robot.

*Ce paramètre est optionnel.
*Exemple : *.tmp ->les fichiers d’extension .tmp dans le répertoire scruté ne seront pas traités par le robot.


Accept = permet de restreindre le type de fichiers à traiter.

*Ce paramètre est optionnel.
*Exemple : *.xml ->seuls les fichiers d’extension .xml dans le répertoire scruté seront traités par le robot



<u>Remarques</u>: 

Pour créer un nouveau robot, il faut renseigner l’ensemble des paramètres désirés, puis cliquer sur le bouton "Enregistrer" pour ajouter le robot à la configuration du serveur.

Pour modifier un robot existant, il faut modifier le ou les paramètres désirés, puis cliquer sur le bouton "Enregistrer" pour modifier le robot dans la configuration du serveur.

Pour modifier ou supprimer un robot, celui-ci doit obligatoirement être arrêté.
 


====Paramètres d'environnement:section MAP_SCANFOLDER CONFIG====

Cette partie présente les détails des paramètres d’environnement de la section consacrée aux robots Scanfolder.


[[Fichier:OX S Config scanfolder.png|centré|sans_cadre|743x743px]]



SCANFOLDER_ID = suffixe de nommage par défaut pour les fichiers temporaires liés à chaque robot (voir ci-après dans la partie Exploitation).

MAP_SCANFOLDER_TIMER = intervalle d’attente par défaut (en secondes) proposé à la création d’un nouveau robot.

CONFIG_PATH_ROBOT = chemin du fichier de configuration des robots.

Exemple sous Linux : <code>/apps/mapping/conf/robot.conf</code>

FTP_TIMEOUT_SEC = temps d’attente maximum (en secondes) pour avoir accès à un fichier déposé dans le répertoire scruté en FTP lorsque le paramètre CHECK_FTP_FILE_ACCESS est activé (« oui », « yes », « true » ou « 1 » seront acceptés).

SCANFOLDER_PATH_DUP_FILES = chemin de déplacement des fichiers après traitement lorsque ceux-ci sont détectés comme ayant déjà été traité par Onyx Server c’est-à-dire pour des fichiers portant des noms identiques. 

SCANFOLDER_FILTER = filtre d’exclusion des fichiers à traiter qui est global pour l’ensemble des robots configurés et qui peut être surchargé par les paramètres locaux de chaque robot. Plusieurs fichiers peuvent être renseignés, séparés par un point-virgule « ; ».

SCANFOLDER_ACCEPT = filtre de restriction des fichiers à traiter qui est global pour l’ensemble des robots configurés et qui peut être surchargé par les paramètres locaux de chaque robot. Plusieurs fichiers peuvent être renseignés, séparés par un point-virgule « ; ».


====Exploitation====

Une fois les robots créés et configurés, ils apparaissent alors dans l’écran de gestion.


[[Fichier:OX S gestion RBT.png|centré|sans_cadre|892x892px]]


Cet écran permet de :

-	Démarrer un robot : [[Fichier:OX S strt rbt.png|frameless|120px]]    

-	Arrêter un robot : [[Fichier:OX S stp rbt.png|frameless|120px]]       

-	Consulter les journaux d’événements d’un robot : [[Fichier:OX S infos rbt.png|frameless|120px]]


Une fois démarré, un robot est un processus qui s’exécute en continu en tâche de fond. Le binaire ONYX Server associé est <FONT color="blue">map_scanfolder</FONT>. La liste des processus actifs du système (Gestionnaire de Tâches sous Windows / commande <FONT color="blue">ps –ef</FONT> sous Linux) montrera autant de processus <FONT color="blue">map_scanfolder[.exe]</FONT> qu’il y a de robots démarrés.


<u>Remarque Windows</u> :

Sous Windows, les robots s’installent en tant que Services dans le Gestionnaire de Services Windows. Cet enregistrement se fait au premier démarrage du robot. Le Service correspondant est nommé en se basant sur le nom du robot s’il est renseigné (d’où l’unicité requise de ce paramètre) ou alors sur le répertoire scruté (d’où là encore l’unicité requise). Exemple : Mapping_ScanFolder_SCAN_TXT.
Chaque Service Windows créé par robot est configuré en démarrage manuel par défaut, cela peut être modifié par la suite pour un démarrage automatique avec le système.


*Fichiers temporaires associés aux robots :


Chaque robot, une fois démarré, crée deux fichiers dans le répertoire temporaire d'Onyx Server. Le premier est nommé en se basant sur le nom du répertoire scruté où les caractères spéciaux sont remplacés par des ‘_’ et il aura comme suffixe la valeur du paramètre SCANFOLDER_ID (« map_scanfolder.ID » par défaut).

Exemple : E__InputData_TXT_map_scanfolder.ID

Le deuxième fichier est nommé par le numéro système du processus map_scanfloder[.exe] associé. 

Exemple : 75668.pid.

Ces fichiers sont utiles en interne au processus uniquement et sont supprimés automatiquement à l’arrêt du robot.
En revanche, l’interface Web s’appuie sur la présence de ces fichiers pour indiquer l’état des robots.


*Lignes de commandes utiles :


<u>Pour démarrer un robot nommé</u> :

-	Linux (après chargement de l’environnement) <code> /apps/mapping/bin/map_scanfolder -name:SCAN_TXT</code>

-	Windows <code> C:\Program Files(x86)\M_Processing Server\Applications\map_scanfolder.exe -name:SCAN_TXT</code>


<u>Pour arrêter un robot nommé</u> :

-	Linux (après chargement de l’environnement) <code>/apps/mapping/bin/map_scanfolder -name:SCAN_TXT –stop</code>

-	Windows <code>C:\Program Files(x86)\M_Processing Server\Applications\map_scanfolder.exe -name:SCAN_TXT –stop</code>


Si le robot n’est pas nommé, il conviendra alors de passer chacun des paramètres décrivant le robot en argument des commandes précédentes (d’où le conseil d’unicité quant au nommage des robots).

===Serveurs d'écoute===


====Introduction====

*Un robot de type Serveur d’écoute scrute un port réseau en attente de réception de données (les données sont envoyées par un système distant par transfert direct en protocole RAW). Le robot réceptionne les données et reconstruit localement les fichiers puis les envoie séquentiellement (les uns après les autres) au moteur d’exécution pour être traités suivant les règles définies dans les Workflows.

*Un robot configuré dans ONYX Server ne peut scruter qu’un seul et unique port réseau de même qu’un port réseau ne peut être scruté que par un seul et unique serveur d’écoute. Autant de serveurs d’écoute qu’il y a de ports différents à scruter devront donc être créés et configurés. Chaque robot sera indépendant des autres ce qui sous-entend que plusieurs fichiers pourront ainsi être traités en parallèle par des robots différents.


====Création/Modification/Suppression====

Grâce à l’icône [[Fichier:Ox s icone edtRBT.png|frameless|120px]] , il est possible de créer ou modifier des robots déjà configurés (s’il n’est pas en cours d’exécution).


[[Fichier:OX S SERV Ecoute.png|centré|sans_cadre|999x999px|alt=]]


Les paramètres à renseigner pour configurer un serveur d’écoute sont :

Nom = permet de donner un nom au robot.

*Ce paramètre est facultatif mais vivement conseillé. Le nom de chaque robot est une variable d’environnement qui sera accessible et pourra donc être utilisée dans les Workflows.
*ONYX Server contrôle l’unicité des noms utilisés pour les différents robots.


Port = numéro du port réseau écouté par le robot.

*Ce paramètre est requis.
*ONYX Server contrôle l’unicité des ports écoutés par les différents robots.


Séparateur de travaux = caractère ou chaine de caractères permettant de découper un large flux réseau en plusieurs fichiers.

*Ce paramètre est optionnel.


Clé (Début Longueur) = permet d’ajouter une information au nom du fichier temporaire construit par le robot.

*Ces 3 paramètres sont optionnels.
*L’information est recherchée dans le flux réseau à partir du mot clé en ignorant X caractères après le mot clé (paramètre début) et en extrayant N caractères (paramètre longueur).
*Cette information pourra être utilisée dans les Workflows notamment comme une condition.


Timeout = délai d’attente réseau (en secondes).

*Ce paramètre est optionnel.
*Il permet de ne pas bloquer le port réseau en cas de problème du côté de l’émetteur du flux. Le robot coupe la connexion au bout de ce délai d’inactivité considérant que la connexion établie n’est plus active.


Remarques :

Pour créer un nouveau serveur d’écoute, il faut renseigner l’ensemble des paramètres désirés puis cliquer sur le bouton "Enregistrer" pour l’ajouter à la configuration du serveur.

Pour modifier un serveur existant, il faudra modifier le ou les paramètres désirés puis cliquer sur le bouton "Enregistrer" pour modifier la configuration du serveur.

Pour modifier un serveur, celui-ci doit obligatoirement être arrêté.

Pour supprimer un robot, celui-ci doit obligatoirement être arrêté.


====Paramètres d'environnement:section MAP_RAWD CONFIG====


Dans le Menu d’exploitation Mapping traitant de la gestion de la configuration, une section est consacrée aux Serveurs d’écoute. Le détail des paramètres d’environnement est décrit ci-dessous.


[[Fichier:OX S MAP RAWD.png|centré|sans_cadre|824x824px]]




MAPRAWD_ID = suffixe de nommage par défaut pour les fichiers temporaires liés à chaque serveur (voir ci-après dans la partie Exploitation).

MAPRAWD_CONFIGFILE = chemin du fichier de configuration des serveurs d’écoute.

Exemple sous Unix : /apps/mapping/conf/maprawd.conf

MAPRAWD_SERVERSTDIN = chemin du fichier dans lequel est redirigée l’entrée standard (stdin).

MAPRAWD_SERVERSTDOUT = chemin du fichier dans lequel est redirigée la sortie standard (stdout).

MAPRAWD_SERVERSTDERR = chemin du fichier dans lequel est redirigée la sortie standard des erreurs (stderr).


====Exploitation====
Une fois les robots créés et configurés, ils apparaissent dans l’écran de gestion.


[[Fichier:OX S srv d'ecoute.png|centré|sans_cadre|884x884px]]


Cet écran permet de :

-	Démarrer un serveur d'écoute : [[Fichier:OX S strt rbt.png|frameless|120px]]    

-	Arrêter un serveur d'écoute  : [[Fichier:OX S stp rbt.png|frameless|120px]]       

-	Consulter les journaux d’événements d’un serveur d'écoute  : [[Fichier:OX S infos rbt.png|frameless|120px]]


Une fois démarré, un serveur d’écoute est un processus qui s’exécute en continu en tâche de fond. Le binaire ONYX Server associé est <FONT color="blue"> map_rawd</FONT> et la liste des processus actifs du système (Gestionnaire de Tâches sous Windows / commande <FONT color="blue"> ps –ef</FONT> sous Linux) montrera autant de processus <FONT color="blue">map_rawd[.exe]</FONT> qu’il y a de serveurs d’écoute démarrés.


<u>Remarque Windows</u> :

Sous Windows, les serveurs d’écoute s’installent en tant que Services dans le Gestionnaire de Services Windows. Cet enregistrement se fait au premier démarrage du robot. Le Service correspondant est nommé en se basant sur le port réseau écouté (d’où l’unicité requise) et le séparateur de travaux. Exemple : Mapping_Rawd_13000, Mapping_Rawd_25006_SEP.

Chaque Service Windows créé par robot est configuré en démarrage manuel par défaut, cela peut être modifié par la suite pour un démarrage automatique avec le système.


*Fichier temporaire associé aux serveurs d’écoute :


Chaque serveur d’écoute, une fois démarré, crée un dossier dans le répertoire temporaire d'Onyx Server. Il sera nommé en se basant sur le port réseau écouté et le séparateur de travaux avec un fichier map_rawd.ID contenant le numéro du processus associé. 
Exemple:<code> …\Temp\map_rawd_25006_SEP\map_rawd.ID</code>


*Lignes de commandes utiles :


<u>Pour démarrer un robot nommé</u> :

-	Linux(après chargement de l’environnement) <code>/apps/mapping/bin/map_rawd -start -name:RAW_25006</code>

-	Windows <code>C:\Program Files(x86)\M_Processing Server\Applications\map_rawd.exe -start -name:RAW_25006</code>



<u>Pour arrêter un robot nommé</u> :

-	Linux(après chargement de l’environnement) <code>/apps/mapping/bin/map_rawd -stop -name:RAW_25006</code>

-	Windows  <code>c:\Program Files(x86)\M_Processing Server\Applications\map_rawd.exe -stop -name:RAW_25006</code>


Si le robot n’est pas nommé, il conviendra de passer les paramètres décrivant le robot (port écouté et séparateur de travaux) en argument des commandes précédentes (d’où le conseil d’unicité quant au nommage des robots).

==Gestion des impressions==


[[Fichier:OX S Gestion IMPRT1.png|centré|sans_cadre|796x796px]]


===Gestion du spooler===

Comme évoqué précédemment, le Spooler ONYX Server est le cœur de la solution. C’est un véritable gestionnaire de flux, de traitements et d’imprimantes. 
En naviguant dans le Menu d’Administration puis Gestion des Impressions et enfin Gestion du Spooler, l’interface suivante permet de : 

 [[Fichier:OX S Gestion Spooler.png|centré|sans_cadre|887x887px]]  


-	Démarrer le Spooler = Démarrer le Spooler.

-	Arrêter le Spooler = Arrêter le Spooler.

-	Consulter les statistiques = Consulter les statistiques d’éditions.

-	Rapports d’Utilisation = Consulter les rapports d’utilisation de la solution.


Une fois démarré, le Spooler est un processus qui s’exécute en continu en tâche de fond. Le binaire ONYX Server associé est <FONT color="blue">map_daemon[.exe]</FONT>.


Remarque Windows :

Sous Windows, le Spooler s’installe en tant que Service dans le Gestionnaire de Services Windows. Cet enregistrement se fait au premier démarrage du Spooler. Le Service correspondant est nommé Mapping_Spooler. Il est configuré en démarrage manuel par défaut, cela peut être modifié par la suite pour un démarrage automatique avec le système.


*Fichier temporaire associé au Spooler :


Une fois démarré, le Spooler crée un fichier map_daemon.ID dans son répertoire de l’installation d'ONYX Server : 

-	par défaut sous Windows <code>C:\ProgramData\M-Processing Server\Spooler</code>

-	par défaut sous Linux <code>/apps/mapping/spool</code>


*Lignes de commandes utiles :


<u>Pour démarrer le Spooler </u>:

-	Linux (après chargement de l’environnement) <code>/apps/mapping/bin/map_daemon start</code>

-	Windows <code>C:\Program Files (x86) \M-Processing Server\Applications\map_daemon.exe" start</code>


<u>Pour arrêter le Spooler</u> :

-	Linux (après chargement de l’environnement) <code>/apps/mapping/bin/map_daemon stop</code>

-	Windows <code>C:\Program Files (x86)\M-Processing Server\Applications\map_daemon.exe" stop</code>

===Gestion des sites et files d'attente===
En naviguant dans Mapping, Menu d’administration puis Gestion des Impressions et enfin Gestion des Sites / Imprimantes / Points d'entrée, l’interface affichée présente la liste de toutes les files d’attente configurées dans le Spooler organisées par sites.


[[Fichier:OX S S I E.png|centré|sans_cadre|549x549px]]



Par exemple, ici, un site SAMPLE a été déclaré dans lequel trois files d’attente (une entrée et deux sorties) sont configurées. Trois autres files d’attente sont déclarées hors site et sont affichées dans un site par défaut appelé Principal.

Depuis cette interface, à l’intérieur de chaque site, il est possible de :

[[Fichier:OX S iconeS.png|gauche|sans_cadre]]
Créer un site : Les sites ne sont qu’une manière logique d’organiser les files d’attente.

[[Fichier:OX S iconeF.png|gauche|sans_cadre]]
Créer une file d’attente de sortie : Elle sera rattachée à une imprimante physique.

[[Fichier:OX S FP.png|gauche|sans_cadre]]
Créer une file d’attente de traitement personnalisé : Elle exécute un script (shell) client.

[[Fichier:OX S FM.png|gauche|sans_cadre]]
Créer une file d’attente de traitements Mapping : Elle exécute un Workflow.



<u>Remarques importantes</u> :

*Tous les objets qui vont être créés et configurés doivent avoir un nom unique quel que soit leur type (une imprimante de sortie ne peut pas avoir le même nom qu’un site).

*Une fois créé et configuré, il n’est plus possible de changer le nom d’un objet. Si besoin, il faudra supprimer l’objet puis le recréer.

===Définitions===

<u>Site</u> : 

Un site peut se définir comme étant un objet Mapping purement logique, chargé d’organiser la présentation des différentes files d’attente. Les sites peuvent représenter différents pays, différentes régions, différentes agences ou magasins.


<u>File d'attente ou Queue</u> : 

Une file d’attente (ou queue) peut, quant à elle, se définir comme étant un objet Mapping qui reçoit la liste des fichiers à traiter et qui organise les traitements en fonction des priorités. La file d’attente ne réalise aucune connexion avec une imprimante physique. C’est un objet qui gère uniquement une liste de fichiers. Elle est liée au minimum à une device qui, elle, se connectera au matériel physique.
Si elle est à l’état Prêt ou Suspendu alors les fichiers ne seront pas traités par la device.


<u>Device</u> : 

Une device est, par définition, un objet Mapping chargé de la communication avec l’imprimante en fonction de certains paramètres tels que l’adresse IP, protocole, … Elle doit être rattachée à une seule file d’attente. Elle peut être à l’état Prêt, Suspendu ou en Erreur. Dans les deux derniers cas, les fichiers ne seront pas traités par la device. Plusieurs devices peuvent être connectées à une seule file d’attente (notion de load balancing).


===Créer un site===

Les sites permettent de classer les files d’attente du Spooler afin de hiérarchiser l’affichage de la gestion des impressions. Cette notion de site pourra également être utilisée comme filtre d’affichage ou recherche dans la vue d’exploitation.

Pour créer un site, cliquer sur le bouton [[Fichier:OX S iconeS.png|frameless|120px]] .


<u>Remarque</u> :

Il est possible de créer des sites dans un site et ainsi de gérer une arborescence d’affichage complexe. Pour cela, il convient d’utiliser le bouton de création sur la ligne du site concerné.

Dans l’écran de saisie, il faut renseigner chacune des informations suivantes, en les validant par "enregistrer"  :

-	Nom  = Un nom pour le site (requis, avec contrainte d’unicité).

-	Description  = optionnel.

Une fois le paramétrage du site achevé, il faut enregistrer ce nouveau site en terminant par "OK" (3).


[[Fichier:OX S Crt Site.png|centré|sans_cadre|885x885px]]

===Créer un point d’entrée===

Un point d’entrée ONYX Server est une file d’attente chargée d’exécuter des traitements Mapping aussi appelés Workflows. Il est constitué de deux objets :

-	Une file d’attente pour réceptionner les demandes (travaux).

-	Une device, ou moteur, pour prendre en charge les demandes et effectuer les traitements.

Pour ajouter un point d’entrée dans un site, cliquer sur le bouton   sur la ligne du site concerné.

Après avoir renseigné les informations voulues, il faut les valider grâce au bouton "Enregistrer" .


[[Fichier:OX S crtpt.png|centré|sans_cadre|683x683px]]


*File d’attente

-	Nom  = nom pour la file d’attente (requis).

-	Description = description pour la file d’attente.

La validation du nom présente le formulaire de création de la device associée.


*Imprimante

-	Nom Device = nom pour la device associée (requis).

-	Description = description pour la device.


*Pilote d’impression

-	Connexion = Type de driver est RULES par défaut et non modifiable (c’est bien le moteur d’exécution qui est appelé).

-	Rules set = Workflow exécuté qui est à choisir dans la liste déroulante. Par défaut (‘Default’ ou ‘Undefined’), le Workflow root sera exécuté.


*Contrôles d’impression

-	Sur erreur  = Comportement de la device sur les erreurs :

o	Default ou Stop : le traitement en cours s’arrête en erreur et la device s’arrête en erreur.

o	Continue : le traitement en cours s’arrête en erreur et la device continue avec les demandes suivantes.

o	Ignore : le traitement en cours est considéré comme ayant été effectué et la device continue avec les demandes suivantes. Cette valeur est déconseillée sauf pour des cas très particuliers.

-	Reprise Automatique (8) = Reprise automatique : si activé, un traitement provoquant une erreur sera relancé.

-	Temps Max = temps maximum pendant lequel un traitement dit en erreur sera relancé avant de réellement être considéré en erreur. Le comportement de la device sur erreur sera alors pris en compte.

===Créer une imprimante===

Une imprimante ONYX Server est une file d’attente chargée de communiquer avec un matériel physique d’impression. 
Elle est constituée de deux objets :

-	Une file d’attente pour réceptionner les demandes d’impression (travaux)

-	Une device ou imprimante, pour prendre en charge les demandes et envoyer les données au matériel physique.

Pour ajouter une imprimante dans un site, cliquer sur le bouton [[Fichier:OX S iconeF.png|frameless|120px]] sur la ligne du site concerné.

Il faut renseigner les informations voulues en les validant par le bouton "enregistrer" .


[[Fichier:OX S CRT IMPRT.png|centré|sans_cadre|700x700px]]


*File d’attente

-	Nom (1) = nom pour la file d’attente (requis).

-	Description (2) = description pour la file d’attente.

La validation du nom présente le formulaire de création de la device associée.

 
*Imprimante

-	Nom Device (3) = nom pour la device associée (requis).

-	Description (4) = description pour la device.

-	Backup (5) = si activé, permet de créer une imprimante de secours qui prendra automatiquement le relais d’une imprimante principale en erreur.


*Pilote d’impression

-	Connexion (6) = type de connexion.ONYX Server implémente plusieurs types de protocoles de communication, le protocole LPR est le plus répandu et est utilisé ici.

-	Type d’impression (7) = type d’impression. Le type default signifie que le matériel adressé est une imprimante physique. Le type MAPPING indique une communication avec une autre Spooler ONYX Server (distant), et permet d’activer la compression des flux échangés.

-	Compatibilité XPS (8) = compatibilité XPS. Cela permet de communiquer en direct avec l’imprimante physique adressée, dans son langage natif d’impression. Les flux XPS sont convertis à la volée suivant le profil sélectionné, puis envoyés à l’imprimante, sans dépendance avec aucun driver.

-	IP (9) = adresse IP de l’imprimante physique.

-	Remote queue (10) = nom interne de l’imprimante physique : PASS en général si elle est connectée directement au réseau, ou alors le nom du port sur le boîtier (HP JetDirect par exemple) si utilisé pour connecter l’imprimante au réseau.

-	Délai (11) = délai d’attente maximum d’une communication réseau.


*Etat

Permet d’interroger l’imprimante physique pour obtenir son statut réel qui sera affichée dans la vue d’exploitation.


*Contrôles d’impression

Permet d’interroger l’imprimante physique pour contrôler le statut réel de l’impression. Cette communication supplémentaire est détaillée dans le Guide Utilisateur. Les paramètres par défaut proposés conviennent dans l’immédiat.

-	Sur erreur (12) = comportement de la device sur les erreurs :

o	default ou stop = le traitement en cours s’arrête en erreur et la device s’arrête en erreur.

o	continue = le traitement en cours s’arrête en erreur et la device continue avec les demandes suivantes.

o	ignore = le traitement en cours est considéré comme ayant été effectué et la device continue avec les demandes suivantes. Valeur déconseillée, sauf pour des cas très particuliers.

-	Reprise Automatique (13) = Reprise automatique : si activé, une impression provoquant une erreur sera relancée

o	Temps Max = temps maximum pendant lequel l’impression en erreur est relancée, avant de réellement être considérée en erreur. Le comportement de la device sur erreur sera alors pris en compte.

o	Mode de reprise : en intégralité ou à la page.

Le paramétrage (simple) de l’imprimante achevé, il faut enregistrer ce nouvel objet en terminant par   (14).


===Paramétrage avancé des imprimantes===

====Pilote d'impression====

Le pilote d’impression correspond à l’ensemble de paramètres concernant, uniquement, la partie connexion à l’imprimante physique pour envoi des données. La configuration du pilote d’impression est indépendante des contrôles d’impression : retour sur erreur, interrogation du statut de l’imprimante...



<u>Connexion</u>

*LPR (valeur par défaut et valeur recommandée)

Il s’agit de la connexion standard pour une imprimante réseau. Le Spooler se connecte sur le port lpr de l’imprimante (515) et envoie les données. Ce protocole intègre des contrôles de connexion et de communication tout au long du processus d’envoi. Il fonctionne avec quasiment l’intégralité des imprimantes et permet également de communiquer avec des serveurs d’impression.

*RAW

Il s’agit d’un autre protocole réseau c’est-à-dire une connexion sur un port donné (à préciser par ailleurs) et envoi des données puis déconnexion. Aucun contrôle n’est géré par ce protocole.

*SHELL

Utilisée pour les files d’attente du même nom, la device de type SHELL n’est pas directement connectée à une imprimante physique mais à un programme tel qu’un script bat ou shell suivant les OS.

*RULES

Utilisée pour les files d’attente Point d’entrée, la device de type RULES n’est pas directement connectée à une imprimante physique mais au moteur d’exécution des Workflows de'ONYX Server.

*USB

L’imprimante doit être connectée à un port USB. Le nom du port doit être précisé par ailleurs.

*SERIAL

L’imprimante doit être connectée à un port série. Le nom du port doit être précisé par ailleurs.

*LOCAL OS SPOOLER (sous Windows uniquement)

La device envoie les fichiers à une imprimante déclarée sur le serveur d’impression Windows. Il faut alors sélectionner le nom de l’imprimante Windows dans la liste déroulante Remote_queue.

*DUMMY

Connexion de type test. Les fichiers sont traités mais pas réellement envoyés.

*IPDS

Le protocole d’impression utilisé est l’IPDS. Il permet d’imprimer des flux AFPDS avec communication bidirectionnelle entre le serveur et les imprimantes.

*EMAIL

La device de type Email n’est pas connectée à une imprimante physique mais est chargée d’envoyer les documents reçus par courrier électronique.



<u>Type d'impression</u>

*DEFAULT

Protocole par défaut.

*MAPPING

Utilisé pour envoi des données à un Spooler Mapping distant permettant notamment de compresser les fichiers avant envoi au serveur distant.

*AXHIOM (disponible pour les protocoles RAW et USB uniquement).

Protocole spécifique aux imprimantes AXHIOM.

*ESCPOS (disponible pour les protocoles RAW et SERIAL uniquement).

Protocole spécifique aux imprimantes de caisse EPSON.

*SAMSUNG (disponible pour le protocole RAW uniquement).

Protocole spécifique aux imprimantes de caisse SAMSUNG.

*ZEBRA (disponible pour le protocole RAW uniquement).

Protocole spécifique aux imprimantes de caisse ZEBRA (pour les imprimantes thermiques ZEBRA, il est conseillé d’utiliser le protocole LPR par défaut).



<u>Résolution des polices</u>

Il s’agit de la résolution des fichiers pour création et envoi des polices AFPDS. Valeur exprimée en dpi (240 ou 300).
Ce paramètre concerne les connexions de type IPDS.



<u>Activer log</u>

Il s’agit de l’activation des traces IPDS. Elles sont créées dans le sous-répertoire<code> \afpds\ipds</code> du répertoire de base ONYX Server.
Ce paramètre concerne les connexions de type IPDS.



<u>Compatibilité XPS</u>

Il s’agit du profil de conversion à utiliser pour l’envoi des fichiers de type XPS. Le profil affiché est repris dans le paramètre <label> du fichier XPSConfig.conf.
Si le fichier à imprimer est au format XPS alors le profil de conversion sélectionné sera appliqué (pour conversion PCL, ZPL…). Si le fichier n’est pas au format XPS alors le paramètre sera ignoré et aucune conversion effectuée.
Si aucun profil de conversion n’est renseigné, le fichier sera envoyé sans conversion (Attention : l’envoi d’un fichier XPS à une imprimante ne le supportant pas produit généralement l’impression de caractères illisibles en continu jusqu’au vidage complet des bacs de l’imprimante…) 
Ce paramètre concerne les connexions de type LPR, RAW, IPDS et EMAIL (pour conversion en PDF et ajout en pièce jointe notamment).


<u>Adresse IP</u>

Il s’agit de l’adresse de destination de l’imprimante (ou du serveur d’impression). L’adresse IP du périphérique ou son nom DNS peuvent être utilisés.
Ce paramètre concerne les connexions de type LPR, RAW et IPDS.
Dans le cas d’une imprimante EMAIL, il s’agira de l’adresse IP du serveur SMTP.


<u>Remote Queue</u>

Il s’agit du nom de la file d’attente interne de l’imprimante (ou du serveur d’impression).
Le nom de la file d’attente dépend du constructeur d’imprimante, le plus commun étant PASS mais il peut également s’agir de RAW, PR1, PR0, PR3, TEXT, mp ou autre. Attention : ce paramètre est généralement sensible à la casse.
Dans le cas d’un serveur d’impression, il s’agit de la file d’attente de destination sur ce serveur c’est_à-dire que pour le cas d’un serveur Mapping = le nom de la file d’attente ; pour un serveur d’impression Windows = le nom de l’imprimante ; pour un iSeries = le nom de l’OUTQ…
Pour une connexion de type LOCAL OS SPOOLER, la liste de sélection est constituée des noms des imprimantes déclarées dans le spooler Windows.
Ce paramètre concerne les connexions de type LPR et LOCAL OS SPOOLER.



<u>Port</u>

Il s’agit du port de connexion à l’imprimante (ou au serveur d’impression).
En connexion de type LPR, le port est 515 par défaut (non modifiable). En connexion de type RAW, la valeur la plus courante est 9100. En connexion de type IPDS, les valeurs les plus courantes sont 9100 ou 2501.
Ce paramètre concerne les connexions de type LPR (non modifiable), RAW, USB, SERIAL et IPDS.



<u>Délai</u>

Ce paramètre est un timeout de communication réseau pris en compte à chaque étape unitaire de la communication avec l’imprimante physique : connexion, envoi d’un paquet unitaire d’information, réception des acquittements.
La valeur * signifie que l’on ne contrôle pas les timeout réseau et que l’imprimante ne tombe donc jamais en erreur.
Ce paramètre concerne les connexions de type LPR, USB, SERIAL, LOCAL OS SPOOLER.



<u>Shell</u>

Il s’agit du chemin complet du script exécuté par la device (un .bat sur Windows, un .sh sur Unix ou Linux).
Ce paramètre concerne les connexions de type SHELL.



<u>Rules Set</u>

Il s’agit du nom du Workflow exécuté par la device.Ce paramètre concerne les connexions de type RULES.



<u>Personnalisés</u>

Ce paramètre permet d’ajouter des paramètres personnalisés (métadonnées) lors de l’envoi en LPR. Les paramètres disponibles sont ceux de la commande map_lpr (attention à ne pas utiliser un paramètre déjà existant : voir la log de la file d’attente pour plus de détails sur la commande map_lpr exécutée).

Exemple : -sleep:10 = pour faire une pause de 10 secondes entre chaque fichier.


====Etat====

Il s’agit d’activer ou non le contrôle de l’état de l’imprimante pour affichage dans l’interface du Spooler. Cette récupération de l’état réel de l’imprimante est indépendante du contrôle d’impression qui est effectué en plus de l’envoi des données pour contrôler les erreurs.
L’utilisation du contrôle d’état suppose que l’imprimante (ou le périphérique) de destination soit capable de renvoyer ce type d’information.


Attention : si l’imprimante est connectée au réseau grâce à un boitier additionnel (type boitier AXIS ou HP JetDirect), le retour d’information sera fait par le boitier et non par l’imprimante. L’état renvoyé sera donc celui du boitier et non de l’imprimante.
En activant le contrôle d’état, l’interface web du Spooler pourra afficher l’état de l’imprimante (prête, hors-ligne, bourrage papier…).

si l’actualisation automatique est demandée, M-Processing Server récupère l’état d’une imprimante uniquement au moment de l’envoi d’un fichier. L’information affichée correspond dans ce cas à l’état de l’imprimante lors de la dernière impression par Mapping.


<u>Protocole</u>

*NONE

Aucune interrogation sur l’état de l’imprimante n’est faite.

*SNMP (mode recommandé)

Le protocole SNMP est utilisé pour contrôler l’état. Il s’agit du protocole le plus fiable et le plus complet. Il est très bien supporté par la majorité des imprimantes récentes et permet généralement d’afficher le contenu du panneau de contrôle de l’imprimante.
Pour contrôler manuellement les capacités SNMP de votre périphérique, la commande <FONT color="blue">mapsnmp[.exe]</FONT> peut être utilisée.

*LPQ

Le protocole LPQ permet un retour d’information basique sur l’état de l’imprimante. Seul le statut (active ou inactive) est affiché.

*PJL (mode déconseillé, conservé uniquement pour des questions de rétrocompatibilité)

L’état de l’imprimante est renvoyé en utilisant le protocole PJL. Ce protocole est assez complet mais peu fiable car peu normalisé (l’implémentation du PJL est différente en fonction du constructeur voire du modèle d’imprimante). Les messages d’erreur ne sont pas normalisés (d’où les paramètres pour appeler un fichier de message PJL et une langue).



<u>Délai</u>

Cela correspond au délai alloué pour recevoir l’état de l’imprimante. Lorsque l’actualisation automatique est activée, il faut veiller à ne pas mettre un délai trop court pour ne pas saturer le système en trames réseau.


<u>Actualisation automatique</u>

Elle permet de rafraichir automatiquement l’état de l’imprimante même lorsqu’il n’y a pas d’impression. Cela peut être utile pour un opérateur qui gère l’ensemble du parc et veut contrôler l’état général du parc d’imprimantes.


====Contrôle d'impression====

Le contrôle d’impression est utilisé notamment :

-	pour vérifier qu’un fichier a bien été complètement imprimé

-	pour effectuer des reprises automatiques si nécessaire

<u>Protocole</u>

*SNMP (mode recommandé)

Le protocole SNMP est utilisé pour contrôler l’état. Il s’agit du protocole le plus fiable et le plus complet. Il est très bien supporté par la majorité des imprimantes récentes. Le SNMP gère notamment le compteur de pages, ce qui permet de vérifier que toutes les pages d’un fichier ont bien été imprimées.

*LPQ

Le protocole LPQ permet un retour d’information basique sur l’état de l’imprimante. Le compteur de pages n’est pas géré ce qui signifie que la reprise automatique ne peut se faire que sur l’intégralité du fichier.


<u>Sur erreur</u>

Cela définit le comportement de la device en cas d’erreur de traitement ou d’impression.

*Default

Comportement par défaut en fonction des paramètres de configuration <FONT color="blue"> DAEMON_NO_HOLD_ON_ERROR</FONT>
et <FONT color="blue"> DAEMON_DONT_HOLD_ENTRY_ON_ERROR </FONT>. A la valeur NO, le comportement par défaut des devices est à l’état Stop.

*Stop

En cas d’erreur, le spool en cours passe à l’état erreur. La device Mapping tombe en erreur également. Dans ce cas, toute impression sur cette imprimante est stoppée jusqu’à une intervention de redémarrage de la device Mapping (par l’interface Web ou par commande). Si une imprimante de backup est définie, les fichiers suivants seront imprimés par la device de backup.

*Ignore (déconseiller)

Les erreurs sont ignorées et le spool en cours est considéré comme traité. Le spool suivant est envoyé à l’imprimante.

*Continue

La device reste à l’état prêt et le spool en cours passe en erreur. Le spool suivant est envoyé à l’imprimante.


<u>Reprise automatique</u>

Si la case est cochée, le spooler renvoie le fichier à l’imprimante en cas d’erreur. Il faut, dans ce cas, préciser un délai maximum pour la reprise et un mode de reprise (complet ou partiel).
Pendant le temps de la reprise, la device passe en erreur mais le spool reste en cours d’impression. Si la reprise automatique échoue, le spool passera alors en erreur également. Si elle réussit, la device repassera à l’état prêt.

*Délai

Le délai est le temps maximum pendant lequel le spooler relance l’impression.

Attention : certaines imprimantes peuvent imprimer plusieurs fois le fichier.

*Mode

Il permet de définir le type de reprise du fichier :

-	Complet : le fichier complet est renvoyé depuis la page 1

-	Page min : le fichier est renvoyé à partir de la dernière page imprimée connue moins n pages (n étant défini dans la longueur du chemin papier)

-	Page max : le fichier est renvoyé à partir de la dernière page imprimée connue plus n pages (n étant défini dans la longueur du chemin papier)


L’information du nombre de pages renvoyée par l’imprimante n’est pas toujours fiable à 100%. Certaines imprimantes comptent les pages à partir du moment où elles sont reçues dans le buffer et non pas physiquement imprimées. Si l’impression est coupée en cours de traitement et que le compteur de l’imprimante indique 50 pages, il se peut que seules 47 pages aient été physiquement imprimées (les 3 autres étant quelque part entre le bac d’entrée et de sortie = le fameux chemin papier).
Sur d’autres imprimantes (plus rares), le compteur est en retard par rapport au nombre de pages réellement imprimées et il faut décompter quelques pages.

Exemples:

Si la dernière page renvoyée par l’imprimante est la page 50 et que la reprise automatique est paramétrée surpage minavec une longueur de chemin papier de 3 pages, la réédition commencera en page 47.
Si la dernière page renvoyée par l’imprimante est la page 50 et que la reprise automatique est paramétrée surpage maxavec une longueur de chemin papier de 3 pages, la réédition commencera en page 53.



<u>Attendre</u>

Le paramètre attendre définit que le spooler attend l’accusé d’impression finale du spool en cours avant d’envoyer le suivant. Il s’agit du mode par défaut. Si le paramètre n’est pas activé, le comptage des pages n’est plus effectif.



<u>Unité de page (PerPage)</u>

L’unité de page dépend du type d’imprimante et du compteur. Elle est utilisée pour vérifier que toutes les pages d’un spool ont été imprimées.
Si l’imprimante est de type feuille à feuille (cutsheet), soit la quasi-totalité des imprimantes laser workgroup, alors l’imprimante compte en pages physiques. Il n’y a donc aucun souci de compatibilité avec Mapping qui compte lui aussi en page. L’unité de page est donc à 1 (par défaut).
Par contre, pour les imprimantes à papier continu qui utilisent des rouleaux de papier (laser à papier continu, imprimantes matricielles ou thermiques), le compteur est défini en distance imprimée (généralement en pouces). Il faut donc calibrer la taille du papier en précisant l’unité de page. Par exemple, sur une imprimante thermique imprimant des étiquettes de 4 pouces de long, il faut définir une unité de page de 4.



<u>Activer les bannières</u>

Les bannières sont des pages de séparation qui sont ajoutées avant et après le fichier d’impression. Consultez la partie spécifique de ce Guide sur la création et l’utilisation de bannières d’impression.

===Paramétrage avancé des files d’attente===

Toute file d’attente Mapping, quel que soit son type, propose deux onglets de paramétrages avancés : une partie Sécurité pour la gestion des droits d’accès sur la file d’attente et un gestionnaire d’événements permettant de déclencher des actions particulières.


Remarque :

L’onglet Imprimantes présente l’ensemble des devices configurées et rattachées à la file d’attente de la même manière que l’onglet Information.


====Sécurité====
Cet onglet permet d’affecter les droits d’accès à la file d’attente. Cette partie va de pair avec la création des utilisateurs et groupes d’utilisateurs ainsi que la gestion des accès aux menus de l’interface Web.Pour affecter des droits d’accès à une file d’attente, il faut:


[[Fichier:OX S Security.png|centré|sans_cadre|483x483px|alt=]]


(1)	Sélectionner le type d’accès :

-	Admin : les utilisateurs administrateurs ont tous les droits d’actions sur la file d’attente et ses devices, ainsi que sur tous les travaux de la file d’attente (même ceux dont ils ne sont pas propriétaires).

-	Simple : les utilisateurs simples n’ont les droits d’actions que sur les travaux dont ils sont propriétaires. Ils ne voient pas les travaux des autres utilisateurs, même contenus dans la file d’attente.

(2)	Utiliser le filtre pour chercher un groupe ou un utilisateur particulier

Remarque :

Par défaut, un filtre sur le caractère ‘[‘ est réalisé, pour ne présenter que les groupes d’utilisateurs (il est en effet généralement conseillé de gérer les droits d’accès sur des groupes d’utilisateurs).

(3)	La liste de gauche présente l’ensemble des utilisateurs et groupes disponibles, n’ayant pas encore les droits sélectionnés sur la file d’attente. Sélectionner un ou plusieurs éléments (multi sélection avec la touche Ctrl), puis cliquer sur le [[Fichier:OX S Iconeplus.png|frameless|120px ]] pour affecter les utilisateurs ou groupes à la liste de droite.

(4)	La liste de droite présente l’ensemble des utilisateurs et groupes d’utilisateurs ayant déjà les droits d’accès (Admin ou Simple) à la file d’attente. Sélectionner un ou plusieurs éléments (multi sélection avec la touche Ctrl), puis cliquer sur le [[Fichier:OX S IconeMUL.png|frameless|120px ]] pour retirer les droits aux utilisateurs ou groupes.

(5)	Valider l’action une fois le paramétrage terminé.


====Event Trigger====

Cet onglet permet de monitorer quatre niveaux d’événements sur une file d’attente afin de déclencher des actions particulières.

<u>Types d'événements</u>

Les quatre types d’événements sont :

-	Shell_queue : changement d’état d’une file d’attente (de Suspendu à Prêt et vice-versa).

-	Shell_device : changement d’état d’une device (de Suspendu à Prêt, de Prêtà Erreur, etc.)

-	Shell_spool : changement d’état d’un travail dans la file d’attente (nouveau travail, passage à l’état Prêt, Erreur, Conservé, etc.)

-	Shell_user : événement déclenché automatiquement par une action utilisateur (clic sur un bouton).


Les trois premiers événements sont déclenchés automatiquement par le Spooler ONYX Server afin de permettre à l’utilisateur de les monitorer ou non, en faisant appel à ses propres scripts d’actions. Au déclenchement d’un événement, le Spooler exécutera le script paramétré.
Ci-dessous un exemple de configuration où les trois événements sont monitorés, chacun appelant un script spécifique :

[[Fichier:OX S Evnt.png|centré|sans_cadre|504x504px]]


Remarque :

Le paramètre '''email''' dans la liste déroulante des événements sert à définir une adresse email qui pourra être réutilisée dans le(s) script(s).
Les paramètres de la section SAP sont utilisés dans le cas d’une connexion avec l’ERP '''SAP'''.


<u>Variables d'environnement</u>

Comme évoqué précédemment, le Spooler ONYX Server lance lui-même l’exécution des scripts paramétrés. Cela implique que dans les scripts, l’ensemble des variables d’environnement Mapping sont accessibles et utilisables, notamment : <FONT color="blue"> PATH_BIN</FONT> pour le chemin des binaires, <FONT color="blue">PATH_TEMP</FONT> pour le répertoire temporaire, <FONT color="blue">PMAP_JOBNUM</FONT> pour l’identifiant unique de travail, etc…

Suivant le type d’événement déclenché, des paramètres supplémentaires sont également accessibles :

*Shell_queue : ensemble des attributs de la file d’attente

{| class="wikitable"
|-
| MAP_QUEUE_NAME || Nom de la file d’attente      Ex : INPUT_DATA

|-
| MAP_QUEUE_SITE || Nom du site dans lequel la file d’attente est déclarée   
Ex : WASQUEHAL

|-
| MAP_QUEUE_STATUS || Etat de la file d’attente après déclenchement de l’événement   
Valeurs : hold | ready
|-
| TMAP_QUEUE_LISTEN || Mode d’écoute de la file d’attente      
Ex : lpd
|-
| MAP_QUEUE_PATH_FILE || Chemin de stockage des travaux   
Ex : E:\MappingWindows\Spooler\global
|-
| MAP_QUEUE_PATH_QUEUE || Paramètre obsolète, non utilisé
|-
| MAP_QUEUE_BACKUP|| Nom de la (ou des) imprimante(s) de backup, séparées par une virgule
|-
| MAP_QUEUE_DESCRIPTION || Description donnée à la file d’attente dans le Spooler 
Ex: Entry point for input text files
|-
| MAP_QUEUE_DEVICES || Liste des imprimantes rattachées à la file d’attente (séparées par une virgule)  
Ex : devINPUT_DATA
|-
| MAP_QUEUE_USERDATA_[[…]] || Données « utilisateur » définies pour la file d’attente  
Ex : valeurs de shell_queue, shell_spool, …
|-
| MAP_RESULT || Le résultat de l’action ayant déclenché l’événement  Valeurs : hold | ready
|-
| MAP_USER_REQUEST || Utilisateur ayant déclenché l’action Valeur : internal_user dans ce cas

|}

*Shell_device : attributs de la file d’attente (ci-dessus) complétés par l’ensemble des attributs de l’imprimante concernée :

{| class="wikitable"
|-
| MAP_DEVICE_NAME || Nom de l’imprimante
Ex : devINPUT_DATA

|-
| MAP_DEVICE_STATUS|| Etat de l’imprimante après déclenchement de l’événement
Valeurs : hold | ready | error

|-
| MAP_DEVICE_CONNECT || Paramètre obsolète, non utilisé
|-
| MAP_DEVICE_MODE || Type de connexion
Ex : LPR, RULES, IPDS, …

|-
| MAP_DEVICE_SUBMODE || Type d’impression
Ex : default, mapping, axhiom, …

|-
| TMAP_DEVICE_IP || Adresse IP de l’imprimante physique
|-
| MAP_DEVICE_SHELL || Script ou programme exécuté
Ex : $PATH_BIN/map_809 (moteur de Workflows)

|-
| MAP_DEVICE_LOGIPDS || Activation ou non des logs IPDS
|-
| MAP_DEVICE_PORTIPDS || Activation ou non des logs IPDS
|-
| MAP_DEVICE_FONTRESOLUTION || Résolution des polices (IPDS)
|-
| MAP_DEVICE_PORT || Port d’impression
Ex : 515, 9100, …

|-
| MAP_DEVICE_REMOTEQ || Nom interne de l’imprimante physique
Ex : PASS

|-
| MAP_DEVICE_XPSMODE || Nom du profil XPS de conversion à la volée
|-
| MAP_DEVICE_TYPESTATUS || Protocole de récupération de l’état
Ex : NONE, SNMP, PJL, …

|-
| MAP_DEVICE_IMPTYPE || Type de codes PJL pour les messages d’état
Ex : PJL_REF

|-
| MAP_DEVICE_LANG || Langue des messages d’état (protocole PJL)
|-
| MAP_DEVICE_PATH_QUEUE || Paramètre obsolète, non utilisé
|-
| MAP_DEVICE_QUEUE || Nom de la file d’attente à laquelle l’imprimante est rattachée
Ex : INPUT_DATA

|-
| MAP_DEVICE_TIMEOUT || Timeout de communication réseau (en secondes)
Ex : 600 (pour 10 minutes)

|-
| MAP_DEVICE_TIMEOUT_STATUS || Délai alloué pour recevoir l’état de l’imprimante (en secondes)
Ex : 10

|-
| MAP_DEVICE_REALSTATUS || Etat réel de l’imprimante physique
Ex : Prêt - running-idle

|-
| MAP_DEVICE_MSGW || Message d’erreur
Ex : Impression échouée

|-
| MAP_DEVICE_BACKUP|| La device est-elle une device de backup ?
|-
| MAP_DEVICE_MONITOR|| Protocole de contrôle de l’impression
Ex : SNMP, LPQ

|-
| MAP_DEVICE_CUSTOM || Paramètres personnalisés
|-
| MAP_DEVICE_PERPAGE || Unité de page
|-
| MAP_DEVICE_RULES || Nom du Workflow exécuté
Ex : Factures.rules.xml

|-
| MAP_DEVICE_ONERROR || Comportement de la device sur erreur
Ex : continue

|-
| MAP_RESULT || Le résultat de l’action ayant déclenché l’événement
Valeurs : hold | ready | error

|-
| TMAP_USER_REQUEST || Utilisateur ayant déclenché l’action
Ex : internal_user dans ce cas


|}

===Envoyer un fichier dans une file d’attente===

Depuis une application tierce, le Spooler ONYX Server est vu comme une imprimante ‘virtuelle’. Pour envoyer des fichiers dans une file d’attente du Spooler, les commandes d’impression sont donc utilisées.
ONYX Server dispose de ses propres commandes d’impression : <FONT color="blue">map_lp</FONT> en local, <FONT color="blue">map_lpr</FONT> en distant.


==== MAP_LP en local :====

Il s’agit d’une requête directe envoyée au Spooler ONYX Server (c’est le programme map_daemon qui y répond).
Deux paramètres sont requis pour cette commande :

- <FONT color="blue"> queue:XXX </FONT> = nom de la file d’attente dans laquelle le fichier sera envoyé.

- <FONT color="blue">data:XXX </FONT> = chemin complet du fichier à envoyer.

D’autres paramètres sont disponibles sur cette commande (argument --help pour les lister) dont voici les plus courants :

- <FONT color="blue">title:XXX </FONT> = permet de donner un titre au document dans la file d’attente affiché dans la vue d’exploitation.

- <FONT color="blue">user:XXX </FONT> = permet de définir le nom d’utilisateur propriétaire du document dans la file d’attente.

- <FONT color="blue">map_hold </FONT> = le fichier est envoyé avec l’état en attente (ne sera traité qu’après libération).

- <FONT color="blue">map_save </FONT> = permet de conserver le fichier après son traitement.

- <FONT color="blue">map_retention:NN </FONT> = permet d’ajouter un délai de rétention (en jours) dans les attributs du spool.


Exemple : les commandes suivantes ajoutent un spool en attente dans la file d’attente INPUT_DATA appartenant à l’utilisateur mapadmin qui possède un délai de rétention de 15 jours et qui passera en état conservé lorsqu’il sera traité.



Sous Windows:

 "C:\M-Processing Server\Applications\map_lp" "-queue:INPUT_DATA" "-map_hold" "-map_save" "-map_retention:15"
 "-user:mapadmin" "-data:D:\Data\extract\FR_DEMO.txt"

Sous Linux:

 "/apps/mapping/bin/map_lp" "-queue:INPUT_DATA" "-map_hold" "-map_save" "-map_retention:15"
 "-user:mapadmin" "-data:/opt/data/extract/FR_DEMO.txt"


==== MAP_LPR en disant : ====

Il s’agit d’une communication réseau d’impression standard. Les données envoyées à ONYX Server par ce protocole LPR sont réceptionnées en local par le programme <FONT color="blue"> map_lpd</FONT> puis ce dernier ordonne au Spooler d’insérer le document dans la bonne file d’attente.

Trois paramètres sont requis pour cette commande :

- <FONT color="blue"> server :NNN.NNN.NNN.NNN </FONT> = adresse IP (ou nom DNS) du serveur ONYX.

- <FONT color="blue">queue:XXX </FONT> = nom de la file d’attente dans laquelle le fichier sera envoyé.

- <FONT color="blue">data:XXX </FONT> = chemin complet du fichier à envoyer.

De plus, suivant la configuration, le server d’écoute LPD d'ONYX Server n’utilise pas forcément le port 515 (port d’impression standard donc peut-être déjà utilisé par une autre application). Dans ce cas, il faudra préciser le port réseau Mapping par l’argument : <FONT color="blue"> -port:NNN </FONT>.

D’autres paramètres sont disponibles sur cette commande (argument --help pour les lister), les plus courants étant identiques à la commande <FONT color="blue"> map_lp </FONT>.


Exemple : les commandes suivantes ajoutent un spool en attente dans la file d’attente INPUT_DATA appartenant à l’utilisateur mapadmin qui possède un délai de rétention de 15 jours et qui passera en état conservé lorsqu’il sera traité.


Sous Windows:
 "C:\App\Mapping_client\map_lpr" "-server:192.168.217.57" "-queue:INPUT_DATA" "-map_hold" "-map_save" "-map_retention:15"   
 "-user:mapadmin" "-data:D:\Data\extract\FR_DEMO.txt"

Sous Linux:
 "/apps/mapping_client/map_lpr" "-server:192.168.217.57" "-queue:INPUT_DATA" "-map_hold" "-map_save" "-map_retention:15"    
 "-user:mapadmin" "-data:/opt/data/extract/FR_DEMO.txt"