ONYX - 9.0 - Utilisation - Guide de prise en main ONYX Server/en

Différence entre versions

De MappingDoc
(Page créée avec « *This parameter is optional. If not specified the root Workflow is executed by default. »)
 
(396 révisions intermédiaires par le même utilisateur non affichées)
Ligne 4 : Ligne 4 :
 
==Software==
 
==Software==
  
ONYX Server is the production engine of the Mapping Suite on Linux and Windows. Apart from their specific features (file system, user rights management), the values, configuration, the way the engine works and is used are identical on both platforms.
+
ONYX Server is the production engine of the Mapping Suite on Linux and Windows. Apart from their specific features (file system, user rights management), the philosophy, configuration, the way the engine works and is used are identical on both platforms.
  
 
The ONYX Server engine mainly relies on its job manager (called Spooler or Output Manager), a scheduler which processes, prints and distributes documents, from their input into the engine to their output towards the end users. Combined with the Mapping Spooler, the Workflows engine allows you to automate the entire output production chain as well as all the processings to run on documents: data extraction, graphical formatting and mapping, indexing, sorting / splitting, routing, omnichannel distribution, etc.
 
The ONYX Server engine mainly relies on its job manager (called Spooler or Output Manager), a scheduler which processes, prints and distributes documents, from their input into the engine to their output towards the end users. Combined with the Mapping Spooler, the Workflows engine allows you to automate the entire output production chain as well as all the processings to run on documents: data extraction, graphical formatting and mapping, indexing, sorting / splitting, routing, omnichannel distribution, etc.
Ligne 21 : Ligne 21 :
 
To access the ONYX Server Web interface, the DNS name or IP address of the server as well as the HTTP port used for Mapping (8002 on a "Typical" installation) must be known. The adress which needs to be typed in your browser uses this syntax: [http://192.168.216.57:8002 http://192.168.216.29:8002]
 
To access the ONYX Server Web interface, the DNS name or IP address of the server as well as the HTTP port used for Mapping (8002 on a "Typical" installation) must be known. The adress which needs to be typed in your browser uses this syntax: [http://192.168.216.57:8002 http://192.168.216.29:8002]
 
[[Fichier:OX S auth.png|centré|700x700px]]
 
[[Fichier:OX S auth.png|centré|700x700px]]
Access to the ONYX Server Web interface is controlled and secured. Although it is possible to interface ONYX Server with an Active Directory directory service or an existing LDAP, the first login to the interface is done through the Apache server, with the admin account of the solution which was specified upon installation of the software, that is to say "'''mapadmin'''" by default:
+
Access to the ONYX Server Web interface is controlled and secured. Although it is possible to interface ONYX Server with an Active Directory service or an existing LDAP, the first login to the interface is done through the Apache server, with the admin account of the solution which was specified upon installation of the software, that is to say "'''mapadmin'''" by default:
 
[[Fichier:OX S id.png|centré]]
 
[[Fichier:OX S id.png|centré]]
 
<br />
 
<br />
Ligne 32 : Ligne 32 :
  
 
*Development Menu (1): Manages M-Connect and M-Designer formats, gives access to customised menus to go along with M-Connect formats
 
*Development Menu (1): Manages M-Connect and M-Designer formats, gives access to customised menus to go along with M-Connect formats
*Administration Menu (2): Manages the overall configuration of the solution, manages access rights, creates input points, managing rules (Workflows), output printers and document distribution rules, manages roll-outs between ONYX Server servers
+
*Administration Menu (2): Manages the overall configuration of the solution, manages access rights, creates entry points, managing rules (Workflows), output printers and document distribution rules, manages roll-outs between ONYX Server servers
 
*Operations Menu (3): Manages jobs, queues, access to event logs
 
*Operations Menu (3): Manages jobs, queues, access to event logs
  
Ligne 82 : Ligne 82 :
 
=Administration Menu=
 
=Administration Menu=
  
This menu gives access to the configuration of the solution, the creation and administration of ONYX Server input points (Scanfolder robots, listening servers, processing queues), execution and routing rules (Workflows), output points and distribution of documents.
+
This menu gives access to the configuration of the solution, the creation and administration of ONYX Server entry points (Scanfolder robots, listening servers, processing queues), execution and routing rules (Workflows), output points and distribution of documents.
  
 
The main screens are the only ones regarded in this documentation, for more information see the User Guide of the solution.
 
The main screens are the only ones regarded in this documentation, for more information see the User Guide of the solution.
Ligne 96 : Ligne 96 :
 
==Managing robots==
 
==Managing robots==
  
This screen can manage all the "robots" configured in the solution, whether they are Scanfolder robots or listening Servers. Upon first installation, the list of robots is blank but it gives access to the creation / editing screen for new input points in ONYX Server:
+
This screen can manage all the "robots" configured in the solution, whether they are Scanfolder robots or listening Servers. Upon first installation, the list of robots is blank but it gives access to the creation / editing screen for new entry points in ONYX Server:
 
[[Fichier:OX S robots.png|centré|896x896px]]
 
[[Fichier:OX S robots.png|centré|896x896px]]
  
Ligne 111 : Ligne 111 :
 
====Creating / Editing / Deleting====
 
====Creating / Editing / Deleting====
  
This screen gives you access to the list of robots which are already configured, each robot can be edited if necessary (and if it is not currently running). The last bloc which contains two blank lines allows you to create a new Scanfolder robot:
+
This screen gives you access to the list of robots which are already configured, each robot can be edited if necessary (and if it is not currently running). The last block which contains two blank lines allows you to create a new Scanfolder robot:
 
[[Fichier:OX S robotsConfig.png|centré|1035x1035px]]
 
[[Fichier:OX S robotsConfig.png|centré|1035x1035px]]
  
Ligne 149 : Ligne 149 :
 
*This parameter is required.
 
*This parameter is required.
 
*'''Stop''': the robot stops, the file in error status stays in the monitored folder.
 
*'''Stop''': the robot stops, the file in error status stays in the monitored folder.
*'''Continue ''': the robot continues to process the next files, the file in error status stays in the monitored folder, renamed with the suffix " _FAILED " (Mapping keyword to prevent the robot from processing this file again during the next folder scan).
+
*'''Continue''': the robot continues to process the next files, the file in error status stays in the monitored folder, renamed with the suffix " _FAILED " (Mapping keyword to prevent the robot from processing this file again during the next folder scan).
 
*'''Retry''': the robot continues to process the next files, the file in error status stays in the monitored folder. The robot will try to process the file again next time it scans the folder.
 
*'''Retry''': the robot continues to process the next files, the file in error status stays in the monitored folder. The robot will try to process the file again next time it scans the folder.
  
Ligne 156 : Ligne 156 :
 
*This parameter is optional. If not specified the root Workflow is executed by default.
 
*This parameter is optional. If not specified the root Workflow is executed by default.
  
'''Filtre''' : permet d’exclure des fichiers des scrutations du robot.
+
'''Filter''': excludes files from being scanned by the robot.
  
*Ce paramètre est optionnel.
+
*This parameter is optional.
*Exemple : *.tmp les fichiers d’extension .tmp dans le répertoire scruté ne seront pas traités par le robot.
+
*Example: *.tmp files in the monitored folder are not processed by the robot.
  
'''Accept''' : permet de restreindre le type de fichiers à traiter.
+
'''Accept''': limits the type of files to process.
  
*Ce paramètre est optionnel.
+
*This parameter is optional.
*Exemple : *.xml seuls les fichiers d’extension .xml dans le répertoire scruté seront traités par le robot.
+
*Example: only *.xml files in the monitored folder are processed by the robot.
  
Pour créer un nouveau robot, renseigner l’ensemble des paramètres désirés, puis cliquer sur le bouton [[Fichier:OX S Save 2.png|sans_cadre]] pour ajouter le robot à la configuration du serveur.
+
To create a new robot, specify all the parameters needed then click on the [[Fichier:OX S Save 2.png|sans_cadre]] button to add the robot to the server configuration.
  
Pour modifier un robot existant, modifier le ou les paramètres désirés, puis cliquer sur le bouton[[Fichier:OX S Save 2.png|sans_cadre]] pour modifier le robot dans la configuration du serveur.
+
To edit an existing robot, edit it or the parameters concerned then click on the [[Fichier:OX S Save 2.png|sans_cadre]] button to edit the robot in the server configuration.
  
<u>Remarque</u> : Pour modifier un robot, celui-ci doit être arrêté.
+
<u>Note</u>: A robot must be stopped for you to edit it.
  
Pour supprimer un robot existant, cliquer sur le bouton[[Fichier:OX S icone delete.png]]. Le robot sera supprimé de la configuration du serveur.
+
To delete an existing robot, click on the [[Fichier:OX S icone delete.png]] button. The robot will be deleted from the server configuration.
  
<u>Remarque</u> : Pour supprimer un robot, celui-ci doit être arrêté.
+
<u>Note</u>: A robot must be stopped for you to delete it.
  
====Exploitation====
+
====Usage====
  
Une fois les robots créés et configurés, ils apparaissent dans l’écran de gestion :
+
Once the robots created and configured, they appear on the managing screen:
 
[[Fichier:OX S startRobots.png|centré|766x766px]]
 
[[Fichier:OX S startRobots.png|centré|766x766px]]
  
  
Cet écran permet de :
+
This screen allows you to:
  
*Démarrer un robot : [[Fichier:OX S strt rbt.png]]
+
*Start a robot: [[Fichier:OX S strt rbt.png]]
*Arrêter un robot : [[Fichier:OX S stp rbt.png]]
+
*Stop a robot: [[Fichier:OX S stp rbt.png]]
*Consulter les journaux d’événements d’un robot : [[Fichier:OX S infos rbt.png]]
+
*See the log of a robot: [[Fichier:OX S infos rbt.png]]
  
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 '''map_scanfolder''', la liste des processus actifs du système (Gestionnaire de Tâches sous Windows, commande '''ps –ef''' sous Unix) montrera autant de processus map_scanfolder[.exe] qu’il y a de robots démarrés.
+
Once started, a robot is a process which is continuously executed as a background task. The ONYX Server binary which is associated with it is '''map_scanfolder''', the list of active system processes (Task Manager under Windows, '''ps –ef''' command under Unix) will display as many map_scanfolder[.exe] processes as there are robots started.
  
'''Remarque Windows :'''
+
'''Note:'''
  
Sous Windows, les robots s’installent en tant que Service 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), sur le répertoire scruté sinon (d’où là encore l’unicité requise). Exemple : Mapping_ScanFolder_SCAN_TXT.
+
Under Windows, robots are installed as Services in the Windows Service Manager. This is registered the first time the robot is started. The corresponding Service is named based on the name of the robot if specified (which is why the names of the robot must be different) in the monitored folder (which is why the names of the folders must be different). Example: 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.
+
Each Windows Service created by the robot is configured in manual start by default, this can be switched to an automatic system start afterwards.
  
'''<u>Fichiers temporaires associés aux robots :</u>'''
+
'''<u>Temporary files associated with the robots:</u>'''
  
Une fois démarré, chaque robot crée deux fichiers dans le répertoire temporaire de 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 suffixé de « map_scanfolder.ID ». Exemple : E__InputData_TXT_map_scanfolder.ID
+
Once started, each robot creates two files in the ONYX Server temporary folder. The first one is named based on the name of the monitored folder, special characters are replaced with ‘_’, and the suffix " map_scanfolder.ID " is added. Example: E__InputData_TXT_map_scanfolder.ID
  
Le deuxième est nommé par le numéro système du processus map_scanfloder[.exe] associé. Exemple : 75668.pid.
+
The second one is named with the system number of the associated process map_scanfloder[.exe]. Example: 75668.pid.
  
Ces fichiers sont à usage interne au processus uniquement et sont supprimés à l’arrêt du robot.
+
These files are intended for internal use of the process only and will be deleted once the robot is stopped.
  
En revanche, l’interface Web s’appuie sur la présence de ces fichiers pour indiquer l’état des robots.
+
However, the Web interface relies on these files to indicate the status of the robots.
  
'''<u>Lignes de commandes utiles :</u>'''
+
'''<u>Useful command lines:</u>'''
  
*Pour démarrer un robot nommé :
+
*To start a robot:
  
Linux (après chargement de l’environnement) :
+
Linux (after the environment was loaded):
  
 
  /apps/mapping/bin/map_scanfolder -name:SCAN_TXT
 
  /apps/mapping/bin/map_scanfolder -name:SCAN_TXT
  
Windows :
+
Windows:
  
 
  E:\MappingWindows\Applications\map_scanfolder.exe -name:SCAN_TXT
 
  E:\MappingWindows\Applications\map_scanfolder.exe -name:SCAN_TXT
  
*Pour arrêter un robot nommé :
+
*To stop a robot:
  
Linux (après chargement de l’environnement) :
+
Linux (after the environment was loaded):
  
 
  /apps/mapping/bin/map_scanfolder -name:SCAN_TXT -stop
 
  /apps/mapping/bin/map_scanfolder -name:SCAN_TXT -stop
  
Windows :
+
Windows:
  
 
  E:\MappingWindows\Applications\map_scanfolder.exe -name:SCAN_TXT -stop
 
  E:\MappingWindows\Applications\map_scanfolder.exe -name:SCAN_TXT -stop
  
*Si le robot n’est pas nommé, il conviendra de passer chacun des paramètres décrivant le robot en argument des commandes précédentes (d’où le conseil quant au nommage des robots).
+
*If the robot is not named, set each parameter that describes the robot as an argument of the previous commands (hence the prior advice on robots unique names)
  
===Serveurs d’Ecoute===
+
===Listening Servers===
  
 
====Introduction====
 
====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 construit localement des 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.
+
*A listening server monitors a network port, searching for received data (data is sent via a remote system by direct transfer in RAW protocol). The robot receives data and builds files locally, it then sends them one by one to the execution engine to be processed according to the rules defined in the Workflows.
*Un robot configuré dans ONYX Server ne peut scruter qu’un et un seul port réseau, un port réseau ne peut être scruté que par un et un seul Serveur d’écoute. Autant de Serveurs d’écoute pourront être créés et configurés, qu’il y a de ports différents à scruter. Chaque robot sera indépendant des autres, plusieurs fichiers pourront ainsi être traités en parallèle par des robots différents.
+
*A robot configured in ONYX Server can only monitor one network port, and a network port can only be monitored by one listening server. There can be as many listening servers created and configured, as there are ports to monitor. Each robot is independent from the others, so several files can be processed by different robots at the same time.
  
====Création / Modification / Suppression====
+
====Creating / Editing / Deleting====
  
L’écran suivant présente la liste des robots déjà configurés, chacun pouvant être modifié si besoin (s’il n’est pas en cours d’exécution). La dernière ligne vierge permet de créer un nouveau Serveur d’écoute :
+
The following screen displays the list of robots which are already configured, each robot can be edited if necessary (if it's not currently being run). The last blank line allows you to create a new listening server:
 
[[Fichier:OX S rawListener.png|alt=|centré]]
 
[[Fichier:OX S rawListener.png|alt=|centré]]
  
  
Paramètres à renseigner pour configurer un serveur d’écoute :
+
Parameters to specify to configure a listening server:
  
'''Nom''' : permet de donner un nom au robot.
+
'''Name''': gives a name to the 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.
+
*This parameter is optional, but it is highly recommended: the name of each robot is an environment variable which can be accessed and used by the Workflows.
*ONYX Server contrôle l’unicité des noms utilisés pour les différents robots.
+
*ONYX Server checks that the names used for the different robots are unique.
  
'''* Port''' : numéro du port réseau écouté par le robot.
+
'''* Port''': number of the network port the robot listens to.
  
*Ce paramètre est requis.
+
*This parameter is required.
*ONYX Server contrôle l’unicité des ports écoutés par les différents robots.
+
*ONYX Server checks that the names of the ports the different robots listen to are unique.
  
'''Séparateur de travaux''' : caractère ou chaine permettant de découper un large flux réseau en plusieurs fichiers.
+
'''Job separator''': character or chain which divides a large network stream into several files.
  
*Ce paramètre est optionnel.
+
*This parameter is optional.
  
'''Clé (début/longueur)''' : permet d’ajouter une information au nom du fichier temporaire construit par le robot.
+
'''Key (start/length)''': adds information to the name of the temporary file built by the robot.
  
*Ces 3 paramètres sont optionnels.
+
*These 3 parameters are optional.
*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 »), en extrayant N caractères (paramètre « longueur »).
+
*The information is searched in the network stream, using a keyword, ignoring X characters after the keyword ("start" parameter), retrieving N characters ("length" parameter).
*Cette information pourra être utilisée dans les Workflows, comme une condition notamment.
+
*This information can be used in the Workflows, notably as a condition.
  
'''Timeout''' : délai d’attente réseau, exprimé en secondes.
+
'''Timeout''': network waiting time, given in seconds.
  
*Ce paramètre est optionnel.
+
*This parameter is optional.
*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.
+
*Prevents the network port from being blocked in case of problem with the stream transmitter: the robot cuts connection after this inactivity period, as it considers the established connection is no longer active.
  
Pour créer un nouveau serveur d’écoute, renseigner l’ensemble des paramètres désirés, puis cliquer sur le bouton [[Fichier:OX S Save 2.png|sans_cadre]] pour l’ajouter à la configuration du serveur.
+
To create a new listening server, fill in all the needed parameters, then, click on the [[Fichier:OX S Save 2.png|sans_cadre]] button to add it to the server configuration.
  
Pour modifier un serveur existant, modifier le ou les paramètres désirés, puis cliquer sur le bouton [[Fichier:OX S Save 2.png|sans_cadre]] pour modifier la configuration du serveur.
+
To change an existing server, edit it or its parameters, then, click on the [[Fichier:OX S Save 2.png|sans_cadre]] button to edit the server configuration.
  
<u>Remarque</u> : Pour modifier un serveur, celui-ci doit être arrêté.
+
<u>Note</u>: The server must be stopped for you to change it.
  
Pour supprimer un serveur d’écoute existant, cliquer sur le bouton [[Fichier:OX S icone delete.png]]. Le robot sera supprimé de la configuration du serveur.
+
To delete an existing listening server, click on the [[Fichier:OX S icone delete.png]] button. The robot is then deleted from the server configuration.
  
<u>Remarque</u> : Pour supprimer un robot, celui-ci doit être arrêté.
+
<u>Note</u>: The robot must be stopped for you to delete it.
  
====Exploitation====
+
====Usage====
  
Une fois les robots créés et configurés, ils apparaissent dans l’écran de gestion :
+
Once created and configured, the robots appear on the managing screen:
 
[[Fichier:OX S startListener.png|alt=|centré]]
 
[[Fichier:OX S startListener.png|alt=|centré]]
  
  
Cet écran permet de :
+
This screen allows you to:
  
*Démarrer un serveur d’écoute : [[Fichier:OX S strt rbt.png]]
+
*Start a listening server: [[Fichier:OX S strt rbt.png]]
*Arrêter un serveur d’écoute : [[Fichier:OX S stp rbt.png]]
+
*Stop a listening server: [[Fichier:OX S stp rbt.png]]
*Consulter les journaux d’événements d’un serveur d’écoute : [[Fichier:OX S infos rbt.png]]
+
*See the log of a listening server: [[Fichier:OX S infos rbt.png]]
  
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 '''map_rawd''', la liste des processus actifs du système (Gestionnaire de Tâches sous Windows, commande '''ps –ef''' sous Unix) montrera autant de processus map_rawd[.exe] qu’il y a de serveurs d’écoute démarrés.
+
Once started, a listening server is a process which is continuously executed as a background task. The associated ONYX Server binary is '''map_rawd''', the list of active system processes (Task Manager under Windows, '''ps –ef''' command under Unix) will display as many map_rawd[.exe] processes as there are listening servers started.
  
'''Remarque Windows :'''
+
'''Note:'''
  
Sous Windows, les serveurs d’écoute s’installent en tant que Service 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.
+
Under Windows, listening servers are installed as Services in the Windows Service Manager. This is registered the first time the robot is started. The corresponding Service is named base on the name of the network port the robot listens to (which is why the names of the ports must be different) in the job separator. Example: 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.
+
Each Windows Service created by the robot is configured in manual start by default, this can be switched to an automatic system start afterwards.
  
'''<span class="underline">Fichier temporaire associé aux serveurs d’écoute :</span>'''
+
'''<span class="underline">Temporary files associated with the listenign servers</span>'''
  
Chaque serveur d’écoute, une fois démarré, crée un dossier dans le répertoire temporaire de ONYX Server, 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 : …\Temp\map_rawd_25006_SEP\map_rawd.ID.
+
Once started, each listening server creates a file in the ONYX Server temporary folder. It is named based on the name of the network port it listens to as well as the name of the job separator, with a map_rawd.ID file which includes the number of the associated process. Example: …\Temp\map_rawd_25006_SEP\map_rawd.ID.
  
'''<span class="underline">Lignes de commandes utiles :</span>'''
+
'''<span class="underline">Useful command lines:</span>'''
  
*Pour démarrer un robot nommé :
+
*To start a robot:
  
Linux (après chargement de l’environnement) :
+
Linux (after the environment was loaded):
  
 
  /apps/mapping/bin/map_rawd -start -name:RAW_25006
 
  /apps/mapping/bin/map_rawd -start -name:RAW_25006
  
Windows :
+
Windows:
  
 
  E:\MappingWindows\Applications\map_rawd.exe -start -name:RAW_25006
 
  E:\MappingWindows\Applications\map_rawd.exe -start -name:RAW_25006
  
*Pour arrêter un robot nommé :
+
*To stop a robot:
  
Linux (après chargement de l’environnement) :
+
Linux (after the environment was loaded):
  
 
  /apps/mapping/bin/map_rawd -stop -name:RAW_25006
 
  /apps/mapping/bin/map_rawd -stop -name:RAW_25006
  
Windows :
+
Windows:
  
 
  E:\MappingWindows\Applications\map_rawd.exe -stop -name:RAW_25006
 
  E:\MappingWindows\Applications\map_rawd.exe -stop -name:RAW_25006
  
*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 quant au nommage des robots).
+
*If the robot is not named, set each parameter that describes the robot (listening port and job separator) as an argument of the previous commands (hence the prior advice on robots unique names)
  
