M-Engine guide

<language/>

Introduction

M-Engine is the new Mapping program. This program replaces map_xps and brings new features.A map_xps program still exists for backwards compatibility, but it uses M-Engine code.

Principle

The M-Engine works with a system of inputs and outputs. Inputs are command line arguments beginning with " -from”, outputs start with “-to”. Each argument can have several parameters (of type parameter=value) separated by the character ‘|’.

For example, converting an XPS file to PCL is done with the following command:

M-Engine.exe -fromXPS:fichier.xps –toPCL:fichier.pcl

If you want to call a conversion profile for PCL rendering:

M-Engine.exe -fromXPS:fichier.xps –toPCL:fichier.pcl|profile=PCL_Color

The file name is a parameter like any other, except that the parameter name is not necessary. But we could write the command like this: M-Engine.exe -fromXPS:file=file.xps –toPCL:file=file.pcl|profile=PCL_Color

Multiple inputs/outputs

The M-Engine command can accept several files as input and output, of different types. For example, converting a XPS file in PCL and PDF is done with the following command:

M-Engine.exe -fromXPS:fichier.xps –toPCL:fichier.pcl –toPDF:fichier.pdf

In the same way we can use several input files, these will be concatenated and/or merged according to the order of appearance in the command line:

Concatenating an XPS and a PDF:

M-Engine.exe -fromXPS:fichier.xps –fromPDF:fichier.pdf –toPCL:fichier.pcl

Using a PDF as a layer on an XPS:

M-Engine.exe -fromXPS:fichier.xps –fromPDF:fichier.pdf|merge=once –toPCL:fichier.pcl

The options can be combined, so you can concatenate several files and apply one or more layers to them before converting them. It is possible to work on all the files in a directory, thanks to the use of the ‘*’ character in the name of the input file. Concatenating all PDF files in a folder into a single PCL file:

M-Engine.exe -fromPDF:folder\*.pdf –toPCL:file.pcl 

Command line arguments

Input files

• -fromImage: or -fromIMG:

Allows you to add an image type input file (PNG, BMP, JPEG or TIFF) to the M-Engine.

• -fromXPS:

Allows you to add an XPS type input file to the M-Engine.

• -fromPDF:

Allows you to add a PDF input file to the M-Engine.

• -fromPS:

Allows you to add a PostScript input file to the M-Engine.

• -fromAFP:

Allows you to add an AFPDS type input file to the M-Engine.

• -fromPCL:

Allows you to add a PCL type input file to the M-Engine.

• -fromIGP:

Allows you to add a Printronix IGP type input file to the M-Engine.

• -fromZPL:

Allows you to add a Zebra ZPLII type input file to the M-Engine.

• -fromTEC:

Allows you to add a Toshiba TEC TPCL type input file to the M-Engine.

• -fromESCP:

Allows you to add an ESC-P type input file to the M-Engine.

• -fromTXT:

Allows you to add a TXT input file to the M-Engine.  

Output files

• -to:

Allows you to add a typeless output file to the M-Engine. The file type must be defined in a conversion profile passed as a -to parameter.

For example: -to:c:\test\outfile.tmp|profile=profilename

The use of a conversion profile is mandatory with this command.  

Outputs for printing

• -toPCL:

Allows you to add a PCL type output file to the M-Engine.

• -toAFP:

Allows you to add an AFPDS type output file to the M-Engine.

• -toESCP:

Allows you to add an ESC-P type output file to the M-Engine.

• -toProPrinter:

Allows you to add a ProPrinter type output file to the M-Engine.

• -toOPOS:

Allows you to add an OPos type output file to the M-Engine.

• -toPrinter:

Allows you to add a printer output to the M-Engine. Example: M-Engine -fromXPS:infile.xps "-toPrinter:RICOH Aficio SP C830DN" Only works on Windows. The following name -toPrinter: must be the name of a printer defined on the Windows workstation.

Outputs for viewing and printing

• -toXPS:

Allows you to add an XPS type output file to the M-Engine.

• -toPDF:

Allows you to add a PDF output file to the M-Engine.

• -toPS:

Allows you to add a PostScript output file to the M-Engine.

• -toRTF:

Allows you to add an RTF output file to the M-Engine.

• -toDOCX:

Allows you to add a Word Docx type output file to the M-Engine.

• -toHTML:

Allows you to add an HTML output file to the M-Engine.  

Outputs for Thermal/BCP printing

• -toDPL:

Allows you to add a Datamx DPL type output file to the M-Engine.

• -toEPL:

Allows you to add an Eltron EPL type output file to the M-Engine.

• -toIGP:

Allows you to add a Printronix IGP type output file to the M-Engine.

• -toTEC:

Allows you to add a Toshiba TEC TPCL type output file to the M-Engine.

• -toDB4:

