ONYX - 9.0 - Utilisation - Adressage des canaux de sortie
Différence entre versions
(→Affichage écran(Windows uniquement)) |
(→Envoyer un document dans le spooler systeme(Windows uniquement)) |
||
(11 révisions intermédiaires par un autre utilisateur non affichées) | |||
Ligne 8 : | Ligne 8 : | ||
==Envoyer un document dans le spooler systeme(Windows uniquement)== | ==Envoyer un document dans le spooler systeme(Windows uniquement)== | ||
+ | En sortie des traitements effectués par la commande map_xps, la possibilité est donnée de rediriger le fichier résultant vers une imprimante Windows déclarée sur le poste. Le pilote d’impression configurée sera alors utilisé pour l’impression. | ||
+ | |||
+ | |||
+ | Exemple : | ||
+ | map_xps -infile:C:\temp\myfile.xps''' -toPrinter''':"Ricoh C830DN" | ||
+ | |||
+ | |||
+ | Les commutateurs suivants peuvent venir compléter cet envoi : | ||
+ | |||
+ | -FitPage : pour forcer l’impression pleine page | ||
+ | |||
+ | -Orientation:NN : pour changer l’orientation (1=Portrait, 2=Paysage) | ||
+ | |||
+ | -res:NN : pour changer la résolution (valeur numérique, exprimée en dpi) | ||
+ | |||
+ | -bpp:NN : gestion du mode couleur (1=Noir et blanc, 8=niveau de gris, 16 et 24=couleur) | ||
+ | |||
+ | -rotation:NN : angle de rotation en degrés (90, 180, 270, -90) | ||
+ | |||
+ | -logfile:XXX : écriture des erreurs dans un fichier de log | ||
+ | |||
+ | -TimeOut:NN : délai d’attente maximal (en secondes) si l’imprimante ne répond pas | ||
==Envoyer un document dans le spooler Mapping== | ==Envoyer un document dans le spooler Mapping== | ||
+ | En sortie des traitements effectués par la commande map_xps, le principe est de rediriger le fichier résultant vers une file d’attente du Spooler ONYX Server. Le commutateur utilisé est : '''-toQueue:XXX''', où XXX est le nom de la file d’attente configurée dans le Spooler Mapping. | ||
+ | |||
+ | Remarque : Cette redirection ne peut se faire qu’en local. | ||
+ | |||
+ | |||
+ | <u>Commutateurs optionnels</u> : | ||
+ | -title:XXX : titre du spool | ||
+ | |||
+ | -user:XXX : propriétaire du spool | ||
+ | |||
+ | -map_save : conserver le spool après édition | ||
+ | |||
+ | -map_hold : envoyer le spool à l’état suspendu | ||
+ | |||
+ | -map_priority:NN : ordre de priorité du spool | ||
+ | |||
+ | -map_nb_copy:NN : nombre de copies | ||
+ | |||
+ | -map_retention:NN : durée de rétention du spool | ||
+ | |||
+ | -map_security:NN : niveau de sécurité du spool | ||
+ | |||
+ | -map_codecompta:NN : code de comptabilité du spool | ||
+ | |||
+ | -map_fidelity:NN : attribut « Fidélité » | ||
+ | |||
+ | - map_userData:XXX=XXX : attribut userData | ||
+ | |||
+ | -o:XXX=XXX : attribut userData | ||
==Exécution d'actions== | ==Exécution d'actions== | ||
+ | Trois commutateurs permettent d’exécuter des actions particulières en sortie des traitements sur les documents XPS : | ||
+ | -exec:XXX : exécution d’une commande ou d’un script | ||
+ | |||
+ | -onError:XXX : exécution d’une commande ou d’un script en cas d’erreur de traitement | ||
+ | -onSuccess:XXX : exécution d’une commande ou d’un script lorsque le traitement réussit | ||
+ | |||
+ | |||
+ | Exemples: | ||
+ | map_xps -infile:/tmp/invoices.xps -toPDF -outfile:/share/invoices.pdf "-exec:/home/shell/call_archive.sh" | ||
+ | |||
+ | map_xps -infile:/tmp/invoices.xps -toPDF -outfile:/share/invoices.pdf "-onError:/home/shell/alert_exploit.sh" | ||
+ | "-onSuccess:/home/shell/send_sms.sh" | ||
==Envoi des mails== | ==Envoi des mails== | ||
+ | La commande '''map_xps''' permet également d’envoyer des documents par email en les joignant en pièce jointe ou directement dans le corps du message. Le commutateur à utiliser est '''-toEmail''' (ou '''-toMail''') suivi de tous les paramètres permettant la personnalisation des messages envoyés. | ||
+ | |||
+ | |||
+ | Attention : Le caractère requis ou optionnel des arguments listés ci-après dépend de la configuration du serveur SMTP adressé. | ||
+ | |||
+ | |||
+ | Paramètres obligatoires : | ||
+ | -server:XXX => adresse IP ou nom DNS du serveur SMTP | ||
+ | |||
+ | -from:XXX => adresse de l’expéditeur du message | ||
+ | |||
+ | -to:XXX => adresse(s) du ou des destinataires, séparées par des ‘;’ | ||
+ | |||
+ | -infile:XXX => document XPS à joindre à l’email envoyé | ||
+ | |||
+ | Paramètres optionnels : | ||
+ | -domain:XXX => domaine du serveur SMTP | ||
+ | |||
+ | -port:NN => port du serveur SMTP (25 par défaut) | ||
+ | |||
+ | -login:XXX => identifiant de connexion au serveur SMTP | ||
+ | |||
+ | -passwd:******* => mot de passé de connexion au serveur SMTP | ||
+ | |||
+ | -cc:XXX => destinataire(s) en copie | ||
+ | |||
+ | -bcc:XXX => destinataire(s) en copie cachée | ||
+ | |||
+ | ’’-subject:This is my subject’’ => sujet du message | ||
+ | |||
+ | ’’-body:This is my body’’ => corps du message au format texte | ||
+ | |||
+ | -bodyhtml:XXX => corps du message au format HTML | ||
+ | |||
+ | -footer:XXX => Pied de page du mail au format texte | ||
+ | |||
+ | -footerhtml:XXX => Pied de page du mail au format HTML | ||
+ | |||
+ | -attachment:XXX => ajout de pièce(s) jointe(s) supplémentaire(s) séparées par une virgule | ||
+ | |||
+ | -outfile:XXX => dans le cas de l’envoi d’email, cet argument sert à nommer la pièce jointe principale (argument infile)envoyée | ||
+ | |||
+ | |||
+ | Remarque : | ||
+ | |||
+ | Pour les deux commutateurs -bodyhtml et -footerhtml, le code HTML peut être passé directement en ligne de commandes. Plus généralement, on utilisera des fichiers externes stockés sur disque qui seront liés à l’envoi d’email avec les syntaxes suivantes : | ||
+ | -bodyhtml:FILE=/home/extern/mail_body.html | ||
+ | |||
+ | -footerhtml: FILE=/home/extern/mail_footer.html | ||
+ | |||
+ | Ces fichiers externes peuvent contenir des paramètres dynamiques (variables d’environnement, valeurs de critères d’indexation) qui seront remplacés à l’exécution. | ||
+ | |||
+ | |||
+ | Exemple 1 : | ||
+ | map_xps -infile:/tmp/invoice.xps -toMail -from:XXX -to:XXX -login:XXX -passwd:XXX -server:XXX ”-subject:Test envoi email” ”-body: | ||
+ | Ceci est un test” -outfile:nomPJ.xps | ||
+ | |||
+ | Exemple 2 : avec ajout de deux pièces jointes | ||
+ | map_xps -infile:/temp/invoice.xps -toMail -from:XXX -to:XXX -login:XXX -passwd:XXX -server:XXX “-subject:Test envoi email” ”-body: | ||
+ | Ceci est un test” -outfile:nomPJ.xps -attachment:/home/extern/PJ1.pdf,/home/extern/PJ2.pdf | ||
+ | |||
+ | Exemple 3 : conversion en PDF de la pièce jointe principale | ||
+ | map_xps -infile:/tmp/invoice.xps -toMail -from:XXX -to:XXX -login:XXX -passwd:XXX “-server:XXX-subject:Test envoi email” “-body: | ||
+ | Ceci est un test” -toPDF -outfile:nomPJ.pdf | ||
==Envoi dans M-Storage== | ==Envoi dans M-Storage== | ||
+ | |||
+ | Le principe est de créer les fichiers nécessaires au module M-Storage pour le stockage et l’indexation du document XPS. Le commutateur à utiliser est : '''-mapout'''. Les paramètres standards pour M-Storage peuvent être utilisés pour personnaliser l’intégration des documents dans la base de stockage soit dans un profil de conversion soit en ligne de commandes avec la syntaxe '''-param:NOM=valeur'''. | ||
+ | |||
+ | |||
+ | <u>Exemple</u> : | ||
+ | map_xps -infile:/tmp/invoice.xps -mapout -param:mapoutUserName=user -param:mapoutSpoolName=spoolname | ||
+ | -param:mapoutJobNum=jobnum -param:mapoutPrinterName=printer -param:mapoutReference=ref | ||
+ | -param:mapoutPaperFormat=paper -param:mapoutPgm=pgm -param:mapoutMapName=mapnam | ||
+ | |||
+ | <u>Signification des paramètres</u> : | ||
+ | -mapoutUserName : Propriétaire du document | ||
+ | |||
+ | -mapoutSpoolName : Nom du fichier spool | ||
+ | |||
+ | -mapoutJobNum : Numéro du travail | ||
+ | |||
+ | -mapoutPrinterName : Nom de l'imprimante | ||
+ | |||
+ | -mapoutReference : Référence | ||
+ | |||
+ | -mapoutPaperFormat : Format de papier | ||
+ | |||
+ | -mapoutPgm : Nom du programme | ||
+ | |||
+ | -mapoutMapName : Nom du format M-Designer de composition |
Version actuelle datée du 2 juin 2020 à 16:58
Sommaire
Affichage écran(Windows uniquement)
Sous Windows, l’utilisation de l’interface graphique (Graphics Device Interface) permet d’afficher un document à l’écran.
Exemple :
map_xps -infile:C:\temp\label.zpl -fromZPL -toGDI
Envoyer un document dans le spooler systeme(Windows uniquement)
En sortie des traitements effectués par la commande map_xps, la possibilité est donnée de rediriger le fichier résultant vers une imprimante Windows déclarée sur le poste. Le pilote d’impression configurée sera alors utilisé pour l’impression.
Exemple :
map_xps -infile:C:\temp\myfile.xps -toPrinter:"Ricoh C830DN"
Les commutateurs suivants peuvent venir compléter cet envoi :
-FitPage : pour forcer l’impression pleine page
-Orientation:NN : pour changer l’orientation (1=Portrait, 2=Paysage)
-res:NN : pour changer la résolution (valeur numérique, exprimée en dpi)
-bpp:NN : gestion du mode couleur (1=Noir et blanc, 8=niveau de gris, 16 et 24=couleur)
-rotation:NN : angle de rotation en degrés (90, 180, 270, -90)
-logfile:XXX : écriture des erreurs dans un fichier de log
-TimeOut:NN : délai d’attente maximal (en secondes) si l’imprimante ne répond pas
Envoyer un document dans le spooler Mapping
En sortie des traitements effectués par la commande map_xps, le principe est de rediriger le fichier résultant vers une file d’attente du Spooler ONYX Server. Le commutateur utilisé est : -toQueue:XXX, où XXX est le nom de la file d’attente configurée dans le Spooler Mapping.
Remarque : Cette redirection ne peut se faire qu’en local.
Commutateurs optionnels :
-title:XXX : titre du spool
-user:XXX : propriétaire du spool
-map_save : conserver le spool après édition
-map_hold : envoyer le spool à l’état suspendu
-map_priority:NN : ordre de priorité du spool
-map_nb_copy:NN : nombre de copies
-map_retention:NN : durée de rétention du spool
-map_security:NN : niveau de sécurité du spool
-map_codecompta:NN : code de comptabilité du spool
-map_fidelity:NN : attribut « Fidélité »
- map_userData:XXX=XXX : attribut userData
-o:XXX=XXX : attribut userData
Exécution d'actions
Trois commutateurs permettent d’exécuter des actions particulières en sortie des traitements sur les documents XPS :
-exec:XXX : exécution d’une commande ou d’un script
-onError:XXX : exécution d’une commande ou d’un script en cas d’erreur de traitement
-onSuccess:XXX : exécution d’une commande ou d’un script lorsque le traitement réussit
Exemples:
map_xps -infile:/tmp/invoices.xps -toPDF -outfile:/share/invoices.pdf "-exec:/home/shell/call_archive.sh"
map_xps -infile:/tmp/invoices.xps -toPDF -outfile:/share/invoices.pdf "-onError:/home/shell/alert_exploit.sh" "-onSuccess:/home/shell/send_sms.sh"
Envoi des mails
La commande map_xps permet également d’envoyer des documents par email en les joignant en pièce jointe ou directement dans le corps du message. Le commutateur à utiliser est -toEmail (ou -toMail) suivi de tous les paramètres permettant la personnalisation des messages envoyés.
Attention : Le caractère requis ou optionnel des arguments listés ci-après dépend de la configuration du serveur SMTP adressé.
Paramètres obligatoires :
-server:XXX => adresse IP ou nom DNS du serveur SMTP
-from:XXX => adresse de l’expéditeur du message
-to:XXX => adresse(s) du ou des destinataires, séparées par des ‘;’
-infile:XXX => document XPS à joindre à l’email envoyé
Paramètres optionnels :
-domain:XXX => domaine du serveur SMTP
-port:NN => port du serveur SMTP (25 par défaut)
-login:XXX => identifiant de connexion au serveur SMTP
-passwd:******* => mot de passé de connexion au serveur SMTP
-cc:XXX => destinataire(s) en copie
-bcc:XXX => destinataire(s) en copie cachée
’’-subject:This is my subject’’ => sujet du message
’’-body:This is my body’’ => corps du message au format texte
-bodyhtml:XXX => corps du message au format HTML
-footer:XXX => Pied de page du mail au format texte
-footerhtml:XXX => Pied de page du mail au format HTML
-attachment:XXX => ajout de pièce(s) jointe(s) supplémentaire(s) séparées par une virgule
-outfile:XXX => dans le cas de l’envoi d’email, cet argument sert à nommer la pièce jointe principale (argument infile)envoyée
Remarque :
Pour les deux commutateurs -bodyhtml et -footerhtml, le code HTML peut être passé directement en ligne de commandes. Plus généralement, on utilisera des fichiers externes stockés sur disque qui seront liés à l’envoi d’email avec les syntaxes suivantes :
-bodyhtml:FILE=/home/extern/mail_body.html
-footerhtml: FILE=/home/extern/mail_footer.html
Ces fichiers externes peuvent contenir des paramètres dynamiques (variables d’environnement, valeurs de critères d’indexation) qui seront remplacés à l’exécution.
Exemple 1 :
map_xps -infile:/tmp/invoice.xps -toMail -from:XXX -to:XXX -login:XXX -passwd:XXX -server:XXX ”-subject:Test envoi email” ”-body: Ceci est un test” -outfile:nomPJ.xps
Exemple 2 : avec ajout de deux pièces jointes
map_xps -infile:/temp/invoice.xps -toMail -from:XXX -to:XXX -login:XXX -passwd:XXX -server:XXX “-subject:Test envoi email” ”-body: Ceci est un test” -outfile:nomPJ.xps -attachment:/home/extern/PJ1.pdf,/home/extern/PJ2.pdf
Exemple 3 : conversion en PDF de la pièce jointe principale
map_xps -infile:/tmp/invoice.xps -toMail -from:XXX -to:XXX -login:XXX -passwd:XXX “-server:XXX-subject:Test envoi email” “-body: Ceci est un test” -toPDF -outfile:nomPJ.pdf
Envoi dans M-Storage
Le principe est de créer les fichiers nécessaires au module M-Storage pour le stockage et l’indexation du document XPS. Le commutateur à utiliser est : -mapout. Les paramètres standards pour M-Storage peuvent être utilisés pour personnaliser l’intégration des documents dans la base de stockage soit dans un profil de conversion soit en ligne de commandes avec la syntaxe -param:NOM=valeur.
Exemple :
map_xps -infile:/tmp/invoice.xps -mapout -param:mapoutUserName=user -param:mapoutSpoolName=spoolname -param:mapoutJobNum=jobnum -param:mapoutPrinterName=printer -param:mapoutReference=ref -param:mapoutPaperFormat=paper -param:mapoutPgm=pgm -param:mapoutMapName=mapnam
Signification des paramètres :
-mapoutUserName : Propriétaire du document
-mapoutSpoolName : Nom du fichier spool
-mapoutJobNum : Numéro du travail
-mapoutPrinterName : Nom de l'imprimante
-mapoutReference : Référence
-mapoutPaperFormat : Format de papier
-mapoutPgm : Nom du programme
-mapoutMapName : Nom du format M-Designer de composition