==Gestion du Spooler==
+
==Managing the Spooler==
  
Comme évoqué précédemment, le Spooler Onyx Serveur 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 :
+
As mentioned previously, the Onyx Server Spooler is the heart of the solution. It is a real stream, processing and printer manager. The interface displayed when navigating through the Administration Menu, to Managing print jobs, and finally Managing the Spooler, allows you to:
  
*Démarrer le Spooler
+
*Start the Spooler
*Arrêter le Spooler
+
*Stop the Spooler
*Consulter les statistiques d’éditions
+
*See output production statistics
*Consulter les rapports d’utilisation de la solution
+
*See solution usage reports
  
 
[[Fichier:OX S Spooler.png|alt=|centré]]
 
[[Fichier:OX S Spooler.png|alt=|centré]]
  
  
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 '''map_daemon[.exe]'''.
+
Once started, the Spooler is a process which is continuously executed as a background task. The associated Onyx Server binary is '''map_daemon[.exe]'''.
  
'''Remarque Windows :'''
+
'''Note:'''
  
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.
+
Under Windows, the Spooler is installed as a Service in the Windows Service Manager. This is registered the first time the Spooler is started. The corresponding Service is named Mapping_Spooler. It is configured in manual start by default, but this can be switched to an automatic system start afterwards.
  
'''<span class="underline">Fichier temporaire associé au Spooler :</span>'''
+
'''<span class="underline">Temporary files associated with the Spooler:</span>'''
  
Une fois démarré, le Spooler crée un fichier « map_daemon.ID » dans son répertoire de l’installation de Onyx Server : C:\ProgramData\MappingWindows\Spooler par défaut sous Windows, /apps/mapping/spool par défaut sous Linux.
+
Once started, the Spooler creates a "map_daemon.ID" file in in its OnyxServer installation folder: C:\ProgramData\MappingWindows\Spooler by default under Windows, /apps/mapping/spool by default under Linux.
  
'''<span class="underline">Lignes de commandes utiles :</span>'''
+
'''<span class="underline">Useful command lines:</span>'''
  
*Pour démarrer le Spooler :
+
*To start the Spooler:
  
Linux (après chargement de l’environnement) :
+
Linux (after the environment was loaded):
  
 
  /apps/mapping/bin/map_daemon start
 
  /apps/mapping/bin/map_daemon start
  
Windows :
+
Windows:
  
 
  E:\MappingWindows\Applications\map_daemon.exe start
 
  E:\MappingWindows\Applications\map_daemon.exe start
  
*Pour arrêter le Spooler :
+
*To stop the Spooler:
  
Linux (après chargement de l’environnement) :
+
Linux (after the environment was loaded):
  
 
  /apps/mapping/bin/map_daemon stop
 
  /apps/mapping/bin/map_daemon stop
  
Windows :
+
Windows:
  
 
  E:\MappingWindows\Applications\map_daemon.exe stop
 
  E:\MappingWindows\Applications\map_daemon.exe stop
  
==Gestion des Sites et Files d’attente==
+
==Managing Sites and Queues==
  
En naviguant dans le Menu d’Administration, puis Gestion des Impressions, et enfin Gestion des Queues / Devices / Entrées, l’interface affichée présente la liste de toutes les files d’attente configurées dans le Spooler, éventuellement organisées par sites :
+
The interface displayed when navigating through the Administration Menu, to Managing print jobs, and finally Managing Queues / Devices / Input, gives you access to the list of all queues configured in the Spooler, potentially being organised per site:
 
[[Fichier:OX S SitesAndEntryPoints.png|alt=|centré]]
 
[[Fichier:OX S SitesAndEntryPoints.png|alt=|centré]]
  
  
Ici par exemple, un site « SAMPLE » a été déclaré, dans lequel 3 files d’attente (une entrée et deux sorties) sont configurées. Puis 3 autres files d’attente sont déclarées hors site, affichées dans un site par défaut appelé Principal (ou Main).
+
Here for example, a "SAMPLE" site was declared in which 3 queues (one input queue and two output queues) are configured. 3 other queues are declared outside of sites and displayed in a default site called Main.
  
Depuis cette interface, il est possible, à l’intérieur de chaque site, de :
+
Using this interface, inside each site, you can:
  
[[Fichier:OX S iconeS.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_site.png]] Créer un site. Les sites ne sont qu’une manière logique d’organiser les files d’attente
+
[[Fichier:OX S iconeS.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_site.png]] Create a site. Sites are a logical way of organising queues
  
[[Fichier:OX S iconeF.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_printer.png]] Créer une file d’attente de sortie, rattachée à une imprimante physique
+
[[Fichier:OX S iconeF.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_printer.png]] Create an output queue linked to a physical printer
  
[[Fichier:OX S FP.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_shell.png]] Créer une file d’attente de traitement personnalisé, exécutant un script (shell) client
+
[[Fichier:OX S FP.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_shell.png]] Create a customised processing queue which executes a client queue (shell)
  
[[Fichier:OX S FM.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_entry.png]] Créer une file d’attente de traitements Mapping, exécutant un Workflow
+
[[Fichier:OX S FM.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_entry.png]] Create a Mapping processing queue which executes a Workflow
  
'''Remarques importantes :'''
+
'''Important notes:'''
  
 
<ul>
 
<ul>
<li><p>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 pourra pas avoir le même nom qu’un site).</p></li>
+
<li><p>All the created and configured objects must have a unique name no matter their type (an output printer must not have the same name as a site).</p></li>
<li><p>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.</p></li></ul>
+
<li><p>Once created and configured, the name of an object cannot be changed anymore. If necessary, the object must be deleted and then recreated.</p></li></ul>
  
===Créer un site===
+
===Creating a 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.
+
Sites allow you to classify Spooler queues so that print jobs can be managed within a hierarchical way. Sites can also be used as display filters or search filters in the operations view.
  
Pour créer un site, cliquer sur le bouton [[Fichier:OX S iconeS.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_site.png]].
+
To create a site, click on the [[Fichier:OX S iconeS.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_site.png]] button.
  
'''Remarque :'''
+
'''Note:'''
  
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é.
+
It is possible to create sites within a site, this allows you to manage a complex tree view. To do so, use the creation button on the line of the concerned site.
  
Dans l’écran de saisie, renseigner chacune des informations suivantes, en les validant par [[Fichier:OX S Save 2.png|sans_cadre]] :
+
Fill in each of the following information in the input screen and validate it by clicking on [[Fichier:OX S Save 2.png|sans_cadre]]:
  
*(1) Un nom pour le site (requis)
+
*(1) Name for the site (required)
*(2) Une description
+
*(2) Description
  
Le paramétrage du site est achevé, il faut enregistrer ce nouveau site en terminant par [[Fichier:OX S OK.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\ok2.png]] (3).
+
Once the site configuration finished, the new site needs to be saved, click on [[Fichier:OX S OK.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\ok2.png]] (3).
 
[[Fichier:OX S createSite.png|alt=|centré]]
 
[[Fichier:OX S createSite.png|alt=|centré]]
 
<br />
 
<br />
  
===Créer un point d’entrée (simple)===
+
===Creating a (simple) input point===
  
Un point d’entrée ONYX Server est une file d’attente chargée d’exécuter des traitements Mapping (Workflows). Il est constitué de deux objets :
+
An ONYX Server input point is a queue which executes Mapping processings (Workflows). It is made up of two objects:
  
*Une file d’attente pour réceptionner les demandes (travaux)
+
*A queue to receive queries (jobs)
*Une &quot;device&quot; ou moteur, pour prendre en charge les demandes et effectuer les traitements
+
*A &quot;device&quot; or engine, to handle queries and carry out processings
  
Pour ajouter un point d’entrée dans un site, cliquer sur le bouton [[Fichier:OX S FM.png|sans_cadre]], sur la ligne du site concerné.
+
To add an input point to a site, click on the [[Fichier:OX S FM.png|sans_cadre]] button, on the line of the concerned site.
  
L’écran de saisie suivant propose plusieurs onglets, seul le premier est détaillé dans ce support. Consulter le Guide Utilisateur pour les options avancées de paramétrage.
+
The following input screen gives you access to several tabs, the first one is the only one this documentation will detail. Refer to the User Guide for more details on the advanced configuration options.
  
Renseigner les informations voulues, en les validant par [[Fichier:OX S Save 2.png|sans_cadre]].
+
Fill in the needed information and validate it by clicking on [[Fichier:OX S Save 2.png|sans_cadre]].
 
[[Fichier:OX S addEntry.png|alt=|centré]]
 
[[Fichier:OX S addEntry.png|alt=|centré]]
  
  
'''File d’attente'''
+
'''Queue'''
  
*(1) Un nom pour la file d’attente (requis)
+
*(1) Name of the queue (required)
*(2) Une description pour la file d’attente
+
*(2) Description of the queue
  
La validation du nom présente le formulaire de création de la device associée.
+
Validating the name of the queue gives you access to the creation form of the associated device.
  
 
'''Device'''
 
'''Device'''
  
*(3) Un nom pour la device associée (requis)
+
*(3) Name of the associated device (required)
*(4) Une description pour la device
+
*(4) Description of the device
  
 
'''Driver'''
 
'''Driver'''
  
*(5) Le type de driver : RULES par défaut, non modifiable (c’est bien le moteur d’exécution qui est appelé)
+
*(5) Type of driver: RULES by default, this cannot be changed (the execution engine is called)
*(6) Le Workflow exécuté, à choisir dans la liste déroulante. Par défaut (‘Default’ ou ‘undefined’), c’est le Workflow root qui sera exécuté.
+
*(6) Executed Workflow, has to be chosen in the drop down menu. By default (‘Default’ or ‘undefined’), the root Workflow is executed.
  
 
'''Monitoring'''
 
'''Monitoring'''
  
*(7) Le comportement de la device sur les erreurs :
+
*(7) Behaviour of the device upon error:
**default ou stop : le traitement en cours s’arrête en erreur, la device s’arrête en erreur.
+
**default or stop: the current processing stops in error status, the device stops in error status.
**continue : le traitement en cours s’arrête en erreur, la device continue avec les demandes suivantes.
+
**continue: the current processing stops in error status, the device continues to process the next queries.
**ignore : le traitement en cours est considéré comme ayant été effectué, la device continue avec les demandes suivantes. <span class="underline">Valeur déconseillée</span>, sauf pour des cas très particuliers.
+
**ignore: the current processing is considered as done, the device continues to process the next queries. <span class="underline">This value is not recommended</span>, except for very specific cases.
*(8) Reprise automatique : si activé, un traitement provoquant une erreur sera relancé
+
*(8) Automatic recovery: if activated, an error inducing processing is relaunched
*Timeout : temps maximum pendant lequel un traitement 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.
+
*Timeout: maximum time during which a processing in error status is relaunched before it is actually considered as being in error status. The behaviour of the device upon error is then taken into account.
  
'''Remarque :'''
+
'''Note:'''
  
La reprise automatique n’est pas forcément conseillée sur les files d’attentes de type point d’entrée. Si un Workflow provoque une erreur, il y a de fortes chances que l’erreur se reproduise tant que le Workflow n’est pas corrigé.
+
Automatic recovery is not necessarily recommended on input queues. If a Workflow triggers an error, it is very likely that this error will keep happening as long as the Workflow is not fixed.
  
Le paramétrage (simple) du point d’entrée est achevé, il faut enregistrer ce nouvel objet en terminant par [[Fichier:OX S OK.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\ok2.png]] (9).
+
Once the (simple) configuration of an input point done, the new object needs to be saved, click on [[Fichier:OX S OK.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\ok2.png]] (9).
  
===Créer une imprimante (simple)===
+
===Creating a (simple) printer ===
  
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 :
+
An ONYX Server printer is a queue which communicates with a physical printer. It is made up of two objects:
  
*Une file d’attente pour réceptionner les demandes d’impression (travaux)
+
*A queue which receives queries (jobs)
*Une &quot;device&quot; ou imprimante, pour prendre en charge les demandes et envoyer les données au matériel physique.
+
*A &quot;device&quot; or printer, which handles queries and sends data to the physical printer.
  
Pour ajouter une imprimante dans un site, cliquer sur le bouton [[Fichier:OX S iconeF.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_printer.png]], sur la ligne du site concerné.
+
To add a printer to a site, click on the [[Fichier:OX S iconeF.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_printer.png]] button on the line of the concerned site.
  
L’écran de saisie suivant propose plusieurs onglets, seul le premier est détaillé dans ce support. Consulter le Guide Utilisateur pour les options avancées de paramétrage.
+
The following input screens give you access to several tabs, the first one is the only one this documentation will detail. Refer to the User Guide for more details on the advanced configuration options.
  
Renseigner les informations voulues, en les validant par [[Fichier:OX S Save 2.png|sans_cadre]].
+
Fill in the needed information and validate it by clicking on [[Fichier:OX S Save 2.png|sans_cadre]].
 
[[Fichier:OX S addPrinter.png|alt=|centré]]
 
[[Fichier:OX S addPrinter.png|alt=|centré]]
  
  
'''File d’attente'''
+
'''Queue'''
  
*(1) Un nom pour la file d’attente (requis)
+
*(1) Name for the queue (required)
*(2) Une description pour la file d’attente
+
*(2) Description for the queue
  
La validation du nom présente le formulaire de création de la device associée.
+
Validating the name of the queue gives you access to the creation form of the associated device.
  
 
'''Device'''
 
'''Device'''
  
*(3) Un nom pour la device associée (requis)
+
*(3) Name of the associated device (required)
*(4) Une description pour la device
+
*(4) Description of the device
*(5) Backup : si activé, permet de créer une imprimante de secours, qui prendra automatiquement le relais d’une imprimante principale en erreur.
+
*(5) Backup: if activated this allows you to create a backup printer which will automatically replace the main printer in case of error.
  
 
'''Driver'''
 
'''Driver'''
  