Allows you to add a Toshiba TEC DB4 type output file to the M-Engine.

• -toZPL: or -toZEBRA:

Allows you to add a Zebra ZPLII type output file to the M-Engine.

• -toMonarch:

Allows you to add a Monarch type output file to the M-Engine.  

File outputs

• -toIMG:

Allows you to add an Image type output file to the M-Engine, the image format will be chosen according to the file extension (.png, .jpeg, .bmp or .tiff).

• -toTXT:

Allows you to add a TXT output file to the M-Engine.

• -toXML:

Allows you to add an XML output file to the M-Engine. This format allows you to export the texts of a document in XML format. Example : <glyph y="64.960000" x="11.520000" line="11" col="4" >SHIP TO POSTAL CODE</glyph>

• -toXMLPOS:

Allows you to add an XML pos output file to the M-Engine. This format allows you to export the texts of a document in XML format.

Example :

<TEXT VALUE="SHIP TO POSTAL CODE" ORIENTATION="0" POSX="24" POSY="135" SIZE="5" FONT="Courier New" BOLD="1" ITALIC="0"/>

• -toIndex:

Allows you to add an index type output file to the M-Engine. The format can be xml or txt depending on the output file extension.

This output is used to export the metadata of a document.

• -toMDesigner:

Allows you to add an M-Designer XML type output file to the M-Engine. The resulting xml file can then be imported into Designer to create a mock-up.

• -toXMLDRAW:

Allows you to add an XML Mapping type output file to the M-Engine. An M-Designer mockup can then be applied to this XML to create a new XPS file.

Output for archiving

• -toEverteam:

Allows you to add an output file for Everteam to the M-Engine.

• -toEasyFolder:

Allows you to add an output file for EasyFolder to the M-Engine.

• -toDigitech:

Allows you to add an output file for Digitech to the M-Engine.

• -toOnBase:

Allows you to add an output file for OnBase to the M-Engine.

• –toMStorage:

Allows you to add an output file for M-Storage to the M-Engine.

Global options

• –replaceEnv

Enables the replacement of values ​​in square brackets (“[[variable]]”) with the contents of environment variables of the same name.

• -addIndex:

Allows the addition of metadata to output files.

Syntax: -addIndex:metadataname=value Or -addIndex:metadataname=FILE:filepath

• –indexOnAllPages:

Permet de dupliquer certains index sur les pages ou ils ne sont pas présents.

Syntaxe : -indexOnAllPages:nomindex1,nomindex2,nomindex3

• -sort:

Indique un index sur lequel se baser pour trier les pages des fichiers.

-sort:nomindex1,nomindex2,nomindex3 Ou -sort:nomindex1 -sort:nomindex2 -sort:nomindex3

• -filter:

Permet de filtrer les pages des fichiers d’entrée en fonction des valeurs des métadonnées. Les opérateurs mathématiques (=, <, >, <=, >=) et logiques (AND, OR) peuvent être employés pour des filtres complexes sans oublier les parenthèses de priorités.

• -exec:

Permet l’exécution d’une ligne de commande quelconque en fin de traitement.

• -onError:

Permet l’exécution d’une ligne de commande quelconque en fin de traitement si une erreur s’est produite.

• -onSuccess:

Permet l’exécution d’une ligne de commande quelconque en fin de traitement si aucune erreur ne s’est produite.

• –duplicateindex

Permet lors d’un export de métadonnées (-toIndex par exemple) de prendre en compte toutes les occurrences des valeurs.  

• -set:

Ajoute ou modifie les options des printtickets.

Syntaxe : -set:option1=valeur1|option2=valeur2|option3=valeur3

Options possibles :

• filter

Permet de filtrer la modification du printticket en fonction des métadonnées de la page (syntaxe identique au -filter)

DUPLEX Permet de choisir une impression recto-verso, les valeurs possibles sont :

• long
• short
• TwoSidedLongEdge
• TwoSidedShortEdge
• OneSided

• INPUTBIN

Détermine le numéro du bac d’entrée à utiliser. Valeur numérique attendue.

• OUTPUBIN

Détermine le numéro du bac de sortie à utiliser. Valeur numérique attendue.

ORIENTATION Détermine l’orientation de la page, les valeurs attendues sont :

• 0 -> Portrait
• 1 -> Paysage
• 2 -> Portrait inversé
• 3 -> Paysage inversé

• COPY

Détermine le nombre de copie de chaque page. Valeur numérique attendue.

• TOPOFFSET

Détermine le décalage haut de chaque page. Valeur numérique attendue.

• LEFTOFFSET

Détermine le décalage gauche de chaque page. Valeur numérique attendue.

• TOGGLE

Ajoute un séparateur de job à la page. Valeur booléenne attendue (0, 1, ON, OFF, YES, NO).

• MEDIATYPE

