Evolis SDK

API mode Print

settings guide

1
Contents
Scope ............................................................................................................................................................................................... 3
Printers compliance .......................................................................................................................................................... 3
Limitations ............................................................................................................................................................................... 3
Initials used in this documentation ......................................................................................................................... 3
General settings ........................................................................................................................................................................ 4
Print settings .............................................................................................................................................................................. 5
Other setting............................................................................................................................................................................... 6
Magnetic settings .................................................................................................................................................................... 7
Combinate settings ................................................................................................................................................................ 7
Primacy 2 ....................................................................................................................................................................................... 8
Evosettings to manage printer's settings ................................................................................... 8
Get the current settings for a Primacy 2 thanks to evosettings ................................... 8
Disclaimer ..................................................................................................................................................................................... 9

2
Scope
Printers compliance
• Zenius, Primacy, Elypso, Apteo, KC200, KC200/B, KM500B, KM2000B
(Managed by Evolis Premium Suite).
• Edikio Access, Flex, Duplex (managed by the Edikio Printer Suite).
• Badgy 100 et Badgy 200 (Managed by the Badgy Premium Suite)

For Primacy 2 (Evolis Premium Suite 2), please refer to this section, pay
attention than the way to access the settings is different but the settings remain
fully compatible.

Limitations
Settings described in this documentation may differ from one printer’s model from another
(ex: Advanced smoothing is not available for Badgy). This means most common printer
settings are described in this document, but values may not be available or different.

A non-existing setting on a specific printer will return an error when sending the request.
To get all printing parameters and their possible values for each printer model, read the
settings.xml file available from:

•
•

Or directory in which the installation of the suite (Evolis Premium Suite, Edikio Printer Suite,
Badgy Premium Suite…) has been performed.

Initials used in this documentation

I : Invisible (e.g. : IShortPanelShift)

G : Global (e.g.: GInputTray)

F : Front (e.g.: FColorContrast)

B : Back (e.g.: BPageRotate180)

This document applies to the PRINT and SETTING services available in the API MODE with
the Evolis Services Provider Framework.

3
 General settings
Setting Description Allowed value

FpageRotate180 Front side rotation (180°) ON

OFF
BPageRotate180 Back side rotation (180°) ON
OFF
GInputTray Card insertion mode FEEDER
AUTO
MANUAL
PRINTER

GoutputTray Card ejection mode HOPPER

REAR
PRINTER
GRejectBox On error ejection mode DEFAULT
REJECT HOPPER
PRINTER

GRibbonType Ribbon type RC_YMCKO

RC_YMCKOS
RC_YMCKOK
RC_YMCKOKOS
RM_KO
RM_KBLACK
RM_KWHITE
RM_KRED
RM_KGREEN
RM_KBLUE
RM_KSCRATCH
RM_KMETALSILVER
RM_KMETALGOLD
RM_KSIGNATURE
RM_KWAX
RM_KPREMIUM
RM_HOLO
Duplex Dual side print management NONE
NONE = Disabled HORIZONTAL
HORIZONTAL = Enabled
GDuplexType Front side and Back side DUPLEX_CC
settingsC = Color DUPLEX_CM
M =Monochrome DUPLEX_MC
Ex: CC = Front Color, Back Color DUPLEX_MM

4
 Sample request for general settings :

{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.Set",
"params": {
"session": "JOB000001", "data":
"GRibbonType=RC_YMCKO"
}
}

Settings could be sent one by one or combinated in the same request

Print settings
Settings for both sides of the card follow this syntax:
• F prefix is for Front Side (ex : FColorContrast : contrast for Color Front Side)
• B prefix is for Back Side (ex: BColorContrast : contrast for Color Back Side)

Setting Description Allowed value

Resolution Define print resolution DPI300

DPI600300
DPI1200300

FColorContrast Contrast adjustment for color panel VAL1 to VAL20

BColorContrast
FcolorBrightness Brightness adjustment for color panel VAL1 to VAL20

