Généralité du XPSConfig/en

<language/>
==The configuration file: xpsConfig.conf==


===Definition===
All conversions from the pivot XPS format to the destination languages are handled natively in the engine. They are defined and refined by different fully configurable conversion profiles and stored in a configuration file called XPSConfig.conf.
Physically, this file is located in the folder defined by the XPSCONFIG configuration variable.

Example on Windows:
 [XPSCONFIG] C:\Program Files\M-Processing Server\Settings\XPSConfig.conf

Example on Linux:
 [XPSCONFIG] /apps/mapping/conf/XPSConfig.conf


===Structure and syntax===


The general structure of the XPSConfig.conf file is based on XML syntax:

 <xpsconfig>
   <profile_1>
          <param_1>valeur</param_1>
          <param_2>valeur</param_2>
          <param_3>valeur</param_3>
           …
    </profile_1>
    <profile_2>
            <param_1>valeur</param_1>
            <param_2>valeur</param_2>
            …
    </profile_2>
            …
 </xpsconfig>

As many conversion profiles as necessary can be declared depending on the different input/output channels of production documents. Each profile must have a unique name which will be used by Spooler Mapping or on the command line to identify the correct conversion profile. For each profile, all the useful parameters allowing the conversion to be carried out, refined and optimized are provided.


Important:

All information contained in this configuration file is case sensitive: name of the different profiles, names and values of the parameters.


Note:


All parameters documented below can also be used on the command line and can be overridden when calling a <FONT color="blue"> map_xps </FONT> conversion command. The syntax for calling a particular parameter is then: <code>-param:parameter_name=value</code>.

===Generic parameters===


Some parameters are generic and can be used in all profiles regardless of the conversion language.



====Language====

This first parameter is required for all profiles. It defines the output language of the conversion. 
The syntax in the profile is:<code><language>PCL</language></code>

Here is the list of all output formats supported by ONYX Server:

*XPS (default language if not specified in the profile)
*Print languages:
**PCL		
**ZEBRA
**AFPDS	
**PGI
**PS (PostScript)
**TEC
**PROPRINTER
**EPL
**ESCP
**MONARCH
**XMLPOS
**DPL (Datamax)
**DB4


*Web languages:
**HTML
**RTF
**PDF
**DOCX
**TXT


*ONYX Server outputs:


MAPDRAW (used for importing XPS assets into M-Designer)


*Image outputs:

IMAGE

BMP

====Label====


This optional parameter allows you to give a user description to the profile. This description will be used in particular in the ONYX Server Spooler for configuring print queues (XPS compatibility parameter).


The syntax in the profile is:<code><label>PCL5 printing in black and white</label></code>


====Color====

This optional parameter allows you to activate or deactivate color conversion for destinations that support it. When this parameter is not specified in the profile, the principle is to respect a conversion faithful to the original XPS document. So, for destinations that support it, color conversion is enabled by default.


The syntax in the profile is: <code> <color>on</color></code>


<u>Supported values</u>: ON/OFF, on/off, YES/NO, yes/no, 0/1


<u>Default value</u>: ON, except for the AFPDS language.


For languages that support it, ICC (International Color Consortium) color profiles are also supported, with the syntax: <code><outputICC>path_to_ICC_file</outputICC></code>



====Code page====


This optional parameter allows you to define the output code page for destinations that support it.
The syntax in the profile is:<code><codepage>850</codepage></code>


<u>Supported values</u>: depending on the output language


<u>Default value</u>: dependent on output language


====Resolution====


This optional parameter allows you to define the output resolution of the document expressed in dpi (dots per inch).
The syntax in the profile is:<resolution>240</resolution>

<u>Supported values</u>: 200, 300, 600....


<u>Default value</u>: that of the defined output language



For destinations that support it, the resolution (in dpi) of the document images can also be specified with the syntax: <code><resolutionimage>240</resolutionimage></code>


<u>Supported values</u>: 203, 300, 600…

<u>Default value</u>: that of the defined output language


====Rotation====