*(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 (consulter le Guide Utilisateur pour les autres protocoles).
+
*(6) Connection: Onyx Server implements several types of communication protocols, the LPR protocol is the most used here (refer to the User Guide for more details on the other protocols).
*(7) Type d’impression : « default » signifie que le matériel adressé est une imprimante physique, « MAPPING » signifie une communication avec une autre Spooler Onyx Server (distant), et permet d’activer la compression des flux échangés.
+
*(7) Print job: "default" indicates a link to a physical printer, "MAPPING" indicates a communication with another (remote) Onyx Server Spooler and allows you to activate the compression of streams.
*(8) Compatibilité XPS : 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.
+
*(8) XPS compatibility: allows you to communicate with the linked physical printer in its direct printing language. The XPS streams are converted on the fly according to the selected profile then sent to the printer. This operation does not depend on any driver.
*(9) Adresse IP de l’imprimante physique
+
*(9) IP address of the physical printer
*(10) Nom interne de l’imprimante physique : PASS en général si elle est connectée directement au réseau, nom du port sur le boîtier (HP JetDirect par exemple) si utilisé pour connecter l’imprimante au réseau.
+
*(10) Internal name of the physical printer: generally PASS if it is directly linked to the network, or the name of the port on the box (HP JetDirect for instance) if it is used to link the printer to the network.
*(11) Délai : délai d’attente maximum d’une communication réseau.
+
*(11) Time: maximum waiting time for a network communication.
  
'''Statut'''
+
'''Status'''
  
Permet d’interroger l’imprimante physique pour obtenir son statut réel, qui sera affichée dans la vue d’exploitation.
+
This allows you to ask the physical printer for its status, which will be displayed in the operations view.
  
 
'''Monitoring'''
 
'''Monitoring'''
  
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.
+
This allows you to ask the physical printer to control the real status of the print job. This additional communication is detailed in the User Guide, the default parameters are enough for the moment.
  
*(12) Le comportement de la device sur les erreurs :
+
*(12) Behaviour of the device upon error:
**default ou stop : le traitement en cours s’arrête en erreur, la device s’arrête en erreur.
+
**default or stop: the current processing stops in error status, the device stops in error status.
**continue : le traitement en cours s’arrête en erreur, la device continue avec les demandes suivantes.
+
**continue: the current processing stops in error status, the device continues to process the next queries.
**ignore : le traitement en cours est considéré comme ayant été effectué, la device continue avec les demandes suivantes. <span class="underline">Valeur déconseillée</span>, sauf pour des cas très particuliers.
+
**ignore: the current processing is considered as done, the device continues to process the next queries. <span class="underline">This value is not recommended</span>, except for very specific cases.
*(13) Reprise automatique : si activé, une impression provoquant une erreur sera relancée
+
*(13) Automatic recovery: if activated, an error inducing print job is relaunched
**Timeout : 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.
+
**Timeout: maximum time during which the print job in error status is relaunched before it is actually considered as being in error. The behaviour of the device upon error is then taken into account.
**Mode de reprise : en intégralité ou à la page
+
**Recovery mode: in its entirety or per page
  
Le paramétrage (simple) de l’imprimante est achevé, il faut enregistrer ce nouvel objet en terminant par [[Fichier:OX S OK.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\ok2.png]] (14).
+
Once the (simple) configuration of the printer is finished, the new object needs to be saved, click on [[Fichier:OX S OK.png|C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\ok2.png]] (14).
  
===Envoyer un fichier dans une file d’attente===
+
===Sending a file to a queue===
  
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.
+
The ONYX Server Spooler is seen as a 'virtual' printer from a third-party application. Print commands are used to send files to a queue of the Spooler.
  
ONYX Server dispose de ses propres commandes d’impression : '''map_lp''' en local, '''map_lpr''' en distant.
+
ONYX Server has its own print commands: '''map_lp''' locally and '''map_lpr''' remotely.
  
====MAP_LP en local====
+
====MAP_LP locally====
  
Il s’agit d’une requête directe envoyée au Spooler ONYX Server (c’est le programme '''map_daemon''' qui y répond).
+
MAP_LP is a direct query sent to the ONYX Server Spooler (the '''map_daemon''' program answers it).
  
Deux paramètres sont requis pour cette commande :
+
Two parameters are required for this command:
  
-queue:XXX : le nom de la file d’attente dans laquelle le fichier sera envoyé
+
-queue:XXX: the name of the queue in which the file is sent
  
-data:XXX : le chemin complet du fichier à envoyer
+
-data:XXX: the path of the file to send
  
D’autres paramètres sont disponibles sur cette commande (argument --help pour les lister), dont les plus courants :
+
Other parameters are available for this command (argument --help to access the list of parameters), the most common ones are:
  
-title:XXX : permet de donner un titre au document dans la file d’attente, affiché dans la vue d’exploitation
+
-title:XXX: gives a title to the document in the queue, displayed in the operations view
  
-user:XXX : permet de définir le nom d’utilisateur propriétaire du document dans la file d’attente
+
-user:XXX: defines the username of the document owner in the queue
  
-map_hold : le fichier est envoyé avec l’état « en attente » (ne sera traité qu’après libération)
+
-map_hold: the file is sent in "hold" status (it will be processed after)
  
-map_save : permet de conserver le fichier après son traitement
+
-map_save: saves the file after it was processed
  
-map_retention:NN : permet d’ajouter un délai de rétention (en jours) dans les attributs du spool
+
-map_retention:NN: adds a retention time (in days) in the spooled file attributes
  
<u>Exemple :</u> 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é.
+
<u>Example:</u> the following commands add a spooled file in the INPUT_DATA queue which is owned by the mapadmin user. It has a retention time of 15 days and will appear in saved status once processed.
  
Sous Windows :
+
Under Windows:
  
 
  E:\MappingWindows\Applications\map_lp &quot;-queue:INPUT_DATA&quot; &quot;-map_hold&quot; &quot;-map_save&quot;  
 
  E:\MappingWindows\Applications\map_lp &quot;-queue:INPUT_DATA&quot; &quot;-map_hold&quot; &quot;-map_save&quot;  
 
  &quot;-map_retention:15&quot; &quot;-user:mapadmin&quot; &quot;-data:D:\Data\extract\FR_DEMO.txt&quot;
 
  &quot;-map_retention:15&quot; &quot;-user:mapadmin&quot; &quot;-data:D:\Data\extract\FR_DEMO.txt&quot;
  
Sous Linux :
+
Under Linux:
  
 
  /apps/mapping/bin/map_lp &quot;-queue:INPUT_DATA&quot; &quot;-map_hold&quot; &quot;-map_save&quot; &quot;-map_retention:
 
  /apps/mapping/bin/map_lp &quot;-queue:INPUT_DATA&quot; &quot;-map_hold&quot; &quot;-map_save&quot; &quot;-map_retention:
 
  15&quot; &quot;-user:mapadmin&quot; &quot;-data:/opt/data/extract/FR_DEMO.txt&quot;
 
  15&quot; &quot;-user:mapadmin&quot; &quot;-data:/opt/data/extract/FR_DEMO.txt&quot;
  
====MAP_LPR en distant====
+
====MAP_LPR remotely====
  
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 '''map_lpd''', puis ce dernier ordonne au Spooler d’insérer le document dans la bonne file d’attente.
+
MAP_LPR is a standard network print communication. The data sent to Onyx Server via the LPR protocol is received locally by the '''map_lpd''' program, the latter then requests for the Spooler to add the document in the correct queue.
  
Trois paramètres sont requis pour cette commande :
+
Three parameters are required for this command:
  
-server :NNN.NNN.NNN.NNN : adresse IP (ou nom DNS) du serveur Onyx Server
+
-server:NNN.NNN.NNN.NNN: IP address (or DNS name) of the Onyx Server server
  
-queue:XXX : le nom de la file d’attente dans laquelle le fichier sera envoyé
+
-queue:XXX: the name of the queue in which the file is sent
  
-data:XXX : le chemin complet du fichier à envoyer
+
-data:XXX: the path of the file to send
  
De plus, suivant la configuration, le server d’écoute LPD de Onyx Server n’utilise pas forcément le port 515 (port d’impression standard, peut-être déjà utilisé par une autre application). Dans ce cas, il faudra préciser le port réseau Mapping par l’argument : -port:NNN.
+
Moreover, depending on the configuration, the LPD listening server of Onyx Server does not necessarily use the 515 port (standard print port, which may already be used by another application). The Mapping network port must be specified with argument -port:NNN in this case.
  
D’autres paramètres sont disponibles sur cette commande (argument --help pour les lister), les plus courants étant identiques à la commande map_lp.
+
Other parameters are available for this command (argument --help to access the list of parameters), the most common ones being identical to the map_lp command.
  
<u>Exemple :</u> 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é.
+
<u>Example:</u> the following commands add a spooled file in the INPUT_DATA queue which is owned by the mapadmin user. It has a retention time of 15 days and will appear in saved status once processed.
  
Sous Windows :
+
Under Windows:
  
 
  E:\App\Mapping_client\map_lpr -server:192.168.217.57 &quot;-queue:INPUT_DATA&quot; -map_hold -map_save  
 
  E:\App\Mapping_client\map_lpr -server:192.168.217.57 &quot;-queue:INPUT_DATA&quot; -map_hold -map_save  
 
  -map_retention:15 -user:mapadmin  &quot;-data:D:\Data\extract\FR_DEMO.txt&quot;
 
  -map_retention:15 -user:mapadmin  &quot;-data:D:\Data\extract\FR_DEMO.txt&quot;
  
Sous Linux :
+
Under Linux:
  
 
  /apps/mapping_client/map_lpr -server:192.168.217.57 &quot;-queue:INPUT_DATA&quot; -map_hold -map_save  
 
  /apps/mapping_client/map_lpr -server:192.168.217.57 &quot;-queue:INPUT_DATA&quot; -map_hold -map_save  
 
  -map_retention:15 -user:mapadmin  &quot;-data:/opt/data/extract/FR_DEMO.txt&quot;
 
  -map_retention:15 -user:mapadmin  &quot;-data:/opt/data/extract/FR_DEMO.txt&quot;
  
==Gestion des Workflows==
+
==Managing Workflows==
  
 
===Introduction===
 
===Introduction===
  
Les Workflows composent le Moteur d’exécution ONYX Server. Un Workflow est défini comme un ensemble de conditions et commandes paramétrables, exécutées lorsqu’un nouveau fichier arrive sur un connecteur d’entrée (robot Scanfolder, serveur d’écoute, point d’entrée, ou par requête Web Service). Les commandes sont traitées séquentiellement : la deuxième commande sera traitée après exécution correcte de la première, jusqu’à la fin du Workflow.
+
Workflows make the ONYX Server execution engine. A Workflow is defined as a set of configurable conditions and commands, executed when a new file is received on an input connector (Scanfolder robot, listening server, entry point, or by Web Service request). Commands are processed one by one: the second command is processed after the first one was processed properly, and so on until the end of the Workflow.
  
Un Workflow se définit graphiquement en connectant différents types d’objet : commandes, conditions et paramètres. Il est nommé de façon unique et doit être attaché à au moins un connecteur pour être actif.
+
A Workflow is defined graphically by linking different types of objects: commands, conditions and parameters. Its name must be unique and it must be linked to at least one connector to be active.
  
Exemple de Workflow :
+
Example of a Workflow:
  
Le Workflow suivant, qui va être construit dans la suite de ce guide :
+
The following Workflow, which is build later in this guide:
  
*Définit un paramètre en lisant une information dans le fichier en entrée
+
*Defines a parameter by reading information in the input file
*Définit une condition en comparant la valeur de ce paramètre avec un mot clé
+
*Defines a condition by comparing the value of this parameter with a keyword
*Définit deux traitements, suivant que la condition est vraie ou fausse
+
*Defines two processings, depending on the condition being true or false
  
Les Workflows sont sauvegardés sur disque dans des fichiers au format XML, dans le sous-répertoire « workflow » du répertoire des règles, pointé par la variable de configuration RULES_PATH.
+
Workflows are saved on disk in XML files, in the "workflow" sub-folder of the rules folder which is pointed by the RULES_PATH configuration variable.
  
Sur l’interface Web de ONYX Server, la page d’administration et configuration des Workflows s’obtient par le Menu d’Administration, puis Gestion des Workflows.
+
On the ONYX Server web interface, the administration and configuration of Workflows is accessed through the Administration Menu, Managing Workflows.
  
<u>Conseil :</u> pour un meilleur confort d’utilisation, le navigateur Firefox est vivement recommandé.
+
<u>Tips:</u> Firefox is recommended as browser for better user experience.
  
===Barre d’outils===
+
===Toolbar===
 
[[Fichier:OX S workflowToolbar.png|alt=|centré]]
 
[[Fichier:OX S workflowToolbar.png|alt=|centré]]
  
  
[[Fichier:OX S iconewrkflw.png|but_new]] Créer un nouveau Workflow. Saisir un nom pour le Workflow, l’extension .rules.xml est automatiquement ajoutée.
+
[[Fichier:OX S iconewrkflw.png|but_new]] Create a new Workflow. Enter the name of the Workflow, the .rules.xml extension is automatically added.
  
[[Fichier:OX S workflowFolder.png|30x30px|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\menu\but_open.jpg]] Ouvrir un Workflow. Sélectionner un Workflow dans la liste.
+
[[Fichier:OX S workflowFolder.png|30x30px|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\menu\but_open.jpg]] Open a Workflow. Select a Workflow in the list.
  
[[Fichier:OX S workflowSave.png|28x28px|but_save.jpg]] Sauvegarder le Workflow actif.
+
[[Fichier:OX S workflowSave.png|28x28px|but_save.jpg]] Save the active Workflow.
  
[[Fichier:OX S workflowSaveAs.png|28x28px|but_saveAs.jpg]] Sauvegarder le Workflow actif sous un autre nom.
+
[[Fichier:OX S workflowSaveAs.png|28x28px|but_saveAs.jpg]] Save the active Workflow under another name.
  
[[Fichier:OX S workflowDelete.png|27x27px|but_delete.jpg]] Supprimer le Workflow actif.
+
[[Fichier:OX S workflowDelete.png|27x27px|but_delete.jpg]] Delete the active Workflow.
  
[[Fichier:OX S workflowCondition.png|28x28px|condition.png]] Insérer une condition dans le Workflow actif. La nouvelle condition sera ajoutée après la boite sélectionnée.
+
[[Fichier:OX S workflowCondition.png|28x28px|condition.png]] Add a condition to the active Workflow. the new condition is added after the selected box.
  
[[Fichier:OX S cmd icone.png|28x28px|but_run.jpg]] Insérer une commande dans le Workflow actif. La nouvelle commande sera ajoutée après la boite sélectionnée.
+
[[Fichier:OX S cmd icone.png|28x28px|but_run.jpg]] Add a command to the active Workflow. the new command is added after the selected box.
  
[[Fichier:OX S iconewrkflwParam.jpg|29x29px|but_set.jpg]] Insérer un paramètre dans le Workflow actif. Le nouveau paramètre sera ajouté après la boite sélectionnée.
+
[[Fichier:OX S iconewrkflwParam.jpg|29x29px|but_set.jpg]] Add a a parameter to the active Workflow. The new parameter is added after the selected box.
  
[[Fichier:OX S workflowReorganize.png|30x30px]] Redessiner le Workflow actif. Permet de redessiner graphiquement le Workflow : alignements des boîtes, des liens, etc…
+
[[Fichier:OX S workflowReorganize.png|30x30px]] Redraw the active Workflow. Graphically redraws the Workflow: aligns boxes, links, etc…
  
[[Fichier:OX S workflowDuplicate.png|27x27px]] Dupliquer un objet. Permet de dupliquer, à l’identique (nom, paramètres, etc.) l’objet sélectionné, sans ses liens.
+
[[Fichier:OX S workflowDuplicate.png|27x27px]] Duplicate an object. Duplicates (name, parameters, etc.) a selected object, without its links.
  
[[Fichier:OX S workflowTables.png|30x30px|but_EditResolve.png]] Gérer les tables de résolution. Permet de créer, modifier et supprimer des tables de résolutions
+
[[Fichier:OX S workflowTables.png|30x30px|but_EditResolve.png]] Manage resolution tables. Creates, edits and deletes resolution tables
  
===Créer un nouveau Workflow===
+
===Creating a new Workflow===
  
Cliquer sur l’icône[[Fichier:OX S iconewrkflw.png|but_new]], nommer le Workflow puis valider :
+
Click on the [[Fichier:OX S iconewrkflw.png|but_new]] icon, give a name to the Workflow and validate by clicking on:
 
[[Fichier:OX S newWrkfl.png|alt=|centré]]
 
[[Fichier:OX S newWrkfl.png|alt=|centré]]
  
  
Le nouveau Workflow s’affiche dans la fenêtre d’édition, avec une première boite, point de départ de la séquence de traitements à venir :
+
The new Workflow is displayed in the editing window, with a first box, starting point of the processing sequence:
 
[[Fichier:OX S createWorkflowFactures.png|alt=|centré]]
 
[[Fichier:OX S createWorkflowFactures.png|alt=|centré]]
 
<br />
 
<br />
  
===Ajouter un Paramètre===
+
===Adding a Parameter===
  
 
====Définition====
 
====Définition====
Ligne 649 : Ligne 649 :
  
  
Les objets de type paramètre permettent de définir la valeur d’un paramètre ou d’en créer un nouveau. Un paramètre peut ensuite être utilisé dans une condition ou une commande. Cela permet la réutilisation d’une valeur dans plusieurs commandes par exemple, tout en ne la définissant qu’une seule fois.
+
The parameter objects allow you to define the value of a parameter or to create a new one. A parameter can then be used as a condition or command. This allows you to reuse a value in several commands for instance, without having to define it each time.
  
====Création / Modification====
+
====Create / Edit====
  
Pour créer un nouveau paramètre, sélectionner la boite après laquelle le nouveau paramètre doit être ajouté, puis cliquer sur l’icône[[Fichier:OX S iconewrkflwParam.jpg|but_set.jpg]]. Pour éditer un paramètre existant, double-cliquer sur la boite correspondante.
+
To create a new parameter, select the box after which the new parameter must be added, then, click on the [[Fichier:OX S iconewrkflwParam.jpg|but_set.jpg]] icon. To edit an existing parameter, double-click on the corresponding box.
  
La fenêtre d’édition de paramètre s’ouvre afin de définir les différents champs :
+
The editing window of the parameter opens to define the different fields:
 
[[Fichier:OX S workflowSetParam.png|alt=|centré]]
 
[[Fichier:OX S workflowSetParam.png|alt=|centré]]
 
<br />
 
<br />
  
*(1) Nom du paramètre à définir (requis)
+
*(1) Name of the parameter to define (required)
*(2) Valeur à affecter (requis)
+
*(2) Value to affect (required)
*(3) Titre de l’objet
+
*(3) Title of the object
*(4) Note (champs libre pour commentaires)
+
*(4) Note (blank field for comments)
  
'''Remarque :'''
+
'''Note:'''
  
Un paramètre sera généralement réutilisé ultérieurement dans le Workflow, dans une condition ou une commande, voire même dans un autre Workflow. Il est conseillé de choisir des noms pertinents quant à l’information véhiculée.
+
A parameter is generally reused afterwards in the Workflow, in a condition or a command, even sometimes in another Workflow. Choosing names that reflect the information transmitted is recommended.
  
====Valorisation====
+
====Value====
  
Pour valoriser le paramètre, différentes méthodes sont disponibles par le menu contextuel sur le champ de saisie :
+
Different methods can be accessed through the context menu to define the value of a parameter in the input field:
  
*'''param''' : valeur dynamique d’un paramètre d’environnement du système, de Onyx Server, du Workflow ou du spool d’entrée
+
*'''param''': dynamic value of a system environment parameter, linked to Onyx Server, the Workflow or the input spooled file
*'''value''' : valeur statique saisie par l’utilisateur
+
*'''value''': static value entered by the user
*'''rulefile''' : valeur dynamique lue dans un fichier texte ou XML (peut être le spool d’entrée, ou tout autre fichier)
+
*'''rulefile''': dynamic value in a text or an XML file (may be the input spooled file, or any other file)
*'''command''' : valeur dynamique résultant de l’exécution d’une commande prédéfinie Onyx Server
+
*'''command''': dynamic value obtained after a predefined Onyx Server command was executed
*'''cmd''' : valeur dynamique résultant de l’exécution d’un script utilisateur
+
*'''cmd''': dynamic value obtained after a user script was executed
*'''SQL''' : valeur dynamique résultant de l’exécution d’une requête SQL (de type SELECT en l’occurrence)
+
*'''SQL''': dynamic value obtained after an SQL request (SELECT type in this case) was executed
*'''resolve''' : valeur dynamique résultant de la recherche dans une table de résolution
+
*'''resolve''': dynamic value obtained after a research in a resolution table
*'''rulefile_multiple''' : permet de définir en une fois plusieurs paramètres valorisés dynamiquement par des informations contenues dans le même fichier en entrée (en mode XML uniquement).
+
*'''rulefile_multiple''': defines several parameters with a dynamic value at once, with information in the same input file (in XML mode only).
  
Suivant le type de champs voulu, une fonction d’aide à la saisie est proposée, affichant une nouvelle interface pour paramétrer la récupération dynamique de la valeur :
+
Depending on the type of field needed, predictive text can be used, this option displays a new interface to configure the dynamic recovery of the value:
  
 
{| class="wikitable"
 
{| class="wikitable"
!'''Type de fonction'''
+
!'''Type of function'''
!'''Contenu'''
+
!'''Content'''
!'''Icone'''
+
!'''Icon'''
!'''Indicateur de type'''
+
!'''Type indicator'''
 
|-
 
|-
|Paramètre
+
|Parameter
|Paramètre de l’application
+
|Parameter of the application
 
|[[Fichier:OX S paramIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_dict.png]]
 
|[[Fichier:OX S paramIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_dict.png]]
|Texte en bleu
+
|Text in blue
 
|-
 
|-
|Aucune
+
|None
|Texte libre ou liste
+
|Free text or list
|aucun
+
|none
|Texte en noir
+
|Text in black
 
|-
 
|-
 
|RuleFile
 
|RuleFile
|Valeur lue dans un fichier de données
+
|Value in a datafile
 
|[[Fichier:OX S rulefileIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_file.png]]
 
|[[Fichier:OX S rulefileIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_file.png]]
|rulefile : keyword(Test)
+
|rulefile: keyword(Test)
 
|-
 
|-
|Commande
+
|Command
|Retour d’une commande prédéfinie
+
|Retrieval of a predefined command
 
|[[Fichier:OX S commandIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_command.png]]
 
|[[Fichier:OX S commandIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_command.png]]
|Command : cutposition
+
|Command: cutposition
 
|-
 
|-
 
|Cmd
 
|Cmd
|Retour d’une ligne commande
+
|Retrieval of a command line
 
|[[Fichier:OX S cmdIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_cmd.png]]
 
|[[Fichier:OX S cmdIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_cmd.png]]
|cmd : chemincomplet...
+
|cmd: completepath...
 
|-
 
|-
 
|SQL
 
|SQL
|Retour d’une requête SQL
+
|Retrieval of an SQL request
 
|[[Fichier:OX S sqlIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_sql.png]]
 
|[[Fichier:OX S sqlIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_sql.png]]
|SQL : Select...
+
|SQL: Select...
 
|-
 
|-
|Table de résolution
+
|Resolution table
|Retour d’une table de résolution
+
|Retrieval of a resolution table
 
|[[Fichier:OX S resolveIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_resolve.png]]
 
|[[Fichier:OX S resolveIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_resolve.png]]
|Resolve : TABLE[PARAM]
+
|Resolve: TABLE[PARAM]
 
|-
 
|-
 
|Rulefile multiple
 
|Rulefile multiple
|Valeurs lues dans un même fichier (XML)
+
|Values in the same file (XML)
 
|[[Fichier:OX S rulefileIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_file.png]]
 
|[[Fichier:OX S rulefileIcon.png|C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_file.png]]
|rulefile_multiple : xml
+
|rulefile_multiple: xml
 
|}
 
|}
  
Chaque fonction d’aide à la saisie associée aux différents types de champs est détaillée dans le Guide Utilisateur de Onyx Server.
+
Every predictive text function and field type is detailed in the Onyx Server User Guide.
  
===Ajouter une Condition===
+
===Adding a Condition===
  
====Définition====
+
====Definition====
  
Les objets de type condition permettent de définir 2 traitements différents en fonction de la validité d’une condition. Les boites conditions sont donc <span class="underline">les seules</span> à avoir 2 sorties :
+
Condition objects define 2 different processings depending on the validity of a condition. Condition boxes are <span class="underline">the only ones</span> which have two outputs:
  
*en bas (''chemin direct'') si la condition est vraie
+
*at the bottom (''direct path'') if the condition is true
*à droite (''chemin détourné'') si la condition est fausse
+
*on the right (''bypath'') if the condition is false
  
 
[[Fichier:OX S wrkflFactures.png]]
 
[[Fichier:OX S wrkflFactures.png]]
  
Une condition est par définition une comparaison entre au moins 2 valeurs. Comme vu précédemment, une valeur peut être un paramètre, une constante, le résultat d’une commande ou d’un script, d’une recherche dans une table de résolution, d’une requête SQL, d’une lecture dans un fichier de données.
+
A condition is defined as a comparison between at least 2 values. As seen previously, a value can be a parameter, a constant, the result of a command or a script, of a research in a resolution table, of an SQL query, of a data file analysis.
  
====Création / Edition====
+
====Create / Edit====
  
Pour créer une nouvelle condition, sélectionner la boite après laquelle la condition doit être ajoutée, puis cliquer sur l’icône[[File:media/image40.png|condition.png]]. Pour éditer une condition existante, double-cliquer sur la boite correspondante.
+
To create a new condition, select the box after which the condition needs to be added, then, click on the [[File:media/image40.png|condition.png]] icon. To edit an existing condition, double-click on the corresponding box.
  
La fenêtre d’édition de condition s’ouvre afin de définir les différents champs :
+
The condition editing window opens so as to define the different fields:
 
[[Fichier:OX S condition.png|alt=|centré]]
 
[[Fichier:OX S condition.png|alt=|centré]]
 
<br />
 
<br />
  
*(1) Nom de l’objet condition
+
*(1) Name of the condition object
*(2) Titre de l’objet
+
*(2) Title of the object
*(3) Outils pour définir la logique de la condition : ajout/suppression d’un filtre, opérateurs logiques AND et OR
+
*(3) Tools to define the logic of the condition: adding/deleting a filter, AND and OR logical operators
*(4) Filtres de condition
+
*(4) Condition filters
*(5) Opérateurs logiques entre les filtres
+
*(5) Logical operators between filters
*(6) Note (champs libre pour commentaires)
+
*(6) Note (blank field for comments)
  
Une condition doit avoir au moins un filtre de condition.
+
A condition needs to have at least one condition filter.
  
'''Conseil :'''
+
'''Tips''':
  
Le champ « Nom de l’objet » (1) est optionnel, mais il est vivement conseillé de le renseigner. En effet, cette information sera reprise dans le journal d’événements associé à l’exécution du Workflow, permettant de facilement identifier les différentes étapes du Workflow.
+
The field "Name of the object" (1) is optional, filling it in is, however, highly recommended. This information appears in the log associated with the Workflow, which allows you to identify the different stages of the Workflow easily.
  
Exemples : « Condition '' failed » si pas de nom, « Condition 'Nom de la condition' success » sinon.''
+
Examples: "Condition '' failed" if no name is provided, otherwise "Condition 'Name of the condition' success".''
  
====Filtre de condition====
+
====Condition filter====
  
La création d’une nouvelle condition propose automatiquement un premier filtre à paramétrer. Un double-clic sur un filtre de condition permet de l’éditer :
+
When creating a new condition you are automatically asked to set a first filter. Double-clicking on a condition allows you to edit it:
 
[[Fichier:OX S conditionParam.png|alt=|centré]]
 
[[Fichier:OX S conditionParam.png|alt=|centré]]
 
<br />
 
<br />
  
*(1) Valeur à comparer
+
*(1) Value to compare
*(2) Opérateur de comparaison
+
*(2) Comparison operator
*(3) Valeur de comparaison
+
*(3) Comparison value
  
Les opérateurs de comparaison disponibles sont :
+
The comparison operators available are:
  
 
<ul>
 
<ul>
<li><p>égal / différent : comparaison alphanumérique stricte entre 2 valeurs</p></li>
+
<li><p>equal to / different from: strict alphanumerical comparison between 2 values</p></li>
<li><p>contient / ne contient pas : recherche alphanumérique d’une valeur dans une autre</p></li>
+
<li><p>contains / does not contain: alphanumerical research of a value in another value</p></li>
<li><p>est vide / n’est pas vide : un paramètre a-t-il ou non une valeur ?</p></li>
+
<li><p>is empty / is not empty: does the parameter have a value?</p></li>
<li><p>supérieur à / supérieur ou égal à : comparaison numérique</p></li>
+
<li><p>greater than / greater than or equal to: numerical comparison</p></li>
<li><p>inférieur à / inférieur ou égal à : comparaison numérique</p></li></ul><p></p>Une condition peut être définie par plusieurs filtres de conditions. Le bouton [[Fichier:OX S iconeajoutcdt.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_add_elt.png]] permet d’ajouter un nouveau filtre de condition.La logique complète entre ces filtres est définie graphiquement en utilisant les cases à cocher devant chaque filtre et les outils [[Fichier:OX S operateurAND.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_and_elt.png]] et [[Fichier:OX S operateurOR.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_or_elt.png]]. Dans l’exemple, la logique de condition vaut : filtre A et (filtre B ou filtre C). Enfin, le bouton [[Fichier:OX S deletecdt.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_del_elt.png]] permet de supprimer un filtre de condition sélectionné, ou une logique de condition (et ses filtres associés) sélectionnée.
+
<li><p>less than/ less than or equal to: numerical comparison</p></li></ul><p></p>A condition can be defined by multiple condition filters. The [[Fichier:OX S iconeajoutcdt.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_add_elt.png]] button allows you to add a new condition filter. The logic between these filters is defined graphically using the boxes to tick before each filter and the [[Fichier:OX S operateurAND.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_and_elt.png]] and [[Fichier:OX S operateurOR.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_or_elt.png]] tools. In this example, the condition logic is defined by: filter A and (filter B or filter C). The [[Fichier:OX S deletecdt.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_del_elt.png]] button allows you to delete a selected condition filter, or a selected condition logic (and the associated filters).
  
===Ajouter une Commande===
+
===Adding a Command===
  
====Définition====
+
====Definition====
 
[[Fichier:OX S cmdDesigner.png|alt=|centré]]
 
[[Fichier:OX S cmdDesigner.png|alt=|centré]]
Les objets de type commande permettent d’exécuter un traitement unitaire. Un même Workflow comportera autant de commandes qu’il y a de traitements à effectuer.
+
Commands allow you to run unitary processings. The Workflow includes as many commands as there are processings to run.
  
Les objets de type commande permettent d’exécuter 4 grandes familles de traitements : des commandes prédéfinies natives Onyx Server, des scripts utilisateurs, des requêtes SQL, ou des appels à d’autres Workflows.
+
Commands allow you to run the 4 main groups of processings: predefined Onyx Server commands in direct language, user scripts, SQL queries, or calls to other Workflows.
  
====Création / Edition====
+
====Create / Edit====
  
Pour créer une nouvelle commande, sélectionner la boite après laquelle la commande doit être ajoutée, puis cliquer sur l’icône[[Fichier:OX S cmd icone.png|but_run.jpg]]. Pour éditer une commande existante, double-cliquer sur la boite correspondante. La fenêtre d’édition de commande s’ouvre afin de définir les différents champs :
+
To create a new command, select the box after which the command needs to be added, then, click on the [[Fichier:OX S cmd icone.png|but_run.jpg]] icon. To edit an existing command, double-click on the corresponding box. The command editing window opens so as to define the different fields:
 
[[Fichier:OX S cmdCopy.png|alt=|centré]]
 
[[Fichier:OX S cmdCopy.png|alt=|centré]]
 
<br />
 
<br />
  
*(1) Type de traitement, parmi : Command, Cmd, Sql, Call
+
*(1) Type of processing: Command, Cmd, Sql or Call
*(2) Nom de l’objet
+
*(2) Name of the object
*(3) Titre de l’objet
+
*(3) Title of the object
*(4) Sélecteur d’un groupe de commandes prédéfinies
+
*(4) Selector of a group of predefined commands
*(5) Sélecteur de la commande prédéfinie à exécuter
+
*(5) Selector of the predefined command to run
*(6) Paramètres de la commande :
+
*(6) Parameters of the command:
**Présente l’ensemble des paramètres requis ou optionnels pour la bonne exécution de la commande
+
**Displays all the required or optional parameters for the command to be run smoothly
**L’onglet Standard regroupe les paramètres principaux de la commande
+
**The Standard tab includes the main parameters of the command
**En fonction des commandes, d’autres onglets spécifiques présentent les paramétrages avancés
+
**Depending on the commands, other specific tabs display advanced parameters
*(7) Note (champs libre pour commentaires)
+
*(7) Note (blank fields for comments)
  
====Les commandes prédéfinies (Command)====
+
====Predefined commands (Command)====
  
Cette première famille de traitement regroupe les commandes &quot;génériques&quot; et natives d'ONYX Server. Elles sont organisées par groupes de commandes en fonction de leur utilisation : Spooler, File, Mapping, XPS Toolbox, Mail…
+
This group of processings includes the &quot;generic&quot; commands and ONYX Server direct language commands. Commands are sorted by groups according to what they are used for: Spooler, File, Mapping, XPS Toolbox, Mail…
  
Parmi les plus utilisées, citons notamment :
+
Amongst the most used ones are:
  
'''Mapping / Text M-Designer :''' application d’un format M-Designer sur un fichier de données en mode texte
+
'''Mapping / Text M-Designer:''' application of a Designer format on a data file in text mode
  
*<span class="underline">Standard :</span>
+
*<span class="underline">Standard:</span>
  
 
<ul>
 
<ul>
<li><p>Nom du format M-Designer à appliquer. La liste des formats importés sur le serveur est disponible par le bouton l’aide à la saisie [[Fichier:OX S format.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_getMapDrawFormat.png]]</p></li>
+
<li><p>Name of the Designer format to use. The list of formats imported on the server can be seen by clicking on the [[Fichier:OX S format.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_getMapDrawFormat.png]] button</p></li>
<li><p>Numéro de séquence (00010, ou *MRG, ou *ALL, etc.)</p></li>
+
<li><p>Sequence number (00010, or *MRG, or *ALL, etc.)</p></li>
<li><p>Fichier d’entrée (le fichier de données)</p></li>
+
<li><p>Input file (data file)</p></li>
<li><p>Fichier de sortie (le document XPS produit)</p></li></ul>
+
<li><p>Output file (finished XPS document)</p></li></ul>
  
*<span class="underline">Advanced :</span>
+
*<span class="underline">Advanced:</span>
  
 
<ul>
 
<ul>
<li><p>Langue de traduction (consulter le Guide Utilisateur de M-Designer pour l’utilisation des traductions)</p></li>
+
<li><p>Translation language (See the Designer User Guide for translations)</p></li>
<li><p>Fichier XPS à incorporer comme calque, avec possibilité de reprendre ses index</p></li></ul>
+
<li><p>XPS file to add as watermark, indexes can also be recovered</p></li></ul>
  
*<span class="underline">Text options :</span>
+
*<span class="underline">Text options:</span>
  
 
<ul>
 
<ul>
<li><p>Nombre de lignes maximum : possibilité de fixer un overflow sur le fichier de données en entrée, et de provoquer un saut de page « automatique »</p></li>
+
<li><p>Maximum number of lines: an overflow can be set on the input data file, an "automatic" page break can also be set.</p></li>
<li><p>Largeur de page : nombre de caractères maximum par ligne à lire dans le fichier de données en entrée</p></li>
+
<li><p>Page width: maximum number of characters per ligne to read in the input data file</p></li>
<li><p>Page de code du fichier en entrée : permet de réaliser une conversion à la volée en Unicode UTF-16 si besoin. La liste des codes pages gérés dans ONYX Server est disponible via le bouton d’aide à la saisie [[Fichier:OX S codePage.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_getcodepage.png]]</p></li></ul>
+
<li><p>Code page of the input file: converts to Unicode UTF-16 on the fly if needed. The list of code pages managed under ONYX Server can be seen by clicking on the [[Fichier:OX S codePage.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_getcodepage.png]] button</p></li></ul>
  
*<span class="underline">Output options :</span>
+
*<span class="underline">Output options:</span>
  
 
<ul>
 
<ul>
<li><p>Page de début / page de fin : intervalle de pages à produire</p></li>
+
<li><p>Start page / end page: interval of pages to produce</p></li>
<li><p>Bac d’entrée / bac de sortie : ajout d’options de finition (PrintTicket) sur le document XPS produit pour la gestion des bacs d’imprimantes</p></li></ul>
+
<li><p>Input bin / output bin: adds finishing options (PrintTicket) to the XPS document produced to manage printer bins</p></li></ul>
  
'''Spooler / Imprimer :''' Envoi d’un spool dans une file d’attente du Spooler
+
'''Spooler / Print:''' sends a spooled file to the Spooler queue
  
*<span class="underline">Standard :</span>
+
*<span class="underline">Standard:</span>
  
 
<ul>
 
<ul>
<li><p>Nom de la file d’attente de destination. La liste des files d’attente déclarées dans le Spooler est disponible par le bouton d’aide à la saisie [[Fichier:OX S queueList.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_getqueue.png]]</p></li>
+
<li><p>Name of the destination queue. The list of queues declared in the Spooler can be seen by clicking on the [[Fichier:OX S queueList.png|C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_getqueue.png]] button</p></li>
<li><p>Nom du fichier à envoyer</p></li>
+
<li><p>Name of the file to send</p></li>
<li><p>Titre : nom donné au spool dans la file d’attente</p></li>
+
<li><p>Title: name of the spooled file in the queue</p></li>
<li><p>Envoyer le spool en état suspendu dans la file d’attente de destination</p></li>
+
<li><p>Send the spooled file to the destination queue in hold status</p></li>
<li><p>Conserver le spool après traitement dans la file d’attente de destination</p></li>
+
<li><p>Keep the spooled file after it was processed in the destination queue</p></li>
<li><p>Conserver les attributs courants : affecter au spool en sortie les attributs du spool en cours</p></li>
+
<li><p>Keep the following attributes: associate the attributes of the current spooled file with the output spooled file</p></li>
<li><p>Ajouter les paramètres courants : affecter au spool en sortie les paramètres de la session en cours</p></li></ul>
+
<li><p>Add common parameters: associate the parameters of the current session with the output spooled file</p></li></ul>
  
*<span class="underline">Page :</span>
+
*<span class="underline">Page:</span>
  
 
<ul>
 
<ul>
<li><p>Page de début / page de fin : positionne les attributs correspondants sur le spool de destination pour son intervalle de traitement</p></li>
+
<li><p>Start page / end page: adds the corresponding attribute to the destination spooled file for its processing interval</p></li>
<li><p>Nombre de copies : positionne l’attribut correspondant sur le spool de destination</p></li></ul>
+
<li><p>Number of copies: adds the corresponding attribute to the destination spooled file</p></li></ul>
  
*<span class="underline">Security :</span>
+
*<span class="underline">Security:</span>
  
 
<ul>
 
<ul>
<li><p>Propriétaire du spool de destination</p></li>
+
<li><p>Owner of the destination spooled file</p></li>
<li><p>Droits d’accès sur le spool de destination</p></li>
+
<li><p>Access rights on the destination spooled file</p></li>
<li><p>Code comptabilité : affectation de l’attribut correspondant</p></li></ul>
+
<li><p>Account code: associates the corresponding attribute</p></li></ul>
  
*<span class="underline">Userdata :</span>
+
*<span class="underline">Userdata:</span>
  
 
<ul>
 
<ul>
<li><p>Possibilité de définir des attributs supplémentaires sur le spool de destination</p></li></ul>
+
<li><p>Additional attributes can be defined on the destination spooled file</p></li></ul>
  
*<span class="underline">Advanced :</span>
+
*<span class="underline">Advanced:</span>
  
 
<ul>
 
<ul>
<li><p>Priorité du spool de destination</p></li>
+
<li><p>Priority of the destination spooled file</p></li>
<li><p>Nombre de jours de conservation du spool de destination</p></li>
+
<li><p>Number of days during which the destination spooled file is stored</p></li>
<li><p>Nombre de jours avant compression du spool de destination (attribut hérité du monde AS/400, parfois utilisé par les applications clientes en amont et en aval)</p></li>
+
<li><p>Number of days before the destination spooled file is compressed (this attribute is inherited from the IBM i environment, it is sometimes used by client applications upstream and downstream)</p></li>
<li><p>Type de support papier</p></li>
+
<li><p>Type of paper</p></li>
<li><p>Fidélité : attribut hérité du monde AS/400 parfois utilisé par certaines applications clientes en amont et en aval</p></li>
+
<li><p>Loyalty: this attribute is inherited from the IBM i environment, it is sometimes used by client applications upstream and downstream</p></li>
<li><p>Nom du fichier spool de destination</p></li></ul>
+
<li><p>Name of the destination spooled file</p></li></ul>
  
La liste exhaustive des commandes prédéfinies ONYX Server est détaillée dans le Guide Utilisateur.
+
The complete list of ONYX Server predefined commands is detailed in the User Guide.
  
====Les scripts utilisateurs (Cmd)====
+
====User scripts (Cmd)====
  
Le mode CMD permet de passer l’objet de type commande en mode éditeur de texte, afin de taper une commande complète, comme il serait fait en mode telnet ou en fenêtre de commandes MS-DOS. Tous les paramètres d’environnement (système et Mapping) ainsi que les attributs du fichier en cours de traitement sont accessibles.
+
The CMD mode allows you to put the command object in text editing mode so as to type a complete command in, as would be done in telnet mode or in MS-DOS command windows. All environment parameters (system and Mapping) and attributes of the file being processed are accessible.
  
La commande exécutée peut être une commande Onyx Server spécifique, et non disponible en commande prédéfinie, ou alors un script (*.bat ou *.sh) complexe.
+
The command being run can be a specific Onyx Server command, which is not available as a predefined command, or a complex script (*.bat or *.sh).
 
[[Fichier:OX S workflowCmd.png|alt=|centré]]
 
[[Fichier:OX S workflowCmd.png|alt=|centré]]
  
====Les requêtes SQL====
+
====SQL queries====
  
Le mode SQL permet de passer l’objet de type commande en mode éditeur de texte afin d’exécuter des ordres SQL. Tous les paramètres d’environnement (système et Mapping) ainsi que les attributs du fichier en cours de traitement sont accessibles. Les paramètres de connexion à la base de données doivent être définis dans la configuration de Onyx Server.
+
The SQL mode allows you to put the command object in text editing mode so as to run SQL orders. All environment parameters (system and Mapping) and attributes of the file being processed are accessible. Parameters to connect to the database must be defined in the Onyx Server configuration.
 
[[Fichier:OX S SQL CMD.png|alt=|centré]]
 
[[Fichier:OX S SQL CMD.png|alt=|centré]]
 
<br />
 
<br />
  
====Les appels à des Workflows (Call)====
+
====Workflows calls (Call)====
  
Le mode CALL permet d’exécuter, dans le Workflow en cours, un autre Workflow, puis de continuer l’exécution du Workflow en cours une fois que le second est correctement terminé. Tous les paramètres d’environnement (système et Mapping) ainsi que les attributs du fichier en cours de traitement sont automatiquement transmis au sous-Workflow, et utilisables dans celui-ci.
+
The CALL mode allows you to run another Workflow in the current workflow, then to continue running the current Workflow once the second one has been correctly processed. All environment parameters (system and Mapping) and attributes of the file being processed are automatically transmitted to the sub-Workflow and can be used in it.
 
[[Fichier:OX S callWorkflow.png|alt=|centré]]
 
[[Fichier:OX S callWorkflow.png|alt=|centré]]
 
<br />
 
<br />
Ligne 911 : Ligne 911 :
 
=Operations Menu=
 
=Operations Menu=
  
Les deux derniers menus de la page d’accueil donnent accès aux deux écrans d’exploitation les plus utilisés de la solution : la gestion des travaux et des imprimantes (contenu du Spooler), et l’accès à l’ensemble des journaux d’événements de la Suite.
+
The last two menus of the home page give you access to the two most used operations screens of the solution: the jobs and printers managing screen (content of the Spooler), and the screen to access all the logs of the solution.
  
==Travaux / Imprimantes==
+
==Jobs/ Printers==
  
Cette première vue d’exploitation se présente sous deux onglets :
+
This first view gives you access to two tabs:
  
*La vue des travaux, qui liste l’ensemble des travaux présents dans le Spooler, dans leurs files d’attente respectives
+
*The jobs view, which lists all the jobs in the Spooler, in their respective queue
*La vue des &quot;imprimantes&quot;, qui liste l’ensemble des files d’attente déclarées dans le Spooler, dans leurs sites respectifs.
+
*The &quot;printers&quot; view, which lists all the queues declared in the Spooler, in their respective sites.
  
===Gestion des Travaux===
+
===Managing Jobs===
  
La navigation dans ce menu « Travaux / Imprimantes » présente directement la vue d’exploitation des travaux du Spooler :
+
Navigating through the "Jobs / Printers" menu gives you directly access to the Spooler jobs view:
 
[[Fichier:OX S jobs.png|alt=|centré]]
 
[[Fichier:OX S jobs.png|alt=|centré]]
  
  
Cette vue se décompose en 3 parties :
+
This view is divided in 3 parts:
  
*La navigation par onglet entre la vue des travaux et la vue des imprimantes
+
*The jobs view and the printers view tabs
  
'''Remarque :'''
+
'''Note:'''
 
<ul>
 
<ul>
<li><p>L’arrivée sur la vue d’exploitation rafraichit automatiquement l’affichage avec les filtres proposés par défaut. La variable d’environnement LOAD_SPOOLS_ON_VIEW (on/off) permet de désactiver ce rafraichissement, pour permettre à l’utilisateur de renseigner ses filtres.</p></li>
+
<li><p>When accessing this first view, the page is automatically refreshed with the default filters. The LOAD_SPOOLS_ON_VIEW (on/off) environment variable allows you to deactivate this refresh so that the user can specify filters.</p></li>
<li><p>La bascule d’un onglet à un autre n'actualise pas la vue automatiquement, de manière à laisser l’opportunité à l’utilisateur de renseigner ses filtres d’affichage avant d’actualiser les résultats</p></li></ul>
+
<li><p>The view is not refreshed automatically when changing from one tab to another so that the user can specify display filters before the results are refreshed</p></li></ul>
  
*Un bandeau de filtres de l’affichage, permettant de limiter le nombre de résultats renvoyés ou d’effectuer une recherche sur un élément précis
+
*A display filter banner, which allows you to limit the number of results or to make a research for a specific element.
  
'''Remarque :'''
+
'''Note:'''
  
Des filtres sont renseignés par défaut à l’arrivée sur la vue : sur le propriétaire des travaux (utilisateur connecté), sur les dates (un jour d’historique). Les filtres peuvent être modifiés, le bouton « Actualiser » actualise la liste des résultats en fonction des filtres renseignés.
+
Filters are specified by default as this first view is displayed: on the jobs owner (logged-in user), on dates (one-day history). The filters can be edited, the "Refresh" button refreshes the list of the results according to the specified filters.
  
*La liste des résultats : tous les travaux correspondant aux différents filtres renseignés, regroupés par site, file d’attente, et état. L’ordre d’affichage des travaux dans chaque groupe d’affichage respecte les priorités affectées à chaque travail, puis les dates d’arrivées dans la file d’attente.
+
*The list of results: all jobs corresponding to the different specified filters, grouped together by site, queue and status. Jobs are displayed in display groups according to their priority level, then, time of input in the queue.
  
Pour chaque travail, les actions suivantes sont accessibles :
+
The following actions can be carried out for each job:
  
[[Fichier:OX S stopPrn.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\littlestopspool.png]] Suspendre le travail. Les travaux en état conservé, en erreur ou en cours de traitement peuvent être suspendus.
+
[[Fichier:OX S stopPrn.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\littlestopspool.png]] Put the job on hold. Jobs with the statuses kept, in error or ongoing processing can be put on hold.
  
[[Fichier:OX S restartPrn.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\littlestartspool.png]] Libérer le travail. Les travaux en état suspendu, conservé ou en erreur peuvent être libérés.
+
[[Fichier:OX S restartPrn.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\littlestartspool.png]] Release the job. Jobs on hold, kept or in error status can be released.
  
[[Fichier:OX S deleteWork.gif|C:\MAPPING\MappingWindows\MapHTTPServer\images\littlecancel.gif]] Supprimer le travail.
+
[[Fichier:OX S deleteWork.gif|C:\MAPPING\MappingWindows\MapHTTPServer\images\littlecancel.gif]] Delete the job.
  
[[Fichier:OX S transferJob.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\transfert.png]] Transférer le travail dans une autre file d’attente.
+
[[Fichier:OX S transferJob.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\transfert.png]] Transfer the job in another queue.
  
[[Fichier:OX S showJob.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\spool_view.png]] Visualiser le contenu du travail.
+
[[Fichier:OX S showJob.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\spool_view.png]] See the content of the job.
  
[[Fichier:OX S printJob.gif|C:\MAPPING\MappingWindows\MapHTTPServer\images\printer.gif]] Imprimer le travail à travers le Web (sous Windows uniquement, permet d’envoyer le travail sur une imprimante déclarée dans le Spooler Windows du poste).
+
[[Fichier:OX S printJob.gif|C:\MAPPING\MappingWindows\MapHTTPServer\images\printer.gif]] Print the job using the Web (only under Windows, this allows you to send the job on a printer declared in the Windows Spooler of the workstation).
  
[[Fichier:OX S pageRecovery.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\reprint_page.png]] Effectuer une reprise de page (pour demander la réimpression du travail de la page 5 à la page 12 par exemple).
+
[[Fichier:OX S pageRecovery.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\reprint_page.png]] Recover pages (this allows you to reprint the job from page 5 to 12 for instance).
  
[[Fichier:OX S infos rbt.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\view_log.png]] Consulter le journal d’événement du travail.
+
[[Fichier:OX S infos rbt.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\view_log.png]] See the job log.
  
[[Fichier:OX S jobAttribute.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\view_info.png]] Afficher les attributs du travail.
+
[[Fichier:OX S jobAttribute.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\view_info.png]] Display job attributes.
  
===Gestion des imprimantes===
+
===Managing printers===
  
Dans la vue précédente, seules les files d’attentes contenant des travaux seront affichées dans les résultats. L’onglet « Imprimantes » permet de lister l’ensemble des files d’attente déclarées dans le Spooler :
+
In this previous view, only the queues which contain jobs are displayed in the results. The "Printers" tab lists all the queues declared in the Spooler:
 
[[Fichier:OX S printers.png|alt=|centré]]
 
[[Fichier:OX S printers.png|alt=|centré]]
  
  
Cette vue suit le même principe de décomposition en trois parties :
+
This view follows the same parting principle as it is divided in three parts:
  
*Les onglets de navigation
+
*The navigation tabs
*Le bandeau de filtres
+
*The filter banner
*La liste des résultats.
+
*The list of results.
  
Pour chaque file d’attente, les actions suivantes sont accessibles :
+
The following actions can be carried out for each job:
  
[[Fichier:OX S Start.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\play.png]] Démarrer une file d’attente (ou une device). Les files d’attentes en état suspendu peuvent être démarrées.
+
[[Fichier:OX S Start.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\play.png]] Start a queue (or device). Queues that are on hold can be started.
  
[[Fichier:OX S Stop.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\stop.png]] Arrêter une file d’attente (ou une device). Les files d’attentes en état démarré peuvent être arrêtées.
+
[[Fichier:OX S Stop.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\stop.png]] Stop a queue (or device). Queues that are started can be stopped.
  
[[Fichier:OX S jobAttribute.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\view_info.png]] Afficher les informations de paramétrage d’une file d’attente (ou d’une device).
+
[[Fichier:OX S jobAttribute.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\view_info.png]] Display the configuration information of the queue (or device).
  
[[Fichier:OX S infos rbt.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\view_log.png]] Consulter le journal d’événement d’une file d’attente.
+
[[Fichier:OX S infos rbt.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\view_log.png]] See the log of the queue.
  
[[Fichier:OX S showJob.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\spool_view.png]] Visualiser les travaux contenus dans une file d’attente. Renvoi sur l’onglet « travaux », avec un filtre activé sur la file d’attente.
+
[[Fichier:OX S showJob.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\spool_view.png]] See the jobs in a queue. This redirects to the "jobs" tab, with a filter activated on the queue.
  
[[Fichier:OX S refreshDevice.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\refresh.png]] Rafraichir l’état d’une device (dans le cas où l’interrogation est paramétrée dans la configuration de la device).
+
[[Fichier:OX S refreshDevice.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\refresh.png]] Refresh device status (if polling is set up in the device configuration).
  
[[Fichier:OX S OK.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\ok2.png]] Réinitialiser une device : permet de redémarrer une device en erreur.
+
[[Fichier:OX S OK.png|C:\MAPPING\MappingWindows\MapHTTPServer\images\ok2.png]] Reboot the device: restarts a device in error status.
  
==Consulter la log==
+
==See the log==
  
Cet écran permet de consulter l’ensemble des journaux d’événements de la solution Onyx Server :
+
This screen allows you to see all the logs of the Onyx Server solution:
 
[[Fichier:OX S logMenu.png|alt=|centré]]
 
[[Fichier:OX S logMenu.png|alt=|centré]]
  
  
Chaque processus ou objet possède son journal :
+
Each process or object has a log:
  
*Le Spooler (map_daemon.log)
+
*The Spooler (map_daemon.log)
*Le serveur d’écoute LPD (map_lpd.log)
+
*The LPD listening server (map_lpd.log)
*Le processus d’écoute des requêtes Web Service (mapsoapserver.log)
+
*The listening process for Web Service queries (mapsoapserver.log)
*Les robots Scanfolder (scan_folder_XXX.log)
+
*The Scanfolder robots (scan_folder_XXX.log)
*Les Serveurs d’écoute Rawd (map_rawd_XXX.log)
+
*The Rawd listening servers (map_rawd_XXX.log)
*Les files d’attente (INPUT_DAT.log par exemple)
+
*The queues (INPUT_DAT.log for instance)
  
Chaque journal d’événement peut être :
+
Each log can be:
  
[[Fichier:OX S showLog.png|C:\PROJETS\Built-Setup\Sources\Branch_v7_2_0\install\AllVersion\httpd\images\littleview.gif]] Consulté (en cliquant également sur le nom du journal)
+
[[Fichier:OX S showLog.png|C:\PROJETS\Built-Setup\Sources\Branch_v7_2_0\install\AllVersion\httpd\images\littleview.gif]] Accessed (by clicking on the name of the log)
  
[[Fichier:OX S txtConvert.png|C:\PROJETS\Built-Setup\Sources\Branch_v7_2_0\install\AllVersion\httpd\images\small_txt_file.png]] Converti au format texte pour affichage dans un éditeur de texte
+
[[Fichier:OX S txtConvert.png|C:\PROJETS\Built-Setup\Sources\Branch_v7_2_0\install\AllVersion\httpd\images\small_txt_file.png]] Converted to text to be displayed in a text editor
  
[[Fichier:OX S xmlConvert.png]] Converti au format XML
+
[[Fichier:OX S xmlConvert.png]] Converted to XML
  
[[Fichier:OX S cleanLog.png|C:\PROJETS\Built-Setup\Sources\Branch_v7_2_0\install\AllVersion\httpd\images\interface_small_cancel_edit.png]] Nettoyé : le journal existe toujours mais son contenu est vidé
+
[[Fichier:OX S cleanLog.png|C:\PROJETS\Built-Setup\Sources\Branch_v7_2_0\install\AllVersion\httpd\images\interface_small_cancel_edit.png]] Cleared: The log still exists but it content is cleared out
  
[[Fichier:OX S deleteWork.gif|C:\MAPPING\MappingWindows\MapHTTPServer\images\littlecancel.gif]] Supprimé
+
[[Fichier:OX S deleteWork.gif|C:\MAPPING\MappingWindows\MapHTTPServer\images\littlecancel.gif]] Deleted
  
Exemple de contenu du journal d’événement d’une file d’attente d’impression :
+
Example of the content of a print queue log:
 
[[Fichier:OX S printLogExample.png|alt=|centré]]
 
[[Fichier:OX S printLogExample.png|alt=|centré]]
  
  
Les trois types d’événement tracés ici sont :
+
The three types of events reported here are:
  
*OK (succès) : Lancement de la commande d’impression (dialogue LPR avec l’imprimante physique, initié par la commande map_lpr)
+
*OK (success): Print command launched (LPR communication with the physical printer, initiated by the map_lpr command)
*EE (erreur) : Erreur de connexion avec l’imprimante : le délai précisé dans la configuration de la file d’attente est atteint avant que la connexion puisse être établie (raison la plus probable : l’imprimante physique est éteinte, ou débranchée du réseau)
+
*EE (error): Connection error to the printer: the time specified in the configuration of the queue is reached before the connection is established (most probable reason: the physical printer is turned off, or disconnected from the network)
*WW (information) : le comportement de la file d’attente sur les erreurs est pris en compte
+
*WW (information): the behaviour of the queue upon error is taken into account
  
Le bandeau de filtres sur ces écrans de consultation permet d’affiner les résultats :
+
The filter banner on these screens allows you to refine the results:
  
*Niveau : afficher uniquement les événements en erreur par exemple
+
*Level: only displays error events for example
*Dates : afficher les événements produits sur un intervalle de durée
+
*Dates: displays all the events from a specific time interval
*Filtre : recherche d’un mot ou expression dans les messages associés aux événements
+
*Filter: research of a word or expression in the messages associated with the events
  
=Maintenance ONYX Server=
+
=ONYX Server maintenance=
  
Cette partie traite des tâches régulières de maintenance qui doivent être planifiées sur le serveur, afin de conserver un fonctionnement optimal pour l’environnement ONYX Server.
+
This section deals with the regular maintenance tasks that must be scheduled in order to maintain optimal performances of the ONYX Server environment.
  
Les différentes commandes ci-dessous pourront être regroupées dans un script global d’épuration, dont l’exécution sera planifiée automatiquement sur le serveur :
+
The following commands can be gathered together in an overall clearing script, which can be scheduled to run automatically on the server:
  
*Gestionnaire des Tâches Planifiées sous Windows
+
*Scheduled tasks manager under Windows
*CRONTAB sous Linux
+
*CRONTAB under Linux
  
==Nettoyage des fichiers du Spooler==
+
==Clearing Spooler files==
  
Dans son fonctionnement normal, le Spooler créé et conserve un certain nombre de fichiers qu’il est conseillé de régulièrement épurer : travaux conservés, journaux d’événements, statistiques. Ces opérations sont réalisables par une commande ONYX Server : '''map_cron'''.
+
The Spooler normally creates and keeps a certain number of files which we advise you regularly clear: kept jobs, logs, statistics. This can be done using an ONYX Server command: '''map_cron'''.
  
===Epuration des travaux===
+
===Clearing jobs===
  
Tous les travaux circulant dans le Spooler possèdent un attribut spécifique : la durée de rétention (en nombre de jours). L’épuration des travaux dans le Spooler se base sur cet attribut pour nettoyer tous les travaux arrivés « à échéance », c’est-à-dire dont la durée de rétention est dépassée.
+
All the jobs in the Spooler have a specific attribute: the retention time (in days). The solution uses this attribute to clear the "expired" jobs in the Spooler, in other words, those with an exceeded retention time.
  
Deux commandes ONYX Server existent :
+
There are two ONYX Server commands which serve this purpose:
  
*'''Suppression de tous les travaux <span class="underline">conservés</span> (donc ayant été traités) dont la durée de rétention est dépassée :'''
+
*'''Deleting all the jobs <span class="underline">kept</span> (which were processed and kept) with an expired retention time:'''
  
Linux : <code>/apps/mapping/bin/map_cron -date</code>
+
Linux: <code>/apps/mapping/bin/map_cron -date</code>
  
Windows : <code>E:\MappingWindows\Applications\map_cron.exe -date</code>
+
Windows: <code>E:\MappingWindows\Applications\map_cron.exe -date</code>
  
*'''Suppression de tous les travaux (quel que soit leur état) dont la durée de rétention est dépassée :'''
+
*'''Deleting all the jobs (whatever status) with an expired retention time:'''
  
Linux : <code>/apps/mapping/bin/map_cron -dateall</code>
+
Linux: <code>/apps/mapping/bin/map_cron -dateall</code>
  
Windows : <code>E:\MappingWindows\Applications\map_cron.exe -dateall</code>
+
Windows: <code>E:\MappingWindows\Applications\map_cron.exe -dateall</code>
  
'''Remarque :'''
+
'''Note:'''
  
Pour fonctionner, l’exécution de ces commandes doit se faire avec le Spooler en état de marche. En effet, seul le Spooler peut interagir avec ses travaux, les commandes précédentes ne faisant qu’envoyer des requêtes de suppression au Spooler.
+
For them to carried out be correctly, these commands must be run as the Spooler is also running. Only the Spooler can interact with its jobs, the previous commands can only send deletion queries to the Spooler.
  
===Epuration des journaux d’événements===
+
===Clearing logs===
  
La commande <code>map_cron</code> permet également de nettoyer les fichiers correspondants aux journaux d’événements d'ONYX Server. Des options permettent de conserver des archives des journaux d’événements avant leur suppression, pour historique.
+
The <code>map_cron</code> command clears the files corresponding to ONYX Server logs. Options can be set to keep archives of the logs before they are deleted, to keep them as history.
  
*'''Création d’une archive (ZIP) des journaux avant suppression :'''
+
*'''Creating an archive (ZIP) of the logs before deleting them:'''
  
Linux : <code>/apps/mapping/bin/map_cron -cleanlog</code>
+
Linux: <code>/apps/mapping/bin/map_cron -cleanlog</code>
  
Windows : <code>E:\MappingWindows\Applications\map_cron.exe -cleanlog</code>
+
Windows: <code>E:\MappingWindows\Applications\map_cron.exe -cleanlog</code>
  
L’archive est conservée par défaut à la racine du répertoire des logs (variable PATH_LOG de la configuration), nommée en fonction de la date/heure d’exécution de la commande.
+
The archive is kept by default at the root of the logs folder (PATH_LOG variable of the configuration) and named according to the date/hour on which the command was run.
  
Exemple : 2014_07_25_15_16.zip
+
Example: 2014_07_25_15_16.zip
  
*'''Suppression des journaux sans sauvegarde :'''
+
*'''Deleting logs without backup:'''
  
Linux : <code>/apps/mapping/bin/map_cron -cleanlog -delete</code>
+
Linux: <code>/apps/mapping/bin/map_cron -cleanlog -delete</code>
  
Windows : <code>E:\MappingWindows\Applications\map_cron.exe -cleanlog -delete</code>
+
Windows: <code>E:\MappingWindows\Applications\map_cron.exe -cleanlog -delete</code>
  
===Epuration des statistiques===
+
===Clearing statistics===
  
Sur le même principe que précédemment, les fichiers correspondants aux statistiques et rapports d’utilisation peuvent être nettoyés :
+
Following the same principle as previously, the files corresponding to statistics and usage reports can be cleared:
  
Linux : <code>/apps/mapping/bin/map_cron -cleanstats [ -delete ]</code>
+
Linux: <code>/apps/mapping/bin/map_cron -cleanstats [ -delete ]</code>
  
Windows : <code>E:\MappingWindows\Applications\map_cron.exe -cleanstats [ -delete ]</code>
+
Windows: <code>E:\MappingWindows\Applications\map_cron.exe -cleanstats [ -delete ]</code>
  
==Nettoyage des fichiers temporaires==
+
==Clearing temporary files==
  
En fonctionnement normal, un certain nombre de fichiers sont créés dans le répertoire temporaire d'ONYX Server (variable PATH_TEMP dans la configuration) : fichiers de connexion à l’interface Web (cookies), fichiers issus des traitements de Workflows, etc.
+
A certain number of files are normally created in the ONYX Server temporary folder (PATH_TEMP variable in the configuration): connection files to the Web interface (cookies), files derived from Workflow processings, etc.
  
La commande <code>map_cron</code> permet de supprimer tous les fichiers cookies, en ne conservant qu’un historique d’un jour :
+
The <code>map_cron</code> command deletes all cookie files as it only keeps a one-day history:
  
Linux : <code>/apps/mapping/bin/map_cron -cleanid</code>
+
Linux: <code>/apps/mapping/bin/map_cron -cleanid</code>
  
Windows : <code>E:\MappingWindows\Applications\map_cron.exe -cleanid</code>
+
Windows: <code>E:\MappingWindows\Applications\map_cron.exe -cleanid</code>
  
La commande <code>map_del</code> nettoie le contenu d’un répertoire, en filtrant sur un nom ou sur une extension. Les exemples de commandes suivants sont fréquemment utilisés dans un script d’épuration ‘standard’ pour ONYX Server :
+
The <code>map_del</code> command clears the content of a folder as it filters it by name or extension. The following examples of commands are often used in ‘standard’ ONYX Server clearing scripts:
  
Linux :
+
Linux:
  
 
  /apps/mapping/bin/map_del -path:/apps/mapping/temp -filter_ext:tmp  
 
  /apps/mapping/bin/map_del -path:/apps/mapping/temp -filter_ext:tmp  
Ligne 1 121 : Ligne 1 121 :
 
  /apps/mapping/bin/map_del -path:/apps/mapping/temp -filter_name:*.1
 
  /apps/mapping/bin/map_del -path:/apps/mapping/temp -filter_name:*.1
  
Windows :
+
Windows:
  
 
  E:\MappingWindows\Applications\map_del.exe -path:E:\MappingWindows\Applications\Temp -filter_ext:tmp
 
  E:\MappingWindows\Applications\map_del.exe -path:E:\MappingWindows\Applications\Temp -filter_ext:tmp

Version actuelle datée du 30 août 2019 à 08:16

Autres langues :
English • ‎français

ONYX Server: General principles

Software

ONYX Server is the production engine of the Mapping Suite on Linux and Windows. Apart from their specific features (file system, user rights management), the philosophy, configuration, the way the engine works and is used are identical on both platforms.

The ONYX Server engine mainly relies on its job manager (called Spooler or Output Manager), a scheduler which processes, prints and distributes documents, from their input into the engine to their output towards the end users. Combined with the Mapping Spooler, the Workflows engine allows you to automate the entire output production chain as well as all the processings to run on documents: data extraction, graphical formatting and mapping, indexing, sorting / splitting, routing, omnichannel distribution, etc.

Diagram of the general operations

OnyxServerDiagram.jpg

ONYX Server manages the entire output production chain of the company. The Spooler (or Output manager) and the Workflows engine constitute the nerve center of the solution. They centralise and schedule every query coming from various sources and are subject to multiple protocols (LPR, RAW, FTP/SFTP, Web Service), they apply processing, mapping, routing, and omnichannel distributing rules to them.

Administration / Operations interface

If the ONYX Server is a fat client installed on the target platform, its administration and operation tasks can be carried out remotely via web browser (minimum Internet Explorer 8.0, Firefox, Google Chrome). This thin client access is supported by the Apache HTTP Server software which is the only software required to install ONYX Server.

Access, logging in

To access the ONYX Server Web interface, the DNS name or IP address of the server as well as the HTTP port used for Mapping (8002 on a "Typical" installation) must be known. The adress which needs to be typed in your browser uses this syntax: http://192.168.216.29:8002

OX S auth.png

Access to the ONYX Server Web interface is controlled and secured. Although it is possible to interface ONYX Server with an Active Directory service or an existing LDAP, the first login to the interface is done through the Apache server, with the admin account of the solution which was specified upon installation of the software, that is to say "mapadmin" by default:

OX S id.png


Home page

OX S homepage.png


Once logged in, the ONYX Server home page offers access to different menus:

  • Development Menu (1): Manages M-Connect and M-Designer formats, gives access to customised menus to go along with M-Connect formats
  • Administration Menu (2): Manages the overall configuration of the solution, manages access rights, creates entry points, managing rules (Workflows), output printers and document distribution rules, manages roll-outs between ONYX Server servers
  • Operations Menu (3): Manages jobs, queues, access to event logs

A drop-down menu provides quick access to the entire menu tree-structure at any time during navigation:

OX S menu.png


Lastly, At the bottom of the screen, on the left, in addition to session information (logged in user, date and time) and the version number of ONYX Server, a navigation bar allows you to:

  • Come back to the previous menu (integrated management of the navigation history, unlike the "Previous" button of your browser)
  • Refresh the current page
  • Come back to the main menu
  • Log off
OX S version.png


Development Menus

The first three menus of the user interface are called "Development" screens, they allows you to manage document template libraries which were created with the Connect and Designer tools.

Managing Designer

OX S DesignerManagement.png


The different screens respectively allow you to:

  • Import Designer formats which were generated from the tool, so that they can be available to and used by the processing rules of the ONYX Server engine
  • View and reinitiate the List of Objects and resources used in Designer formats which can be seen in the server (imported or not)
  • View the list of Designer Formats in production on the server, you can delete each format from the server or roll them out to another ONYX Server environment.
  • Declare, configure and manage the different Conversion Rates which can be used in Designer formats.

Managing Connect

OX S connectManagement.png


The different screens respectively allow you to:

  • Import Connect formats which were generated from the tool, so that they can be available to and used by the processing rules of the ONYX Server engine
  • Manage and view the list of Connect formats in production on the server, you can delete each format from the server or roll them out to another ONYX Server environment.
  • Execute a Connect format in interactive mode, so that, for instance, you can confirm that the server is running smoothly
  • Start and Stop the Connect development engine on the server which allows users to create previews.
  • Retrieve the definitions of databases tables which were interfaced with the Connect tool, the resulting files are then imported into the tool to create the internal structure of data in the developed Connect formats.

Customised Menus

This screen gives you access to interactive interfaces which allow you to execute Connect formats upon request, to create output production queries. These interfaces are developed from the Connect tool, generated and imported with the corresponding format(s), and can answer to a need of production upon request, they, however, cannot be automated.

Administration Menu

This menu gives access to the configuration of the solution, the creation and administration of ONYX Server entry points (Scanfolder robots, listening servers, processing queues), execution and routing rules (Workflows), output points and distribution of documents.

The main screens are the only ones regarded in this documentation, for more information see the User Guide of the solution.

Managing the configuration

This screen displays all the environment parameters of the solution from its installation to its general configuration.

OX S Config.png


Most values featured here are only informative and must not be changed unless explicitly requested. The User guide of the solution provides more information on values which can be changed as well as their behaviour depending on the context of the application.

Managing robots

This screen can manage all the "robots" configured in the solution, whether they are Scanfolder robots or listening Servers. Upon first installation, the list of robots is blank but it gives access to the creation / editing screen for new entry points in ONYX Server:

OX S robots.png


From the perspective of ONYX Server, a robot is an entry point into the solution, a way for a third party application to send an execution query. Robots are programs executed as background tasks (in Service mode under Windows) to monitor data delivery: in a folder in the case of Scanfolder robots, on a network port in the case of listening servers. Each file received is handled by the Workflow execution engine, to then carry out the appropriate processing.

Scanfolder Robots

Introduction

  • Scanfolder robots monitor a file system folder searching for input files (transferred by copy or FTP/SFTP). Files detected in the folder are sent one by one to the execution engine to be processed according to the rules defined in the Workflows.
  • A robot which was configured in ONYX Server can only monitor one file, the same way a folder of the file system can only be monitored by one Scanfolder robot. There can be as many scanfolder robots created and configured as there are folders to monitor. Each robot is independent from the others, so several files can be processed by different robots at the same time.

Creating / Editing / Deleting

This screen gives you access to the list of robots which are already configured, each robot can be edited if necessary (and if it is not currently running). The last block which contains two blank lines allows you to create a new Scanfolder robot:

OX S robotsConfig.png


Parameters to specify to configure the robot:

Name: gives a name to the robot.

  • This parameter is optional, but it is highly recommended: the name of each robot is an environment variable which is accessible and can be used in Workflows.
  • ONYX Server checks that the names used for the different robots are unique.

* Folder to scan: Complete path of the folder scanned by the robot.

  • This parameter is required.
  • It can point to a network drive or a UNC path (under Windows), in this case be careful to have access rights.
  • ONYX Server checks that the names of the folders monitored by the different robots are unique.
  • ONYX Server can create the folder specified if it does not already exist.

* CMD: action run on every detected file after it was properly processed by the execution engine.

  • This parameter is required.
  • Delete: Files which were detected and processed are deleted from the monitored folder.
  • Move: Files which were detected and processed are moved to another folder, for the history for instance.

* Destination folder: destination path of processed files.

  • This parameter is required if the move command was previously chosen.
  • ONYX Server checks that the destination folder is different from the monitored folder.
  • ONYX Server can create the folder specified if it does not already exist.

* Delay: waiting time interval in between two folder scans, given in seconds.

  • This parameter is required.

* On Error: defines the robot's behaviour when a processing error is reported on a detected file.

  • This parameter is required.
  • Stop: the robot stops, the file in error status stays in the monitored folder.
  • Continue: the robot continues to process the next files, the file in error status stays in the monitored folder, renamed with the suffix " _FAILED " (Mapping keyword to prevent the robot from processing this file again during the next folder scan).
  • Retry: the robot continues to process the next files, the file in error status stays in the monitored folder. The robot will try to process the file again next time it scans the folder.

Workflow: name of the Workflow to execute.

  • This parameter is optional. If not specified the root Workflow is executed by default.

Filter: excludes files from being scanned by the robot.

  • This parameter is optional.
  • Example: *.tmp files in the monitored folder are not processed by the robot.

Accept: limits the type of files to process.

  • This parameter is optional.
  • Example: only *.xml files in the monitored folder are processed by the robot.

To create a new robot, specify all the parameters needed then click on the OX S Save 2.png button to add the robot to the server configuration.

To edit an existing robot, edit it or the parameters concerned then click on the OX S Save 2.png button to edit the robot in the server configuration.

Note: A robot must be stopped for you to edit it.

To delete an existing robot, click on the OX S icone delete.png button. The robot will be deleted from the server configuration.

Note: A robot must be stopped for you to delete it.

Usage

Once the robots created and configured, they appear on the managing screen:

OX S startRobots.png


This screen allows you to:

  • Start a robot: OX S strt rbt.png
  • Stop a robot: OX S stp rbt.png
  • See the log of a robot: OX S infos rbt.png

Once started, a robot is a process which is continuously executed as a background task. The ONYX Server binary which is associated with it is map_scanfolder, the list of active system processes (Task Manager under Windows, ps –ef command under Unix) will display as many map_scanfolder[.exe] processes as there are robots started.

Note:

Under Windows, robots are installed as Services in the Windows Service Manager. This is registered the first time the robot is started. The corresponding Service is named based on the name of the robot if specified (which is why the names of the robot must be different) in the monitored folder (which is why the names of the folders must be different). Example: Mapping_ScanFolder_SCAN_TXT.

Each Windows Service created by the robot is configured in manual start by default, this can be switched to an automatic system start afterwards.

Temporary files associated with the robots:

Once started, each robot creates two files in the ONYX Server temporary folder. The first one is named based on the name of the monitored folder, special characters are replaced with ‘_’, and the suffix " map_scanfolder.ID " is added. Example: E__InputData_TXT_map_scanfolder.ID

The second one is named with the system number of the associated process map_scanfloder[.exe]. Example: 75668.pid.

These files are intended for internal use of the process only and will be deleted once the robot is stopped.

However, the Web interface relies on these files to indicate the status of the robots.

Useful command lines:

  • To start a robot:

Linux (after the environment was loaded):

/apps/mapping/bin/map_scanfolder -name:SCAN_TXT

Windows:

E:\MappingWindows\Applications\map_scanfolder.exe -name:SCAN_TXT
  • To stop a robot:

Linux (after the environment was loaded):

/apps/mapping/bin/map_scanfolder -name:SCAN_TXT -stop

Windows:

E:\MappingWindows\Applications\map_scanfolder.exe -name:SCAN_TXT -stop
  • If the robot is not named, set each parameter that describes the robot as an argument of the previous commands (hence the prior advice on robots unique names)

Listening Servers

Introduction

  • A listening server monitors a network port, searching for received data (data is sent via a remote system by direct transfer in RAW protocol). The robot receives data and builds files locally, it then sends them one by one to the execution engine to be processed according to the rules defined in the Workflows.
  • A robot configured in ONYX Server can only monitor one network port, and a network port can only be monitored by one listening server. There can be as many listening servers created and configured, as there are ports to monitor. Each robot is independent from the others, so several files can be processed by different robots at the same time.

Creating / Editing / Deleting

The following screen displays the list of robots which are already configured, each robot can be edited if necessary (if it's not currently being run). The last blank line allows you to create a new listening server:


Parameters to specify to configure a listening server:

Name: gives a name to the robot.

  • This parameter is optional, but it is highly recommended: the name of each robot is an environment variable which can be accessed and used by the Workflows.
  • ONYX Server checks that the names used for the different robots are unique.

* Port: number of the network port the robot listens to.

  • This parameter is required.
  • ONYX Server checks that the names of the ports the different robots listen to are unique.

Job separator: character or chain which divides a large network stream into several files.

  • This parameter is optional.

Key (start/length): adds information to the name of the temporary file built by the robot.

  • These 3 parameters are optional.
  • The information is searched in the network stream, using a keyword, ignoring X characters after the keyword ("start" parameter), retrieving N characters ("length" parameter).
  • This information can be used in the Workflows, notably as a condition.

Timeout: network waiting time, given in seconds.

  • This parameter is optional.
  • Prevents the network port from being blocked in case of problem with the stream transmitter: the robot cuts connection after this inactivity period, as it considers the established connection is no longer active.

To create a new listening server, fill in all the needed parameters, then, click on the OX S Save 2.png button to add it to the server configuration.

To change an existing server, edit it or its parameters, then, click on the OX S Save 2.png button to edit the server configuration.

Note: The server must be stopped for you to change it.

To delete an existing listening server, click on the OX S icone delete.png button. The robot is then deleted from the server configuration.

Note: The robot must be stopped for you to delete it.

Usage

Once created and configured, the robots appear on the managing screen:


This screen allows you to:

  • Start a listening server: OX S strt rbt.png
  • Stop a listening server: OX S stp rbt.png
  • See the log of a listening server: OX S infos rbt.png

Once started, a listening server is a process which is continuously executed as a background task. The associated ONYX Server binary is map_rawd, the list of active system processes (Task Manager under Windows, ps –ef command under Unix) will display as many map_rawd[.exe] processes as there are listening servers started.

Note:

Under Windows, listening servers are installed as Services in the Windows Service Manager. This is registered the first time the robot is started. The corresponding Service is named base on the name of the network port the robot listens to (which is why the names of the ports must be different) in the job separator. Example: Mapping_Rawd_13000, Mapping_Rawd_25006_SEP.

Each Windows Service created by the robot is configured in manual start by default, this can be switched to an automatic system start afterwards.

Temporary files associated with the listenign servers

Once started, each listening server creates a file in the ONYX Server temporary folder. It is named based on the name of the network port it listens to as well as the name of the job separator, with a map_rawd.ID file which includes the number of the associated process. Example: …\Temp\map_rawd_25006_SEP\map_rawd.ID.

Useful command lines:

  • To start a robot:

Linux (after the environment was loaded):

/apps/mapping/bin/map_rawd -start -name:RAW_25006

Windows:

E:\MappingWindows\Applications\map_rawd.exe -start -name:RAW_25006
  • To stop a robot:

Linux (after the environment was loaded):

/apps/mapping/bin/map_rawd -stop -name:RAW_25006

Windows:

E:\MappingWindows\Applications\map_rawd.exe -stop -name:RAW_25006
  • If the robot is not named, set each parameter that describes the robot (listening port and job separator) as an argument of the previous commands (hence the prior advice on robots unique names)

Managing the Spooler

As mentioned previously, the Onyx Server Spooler is the heart of the solution. It is a real stream, processing and printer manager. The interface displayed when navigating through the Administration Menu, to Managing print jobs, and finally Managing the Spooler, allows you to:

  • Start the Spooler
  • Stop the Spooler
  • See output production statistics
  • See solution usage reports


Once started, the Spooler is a process which is continuously executed as a background task. The associated Onyx Server binary is map_daemon[.exe].

Note:

Under Windows, the Spooler is installed as a Service in the Windows Service Manager. This is registered the first time the Spooler is started. The corresponding Service is named Mapping_Spooler. It is configured in manual start by default, but this can be switched to an automatic system start afterwards.

Temporary files associated with the Spooler:

Once started, the Spooler creates a "map_daemon.ID" file in in its OnyxServer installation folder: C:\ProgramData\MappingWindows\Spooler by default under Windows, /apps/mapping/spool by default under Linux.

Useful command lines:

  • To start the Spooler:

Linux (after the environment was loaded):

/apps/mapping/bin/map_daemon start

Windows:

E:\MappingWindows\Applications\map_daemon.exe start
  • To stop the Spooler:

Linux (after the environment was loaded):

/apps/mapping/bin/map_daemon stop

Windows:

E:\MappingWindows\Applications\map_daemon.exe stop

Managing Sites and Queues

The interface displayed when navigating through the Administration Menu, to Managing print jobs, and finally Managing Queues / Devices / Input, gives you access to the list of all queues configured in the Spooler, potentially being organised per site:


Here for example, a "SAMPLE" site was declared in which 3 queues (one input queue and two output queues) are configured. 3 other queues are declared outside of sites and displayed in a default site called Main.

Using this interface, inside each site, you can:

C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_site.png Create a site. Sites are a logical way of organising queues

C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_printer.png Create an output queue linked to a physical printer

C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_shell.png Create a customised processing queue which executes a client queue (shell)

C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_entry.png Create a Mapping processing queue which executes a Workflow

Important notes:

  • All the created and configured objects must have a unique name no matter their type (an output printer must not have the same name as a site).

  • Once created and configured, the name of an object cannot be changed anymore. If necessary, the object must be deleted and then recreated.

Creating a site

Sites allow you to classify Spooler queues so that print jobs can be managed within a hierarchical way. Sites can also be used as display filters or search filters in the operations view.

To create a site, click on the C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_site.png button.

Note:

It is possible to create sites within a site, this allows you to manage a complex tree view. To do so, use the creation button on the line of the concerned site.

Fill in each of the following information in the input screen and validate it by clicking on OX S Save 2.png:

  • (1) Name for the site (required)
  • (2) Description

Once the site configuration finished, the new site needs to be saved, click on C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\ok2.png (3).


Creating a (simple) input point

An ONYX Server input point is a queue which executes Mapping processings (Workflows). It is made up of two objects:

  • A queue to receive queries (jobs)
  • A "device" or engine, to handle queries and carry out processings

To add an input point to a site, click on the OX S FM.png button, on the line of the concerned site.

The following input screen gives you access to several tabs, the first one is the only one this documentation will detail. Refer to the User Guide for more details on the advanced configuration options.

Fill in the needed information and validate it by clicking on OX S Save 2.png.


Queue

  • (1) Name of the queue (required)
  • (2) Description of the queue

Validating the name of the queue gives you access to the creation form of the associated device.

Device

  • (3) Name of the associated device (required)
  • (4) Description of the device

Driver

  • (5) Type of driver: RULES by default, this cannot be changed (the execution engine is called)
  • (6) Executed Workflow, has to be chosen in the drop down menu. By default (‘Default’ or ‘undefined’), the root Workflow is executed.

Monitoring

  • (7) Behaviour of the device upon error:
    • default or stop: the current processing stops in error status, the device stops in error status.
    • continue: the current processing stops in error status, the device continues to process the next queries.
    • ignore: the current processing is considered as done, the device continues to process the next queries. This value is not recommended, except for very specific cases.
  • (8) Automatic recovery: if activated, an error inducing processing is relaunched
  • Timeout: maximum time during which a processing in error status is relaunched before it is actually considered as being in error status. The behaviour of the device upon error is then taken into account.

Note:

Automatic recovery is not necessarily recommended on input queues. If a Workflow triggers an error, it is very likely that this error will keep happening as long as the Workflow is not fixed.

Once the (simple) configuration of an input point done, the new object needs to be saved, click on C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\ok2.png (9).

Creating a (simple) printer

An ONYX Server printer is a queue which communicates with a physical printer. It is made up of two objects:

  • A queue which receives queries (jobs)
  • A "device" or printer, which handles queries and sends data to the physical printer.

To add a printer to a site, click on the C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\add_printer.png button on the line of the concerned site.

The following input screens give you access to several tabs, the first one is the only one this documentation will detail. Refer to the User Guide for more details on the advanced configuration options.

Fill in the needed information and validate it by clicking on OX S Save 2.png.


Queue

  • (1) Name for the queue (required)
  • (2) Description for the queue

Validating the name of the queue gives you access to the creation form of the associated device.

Device

  • (3) Name of the associated device (required)
  • (4) Description of the device
  • (5) Backup: if activated this allows you to create a backup printer which will automatically replace the main printer in case of error.

Driver

  • (6) Connection: Onyx Server implements several types of communication protocols, the LPR protocol is the most used here (refer to the User Guide for more details on the other protocols).
  • (7) Print job: "default" indicates a link to a physical printer, "MAPPING" indicates a communication with another (remote) Onyx Server Spooler and allows you to activate the compression of streams.
  • (8) XPS compatibility: allows you to communicate with the linked physical printer in its direct printing language. The XPS streams are converted on the fly according to the selected profile then sent to the printer. This operation does not depend on any driver.
  • (9) IP address of the physical printer
  • (10) Internal name of the physical printer: generally PASS if it is directly linked to the network, or the name of the port on the box (HP JetDirect for instance) if it is used to link the printer to the network.
  • (11) Time: maximum waiting time for a network communication.

Status

This allows you to ask the physical printer for its status, which will be displayed in the operations view.

Monitoring

This allows you to ask the physical printer to control the real status of the print job. This additional communication is detailed in the User Guide, the default parameters are enough for the moment.

  • (12) Behaviour of the device upon error:
    • default or stop: the current processing stops in error status, the device stops in error status.
    • continue: the current processing stops in error status, the device continues to process the next queries.
    • ignore: the current processing is considered as done, the device continues to process the next queries. This value is not recommended, except for very specific cases.
  • (13) Automatic recovery: if activated, an error inducing print job is relaunched
    • Timeout: maximum time during which the print job in error status is relaunched before it is actually considered as being in error. The behaviour of the device upon error is then taken into account.
    • Recovery mode: in its entirety or per page

Once the (simple) configuration of the printer is finished, the new object needs to be saved, click on C:\PROJETS\Built-Setup\Sources\Branch_trunk_v8\install\AllVersion\httpd\images\ok2.png (14).

Sending a file to a queue

The ONYX Server Spooler is seen as a 'virtual' printer from a third-party application. Print commands are used to send files to a queue of the Spooler.

ONYX Server has its own print commands: map_lp locally and map_lpr remotely.

MAP_LP locally

MAP_LP is a direct query sent to the ONYX Server Spooler (the map_daemon program answers it).

Two parameters are required for this command:

-queue:XXX: the name of the queue in which the file is sent

-data:XXX: the path of the file to send

Other parameters are available for this command (argument --help to access the list of parameters), the most common ones are:

-title:XXX: gives a title to the document in the queue, displayed in the operations view

-user:XXX: defines the username of the document owner in the queue

-map_hold: the file is sent in "hold" status (it will be processed after)

-map_save: saves the file after it was processed

-map_retention:NN: adds a retention time (in days) in the spooled file attributes

Example: the following commands add a spooled file in the INPUT_DATA queue which is owned by the mapadmin user. It has a retention time of 15 days and will appear in saved status once processed.

Under Windows:

E:\MappingWindows\Applications\map_lp "-queue:INPUT_DATA" "-map_hold" "-map_save" 
"-map_retention:15" "-user:mapadmin" "-data:D:\Data\extract\FR_DEMO.txt"

Under 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 remotely

MAP_LPR is a standard network print communication. The data sent to Onyx Server via the LPR protocol is received locally by the map_lpd program, the latter then requests for the Spooler to add the document in the correct queue.

Three parameters are required for this command:

-server:NNN.NNN.NNN.NNN: IP address (or DNS name) of the Onyx Server server

-queue:XXX: the name of the queue in which the file is sent

-data:XXX: the path of the file to send

Moreover, depending on the configuration, the LPD listening server of Onyx Server does not necessarily use the 515 port (standard print port, which may already be used by another application). The Mapping network port must be specified with argument -port:NNN in this case.

Other parameters are available for this command (argument --help to access the list of parameters), the most common ones being identical to the map_lp command.

Example: the following commands add a spooled file in the INPUT_DATA queue which is owned by the mapadmin user. It has a retention time of 15 days and will appear in saved status once processed.

Under Windows:

E:\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"

Under 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"

Managing Workflows

Introduction

Workflows make the ONYX Server execution engine. A Workflow is defined as a set of configurable conditions and commands, executed when a new file is received on an input connector (Scanfolder robot, listening server, entry point, or by Web Service request). Commands are processed one by one: the second command is processed after the first one was processed properly, and so on until the end of the Workflow.

A Workflow is defined graphically by linking different types of objects: commands, conditions and parameters. Its name must be unique and it must be linked to at least one connector to be active.

Example of a Workflow:

The following Workflow, which is build later in this guide:

  • Defines a parameter by reading information in the input file
  • Defines a condition by comparing the value of this parameter with a keyword
  • Defines two processings, depending on the condition being true or false

Workflows are saved on disk in XML files, in the "workflow" sub-folder of the rules folder which is pointed by the RULES_PATH configuration variable.

On the ONYX Server web interface, the administration and configuration of Workflows is accessed through the Administration Menu, Managing Workflows.

Tips: Firefox is recommended as browser for better user experience.

Toolbar


but_new Create a new Workflow. Enter the name of the Workflow, the .rules.xml extension is automatically added.

C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\menu\but_open.jpg Open a Workflow. Select a Workflow in the list.

but_save.jpg Save the active Workflow.

but_saveAs.jpg Save the active Workflow under another name.

but_delete.jpg Delete the active Workflow.

condition.png Add a condition to the active Workflow. the new condition is added after the selected box.

but_run.jpg Add a command to the active Workflow. the new command is added after the selected box.

but_set.jpg Add a a parameter to the active Workflow. The new parameter is added after the selected box.

OX S workflowReorganize.png Redraw the active Workflow. Graphically redraws the Workflow: aligns boxes, links, etc…

OX S workflowDuplicate.png Duplicate an object. Duplicates (name, parameters, etc.) a selected object, without its links.

but_EditResolve.png Manage resolution tables. Creates, edits and deletes resolution tables

Creating a new Workflow

Click on the but_new icon, give a name to the Workflow and validate by clicking on:


The new Workflow is displayed in the editing window, with a first box, starting point of the processing sequence:


Adding a Parameter

Définition


The parameter objects allow you to define the value of a parameter or to create a new one. A parameter can then be used as a condition or command. This allows you to reuse a value in several commands for instance, without having to define it each time.

Create / Edit

To create a new parameter, select the box after which the new parameter must be added, then, click on the but_set.jpg icon. To edit an existing parameter, double-click on the corresponding box.

The editing window of the parameter opens to define the different fields:


  • (1) Name of the parameter to define (required)
  • (2) Value to affect (required)
  • (3) Title of the object
  • (4) Note (blank field for comments)

Note:

A parameter is generally reused afterwards in the Workflow, in a condition or a command, even sometimes in another Workflow. Choosing names that reflect the information transmitted is recommended.

Value

Different methods can be accessed through the context menu to define the value of a parameter in the input field:

  • param: dynamic value of a system environment parameter, linked to Onyx Server, the Workflow or the input spooled file
  • value: static value entered by the user
  • rulefile: dynamic value in a text or an XML file (may be the input spooled file, or any other file)
  • command: dynamic value obtained after a predefined Onyx Server command was executed
  • cmd: dynamic value obtained after a user script was executed
  • SQL: dynamic value obtained after an SQL request (SELECT type in this case) was executed
  • resolve: dynamic value obtained after a research in a resolution table
  • rulefile_multiple: defines several parameters with a dynamic value at once, with information in the same input file (in XML mode only).

Depending on the type of field needed, predictive text can be used, this option displays a new interface to configure the dynamic recovery of the value:

Type of function Content Icon Type indicator
Parameter Parameter of the application C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_dict.png Text in blue
None Free text or list none Text in black
RuleFile Value in a datafile C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_file.png rulefile: keyword(Test)
Command Retrieval of a predefined command C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_command.png Command: cutposition
Cmd Retrieval of a command line C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_cmd.png cmd: completepath...
SQL Retrieval of an SQL request C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_sql.png SQL: Select...
Resolution table Retrieval of a resolution table C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_resolve.png Resolve: TABLE[PARAM]
Rulefile multiple Values in the same file (XML) C:\Program Files\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_file.png rulefile_multiple: xml

Every predictive text function and field type is detailed in the Onyx Server User Guide.

Adding a Condition

Definition

Condition objects define 2 different processings depending on the validity of a condition. Condition boxes are the only ones which have two outputs:

  • at the bottom (direct path) if the condition is true
  • on the right (bypath) if the condition is false

OX S wrkflFactures.png

A condition is defined as a comparison between at least 2 values. As seen previously, a value can be a parameter, a constant, the result of a command or a script, of a research in a resolution table, of an SQL query, of a data file analysis.

Create / Edit

To create a new condition, select the box after which the condition needs to be added, then, click on the condition.png icon. To edit an existing condition, double-click on the corresponding box.

The condition editing window opens so as to define the different fields:


  • (1) Name of the condition object
  • (2) Title of the object
  • (3) Tools to define the logic of the condition: adding/deleting a filter, AND and OR logical operators
  • (4) Condition filters
  • (5) Logical operators between filters
  • (6) Note (blank field for comments)

A condition needs to have at least one condition filter.

Tips:

The field "Name of the object" (1) is optional, filling it in is, however, highly recommended. This information appears in the log associated with the Workflow, which allows you to identify the different stages of the Workflow easily.

Examples: "Condition failed" if no name is provided, otherwise "Condition 'Name of the condition' success".

Condition filter

When creating a new condition you are automatically asked to set a first filter. Double-clicking on a condition allows you to edit it:


  • (1) Value to compare
  • (2) Comparison operator
  • (3) Comparison value

The comparison operators available are:

  • equal to / different from: strict alphanumerical comparison between 2 values

  • contains / does not contain: alphanumerical research of a value in another value

  • is empty / is not empty: does the parameter have a value?

  • greater than / greater than or equal to: numerical comparison

  • less than/ less than or equal to: numerical comparison

A condition can be defined by multiple condition filters. The C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_add_elt.png button allows you to add a new condition filter. The logic between these filters is defined graphically using the boxes to tick before each filter and the C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_and_elt.png and C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_or_elt.png tools. In this example, the condition logic is defined by: filter A and (filter B or filter C). The C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_del_elt.png button allows you to delete a selected condition filter, or a selected condition logic (and the associated filters).

Adding a Command

Definition

Commands allow you to run unitary processings. The Workflow includes as many commands as there are processings to run.

Commands allow you to run the 4 main groups of processings: predefined Onyx Server commands in direct language, user scripts, SQL queries, or calls to other Workflows.

Create / Edit

To create a new command, select the box after which the command needs to be added, then, click on the but_run.jpg icon. To edit an existing command, double-click on the corresponding box. The command editing window opens so as to define the different fields:


  • (1) Type of processing: Command, Cmd, Sql or Call
  • (2) Name of the object
  • (3) Title of the object
  • (4) Selector of a group of predefined commands
  • (5) Selector of the predefined command to run
  • (6) Parameters of the command:
    • Displays all the required or optional parameters for the command to be run smoothly
    • The Standard tab includes the main parameters of the command
    • Depending on the commands, other specific tabs display advanced parameters
  • (7) Note (blank fields for comments)

Predefined commands (Command)

This group of processings includes the "generic" commands and ONYX Server direct language commands. Commands are sorted by groups according to what they are used for: Spooler, File, Mapping, XPS Toolbox, Mail…

Amongst the most used ones are:

Mapping / Text M-Designer: application of a Designer format on a data file in text mode

  • Standard:
  • Name of the Designer format to use. The list of formats imported on the server can be seen by clicking on the C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_getMapDrawFormat.png button

  • Sequence number (00010, or *MRG, or *ALL, etc.)

  • Input file (data file)

  • Output file (finished XPS document)

  • Advanced:
  • Translation language (See the Designer User Guide for translations)

  • XPS file to add as watermark, indexes can also be recovered

  • Text options:
  • Maximum number of lines: an overflow can be set on the input data file, an "automatic" page break can also be set.

  • Page width: maximum number of characters per ligne to read in the input data file

  • Code page of the input file: converts to Unicode UTF-16 on the fly if needed. The list of code pages managed under ONYX Server can be seen by clicking on the C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_getcodepage.png button

  • Output options:
  • Start page / end page: interval of pages to produce

  • Input bin / output bin: adds finishing options (PrintTicket) to the XPS document produced to manage printer bins

Spooler / Print: sends a spooled file to the Spooler queue

  • Standard:
  • Name of the destination queue. The list of queues declared in the Spooler can be seen by clicking on the C:\MAPPING\MappingWindows\MapHTTPServer\JS_Common\workflow\img\button_getqueue.png button

  • Name of the file to send

  • Title: name of the spooled file in the queue

  • Send the spooled file to the destination queue in hold status

  • Keep the spooled file after it was processed in the destination queue

  • Keep the following attributes: associate the attributes of the current spooled file with the output spooled file

  • Add common parameters: associate the parameters of the current session with the output spooled file

  • Page:
  • Start page / end page: adds the corresponding attribute to the destination spooled file for its processing interval

  • Number of copies: adds the corresponding attribute to the destination spooled file

  • Security:
  • Owner of the destination spooled file

  • Access rights on the destination spooled file

  • Account code: associates the corresponding attribute

  • Userdata:
  • Additional attributes can be defined on the destination spooled file

  • Advanced:
  • Priority of the destination spooled file

  • Number of days during which the destination spooled file is stored

  • Number of days before the destination spooled file is compressed (this attribute is inherited from the IBM i environment, it is sometimes used by client applications upstream and downstream)

  • Type of paper

  • Loyalty: this attribute is inherited from the IBM i environment, it is sometimes used by client applications upstream and downstream

  • Name of the destination spooled file

The complete list of ONYX Server predefined commands is detailed in the User Guide.

User scripts (Cmd)

The CMD mode allows you to put the command object in text editing mode so as to type a complete command in, as would be done in telnet mode or in MS-DOS command windows. All environment parameters (system and Mapping) and attributes of the file being processed are accessible.

The command being run can be a specific Onyx Server command, which is not available as a predefined command, or a complex script (*.bat or *.sh).

SQL queries

The SQL mode allows you to put the command object in text editing mode so as to run SQL orders. All environment parameters (system and Mapping) and attributes of the file being processed are accessible. Parameters to connect to the database must be defined in the Onyx Server configuration.


Workflows calls (Call)

The CALL mode allows you to run another Workflow in the current workflow, then to continue running the current Workflow once the second one has been correctly processed. All environment parameters (system and Mapping) and attributes of the file being processed are automatically transmitted to the sub-Workflow and can be used in it.


Operations Menu

The last two menus of the home page give you access to the two most used operations screens of the solution: the jobs and printers managing screen (content of the Spooler), and the screen to access all the logs of the solution.

Jobs/ Printers

This first view gives you access to two tabs:

  • The jobs view, which lists all the jobs in the Spooler, in their respective queue
  • The "printers" view, which lists all the queues declared in the Spooler, in their respective sites.

Managing Jobs

Navigating through the "Jobs / Printers" menu gives you directly access to the Spooler jobs view:


This view is divided in 3 parts:

  • The jobs view and the printers view tabs

Note:

  • When accessing this first view, the page is automatically refreshed with the default filters. The LOAD_SPOOLS_ON_VIEW (on/off) environment variable allows you to deactivate this refresh so that the user can specify filters.

  • The view is not refreshed automatically when changing from one tab to another so that the user can specify display filters before the results are refreshed

  • A display filter banner, which allows you to limit the number of results or to make a research for a specific element.

Note:

Filters are specified by default as this first view is displayed: on the jobs owner (logged-in user), on dates (one-day history). The filters can be edited, the "Refresh" button refreshes the list of the results according to the specified filters.

  • The list of results: all jobs corresponding to the different specified filters, grouped together by site, queue and status. Jobs are displayed in display groups according to their priority level, then, time of input in the queue.

The following actions can be carried out for each job:

C:\MAPPING\MappingWindows\MapHTTPServer\images\littlestopspool.png Put the job on hold. Jobs with the statuses kept, in error or ongoing processing can be put on hold.

C:\MAPPING\MappingWindows\MapHTTPServer\images\littlestartspool.png Release the job. Jobs on hold, kept or in error status can be released.

C:\MAPPING\MappingWindows\MapHTTPServer\images\littlecancel.gif Delete the job.

C:\MAPPING\MappingWindows\MapHTTPServer\images\transfert.png Transfer the job in another queue.

C:\MAPPING\MappingWindows\MapHTTPServer\images\spool_view.png See the content of the job.

C:\MAPPING\MappingWindows\MapHTTPServer\images\printer.gif Print the job using the Web (only under Windows, this allows you to send the job on a printer declared in the Windows Spooler of the workstation).

C:\MAPPING\MappingWindows\MapHTTPServer\images\reprint_page.png Recover pages (this allows you to reprint the job from page 5 to 12 for instance).

C:\MAPPING\MappingWindows\MapHTTPServer\images\view_log.png See the job log.

C:\MAPPING\MappingWindows\MapHTTPServer\images\view_info.png Display job attributes.

Managing printers

In this previous view, only the queues which contain jobs are displayed in the results. The "Printers" tab lists all the queues declared in the Spooler:


This view follows the same parting principle as it is divided in three parts:

  • The navigation tabs
  • The filter banner
  • The list of results.

The following actions can be carried out for each job:

C:\MAPPING\MappingWindows\MapHTTPServer\images\play.png Start a queue (or device). Queues that are on hold can be started.

C:\MAPPING\MappingWindows\MapHTTPServer\images\stop.png Stop a queue (or device). Queues that are started can be stopped.

C:\MAPPING\MappingWindows\MapHTTPServer\images\view_info.png Display the configuration information of the queue (or device).

C:\MAPPING\MappingWindows\MapHTTPServer\images\view_log.png See the log of the queue.

C:\MAPPING\MappingWindows\MapHTTPServer\images\spool_view.png See the jobs in a queue. This redirects to the "jobs" tab, with a filter activated on the queue.

C:\MAPPING\MappingWindows\MapHTTPServer\images\refresh.png Refresh device status (if polling is set up in the device configuration).

C:\MAPPING\MappingWindows\MapHTTPServer\images\ok2.png Reboot the device: restarts a device in error status.

See the log

This screen allows you to see all the logs of the Onyx Server solution:


Each process or object has a log:

  • The Spooler (map_daemon.log)
  • The LPD listening server (map_lpd.log)
  • The listening process for Web Service queries (mapsoapserver.log)
  • The Scanfolder robots (scan_folder_XXX.log)
  • The Rawd listening servers (map_rawd_XXX.log)
  • The queues (INPUT_DAT.log for instance)

Each log can be:

C:\PROJETS\Built-Setup\Sources\Branch_v7_2_0\install\AllVersion\httpd\images\littleview.gif Accessed (by clicking on the name of the log)

C:\PROJETS\Built-Setup\Sources\Branch_v7_2_0\install\AllVersion\httpd\images\small_txt_file.png Converted to text to be displayed in a text editor

OX S xmlConvert.png Converted to XML

C:\PROJETS\Built-Setup\Sources\Branch_v7_2_0\install\AllVersion\httpd\images\interface_small_cancel_edit.png Cleared: The log still exists but it content is cleared out

C:\MAPPING\MappingWindows\MapHTTPServer\images\littlecancel.gif Deleted

Example of the content of a print queue log:


The three types of events reported here are:

  • OK (success): Print command launched (LPR communication with the physical printer, initiated by the map_lpr command)
  • EE (error): Connection error to the printer: the time specified in the configuration of the queue is reached before the connection is established (most probable reason: the physical printer is turned off, or disconnected from the network)
  • WW (information): the behaviour of the queue upon error is taken into account

The filter banner on these screens allows you to refine the results:

  • Level: only displays error events for example
  • Dates: displays all the events from a specific time interval
  • Filter: research of a word or expression in the messages associated with the events

ONYX Server maintenance

This section deals with the regular maintenance tasks that must be scheduled in order to maintain optimal performances of the ONYX Server environment.

The following commands can be gathered together in an overall clearing script, which can be scheduled to run automatically on the server:

  • Scheduled tasks manager under Windows
  • CRONTAB under Linux

Clearing Spooler files

The Spooler normally creates and keeps a certain number of files which we advise you regularly clear: kept jobs, logs, statistics. This can be done using an ONYX Server command: map_cron.

Clearing jobs

All the jobs in the Spooler have a specific attribute: the retention time (in days). The solution uses this attribute to clear the "expired" jobs in the Spooler, in other words, those with an exceeded retention time.

There are two ONYX Server commands which serve this purpose:

  • Deleting all the jobs kept (which were processed and kept) with an expired retention time:

Linux: /apps/mapping/bin/map_cron -date

Windows: E:\MappingWindows\Applications\map_cron.exe -date

  • Deleting all the jobs (whatever status) with an expired retention time:

Linux: /apps/mapping/bin/map_cron -dateall

Windows: E:\MappingWindows\Applications\map_cron.exe -dateall

Note:

For them to carried out be correctly, these commands must be run as the Spooler is also running. Only the Spooler can interact with its jobs, the previous commands can only send deletion queries to the Spooler.

Clearing logs

The map_cron command clears the files corresponding to ONYX Server logs. Options can be set to keep archives of the logs before they are deleted, to keep them as history.

  • Creating an archive (ZIP) of the logs before deleting them:

Linux: /apps/mapping/bin/map_cron -cleanlog

Windows: E:\MappingWindows\Applications\map_cron.exe -cleanlog

The archive is kept by default at the root of the logs folder (PATH_LOG variable of the configuration) and named according to the date/hour on which the command was run.

Example: 2014_07_25_15_16.zip

  • Deleting logs without backup:

Linux: /apps/mapping/bin/map_cron -cleanlog -delete

Windows: E:\MappingWindows\Applications\map_cron.exe -cleanlog -delete

Clearing statistics

Following the same principle as previously, the files corresponding to statistics and usage reports can be cleared:

Linux: /apps/mapping/bin/map_cron -cleanstats [ -delete ]

Windows: E:\MappingWindows\Applications\map_cron.exe -cleanstats [ -delete ]

Clearing temporary files

A certain number of files are normally created in the ONYX Server temporary folder (PATH_TEMP variable in the configuration): connection files to the Web interface (cookies), files derived from Workflow processings, etc.

The map_cron command deletes all cookie files as it only keeps a one-day history:

Linux: /apps/mapping/bin/map_cron -cleanid

Windows: E:\MappingWindows\Applications\map_cron.exe -cleanid

The map_del command clears the content of a folder as it filters it by name or extension. The following examples of commands are often used in ‘standard’ ONYX Server clearing scripts:

Linux:

/apps/mapping/bin/map_del -path:/apps/mapping/temp -filter_ext:tmp 
/apps/mapping/bin/map_del -path:/apps/mapping/temp -filter_ext:ttf
/apps/mapping/bin/map_del -path:/apps/mapping/temp -filter_ext:xps
/apps/mapping/bin/map_del -path:/apps/mapping/temp -filter_name:*.0
/apps/mapping/bin/map_del -path:/apps/mapping/temp -filter_name:*.1

Windows:

E:\MappingWindows\Applications\map_del.exe -path:E:\MappingWindows\Applications\Temp -filter_ext:tmp
E:\MappingWindows\Applications\map_del.exe -path:E:\MappingWindows\Applications\Temp -filter_ext:ttf
E:\MappingWindows\Applications\map_del.exe -path:E:\MappingWindows\Applications\Temp -filter_ext:xps
E:\MappingWindows\Applications\map_del.exe -path:E:\MappingWindows\Applications\Temp -filter_name:*.0
E:\MappingWindows\Applications\map_del.exe -path:E:\MappingWindows\Applications\Temp -filter_name:*.1