Défini le type de papier à utiliser. Chaine de caractère attendue.

• FRONTSIDE

Permet de forcer l’impression en recto de la page. Quel que soit le mode de duplex en cours.

STAPLE Gestion de l’agrafage. Valeurs possibles :

• 1 : SaddleStitch (agrafage au milieu de la feuille)
• 2 : StapleBottomLeft (agrafage en bas à gauche)
• 3 : StapleBottomRight (agrafage en bas à droite)
• 4 : StapleDualBottom (agrafage en bas)
• 5 : StapleDualLeft (agrafage à gauche)
• 6 : StapleDualRight (agrafage à droite)
• 7 : StapleDualTop (agrafage en haut)
• 8 : StapleTopLeft (agrafage en haut à gauche)
• 9 : StapleTopRight (agrafage en bas à droite)
• 16 : None (pour stopper l’agrafage) *Dans la documentation il est indiqué 10, probablement une erreur dans le code

• La documentation fait référence aux options NUP et JOBCUT, mais ces options ne sont pas présentes en v8 actuellement

-lpr: Permet l’envoi des fichiers de sortie à une queue Mapping. Les différents paramètres sont séparés par le caractère ‘|’. Les paramètres possibles sont :

• title=title
• queue=queue
• user=user
• priority=priority
• nbcopy=nbcopy
• retention
• compress=compress
• security=security
• codecompta=codecompta
• fidelity=fidelity
• userdata=userdata
• add
• save
• hold

Paramètres des Loaders et Renders

Chaque fichier d’entrée (loader) et chaque fichier de sortie (render) peut posséder une liste de paramètres. Ces paramètres sont séparés par le caractère ‘|’ et suivent la syntaxe « paramètre=valeur ».

Ces paramètres sont toutes les options possibles du fichier XpsConfig.xml, par exemple l’option de choix de résolution d’un profil du XpsConfig (<dpi>300</dpi> dans le fichier) sera utilisé en ligne de commande de cette manière : « toPCL:nomfichier.pcl|dpi=300 »  

Concaténation et utilisation de calques

Concaténation

Il existe plusieurs manières de concaténer des fichiers.

Utilisation de plusieurs loaders

Il suffit d’indiquer plusieurs fichiers d’entrée pour les concaténer. La concaténation se fera selon l’ordre d’apparition dans la ligne de commande.

-fromXPS:fichier1.xps -fromXPS:fichier2.xps -toXPS:concat.xps

Les fichiers d’entrée peuvent être de langages différents, il est aussi possible d’avoir plusieurs fichiers de sortie pour effectuer la concaténation dans diffèrent langage par exemple.

Scanne de répertoires

La deuxième méthode pour concaténer des fichiers consiste à utiliser le caractère ‘*’ dans le nom du fichier pour permettre la lecture de plusieurs fichiers.

-fromXPS:*.xps -toXPS:concat.xps

Ou

-fromXPS:prefixe* -toXPS:concat.xps

Calques

Pour utiliser un fichier d’entrée comme calque il doit posséder le paramètre « merge ». Le paramètre « merge » peut prendre plusieurs valeurs :

• repeatall

Toutes les pages sont fusionnées en répétant le calque jusqu’à la fin des fichiers d’entrée.

• repeatfull

Toutes les pages sont fusionnées en répétant le calque tant qu’il peut être inséré entièrement.

• once

Le calque n’est inséré qu’une seule fois sur la ou les premières pages du fichier d’entrée.

Ordre des traitements

• Etape 1 :

Tri des pages des fichiers d’entrée si nécessaire (présence de l’option -sort par exemple).

• Etape 2 :

Récupération de la page à traiter. Le traitement démarre avec la première page du premier fichier d’entrée, une fois toutes les pages du fichier traitées on passe au fichier suivant. Fin du traitement lorsqu’il n’y a plus de page à traiter.

• Etape 3 :

Application des options de transformation du fichier d’entrée à la page (rotation, offset, redimensionnent)

• Etape 4 :

Vérification des filtres. Si l’option -filter est présente, le filtre est appliqué à la page pour déterminer si elle doit être traitée. Retour à l’étape 2 si la page ne correspond pas au filtre.

• Etape 5 :

Modification des printtickets de la page si présence de l’option -set.

• Etape 6 :

Remplacement des variables M-Designer de type « nombre total de page », « nombre total de document », etc…

• Etape 7 :

Rendu des calques dans les fichiers de sortie. (Apres avoir appliqué les options de transformation au calque)

• Etape 8 :

Application des options de transformation du fichier de sortie à la page (rotation, offset, redimensionnent) Et rendu de la page dans le fichier de sortie. Etape répétée pour chaque fichier de sortie.

• Etape 9 :

Génération d’un saut de page dans chaque fichier de sortie. Et retour à l’étape 2.