This optional parameter allows you to define the rotation angle (anti-clockwise or trigonometric) of the output pages. The syntax in the profile is:<code><pagerotation>90</pagerotation></code>

<u>Supported values</u>: 0, 90, 180, 270

<u>Default value</u>: 0 (no rotation)


====Paper Size====


This optional parameter allows you to modify the format of the output pages. The size of the pages as well as the content will be recalculated.
The syntax in the profile is:<code><changeformat>Letter</changeformat></code>

<u>Supported ISO standard values</u>: A2, A3, A3 Extra, A4, A4 Plus, A4 Extra, A5, A5 Extra, A6, B4, B5, B5 Extra, B6, Envelope #9, Envelope #10 , Envelope #11, Envelope #12, Envelope #14, Envelope B4, Envelope B5, Envelope B6, Envelope C3, Envelope C4, Envelope C5, Envelope C6, Envelope C65, Envelope DL, Envelope Invite, Envelope Monarch, Envelope, Executive, Folio, German Legal Fanfold, German Std Fanfold, Japanese Postcard, Japanese Double Postcard, Ledger, Legal, Legal Extra, Letter , Letter Extra, Letter Plus, Letter Small, Note,PRC 16K, PRC 32K, PRC 32K(Big), PRC Envelope #1, PRC Envelope #2, PRC Envelope #3, PRC Envelope #4, PRC Envelope #5, PRC Envelope #6, PRC Envelope #7, PRC Envelope #8, PRC Envelope #9, PRC Envelope #10, Quarto, Statement, SuperA, SuperB, Tabloid, Tabloid Extra, US Std Fanfold.


Custom values are also supported, with the syntax:<code><changeformat>xx.xx,xx.xx[,cm|in|mm]</changeformat></code>


*two decimal values, separated by a comma corresponding to width and height respectively
*The decimal separator is ‘.’
*The unit is optional: cm (default), mm or in (for inch)
*The brackets should be removed (they symbolize the optional aspect)


====Image output====


This optional parameter allows conversion to image mode, for languages that support it. The size of the flows is not optimal but the rendering of all elements is thus guaranteed.
The syntax in the profile is:<code><fullimage>on</fullimage></code>



<u>Supported values</u>: ON/OFF, on/off, YES/NO, yes/no, 0/1


<u>Default value</u>: off


====Interval between 2 labels==== 


This optional parameter allows you to define, for thermal languages, the distance between two labels. The value is expressed in points. The syntax in the profile is:<code><gap>24</gap></code>



====Page offset====


These optional parameters allow you to shift all the pages of a document without changing the margins. Values are expressed in 96dpi and are decimal. The syntax in the profile is:
 <XpsTopOffset>10.2</XpsTopOffset>
 <XpsLeftOffset>8.1</XpsLeftOffset>



====Image resizing quality====


This optional parameter allows you to improve the quality of image resizing in order to make it more precise. The syntax in the profile is:<code><precisemode>on</precisemode></code>



<u>Supported values</u>: ON/OFF, on/off, YES/NO, yes/no, 0/1


<u>Default value</u>: off



===Font management===


The XPS document contains all the resources necessary for its display including, in particular, the fonts used in ODTTF format. In conversion to an output language, the choice is possible whether or not to embed the fonts in the flow. This choice will depend on the languages and printing equipment.



====Embedded fonts====

This optional parameter allows you to activate or deactivate the incorporation of fonts in the final document. When this setting is enabled, the fonts used in the XPS document will be embedded in the output stream and therefore sent to the printer. Otherwise, the printer's resident fonts will be used for printing. When this parameter is not specified, it is enabled by default. The syntax in the profile is: <code><embeddedfont>ON</embeddedfont></code>


<u>Supported values</u>: ON/OFF


<u>Default value</u>: ON (except for AFPDS, PS and RTF languages)


When this setting is disabled, another setting allows you to force the use of a default resident font for any undeclared XPS font (see below). The syntax in the profile is:<code><defaultfont>1</defaultfont></code>



<u>Supported values</u>: from 1 to n, identifying the number of the font match to use by default in the profile.


<u>Default value</u>: 1


====Resident fonts====