BColorBrightness
FBlackManagement Black panel management mode NOBLACKPOINT
BBlackManagement ALLBLACKPOINT
TEXTINBLACK
FHaltoning Grayscale adjustment for black panel THRESHOLD FLOYD
BHalftoning DITHERING
CLUSTERED_DITHERING
FMonochromeContrast Monochrome resin adjustment VAL1 to VAL20

BMonochromeContrast
Front and back Overlay contrast VAL1 to VAL20
FOverlayContrast
BOverlayContrast
FOverlaymanagement Varnish /Overlay type NOVARNISH
BOverlaymanagement FULLVARNISH
BMPVARNISH

5
 Sample JSON request corresponding to a print setting :

{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.Set",
"params":{
"session": "JOB000002",
"data": "FColorBrightness=VAL12"
}
}

Other setting
Gsmoothing Smoothing mode STDSMOOTH
ADVSMOOTH
NOSMOOTH

GShortPanelManagement Short panel management AUTO

mode CUSTOM
OFF
IShortPanelShift Short panel management shift Shift in pixel

IGStrictPageSetup Strict page setup mode ON

OFF
Passthrough / RawData Send raw data to printer Data in text format

Short panel management (GShortPanelManagement)requires to be set on CUSTOM first to

set a shiftvalue (IShortPanelShift).

{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.Set",
"params": {
"session": "JOB000002",
"data": " GShortPanelManagement=CUSTOM;IShortPanelShift=450"
}
}

6
 Magnetic settings
Setting Description Allowed value

GMagT1Encoding Smoothing mode ISO1

GMagT2Encoding ISO2
ISO3
GMagT3Encoding
SIPASS
C2
JIS2
C4
NONE
Track1Data Magnetic track 1 data AUTO
Track2Data Magnetic track 2 data CUSTOM
Track3Data Magnetic track 3 data OFF

GMagCoercivity Magnetic coercivity OFF

LOCO
HICO

Combinate settings
The parameters can be sent either individually or combined.
Each Setting will be separated by semicolons and passed through the data
parameter (via the PRINT.Set method), e.g.:
"data":
"FColorBrightness=VAL12;GRibbonType=RC_YMCKO;Resolution=

DPI600300". Sample JSON request :

{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.Set",
"params": {
"session": "JOB000002",
"data": " FColorBrightness=VAL12;GRibbonType=RC_YMCKO;Resolution=DPI600300"
}
}

7
Primacy 2
Evosettings to manage printer's settings
Primacy 2 works with the new Evolis Premium Suite 2 (release superior to 7.0.0.0)

To get the available settings for Primacy 2, pay attention to use the new evosettings.exe
tool (settings is no more available via the xml file).

This tool is available here (default installation path ) once you have installed Evolis Premium
Suite 2 :

C:\Program Files\Evolis Card Printer 2\Evolis Premium Suite 2\tools\evosettings.exe

The full help/manual of the evosettings utility is available by invoking - - help argument, see
below :

Get the current settings for a Primacy 2 thanks to evosettings

Use the following command to get the current setting for a printer:

evosettings -p "Evolis Primacy 2" -l

or
evosettings -p "Evolis Primacy 2" --list

Get all available settings for a Primacy 2 thanks to evosettings

To get all available settings and their possible values for a printer, please use following
command :

Evosettings.exe -p "Evolis Primacy 2" --list-key

8
Disclaimer
While Evolis makes every effort to deliver high quality products, we do not guarantee that our products
are free from defects. Our SDK, samples and demo software, any content or documentation delivered in
this package (Evolis SDK) is provided "as is". The use of it is at your own risk.

Evolis makes no warranties as to performance, merchantability, fitness for a particular purpose, or any
other warranties whether expressed or implied.

No oral or written communication from or information provided by Evolis shall create a warranty.

Under no circumstances shall Evolis be liable for direct, indirect, special, incidental, or consequential
damages resulting from the use, misuse, or inability to use this Software Development Kit (named Evolis
SDK), even if Evolis has been advised of the possibility of such damages.

Evolis - 14 Avenue de la Fontaine - ZI Angers-Beaucouzé 49070 Beaucouzé - France

T +33 (0) 241 367 606 - F +33 (0) 241 367 612 - [email protected]
www.evolis.com