When the previous setting is disabled, it is necessary to predict the correspondence between the fonts of the XPS document and those to be used on the printer. This correspondence table is constructed in the profile with the following syntax:
 <nowiki><fonts>
          <font name="Arial" size="10" height="100" italic="0" bold="0" zoomx="1" zoomy="1" codeFont="4" />
          <font name="Tahoma" size="10" height="100" italic="0" bold="0" zoomx="1" zoomy="1" codeFont="A" />
          …
          </fonts></nowiki>


In this table, between one and five parameters are used to identify XPS fonts:


*name = XPS font name (required)
*size = size in points of the font (optional)
*height = height or vertical deformation in percentage (optional)
*italic = italicized font or not (optional)
*bold = bold font or not (optional)


Then between one and five parameters are used to identify the resident font that should be called:


*codeFont = resident font number to use for printing (required). The values depend on the printing language and printer model and are generally given by the printer manufacturer.


Examples: 


- for a Zebra printer, the values go from A to Z, or from 1 to 9


- for an Eltron printer, the values range from 1 to 5


*zoomx = size to width multiplication factor (optional)
*zoomy = size-height multiplication factor (optional)
*type = resident font type (bitmap or vector) in TEC language (optional)
*fgid = AFP font identifier (optional)



===1D barcode management===


Since 1D barcodes are also rendered by fonts, the same choice as above is possible depending on the languages and printing equipment.



====Onboard or resident barcode====

This optional parameter allows, for thermal languages and AFPDS, to activate or deactivate the rendering of 1D barcodes by the printers themselves. When this setting is enabled, barcode printing is handled by the printer using its resident fonts. Otherwise, the fonts used in the XPS document will be embedded in the flow and therefore sent to the printer. When this parameter is not specified, it is activated by default.

The syntax in the profile is:<code><barcode>PRINTER</barcode></code>

<u>Supported values</u>: IMG, FONT, PRINTER

<u>Default value</u>: PRINTER


IMG: embedded as an image<br>
FONT: embedded as a font<br>
PRINTER: the barcode is generated by the printer<br>


====Printer rendering====

When the previous setting is activated, it is necessary to predict the correspondence between the fonts of the XPS document and those to be used on the printer. This correspondence table is constructed in the profile with the following syntax:
 <barcodes>
 <barcode type="21" size="35" height="200" bcheight="40" bcwidth="A,B" />
 …
 </barcodes>


In this table, three parameters are used to identify XPS fonts:

*type = barcode type (see table below)
*size = size in points of the font
*height = height or vertical deformation in percentage



Then two parameters are used to customize the physical dimensions of a barcode when printed:


*bcheight = desired height of the barcode (in points)
*bcwidth = desired width of the barcode, specifying for example the width of a thin element and the ratio between thin and thick element


The syntax and values of these two parameters depend on the final printing language and the type of barcode. List of barcodes supported by ONYX Server, with their type:

{| class="wikitable"
|-
|2||PDF 417
|-
|11||Data Matrix
|-
|12||QR Code
|-
|14||MaxiCode
|-
|17||EAN 13
|-
|18||EAN 8
|-
|19||Code 39
|-
|20||Code 39 No check
|-
|21||Code 128 alpha optimzed
|-
|22||Code 128 alpha non optimized
|-
|23||Code 128 Numeric
|-
|24||2 Among 5 Interlaced
|-
|25||2 Among 5 Interlaced No Check
|-
|26||2 Among 5 industrial
|-
|27||2 Among 5 industrial No ckeck
|-
|28||EAN 128 alpha non optimized
|-
|29||EAN 128 numéric
|-
|30||EAN 128 alpha optimized
|-
|31||Postnet
|-
|32||Planet
|-
|35||Native
|-
|77||Japan Postal
|-
|78||Codabar
|-
|79||USPS
|-
|80||UPC-A
|-
|81||UPC-E
|-
|82||MSI
|-
|83||MSI 2 mod. 10
|-
|84||MSI mod. 11
|-
|85||MSI mod. 11 mod. 10
|-
|86||MSI no check
|}