Professional Documents
Culture Documents
V2.1/10
Installation Manual
J/Install Installation
Installation Steps
Parameters in "CUSTOM.PPF"
Parameter Management
Continued
Installation and Configuration Tools
Installation of Communication SW
Contents
Contents
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
What’s new ? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
ProBase/C Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Hardware Configuration Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Customization File for ProBase/C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
PROBASE.CUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Customization Files for ProSetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
PROSETUP.CUS and PROSETUP.PAR . . . . . . . . . . . . . . . . . . . . . . . . 37
J/Install Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Registration Key Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Product Updates via J/Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Installation of ProTect/One . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Customizing Media for J/Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Creation of Installation Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Multi Vendor Installation capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Installation subfolders of custom/update files . . . . . . . . . . . . . . . . . . . . . 45
The Installation Disk Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Installation Disk Manager for SlimCash . . . . . . . . . . . . . . . . . . . . . . . . . 48
Installation on ProCash28x systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
ProCash/NDC_28x and ProCash/DDC_28x license keys . . . . . . . . . . . 49
Run application as "Non Administrator" user . . . . . . . . . . . . . . . . . . . . . . . . 50
Installation restriction with NCR Aptra 05.01.xx . . . . . . . . . . . . . . . . . . . 51
Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Step 1 - Windows Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Windows XP + Service Pack 2 or 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Step 2 - Communication Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Step 3 - J/Install Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
PROEINFO installation log folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
July 2011 5
Contents
Parameters in “CUSTOM.PPF” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
[START_APPLICATION] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Program list called by the Restart Manager . . . . . . . . . . . . . . . . . . . . . . 64
[STARTUP] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Communication framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Operator panel framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
EPP framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
System Management Information Service framework . . . . . . . . . . . . . . . 66
Special Electronics framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Cash Dispenser framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Coin Dispenser framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Card Reader framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Journal framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Service Handler framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Dialog framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Application framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Data framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Variable framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Converter framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Presentation framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Protocol framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Message Control framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Receipt Printer framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Journal Printer framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Document Printer framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Synchronisation framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
User Exit framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Device Status framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Deposit framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Transaction framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Script framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Utility framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Security framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
ProCash/XDC-SOP dialog framework . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Barcode Reader framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
System Restart settings of the Restart Manager . . . . . . . . . . . . . . . . . . . . . 78
6 July 2011
Contents
July 2011 7
Contents
8 July 2011
Contents
[LYNXCI_PARAMETER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Optional Parameters (NDC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Miscellaneous Features I (DDC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Miscellaneous Features II (DDC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Miscellaneous Features III (DDC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Logical Unit Number (LUNO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Configuration Identification (Config ID) . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
[LYNXCI_TIMER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Keyboard response time (Timer 00) . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Additional time (Timer 01) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Close state time delay (Timer 02) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Communication response time (Timer 03) . . . . . . . . . . . . . . . . . . . . . . 121
Envelope insertion time (Timer 04) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Cash retract time-out ( Timer 05) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Poll/select time (Timer 06) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Take cash time (Timer 07) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Card capture time (Timer 09) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Additional cash present time (Timer 10) . . . . . . . . . . . . . . . . . . . . . . . . 123
Document/Envelope present timeout (Timer 94) . . . . . . . . . . . . . . . . . 123
Statement retract (Timer 95) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Statement present (Timer 96) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Vandal guard close (Timer 98) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Vandal guard close time (Timer 99) . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Unsupported timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
[LYNXCI_SCREEN] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Screen default foreground color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Screen default background color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Screen transparent mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Screen softkey layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Blink rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Graphic file location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Configure MacroMedia Flash Animations . . . . . . . . . . . . . . . . . . . . . . . 130
Palette file location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Character Width screen global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Character Height screen global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Screen horizontal offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Screen vertical offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Screen background picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Play videos in full screen mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
July 2011 9
Contents
10 July 2011
Contents
July 2011 11
Contents
12 July 2011
Contents
July 2011 13
Contents
14 July 2011
Contents
July 2011 15
Contents
16 July 2011
Contents
July 2011 17
Contents
18 July 2011
Contents
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
July 2011 19
Contents
20 July 2011
Introduction
This manual provides a detailed description for service technicans how to install
the neccessary software components needed to get ProCash/NDC or
ProCash/DDC running. It gives instructions in which order each product has to
be installed and which parameters you have to keep an eye on. Furthermore
this manual provides function descriptions about customizable parameters and
how to create a branch specific installation set.
July 2011 21
Introduction
22 July 2011
What’s new ?
What’s new ?
This section lists a summery of documentation changes and extensions of the
ProCash/NDC - ProCash/DDC Installation Manual.
Since March 2011 until May 2011:
New section ”Reconnection delay time” on page 192
New section ”Withdrawal Retract logging and recycling on RM3” on
page 218
New section ”Changing Network settings under restricted User” on
page 341
New section ”Power Save Mode delay time” on page 193
New section ”Installation restriction with NCR Aptra 05.01.xx” on page 51
July 2011 23
What’s new ?
24 July 2011
What’s new ?
July 2011 25
What’s new ?
26 July 2011
What’s new ?
July 2011 27
What’s new ?
28 July 2011
What’s new ?
July 2011 29
What’s new ?
30 July 2011
Software Product Overview
CD WINDOWS XP CD
Communication Packets
CD EICON SNA CD
Software Workstation
ProBase/C 1.1/20
CD Device Drivers
CD
Firmware CSC-W32
ProDevice (XFS)
2.1/10 NDC/DDC J
J
/ /
I
ProCash/NDC I
N ProCash/DDC N
CD S S CD
T T
A ProTopas Manager A
L L
L
AddOn Products L
ProAgent
July 2011 31
Product short description Software Product Overview
32 July 2011
Software Product Overview Product short description
July 2011 33
Product short description Software Product Overview
34 July 2011
ProBase/C Installation Product short description
ProBase/C Installation
Since ProCash/NDC - ProCash/DDC 2.0/00 the installation concept has been
redesigned. As it is shown in table “Product Overview” on page 31,
the CSC-W32 Operating System, T-SOP, Firmware, ProDevice (XFS) and
drivers are separated in a new Product CD named ProBase/C.
For the ProBase/C installation you need the Hardware Configuration Media
(HW_CONF.INI) and minimum one Customizing Media where the customizing
file PROBASE.CUS has to be included. You can use "Installation Disk Manager"
for automatic creation of the Customizing Media. Refer to section ”Creation of
Installation Media” on page 45 for detailed description.
July 2011 35
Product short description ProBase/C Installation
CD CD
ProBase/C
1. 2.
Hardware Customization
Media Media
Note: Instead of floppy diskettes you can use CD’s, USB or HDD medias
Please refer to ProBase Installation 1.1/20 User manual for detailed descriptions
how to install and customize the ProBase/C product.
Detailed descriptions about ProSetup configuration are described in
ProSetup XP for ProClassic Operator’s Guide.
36 July 2011
ProBase/C Installation Hardware Configuration Media
With each new ordered hardware system the specific Hardware Configuration
Media will be delivered automatically from the factory. Service technicans have
the possibility to create their own „HW_CONF.INI“ with the utility HW_CREATE
on the original J/Install CD. With HW_CREATE you can select the requested
hardware system, printers, card reader and additional devices that differ from
the standard configuration.
PROBASE.CUS
July 2011 37
Customization Files for ProSetup ProBase/C Installation
38 July 2011
J/Install Installation Customization Files for ProSetup
J/Install Installation
The J/Install CD contains the application product components that will be
installed above ProBase/C on Wincor hardware systems. The core product and
AddOn products can be installed only with a valid security key (REG_KEY.INI).
This registration mechanism allows the installation of licensed software only.
Different hardware systems and their customer specific variations presuppose
specific configuration settings. Each customer has the possibility to create a
customized configuration for different branches. Furthermore the product
contents of the CD can be overloaded via an update configuration. The next
figure clearifies the combination of CD, registration, customization and update.
Please refer to J/Install User Guide to get detailed information about the instal-
lation concept and configuration possibilities.
CD CD
J/Install
1. 2.
Registration Key Customization
Medias Media
3.
Update
Medias
Note: Instead of floppy diskettes you can use CD’s, USB or HDD medias
July 2011 39
Registration Key Media J/Install Installation
Please contact the Wincor Nixdorf support center if anybody else has
tried to change this file or if the disk is corrupted.
E-mail can be sent to following address:
SoftwareSupport-BD.EMEA@wincor-nixdorf.com
The registration key file "REG_KEY.INI" on the Registration Key Media contains
the product name and major version of the main product you have ordered. All
sub products like, ProTopas Manager, XFSAddOn, PARAC, ..., etc. are defined
in the component file "PRODUCT.INI". This file also is key generated as the
REG_KEY.INI file on the registration key diskette or CD.
You will find the file "PRODUCT.INI" on the J/Install CD in subfolder
"INSTALL\PRODUCTS" separated for each product and release version.
40 July 2011
J/Install Installation Installation of ProTect/One
Please refer to J/Install User Guide to get detailed information how to update
application software.
Installation of ProTect/One
ProTect/One is used to secure the Windows logon procedure. Within
ProTect/One you can create multiple users with different access rights to the
Windows file system.
This product will be installed together with the installation procedure of basic
product ProCash/NDC and ProCash/DDC. If you like to install ProTect/One you
have to order the ProTect/One Registration Key disk.
If you insert the Registration Key Media together with the Registration Key
Media of the basic product at the beginning of the J/Install installation,
ProTect/One will be installed automatically.
After successful installation following dialog window appears during the
Windows logon procedure:
Please refer to the Protect/One V1.3 Product Manual for detailed descriptions
about how to create multiple users and to set access rights for each user.
You will find the manual in sub folder \DOC\ProTect_One on the J/Install CD.
July 2011 41
Customizing Media for J/Install J/Install Installation
42 July 2011
J/Install Installation Customizing Media for J/Install
July 2011 43
Customizing Media for J/Install J/Install Installation
44 July 2011
J/Install Installation Creation of Installation Media
The relevant files for the Customizing Media are stored in subfolder
\INSTALL\PRONDC\R21.10\CUSTOM
or
\INSTALL\PRODDC\R21.10\CUSTOM
July 2011 45
Creation of Installation Media J/Install Installation
Vendor selection
The Installation Disk Manager has to be called directly from the J/Install CD. For
the ProCash/DDC installation you have to start the executable program
"DSKMANAG.EXE" from folder \INSTALL\PRODDC\R21.10. For ProCash/NDC
you have to start it from \INSTALL\PRONDC\R21.10.
See further steps on the next page ...
46 July 2011
J/Install Installation Creation of Installation Media
If you have selected a floppy drive destination (A:) and you press the "OK"
button after the vendor selection, you will be advised to get an empty formatted
1,44 MB floppy diskette.
If you have inserted the diskette correctly, the required files for the Customizing
Media will be copied from the J/Install CD onto the floppy disk. If the copy
process is completed, you are ready for the product installation with J/Install.
July 2011 47
Creation of Installation Media J/Install Installation
48 July 2011
J/Install Installation Installation on ProCash28x systems
July 2011 49
Run application as "Non Administrator" user J/Install Installation
50 July 2011
J/Install Installation Run application as "Non Administrator" user
On NCR systems if the application has to run as "Non Adminstrator" user, the
installation cannot be performed automatically without user interaction. The
reason is because the Aggregate Builder from NCR needs administrator
rights.
This will be noticed at the first Windows logon as "Non Administrator" user.
The following pop up window appears, and has to be confirmed with OK:
NOTE: If the pop up window has been confirmed, it does not come up any
more after Windows logon.
July 2011 51
Run application as "Non Administrator" user J/Install Installation
52 July 2011
Installation Steps Step 1 - Windows Installation
Installation Steps
Wincor Nixdorf hardware systems
On Wincor hardware systems the J/Install installation can be performed as
follows:
Install Windows XP and additional drivers manually. Install from ProBase/C CD
via call AUTORUN.BAT, but do NOT boot from CD. Install from J/Install CD. See
brief description of Step 1 to Step 3.
July 2011 53
Step 3 - J/Install Installation Installation Steps
For X.25 Native and TCP/IP all drivers are included on the J/Install CD.
54 July 2011
Installation Steps Step 3 - J/Install Installation
3. After product selection the next J/Install Dialog asks for the
Customizing Disk or Customizing folder:
Note: The predefined folder C:\JINSTALL can be changed through the drive
and/or folder where your customizing files can be located.
July 2011 55
Step 3 - J/Install Installation Installation Steps
Note: The predefined folder C:\JINSTALL can be changed through the drive
and/or folder where your customizing files can be located.
56 July 2011
Installation Steps Step 3 - J/Install Installation
5. This dialog instructs you to insert the Update Disk(s). Alternatively you
can select a subfolder on the harddisk or another medium where the ZIP
compressed data can be located. Make shure that the ZIP file is stored
under sub folder POST of the slected Update folder. You can have
multiple Update Disks that you can insert sequentely after each Update
Disk that has been processed. You will be asked after insertion of each
Update Disk if you want to process more Update Disks.
As minimum you have to insert the Update Disk that has been created
by the Disk Manager:
July 2011 57
Step 3 - J/Install Installation Installation Steps
If you select the item “Configuration is already prepared” or after you have
finished specific configurations and you select “All settings done”
("Configuration is already prepared" will be replaced), the J/Install installation is
processing the next dialog window.
58 July 2011
Installation Steps Step 3 - J/Install Installation
After J/Install has successfully finished the Installation you will see the instal-
lation finished screen. Please read the notes in the background around the
dialog window of the screen.
July 2011 59
PROEINFO installation log folder Installation Steps
60 July 2011
Parameter Configuration Dialog Dialog main and sub menus
Screen display
Printers
Journal Printer
Electronic Journal settings
Receipt Printer
Document printer
Cash Dispenser
Deposit module
ProAgent
Encryption Security
Configuration already prepared (All settings done)
July 2011 61
Dialog main and sub menus Parameter Configuration Dialog
62 July 2011
Parameters in “CUSTOM.PPF”
Parameters in “CUSTOM.PPF”
This chapter describes parameters which are customizable in the Parac
Parameter File (PPF) “CUSTOM.PPF”. Parameters in "CUSTOM.PPF can be
modified with the Parameter Configuration Editor PCEDT.EXE. All parameters
which are not described in this section but exist in "CUSTOM.PPF" should not
be modified or removed.
On the customizing disk, the major CUSTOM.PPF file is located in the root of
the diskette. Vendor specific parameters will be found in the vendor sub folder,
specifically devided between WOSA XFS30 and XFS20 parameters under the
"VENDORS" folder. Parameters that are used by the ADDON products are
found in sub folder "ADDON.PPF". Configuration files in these sub folders do
NOT have the file extension *.PPF.
The parameters of the configuration files, which have another extension than
*.PPF, are added and merged together to one single CUSTOM.PPF file that
finally can be found in folder "C:\INSTALL\CUSTOM" on the harddisk after
installation.
July 2011 63
[START_APPLICATION] Parameters in “CUSTOM.PPF”
[START_APPLICATION]
This section describes the parameters which are used to specify the
programs and framework list which are called by the restart manager of
Protopas.
This parameter specifies the programs and in which order they are loaded.
Each parameter value comma separated is a separate parameter which
contains a programm with execution parameters.
Parameter name: PROGRAMLIST
Section in *.PPF: [START_APPLICATION]
Valid range: Parameter,Parameter,Parameter,...,...,...
Value description: Each Parameter contains a program with execution
parameters which are loaded in the specified order from left
to right.
Default value: “CCBase,WosaCtrl,ApplPM,ProSop,ApplStart”
Enable ProAgent:
“ProViewAgent,CCBase,WosaCtrl,ApplPM,ProSop,ApplStart”
64 July 2011
Parameters in “CUSTOM.PPF” [STARTUP]
[STARTUP]
This section describes the parameters which are used to specify the
frameworks path definition for the Repository Manager of Protopas.
See Protopas Programmers Reference manual for detailed descriptions about
Repository- and Restart Manager.
Communication framework
This parameter specifies the location of the operator panel framework which
has to be started.
Parameter name: OPL_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCOpl20.DLL”
July 2011 65
[STARTUP] Parameters in “CUSTOM.PPF”
EPP framework
This parameter specifies the location of the EPP framework which has to be
started. The EPP framework is the direct interface to the encryption services of
WOSA for the EPP or EDM. Refer to Abschnitt ”Enable Triple DES operation”
on page 322 for detailed description about Triple DES activation.
Parameter name: EPP_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCEpp20.DLL”
66 July 2011
Parameters in “CUSTOM.PPF” [STARTUP]
This parameter specifies the location of the Cash Dispenser framework which
has to be started. Since release 1.1/00 the logical WOSA cash dispenser
service is in use. Therefore is needed the basic framework CCCdm20L.DLL.
Parameter name: CDM_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCCdm20L.DLL;
C:\PROTOPAS\BIN\dcCdmFw.DLL”
July 2011 67
[STARTUP] Parameters in “CUSTOM.PPF”
This parameter specifies the location of the Coin Dispenser framework that has
to be started.
Parameter name: COINOUT_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCCoinOutFW”
This parameter specifies the location of the Card Reader framework which has
to be started.
Parameter name: CARD_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCCard20.DLL”
68 July 2011
Parameters in “CUSTOM.PPF” [STARTUP]
Journal framework
This parameter specifies the location of the Journal framework which has to be
started.
Parameter name: JOURNAL_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCJOURNA.DLL”
This parameter specifies the location of the Service Handler framework which
has to be started.
Parameter name: SERVICE_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\dcServic.DLL”
July 2011 69
[STARTUP] Parameters in “CUSTOM.PPF”
Dialog framework
This parameter specifies the location of the Dialog framework which has to be
started.
Parameter name: DLG_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value (NDC):“C:\PROTOPAS\BIN\ndcDiaFw.DLL”
Default value (DDC):“C:\PROTOPAS\BIN\ddcDiaFw.DLL”
Application framework
This parameter specifies the location of the Application framework which has to
be started.
Parameter name: APPLICATION_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\dcApplFw.DLL”
Data framework
This parameter specifies the location of the Data framework which has to be
started.
Parameter name: APPL_DATA_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCDATAFW.DLL”
70 July 2011
Parameters in “CUSTOM.PPF” [STARTUP]
Variable framework
This parameter specifies the location of the Variable framework which has to be
started.
Parameter name: VARIABLE_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCVarFw.DLL”
Converter framework
This parameter specifies the location of the Converter framework which has to
be started.
Parameter name: CONVERTER_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\dcConvFw.DLL”
Presentation framework
This parameter specifies the location of the Presentation framework which has
to be started.
Parameter name: PRESS_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCNtPres.DLL”
July 2011 71
[STARTUP] Parameters in “CUSTOM.PPF”
Protocol framework
This parameter specifies the location of the Protocol framework which has to be
started.
Parameter name: PROT1_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCProtFw.DLL”
This parameter specifies the location of the Message Control framework which
has to be started.
Parameter name: MSGCTRL1_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\dcMsgCFw.DLL”
72 July 2011
Parameters in “CUSTOM.PPF” [STARTUP]
This parameter specifies the location of the Receipt Printer framework which
has to be started.
Parameter name: RECPRT_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value (NDC):“C:\PROTOPAS\BIN\CCFms20.DLL;
C:\PROTOPAS\BIN\ndcPrtFw.DLL”
Default value (DDC):“C:\PROTOPAS\BIN\CCFms20.DLL;
C:\PROTOPAS\BIN\ddcPrtFw.DLL”
This parameter specifies the location of the Journal Printer frameworks which
have to be started.
Parameter name: JRNPRT_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value (NDC):“C:\PROTOPAS\BIN\CCFms20.DLL;
C:\PROTOPAS\BIN\ndcPrtFw.DLL”
Default value (DDC):“C:\PROTOPAS\BIN\CCFms20.DLL;
C:\PROTOPAS\BIN\ddcPrtFw.DLL”
July 2011 73
[STARTUP] Parameters in “CUSTOM.PPF”
This parameter specifies the location of the Document Printer framework which
has to be started.
Parameter name: DOCPRT_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value (NDC):“C:\PROTOPAS\BIN\CCFms20.DLL;
C:\PROTOPAS\BIN\ndcPrtFw.DLL”
Default value (DDC):“C:\PROTOPAS\BIN\CCFms20.DLL;
C:\PROTOPAS\BIN\ddcPrtFw.DLL”
Synchronisation framework
74 July 2011
Parameters in “CUSTOM.PPF” [STARTUP]
This parameter specifies the location of the User Exit framework which has to
be started.
Parameter name: USEREXIT_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\dcSueFW.DLL”
This parameter specifies the location of the Device Status framework which has
to be started.
Parameter name: DEVSTA_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\dcDevSta.DLL”
Deposit framework
This parameter specifies the location of the Deposit framework which has to be
started.
Parameter name: DEPOSIT_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCDepo20.DLL”
July 2011 75
[STARTUP] Parameters in “CUSTOM.PPF”
Transaction framework
This parameter specifies the location of the Transaction framework which has
to be started.
Parameter name: TRANSACT_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\dcSttFW.DLL”
Script framework
This parameter specifies the location of the Script framework which has to be
started.
Parameter name: SCRIPT_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCScript.DLL”
Utility framework
This parameter specifies the location of the ProTopas Utility framework which
has to be started.
Parameter name: UTILFW_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCUtilFW.DLL”
76 July 2011
Parameters in “CUSTOM.PPF” [STARTUP]
Security framework
This parameter specifies the location of the Security framework which has to be
started.
Parameter name: SECURE_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCSecure.DLL;
C:\PROTOPAS\BIN\dcSecure.DLL”
This parameter specifies the location of the SOP dialog framework for
ProTopas/SOP-NDC or ProTopas/SOP-DDC.
Parameter name: CCSOP_DIALOG
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “CCSopDiaJFW@C:\Protopas\java\lib\
JVMPROPERTIES.TXT;C:\ProTopas\bin\ccsopdia.DLL
This parameter specifies the location of the Barcode Reader framework which
has to be started.
Parameter name: BARCODE_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\CCBcr30.DLL"
July 2011 77
System Restart settings of the Restart ManagerParameters in “CUSTOM.PP
This parameter specifies how many reboots the Restart Manager performs if the
application has run in a trapp situation.
Parameter name: MAXREBOOT
Section in *.PPF: [DEFAULT]
Valid range: 0-99
Value description: specifies the number of reboots the Restart Manager is
allowed to perform
Default value: “3"
78 July 2011
Parameters in “CUSTOM.PPF”System Restart settings of the Restart Mana
This parameter specifies after what time (in minutes) the number of actual
reboots should be cleared after system has been restarted.
Parameter name: POWER_UP_PERIOD
Section in *.PPF: [DEFAULT]
Valid range: -1; 0-999
Value description: -1 parameter ignored
0 - 999 number of minutes the system must run properly
before the actual reboot counter is set to zero
Default value: “20" - cleares the actual reboot counter if the application
longer than 20 minutes is up.
This parameter can be used to configure a specific bitmap (BMP format) that is
displayed via call of utility "SHOWBMP.EXE" during a system shut down
initiated by the Restart Manager (RM).
Parameter name: SHUTDOWN_EXE
Section in *.PPF: [DEFAULT]
Valid range: C:\PROTOPAS\BIN\SHOWBMP.EXE,path of the bitmap
Value description: program path of SHOWBMP.EXE and path of the bitmap
separated by a comma.
Default value: C:\PROTOPAS\BIN\SHOWBMP.EXE,
C:\PROTOPAS\BITMAPS\DCTMPOOS.BMP
July 2011 79
[CCPROTFW1] Parameters in “CUSTOM.PPF”
[CCPROTFW1]
Message Protocol
This parameter defines whether the NCR Direct Connect (NDC) or Diebold
Direct Connect (DDC) message protocol is in use.
Parameter name: PROTOCOL
Section in *.PPF: [CCPROTFW1]
Valid range: NDC, DDC
Value description: NDC - defines the NCR protocol;
DDC - defines the Diebold protocol
Default value: depends on which protocol has to be used
This parameter specifies the path location of the Character Conversion Table.
The Character Convertion Table handles the ASCII-EBCDIC conversion for
NDC and DDC messages.
Parameter name: CCVTABLE
Section in *.PPF: [CCPROTFW1]
Valid range: path of character convertion table
Value description: path of char conversion table
Default value: “C:\PROTOPAS\CONF\CCVTABLE.FIL”
80 July 2011
Parameters in “CUSTOM.PPF” [CCPROTFW1]
This parameter specifies the path location of the Messages log file. All host to
terminal and terminal to host messages will be stored in this file.
Parameter name: LOG_FILE
Section in *.PPF: [CCPROTFW1]
Valid range: character string
Value description: path of log file
Default value: “C:\PROTOPAS\CCPROT.LOG”
This parameter specifies the size of the Messages log file in KB.
Parameter name: LOG_FILE_SIZE
Section in *.PPF: [CCPROTFW1]
Valid range: 50-2000
Value description: log file size in kilo bytes
Default value: 200
July 2011 81
Communication Parameters in “CUSTOM.PPF”
Communication
[SNA]
This parameter is evaluated for a LU-LU session and can have the values either
YES or NO. If it is YES a Function Management Header (FMH) which is a SNA
specific prefix in a received message is stripped before it is passed to the
communication framework user for further processing. If the value is NO a
received FMH is not stripped.
Parameter name: STRIPFMH
Section in *.PPF: [SNA_PROJECT]
Valid range: NO, YES
Value description: NO - not stripped, YES - Received FMH is stripped
Default value: NO
82 July 2011
Parameters in “CUSTOM.PPF” Communication
NAUTYPE
This parameter can have the value either PU for a SSCP-PU session or LU for
a LU-LU session.
Parameter name: NAUTYPE
Section in *.PPF: [SNA_PROJECT]
Valid range: LU, PU
Value description: LU - logical unit, PU - physical unit
Default value: LU
July 2011 83
Communication Parameters in “CUSTOM.PPF”
This parameter is only evaluated for a LU-LU session. It is the name of the LU
that is configurated in the IBM CM/2 respectively in the MS SNA Server.
Parameter name: LUNAME
Section in *.PPF: [SNA_PROJECT]
Valid range: char string
Value description: represents the LU name of the SNA Server
Default value: XXXLU
This is the waiting time in seconds for completion of a send request that is
initiated by the Send() method of the communication framework. For a LU-LU
session a Request Unit (RU) that contains the send data is sent to the PLU in
the SNA host. If this RU requires a SNA acknowledgement (that depends on the
parametrization of the BIND command from the PLU that opened the session),
the PLU sends a SNA response for this RU to the SLU that is used by the
communication framework. In the SSCP-PU session a response is always
required for a RU that is sent from the PU to the SSCP. If sending of the RU and
the optional receiving of a SNA response takes more time then the parameter
value indicates then an error is returned by the Send() method.
Parameter name: RSPTIMER
Section in *.PPF: [SNA_PROJECT]
Valid range: 0-255
Value description: integer value
Default value: 20
84 July 2011
Parameters in “CUSTOM.PPF” Communication
This parameter is used to set the size of the receivebuffer within the SNA
communication framework in bytes. It should not be smaller than the largest
size of a message from the application protocol.
Parameter name: PROJECT_RECEIVE_BUFFER_SIZE
Section in *.PPF: [SNA_PROJECT]
Valid range: 0-4096
Value description: integer value
Default value: 2048
OPMODE
This parameter can be used to set a symbolic name that is used by the host for
an internal configuration of the SNA connection. If the host does not require this
parameter, its value has to consist of 8 blanks.
Parameter name: OPMODE
Section in *.PPF: [SNA_PROJECT_INITSELF]
Valid range: maximum 8 digit character string
Value description:
Default value: “ ”
This parameter can be used to set a symbolic name of the Destination LU (DLU)
that has to be known on the host side. The DLU name specifies the PLU on the
host side that has to open the LU-LU session after the INITSELF command was
sent. If the host does not require this parameter, its value has to consist of 8
blanks.
Parameter name: DLUNAME
Section in *.PPF: [SNA_PROJECT_INITSELF]
Valid range: 8 digit character string
Value description:
Default value: “ ”
July 2011 85
Communication Parameters in “CUSTOM.PPF”
OPUID
This parameter can be used to enter a symbolic name that represents a user
identification of the SLU that sends the INITSELF command. If the host does
not require this parameter, its value has to consist of 8 blanks.
Parameter name: OPUID
Section in *.PPF: [SNA_PROJECT_INITSELF]
Valid range: 8 digit character string
Value description:
Default value: “ ”
OPPASS
This parameter can be used to enter a symbolic name that represents the SNA
host password for the SLU that sends the INITSELF command. If the host does
not require this parameter, its value has to consist of 4 blanks.
Parameter name: OPPASS
Section in *.PPF: [SNA_PROJECT_INITSELF]
Valid range: 4 digit charcater string
Value description: SNA host password
Default value: “ ”
OPLIB
This parameter can be used to enter a symbolic name that represents user
specific data of the SLU that sends the INITSELF command. The SNA host
passes this data to the PLU that has to open the LU-LU session. If the host does
not require this parameter, its value has to consist of 8 blanks.
Parameter name: OPLIB
Section in *.PPF: [SNA_PROJECT_INITSELF]
Valid range: 8 digit character string
Value description: user specific data of SLU
Default value: “ ”
86 July 2011
Parameters in “CUSTOM.PPF” Communication
[X25]
July 2011 87
Communication Parameters in “CUSTOM.PPF”
This parameter is used to set a timer value in seconds for those X.25 commu-
nication frameworks that have configured the Short Hold Mode. If a X.25
connection is established by such a communication framework and there was
no data traffic for the duration of this value, the VC is closed internally but the
upper communication layers on both the local and the remote DTE are not
informed about this event. Internally both communication partners change to
listen mode and wait for a connection setup from the other side. If one of the
both has to send something, it leaves its listen state and makes an active call to
reestablish the connection. For the user of the X.25 communication framework,
the connection is in online state the whole time although the VC may be offline
internally after the Short Hold Mode timer had expired. If the value of this
parameter is greater then 999, it is reset to 999.
Parameter name: SHMDELAY
Section in *.PPF: [X25]
Valid range: 0-999
Value description: integer timer value
Default value: 15
This parameter is used to specify the waiting time for the processing of a X.25
CALL ACCEPT packet by the EICON card during the connection setup. If there
was no reaction from the network within this time, an error is reported. The value
can be set from 4 up to 999 seconds.
Parameter name: NETTIME
Section in *.PPF: [X25]
Valid range: 4 - 999
Value description: integer time value
Default value: 20
88 July 2011
Parameters in “CUSTOM.PPF” Communication
This parameter is used to set the waiting time for processing of a X.25 CALL
REQUEST packet by the EICON card during the connection setup. If there was
no reaction from the network within this time, an error is reported. The value can
be set from 5 up to 180 seconds.
Parameter name: OPENTIME
Section in *.PPF: [X25]
Valid range: 5 - 180
Value description: integer time value
Default value: 30
This parameter is used to set the waiting time for processing of a X.25 CLEAR
REQUEST packet by the EICON card during the connection release. If there
was no reaction from the network within this time, an error is reported. The value
can be set from 5 up to 180 seconds.
Parameter name: CLOSETIME
Section in *.PPF: [X25]
Valid range: 5 - 180
Value description: integer time value
Default value: 30
July 2011 89
Communication Parameters in “CUSTOM.PPF”
This is the waiting time between two connection tries in seconds. The value can
be set up to 300. If the value is greater, it is reset to 300.
Parameter name: CALLDELAY
Section in *.PPF: [X25]
Valid range: 0-300
Value description: integer time value in seconds
Default value: 20
This parameter is used to set the size of the receivebuffer in bytes within the
X.25 communication framework. It should not be smaller then the value of
parameter MAXRECVSIZE.
Parameter name: PROJECT_RECEIVE_BUFFER_SIZE
Section in *.PPF: [X25_PROJECT]
Valid range: 0-2048
Value description: integer value
Default value: 2048
90 July 2011
Parameters in “CUSTOM.PPF” Communication
This parameter is used to set the index for the specified X.25 connection. The
index points to an entry in the X.25 connection table that is administrated by the
X.25 support DLL x25corei.dll. This entry contains all necessary administration
data for the specified X.25 connection. The value can be omitted. In this case a
default value of 1 is assumed. 1 is the lowest entry number and there can not
be more entries in the X.25 connection table than the global parameter
CONTABSIZE indicates.
Parameter name: INDEX
Section in *.PPF: [X25_PROJECT]
Valid range: 0-99
Value description: integer value
Default value: 0
This parameter can have one of the values 0, 1 or 2. If the value is 0, the
connection is opened actively by sending a X.25 CALL REQUEST packet to the
remote DTE. If the value is 1, the connection is opened passively by changing
to the listen mode and waiting for an INCOMING CALL packet from the remote
DTE. If the value is 2, the connection is used as a PVC (Permanent Virtual
Circuit). Since such a connection is permanent, there is no special need for
opening a connection. Nevertheless a X.25 RESET packet is sent. This packet
reinitialises counters and buffers of the existing VC and indicates to the remote
DTE that the local DTE is operational.
Parameter name: VCTYPE
Section in *.PPF: [X25_PROJECT]
Valid range: 0-2
Value description: 0 - active SVC, 1 - passive SVC, 2 - PVC
Default value: 0 - active SVC
July 2011 91
Communication Parameters in “CUSTOM.PPF”
This parameter is used to set the internal VC send buffer size in bytes that is
evaluated by the X.25 support DLL x25corei.dll. The value can be up to 4096
bytes large.
Parameter name: MAXSENDSIZE
Section in *.PPF: [X25_PROJECT]
Valid range: 0-2048
Value description: integer value
Default value: 2048
This parameter is used to set the internal VC receive buffer size in bytes that is
evaluated by the X.25 support DLL x25corei.dll. The value can be up to 4096
bytes large.
Parameter name: MAXRECVSIZE
Section in *.PPF: [X25_PROJECT]
Valid range: 0-2048
Value description: integer value
Default value: 2048
92 July 2011
Parameters in “CUSTOM.PPF” Communication
July 2011 93
Communication Parameters in “CUSTOM.PPF”
This parameter is used to activate Short Hold Mode for the local DTE. This
parameter can be used only in SVC connections.
Parameter name: SHMDELAY_FLAG
Section in *.PPF: [X25_PROJECT]
Valid range: 0, 1
Value description: 0 - no short hold mode, 1 - short hold mode is active
Default value: 0
This parameter is used to refine the behaviour of Short Hold Mode. It can take
the value 0, 1 or 2. If the value is 0, every CALL CLEAR packet received from
the EICON card is regarded as a Short Hold Mode CALL CLEAR. The commu-
nication framework changes into the listen mode and waits for an INCOMING
CALL packet from the remote DTE. If the value is 1, during listen mode it is
additionally checked whether the physical connection with the modem is active.
If this connection is lost, an error is reported. If the value is 2 every CALL
CLEAR is regarded as error and is reported to the communication framework
user. This parameter is used only in SVC connections.
Parameter name: SHM_PASSIVE
Section in *.PPF: [X25_PROJECT]
Valid range: 0-2
Value description: 0 - CALL CLEAR packets are handled as a Short Hold
Mode CALL CLEAR. The communication framework
changes to listen mode and waits for an INCOMING
CALL from the remote DTE.
1 - Check physical line during listen mode.
2 - Every CALL CLEAR is reported as an error to the
communication framework (SVC connections only).
Default value: 1
94 July 2011
Parameters in “CUSTOM.PPF” Communication
This parameter is used to set how the SVC or PVC Open() should be returned.
If the value is 0, the Open() method returns immediately. If the value is 1, it
blocks infinitely until the connection is established. For a SVC this means that
an INCOMING CALL packet has arrived and for a PVC, that a RESET packet
has arrived from the remote DTE. If the value is greater then 1 it indicates the
number of seconds the Open() method waits for a connection establishment
Parameter name: PASSIVE_START
Section in *.PPF: [X25_PROJECT]
Valid range: 0, 1, >1
Value description: integer value
Default value: 1
Connection reconnect
July 2011 95
Communication Parameters in “CUSTOM.PPF”
This parameter is used to specify a diagnostic code for the SHM clear cause.
The value of this parameter is a four characters long string of hexdigits. The first
two digits from the left are the Cause Code, the last two digits are the Diagnostic
Code that is sent in a CALL CLEAR packet for a Short Hold Mode VC for closing
the line. Usually the user defined Cause Code is set to 80h. This parameter is
used only in SVC connections.
Parameter name: SHMCLRCAUSEDIAG
Section in *.PPF: [X25_PROJECT]
Valid range: 0000-FFFF
Value description: 4 digit hex value
Default value: 0000
This parameter is used to specify a closed user group number. It can have a
value between 0 and 100. If it is between 0 and 99 it indicates the Closed User
Group that the X.25 DTE is assigned to. A Closed User Group is a strictly
isolated subnet from the X.25 net. Only users within the group can communicate
with each other. If the value is 100, no Closed User Group is defined. The
Closed User Group is a X.25 facility that is added to the facility field in the X.25
CALL REQUEST packet to the remote DTE to open the connection. This
parameter is used only in SVC connections.
Parameter name: CUGSELECTION
Section in *.PPF: [X25_PROJECT]
Valid range: 0-99, 100
Value description: 0 - 99 specifies a closed user group number
100 - no closed user group defined
Default value: 100 - no closed user group defined
96 July 2011
Parameters in “CUSTOM.PPF” Communication
This parameter is used to specify a Closed User Group with Outgoing Call that
X.25 DTE is assigned to. The parameter can have a value between 0 and 100.
If it is between 0 and 99 it indicates the Closed User Group with Outgoing Call
that X.25 DTE is assigned to. A Closed User Group with Outgoing Call is a
restricted subnet of a X.25 net. Users within the group can communicate with
each other and can connect to addresses outside of this group. It is not possible
to connect to a member of this group from outside of the group. If the value is
100, no Closed User Group with Outgoing Call is defined. The Closed User
Group with Outgoing Call is a X.25 facility that is added to the facility field in the
X.25 CALL REQUEST packet that is sent from the communication framework
to the remote DTE to open the connection. This parameter is used only in SVC
connections.
Parameter name: CUGOUTSELECT
Section in *.PPF: [X25_PROJECT]
Valid range: 0 - 99, 100
Value description: 0 - 99 specifies the closed user group number
100 - no closed user group defined
Default value: 100 - no closed user group defined
This parameter is used to add reversed charging facilities for SVC active
connections. The value be 0 or 1. If it is 1 the Reversed Charging Facility is
added to the facility field of a X.25 CALL REQUEST packet that is sent from the
communication framework to open the connection. The communication costs
are burdened to the communication partner, if it accepts this facility. This
parameter is used only in SVC connections.
Parameter name: REVERSECHRG_ACT
Section in *.PPF: [X25_PROJECT]
Valid range: 0, 1
Value description: 0 - no facilities, 1 - add facilities
Default value: 0 - no facilities
July 2011 97
Communication Parameters in “CUSTOM.PPF”
This parameter is used to add reversed charging facilities for SVC active
connections. The value can be 0 or 1. If it is 1 the Reversed Charging Facility is
accepted if it is set in the reversed charging facility field of a X.25 INCOMING
CALL packet that was received from the remote DTE to open the connection.
The communication costs are burdened to the local DTE account in this case.
The parameter is used only in SVC connections.
Parameter name: REVERSECHRG_PAS
Section in *.PPF: [X25_PROJECT]
Valid range: 0, 1
Value description: 0 - accept reversed charging facility
1 - ignore reversed charging facility
Default value: 0 - ignore reversed charging facility
The parameter is used to add Call User Data in call request packets. The value
of this parameter is a string of maximum 16 two-figured hexadecimal numbers
separated by blanks. The data of this string defines the Call User Data to be
added to a X.25 CALL REQUEST packet that is sent to the remote DTE. This
parameter is used only in SVC connections. If no call user data is used, the
value of this parameter is an empty string.
Parameter name: CALLUSERDATA_A
Section in *.PPF: [X25_PROJECT]
Valid range: 00 00 00 00 - FF FF FF FF
Value description: call user data in hex notation
Default value: 00 00 00 00 - no user data
98 July 2011
Parameters in “CUSTOM.PPF” Communication
This parameter is used to define call user data to be checked for incoming calls.
The value of this parameter is a string of maximum 16 two-figured hexadecimal
numbers separated by blanks. The data of this string defines the Call User Data
which are checked against the Call User Data in a X.25 INCOMING CALL
packet that was received from the remote DTE. The VC is established only if the
incoming Call User Data is equal to the parameter value. This parameter is used
only in SVC connections. If no call user data is used, the value of this parameter
is an empty string.
Parameter name: CALLUSERDATA_P
Section in *.PPF: [X25_PROJECT]
Valid range: 00 00 00 00 - FF FF FF FF
Value description: call user data in hex notation
Default value: 00 00 00 00 - no user data
This parameter is used to set the X.25 address of the local DTE. It can contain
a maximum of 15 digits and a possible address extension of maximum 40 digits.
This extension has to be separated from the address prefix by a period.
Characters other than digits and the period are ignored. This value is used only
for SVC connections.
Parameter name: LOCALADR
Section in *.PPF: [X25_PROJECT]
Valid range: integer values max. 15 digits, inclusive address extension
40 digits
Value description: local address
Default value: ““
July 2011 99
Communication Parameters in “CUSTOM.PPF”
There are a maximum of five alternative X.25 addresses of the remote DTE. An
address not defined is indicated by an empty string for the corresponding
parameter. Each address can contain a maximum of 15 digits and a maximum
possible address extension of 40 digits. This extension has to be separated
from the address prefix by a period. Characters other than digits, the period and
asterisks are ignored. If the connection is opened actively, the remote
addresses are checked in order from REMOTEDAR1 to REMOTEADR5 for a
connection setup. In each probe the remote DTE address is added to the CALL
REQUEST packet that is sent to the remote DTE. If the connection is opened
passively, the remote address in the INCOMING CALL packet is checked
against the alternative addresses in order from REMOTEADR1 to
REMOTEADR5.
Parameter names: REMOTEADRx [1]
Section in *.PPF: [X25_PROJECT]
Valid range: integer values max. 15 digits, inclusive address extension
40 digits
Value description: local address
Default value: ““
[1] ’x’ represents the remote address number from 1 up to 5.
[TCPIP]
This parameter is used to set the IP address of the remote station that it tries to
connect to.
Parameter names: REMOTEPEER
REMOTEPEER_X[1]
Section in *.PPF: [TCPIP_PROJECT]
Valid range: integer values in format xxx.xxx.xxx
Value description: remote station IP address. If DNS is configured you can
also enter a name instead of the adress number.
Default value: ““
[1] - X = placeholder for values in range 1 to 32
This parameter is used to activate keep alive mode. To improve the offline
recognition, so-called KEEPALIVE packets can be exchanged over a TCP
connection. By using KEEPALIVE packets, one communication partner signals
the other that it is still operable. The value of this parameter can be either YES
if the local socket sends KEEPALIVE packets to the remote socket or NO if the
local socket does not send KEEPALIVE messages. This parameter can be
omitted. In this case the default value NO is assumed internally.
Parameter name: KEEPALIVES
Section in *.PPF: [TCPIP_PROJECT]
Valid range: NO, YES
Value description: NO - keep alive mode off, YES - keep alive mode on
Default value: YES
This parameter is used to specify how long the Open() method waits for a
successful connect. If there was no connection established within this time, the
Open() method returns with an error code unequal to zero. In the client case the
Open() method implicitly retries to establish the connection as many times as
the value of the parameter CLIENTOPENRETRY indicates. Every try waits at
most OPENTIMEOUT seconds. If no try could open the connection, an error
code unequal to zero is returned.
Parameter name: OPENTIMEOUT
Section in *.PPF: [TCPIP_PROJECT]
Valid range: 0 - 255
Value description: timer value in seconds
Default value: 20
Connection retries
This parameter specifies the maximum number of times the ATM tries to
connect to the server.
Parameter name: CLIENTOPENRETRY
Section in *.PPF: [TCPIP_PROJECT]
Valid range: 0 - 255
Value description: number of retries
Default value: 2
This parameter sets the maximum waiting time the Send() Method waits for
processing of the send data by the connected socket. If the data was not
processed within this time, a code unequal to zero is returned. This value is
necessary because the stream oriented socket can process send data in
several send calls where in each call only a part of the message is sent.
Parameter name: SENDTIMEOUT
Section in *.PPF: [TCPIP_PROJECT]
Valid range: 0 - 255
Value description: timer value in seconds
Default value: 20
This parameter sets the waiting time in seconds the Open() Method waits for
closing of the TCP/IP connection. If the connection was not closed within this
time, a value unequal to zero is returned. In the client case only the connected
socket is invalidated.
Parameter name: CLOSETIMEOUT
Section in *.PPF: [TCPIP_PROJECT]
Valid range: 0 - 255
Value description: timer value in seconds
Default value: 20
This parameter can be used to specify a specific local port adress used by
TCPIP. If this parameter is set the ATM always is using this local port number.
Parameter name: LOCALPORT
Section in *.PPF: [TCPIP_PROJECT]
Valid range: 0 - 999999
Value description: local port number used by TCPIP
Default value: not set in registry and CUSTOM.PPF
This parameter contains the absolute pathname of the DLL that processes the
conversion between the byte stream delivered by the socket and the messages
of the application protocol and vice versa. To identify message boundaries in a
bytestream in most cases it is necessary to enhance the application protocol by
a special intermediate protocol. The DLL identified by this parameter will be
implemented in such a protocol specific enhancement.
Parameter name: CODINGDLL
Section in *.PPF: [TCPIP_PROJECT]
Valid range: character string (path)
Value description: absolute path of the com dll
Default value: ““
This parameter gives the size of a memory block that will be allocated within the
Open() method. A pointer to this block is passed as a parameter to every public
function of the DLL that is concerned with the protocol conversion between the
bytestream and application message protocol. Since the memory block is local
to the communication framework, it allows individual message processing, even
if two TCP/IP communication framework objects have been created in the same
address space.
Parameter name: ADMINSIZE
Section in *.PPF: [TCPIP_PROJECT]
Valid range: 0 - 99999
Value description: size of allocated memory blocks
Default value: 8200
The following parameters are needed for the TCP/IP service of Windows. Those
parameters have influence for online and offline recognition and they have to be
set if you need an immediate response (timer controlled) from the TCP/IP
service where the ProCash/NDC or ProCash/DDC application can react on
offline and online situations.
NOTE: The following parameters are NOT included in CUSTOM.PPF.
You have to create a REG file using REGEDIT to add that parameters.
All parameters described in this section are located in the follwing Windows
registry tree:
[HKEY_LOCAL_MACHINE\
SYSTEM\CurrentControlSet\Services\Tcpip\Parameters]
KeepAliveTime
TcpKeepTries
TcpKeepCnt
KeepAliveInterval
TcpMaxDataRetransmissions
Description:
Parameter "KeepAliveTime" is set to 15000 milliseconds.
Parameter "TcpKeepTries" and "TcpKeepCnt" is set to 10.
Parameter "KeepAliveInterval" is set to 15000 milliseconds.
Parameter "TcpMaxDataRetransmissions" is set to 10.
[SSL_PROJECT]
For a Client this parameter is a comma separated list with values, which the
client tries to connect itself to. For a Server it is the address of the client which
tries to connect. If the value is ’*’ any client will be accepted. The values can be
represented as a legal IP address in format d1.d2.d3.d4. D1, d2, d3 and d4 can
be configured from 0 up to 255. An alternative representation of these values is
as a host name. It is passed to the DNS resolution.
Parameter name: REMOTEPEER
Section in *.PPF: [SSL_PROJECT]
Valid range: comma separated list
Value description: ip address or DNS name
Default value: ““
Example: "172.18.10.30,172.18.11.11,host.bank.com"
This parameter defines the remote endpoint at host site for the logical
connection. Applications above the TCP/IP protocol stack which use TCP
communication are identified by their ports. For a successful communication
both client and server have to use the same port number.
Parameter name: PORTNUMBER
Section in *.PPF: [SSL_PROJECT]
Valid range: 00000 - 99999
Value description: 5 digit port number
Default value: 99999
This is the absolute pathname of the DLL that processes the conversion
between the bytestream delivered by the socket and the messages of the appli-
cation protocol and vice versa. To identify message boundaries in a bytestream
in most cases it is necessary to enhance the application protocol by a special
intermediate protocol. The DLL identified by this parameter will implement such
a protocol. The following chapter describes the DLL in detail.
Parameter name: CODINGDLL
Section in *.PPF: [SSL_PROJECT]
Valid range: character string (path)
Value description: absolute path of the com dll
Default value: ““
SSL Protocols
This parameter gives the size of a memory block which will be allocated within
the Open() method. It is the number of bytes read at once from the TCP input
stream.
Parameter name: MAX_MESSAGE_LENGTH
Section in *.PPF: [SSL_PROJECT]
Valid range:
Value description:
Default value: “8000“
[LYNXCI_PARAMETER]
This section contains the NDC specific optional parameters which are
downloaded from the host with the “Enhanced Customization Table” load
command. Furthermore this section contains parameters where the Logical Unit
Number (LUNO) and the four digit Configuration ID is set.
BIT Description
128 Append rollover counts
64 Decimal Style
32 Deposit cancel status bit [1]
16 Dollar decimal places
8 Dollar buffer size ( if enabled 12 digits instead of 8 )
4 Fault status bit [1]
2 Automatic return to previous mode
1 Separate ready response
BIT Description
128 Reserved
64 Reject Reason codes to network
32 Send MDS status to network
16 Send Maintanance Mode log to network [1]
8 Change MMD mispick timer from 2 minutes to 30 seconds [1]
4 Send Expanded Hardware Configuration status [1]
2 Reserved
1 Reserved
BIT Description
128 Reserved [1]
64 Transaction verification status
32 No retract [1]
16 Send all status [1]
8 Message sequence number in solicited status [1]
4 Extended range for message coordination number field [1]
2 Doubling timer 03 feature [1]
1 Double Expanded hardware configuration status [1]
[LYNXCI_TIMER]
This section contains timer parameters which are downloaded through the
“Configuration Parameters” load or “Enhanced Configuration Parameters” load
command. All settings provided in “CUSTOM.PPF” are default settings. They
can be modified if the values will not be modified via the host download. Timer
values of the "Configuration Parameters" load command are downloaded in
ticks (1 tick = 0,8s). The timer values of the enhanced load are seconds.
ProCash/NDC-DDC stores all timer values as seconds into the registry.
Number of extra seconds allowed for keyboard input and form or envelope
insertion.
Parameter name: TIMER_01
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds, 0 - no additional time
Default value: 30
Number of seconds the ATM will remain in the close state after the card has
been ejected or if the card cannot be ejected.
Parameter name: TIMER_02
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds, 0 - no delay
Default value: 5
Number of seconds allowed for the terminal to receive a transaction reply from
the host.
Parameter name: TIMER_03
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds, 0 - no time checking
Default value: 60
Number of seconds allowed for the client to take the cash before a retract is
attempted.
Parameter name: TIMER_05
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds
Default value: 60
Number of seconds allowed for the client to take the cash that has been
dispensed.
Parameter name: TIMER_07
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds
Default value: 1
Number of seconds allowed for the client to remove a card that has been
ejected. This card will be retained by the ATM when this timer has expired.
Parameter name: TIMER_09
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds
Default value: 40
This indicates the numbers of additional seconds the CSC will wait for the
customer to take the cash.
Parameter name: TIMER_10
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds
Default value: 2
This timer specifies the time how long the Document/Envelope is presented
before it will be retracted.
Parameter name: TIMER_94
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds
Default value: 30
This timer determines when to retract a statement that has not been taken by
the cardholder.
Parameter name: TIMER_95
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds
Default value: 30
This timer is started when a statement has been cut and delivered in a “print
statement and set next state” function command. When the timer expires the
next state specified in the transaction reply is entered. The value of ’000’ means
’do not wait’.
Parameter name: TIMER_96
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds
Default value: 1
This timer is started when a card read state is entered. The vandal guard closes
when the timer expires. The value of ’000’ means the vandal guard will remain
permanently open when the terminal goes in service.
Parameter name: TIMER_98
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds
Default value: 10
Number of seconds the vandal guard remains open after the last customer left
the ATM.
Parameter name: TIMER_99
Section in *.PPF: [LYNXCI_TIMER]
Valid range: 0-255
Value description: number of seconds; 0 - permanently open
Default value: 10
Unsupported timers
The following table lists downloadable timers which are not supported by
ProCash/NDC-DDC:
[LYNXCI_SCREEN]
This parameter is used to set the default foreground color of the screens to be
displayed. The parameter consists of the three RGB (Red, Green, Blue) compo-
nents used in creating the specified color.
Parameter name: SCREEN_FOREGROUND_COLOR
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0-255, 0-255, 0-255
Value description: three integer values which contain the RGB components of
the color.
Default value: 255,255,255
The following table shows the RGB values for the 16 standard colors:
Table 10: RGB values for 16 standard colors
This parameter is used to set the default background color of the screens to be
displayed. The parameter consists of the three RGB (Red, Green, Blue) compo-
nents used in creating the specified color.
Parameter name: SCREEN_BACKGROUND_COLOR
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0-255, 0-255, 0-255
Value description: three integer values which contain the RGB components of
the color.
Default value: 0,0,0
This parameter activates transparent mode for every screen by default. Trans-
parent mode configuration should be used only if all screens are cleared via the
clear screen sequence (FF) before the next screen is displayed. This setting is
useful if you want to display a full screen background picture and you want to
overlay the downloaded text. The downloaded screens should not contain color
sequences if you want to use transparent mode.
Parameter name: SCREEN_TRANSPARENT_MODE
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0, 1
Value description: 0 - No, 1- Yes
Default value: 0
This parameter sets the screen layout depending on whether you have NCR,
Diebold compatible or SNI softkeys installed.
Parameter name: SOFTKEYS
Section in *.PPF: [LAYOUT]
Valid range: SNI, NCR, DBO
Value description: three characters in uppercase
Default value: NCR - sets the NCR compatible layout
Blink rate
This parameter can be used to modify the default blink rate which is used for the
blinking sequence defined in a downloaded screen.
Parameter name: BLINK_RATE
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 200 - 9999
Value description: number of milli seconds
Default value: 1000 - 1 second
This parameter is needed to specify in which directory the graphic files are
stored on the harddisk. Graphic file types can be BMP, DDU, PCX, ICN or AVI.
Parameter name: PICTURE_XXXX [1]
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: character string
Value description: path of the graphic file including the file name
Default value: “”
Example: "C:\PROTOPAS\BITMAPS\PICTURE.PCX"
[1] XXXX represents the graphic number which is defined in the downloaded
screen. The number can represent icons, logos, or picture sequences.
If you want to display Flash animation files, you have to use parameter
"PICTURE_XXXX" to specify the path and additional options of a Flash
animation file. The Flash animation file has to be stored as an executable file.
Parameter name: PICTURE_XXXX [1]
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: character string
Value description: the parameter value consists of a list of 6 comma separated
parameters:
Position Description
0 path location of the Flash file
1 delay time in milli seconds. Specifies how long the Flash
animation remain displayed after the process has been
terminated. This is useful to prevent screen flickery when after a
Flash movie is following a JPG or BMP picture.
Default if not specified: 0
2 Display priority of the running Flash process. This option can be
used to specify the process priority. If you specify 1, the process
has a lower priority as other processes.
0 - normal
1 - IDLE
2 - HIGH
Default if not specified: 0
3 Specifies the window name (case sensitive) of the Flash movie.
Default if not specified: ShockwaveFlash
4 Display Options (bits):
1 - show Flash in normal mode (no Fullscreen stretch)
2 - display Background screen if configured via parameter
PICTURE_BACKGROUND after Flash is displayed
5 reserved
6 file name of the Flash movie inclusive .EXE extension
This parameter is needed to specify in which directory the palette files are
stored on the harddisk. Palette files are used to set the color table for the
relevant graphic file.
Parameter names: PALETTE_XXX [1] ; PALETTE_DEFAULT [2]
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: character string
Value description: path of the palette file including the file name
Default value: “”
Example: "C:\PROTOPAS\BITMAPS\DAC000.DAT"
[1] XXX represents the palette file number which is appended to the graphic
file name.
[2] PALETTE_DEFAULT can be used to set a basic color palette for all
graphic files if you do not have specific palette files for each graphic.
This parameter can be used to set a basic character width for all screens.
Parameter name: CHARACTER_WIDTH
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0 - 99
Value description: number of pixels for one character
Default value: 16
This parameter can be used to set a basic character height for all screens.
Parameter name: CHARACTER_HEIGHT
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0 - 99
Value description: number of pixels for one character
Default value: 24
This parameter can be used to set a horizontal offset default setting for all
screens.
Parameter name: HORIZONTAL_OFFSET
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0-999
Value description: number of pixels the window is moved down from the top
most position.
Default value: 0
This parameter can be used to set a horizontal offset default setting for all
screens.
Parameter name: VERTICAL_OFFSET
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0-999
Value description: number of pixels the window is moved from the left most
position to the right.
Default value: 0
This parameter can be used to force playing video files in full screen mode. If
you have enabled this option all video files are stretched to full screen videos.
Parameter name: SCREEN_FULL_SCREEN_VIDEO
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0, 1
Value description: 0 - play videos in original size
1 - play videos stretched in full screen mode
This parameter can be set if you need the configure a specific substitution
character that is replaced for the ESC (1BH) character in the downloaded
screen data that is downloaded by the host.
Parameter name: ESC_SUB
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: One ASCII character in range (20H-7FH)
Value description: specifies the substitution character
The following parameters can be used to assign a different file extension for
graphics and video files that are included in screen downloades or for local
configured background pictures. If a file extension is downloaded that is not
supported by ProCash/NDC (e.g. "ESCPEfilepath") or ProCash/DDC (e.g.
"ESCPxxxx" xxxx = picture number) or you like to use a different extension thus
the downloaded one is supported, you have here the possibility to specify a file
extension that replaces the downloaded extension, or the file extension
specified via parameter PICTURE_BACKGROUND or PICTURE_XXXX.
In addition you can specify in the second parameter in which display method,
the file with the specified extension should be displayed.
Parameter names: PICTURE_EXT_ICN PICTURE_EXT_DAT
PICTURE_EXT_PCX PICTURE_EXT_PCC
PICTURE_EXT_DDU PICTURE_EXT_AVI
PICTURE_EXT_MOV PICTURE_EXT_FLC
PICTURE_EXT_FLI PICTURE_EXT_GIF
PICTURE_EXT_TIF PICTURE_EXT_MPEG
PICTURE_EXT_JPG PICTURE_EXT_MPG
PICTURE_EXT_BMP
PICTURE_EXT_FLC = "AVI,1"
The following parameter is neccessary to enable touch zone support for the PIN
entry state. If the entered PIN has to be confirmed via a touch key and not via a
Function Display Key (FDK), this parameter has to be enabled otherwise the
presentation framework of Protopas returns with an error if a touch zone has
been touched.
Parameter name: PIN_TOUCH_ENABLE
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0, 1
Value description: 0 - No touch zone support in PIN entry states
1 - Enable touch zone support in PIN entry dialogs
This parameter is needed if you have to assign the confirmation key in a PIN
entry dialog to an FDK other than A, and the hardware configuration consists of
PINPAD and EDM. In PIN entry dialogs the FDK confirmation key is assigned
to FDK A (defined in CSCW32 PIN Key File (PKF) by default). It is also
neccessary that you assign the new termination key to the new FDK position in
the PKF file.
Parameter name: PIN_CONFIRM_KEY
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: A, B, C, D, F, G, H, I
Value description: specifies the FDK where the confirm key is assigned to.
Default value: not configured in Registry
This parameter is used to configure the path location of audio (*.WAV) files for
ProCash/NDC. Those wave files are called if digital audio messages are
configured in the screen download (via ESCP0...ESC\) or/and automatic voice
support is enabled in the Enhanced Configuration Parameters Load message.
See ProCash/NDC User Guide for detailed description about voice support and
configuration.
Parameter name: AUDIOX_PATH [1]
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: ASCII string (max. 128 digits)
Value description: full path definition of the wave file.
Default value: not configured in registry
[1] - ’X’ represents the language group number 0-7.
This parameter is used to configure the path location of audio (*.WAV) files for
ProCash/DDC. Those wave files are called if voice prompting commands are
configured in the screen download (via ESC;...) or/and voice states are
downloaded from host. See ProCash/DDC User Guide for detailed description
about voice support and configuration.
Parameter name: AUDIOXXX_PATH [1]
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: ASCII string (max. 128 digits)
Value description: full path definition of the wave file.
Default value: not configured in registry
[1] - ’XXX’ represents the language bank number number 000-255.
This parameter can be used to specify a specific screen number that should be
displayed during supervisor mode instead of the standard screen 003 (DDC) or
C03 (NDC).
Parameter name: SPECIFIC_SV_MODE_SCREEN
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 3 or 4 ASCII characters
Value description: specifies the screen number that is displayed instead of
screen 003 or C03.
Default value: not configured in registry
Note: If you have to emulate a Diebold MDS i series system, you need to
specify value 002.
This parameter can be used to define how many PIN digits the consumer has
to enter before the next state can be entered. If the parameter is configured, the
minimum PIN digit definition of the FIT table is ignored.
Parameter name: SCREEN_MIN_PIN_LEN
Section in *.PPF: [LYNXCI_SCREEN]
Valid range: 0-64
Value description: specifies the minimum PIN digits the consumer has to enter
on the PIN pad.
Default value: not configured in registry
[SCREEN_XXX] [1]
[1] ’XXX’ represents the screen number which is downloaded from host.
Foreground Color
This parameter can be used to set a specific foreground color for a downloaded
screen.
Parameter name: FOREGROUND_COLOR
Section in *.PPF: [SCREEN_XXX]
Valid range: 0-255, 0-255, 0-255
Value description: three integer values which contain the RGB components of
the color.
Default value: if the parameter is not set, the values in Registry section
"SCREEN" are used.
Background Color
This parameter can be used to set a specific background color for a downloaded
screen.
Parameter name: BACKGROUND_COLOR
Section in *.PPF: [SCREEN_XXX]
Valid range: 0-255, 0-255, 0-255
Value description: three integer values which contain the RGB components of
the color.
Default value: if the parameter is not set, the values in Registry section
"SCREEN" are used.
This parameter can be used to specify a next screen where it goes to after the
current screen has been displayed. This parameter can be independently set
from the screen download. With this parameter you can insert local screen idle
rotations in combination with, or separately to the screen download. See also
the next parameter for the display time definition of the screen.
Parameter name: IDLE_NEXT_SCREEN
Section in *.PPF: [SCREEN_XXX]
Valid range: -1; 0-999
Value description: -1 - no next screen; next screen number
Default value: -1 - no next screen
This parameter can be used to specify an idle time how long the current screen
appears before it changes to the next screen which can be specified via
parameter IDLE_NEXT_SCREEN.
Parameter name: IDLE_TIME
Section in *.PPF: [SCREEN_XXX]
Valid range: -1; 0-3600000
Value description: -1 - no time; timer value in milli seconds
Default value: -1 - no time
This parameter can be used to specify a char width for a specific downloaded
screen.
Parameter name: CHARACTER_WIDTH
Section in *.PPF: [SCREEN_XXX]
Valid range: 0-99
Value description: number of pixels in horizontal direction
Default value: If the parameter is not set, the values of Registry section
"SCREEN" are used.
This parameter can be used to specify a char height for a specific downloaded
screen.
Parameter name: CHARACTER_HEIGHT
Section in *.PPF: [SCREEN_XXX]
Valid range: 0-99
Value description: number of pixels in vertical direction
Default value: If the parameter is not set, the values of Registry section
"SCREEN" are used.
Screen contents
This parameter can be used to set a horizontal offset for a specific downloaded
screen.
Parameter name: HORIZONTAL_OFFSET
Section in *.PPF: [SCREEN_XXX]
Valid range: 0-999
Value description: number of pixels the window is moved down from the top
most position.
Default value: 0
This parameter can be used to set a horizontal offset for a specific downloaded
screen.
Parameter name: VERTICAL_OFFSET
Section in *.PPF: [SCREEN_XXX]
Valid range: 0-999
Value description: number of pixels the window is moved from the left most
position to the right.
Default value: 0
This parameter is used to switch off displaying the screen contents of a specific
downloaded screen.
Parameter name: DISPLAY_CONTENTS
Section in *.PPF: [SCREEN_XXX]
Valid range: 0-1
Value description: 0 - suppress displaying downloaded screen contents
1 - yes, display contents
Default value: 1 - yes, display contents
The following parameters are used to set if you need to configure the cursor
position and cursor adjustment of consumer inputs locally. Sometimes it is
neccessary to place the curser exactly to the input field of a background picture.
Often the cursor positioning downloaded from host does not match with the
coordinates of the input rectangle from the background graphic. The following
parameters should solve that problem.
Input adjustment
It is very important that for the cursor configuration all five parameters
as described above are set in the [SCREEN_XXX] section.
Configuration Example:
You have set following values:
INPUT_FIELD_LEFT = 0;
INPUT_FIELD_TOP = 24;
INPUT_FIELD_RIGHT = 32;
INPUT_FIELD_BOTTOM = 456;
INPUT_FIELD_ADJUST = 0;
Description: The input rectangle is definded on the left side starting with the first
character at the left border on the second line. The input size is exactly two
characters.
The offset values are dependent from the display resolution and the
font size. If you have a display resolution of 640x480 and your font
has the size and height of 16x24, (value / 16) = 1 character adjust for
parameter xxx_LEFT or xxx_RIGHT, (value / 24) = 1 character adjust
for parameter xxx_TOP or xxx_BOTTOM.
Parameters Parameters
FOREGROUND_COLOR INPUT_FIELD_RIGHT
BACKGROUND_COLOR INPUT_FIELD_TOP
TRANSPARENT_MODE INPUT_FIELD_BOTTOM
PICTURE_BACKGROUND INPUT_FIELD_ADJUST
CHARACTER_WIDTH PICTURE_BACKGROUND
CHARACTER_HEIGHT PICTURE_XXX
VERTICAL_OFFSET
HORIZONTAL_OFFSET
INPUT_FIELD_LEFT
Example:
If the host downloads screen 011 that contains "ESCL002", the screen contents
are stored in registry section "..\LYNXCI\SCREEN\BANK_002\011".
[1] ’XXXX’ represents a fixed four digit definition number which is related to
the error map table (CCErrMap) together with DESTXXXX.
Format Variables
The event and error message text can be prepared with some variables. Here
is a short overview of some variables and their meaning:
Table 13: Variables and formats for event and error messages
This parameter defines the output destinations of the event or error messages.
The destination values can be combinated via enabling the requested bits
(see value description).
Parameter name: DESTXXXX [1]
Section in *.PPF: [TOP_MSG] and [CUST_MSG]
Valid range: 0-39
Value description:
[HARDWARE_CONFIGURATION]
The following table describes the hardware device configuration which is sent
in the NDC solicited status message “Send Configuration Information”.
[1] - Depending on the available hardware, this value will be modified by utility
"SETHWPPF.EXE" during installation.
This parameter activates NCR compatible logging or DDC MDS status logging
of unsolicited and solicited messages on journal destination.
Parameter name: MESSAGE_LOGGING
Section in *.PPF: [HARDWARE_CONFIGURATION]
Valid range: 0, 1, 2
Value description: 0 - logging off; 1 - NDC logging on; 2 - DDC logging on
Default value: 0
The following table describes the hardware device configuration which is sent
in the DDC solicited status message “Send Configuration Information”.
[1] - Depending on the available hardware, this value will be modified by utility
"SETHWPPF.EXE" during installation.
Note1: This field will be filled dynamically by application
Note2: The two digit value represents one Byte where the left digit is the high
part and the right digit the low part. The range of each digit is 30H to
3FH. The value itself has to be entered as an ASCII character value
for the high part and the low part of the byte (see reference table).
HEX Value ASCII char HEX Value ASCII char HEX Value ASCII char
30H 0 36H 6 3CH <
31H 1 37H 7 3DH =
32H 2 38H 8 3EH >
33H 3 39H 9 3FH ?
34H 4 3AH :
35H 5 3BH ;
MACing configuration
This parameter is used to set if the TVN (Time Variant Number) and MAC have
to be sent in Transation Request messages.
Parameter name: SEND_TVN_MAC
Section in *.PPF: [HARDWARE_CONFIGURATION]
Valid range: 0-1
Value description: 0 - do not send TVN and MAC
1 - TVN and MAC will be sent
Default value: 0 - do not send TVN and MAC
This parameter is used to set if the TVN (Time Variant Number) and the MAC
have to be checked in Transaction Reply, State table or FIT Load messages.
Parameter name: CHECK_TVN_MAC
Section in *.PPF: [HARDWARE_CONFIGURATION]
Valid range: 0-1
Value description: 0 - do not check TVN and MAC
1 - TVN and MAC will be checked
Default value: 0 - do not check TVN and MAC
This parameter is used to set if the Time Variant Number and MAC have to be
sent in solicited device status messages.
Parameter name: SEND_TVN_MAC_SOL
Section in *.PPF: [HARDWARE_CONFIGURATION]
Valid range: 0-1
Value description: 0 - do not send TVN and MAC
1 - TVN and MAC will be sent
Default value: 0 - do not send TVN and MAC
This parameter is used to activate field selected MACing. The fields to MACed
are defined in the Message Authentication Field Selection Load command.
Parameter name: MAC_FLD_SELECTED
Section in *.PPF: [HARDWARE_CONFIGURATION]
Valid range: 0-1
Value description: 0 - Field selected MACing OFF
1 - Filed selected MACing ON
Default value: 0 - Field selected MACing OFF (DDC)
1 - Field selected MACing ON (NDC)
This parameter is used to specify how the CCERRMAP entries for M_DATA and
DDC_MDS_STATUS have to be modified in the unsolicited or solicited
message by the application at runtime before it be sent to the host. How the
values should be set by the application depends on how the host verifies those
status fields.
Parameter name: STATUS_CODE_HANDLING
Section in *.PPF: [HARDWARE_CONFIGURATION]
Valid range: 0, 1, 2
Value description: 0 - Status codes entered in CCERRMAP.INA are modified
by the application for solicited and unsolicited messages.
1 - M-Data or MDS i series status codes are replaced
through STCLASS, STCODE, STWARN for solicited or
unsolicited messages. (3 x 4 Bytes = 12 characters)
2 - Status codes entered in CCERRMAP.INA remain
unchanged in solicited and unsolicited messages.
Default value: 0 - Status codes entered in CCERRMAP.INA are modified
by the application for solicited and unsolicited messages.
This parameter can be used to set if the terminal should change the ATM mode
to Offline (Communication framework receives offline event), when the host
does not sent the transaction reply message within the time specified by
TIMER_03 (Host Response Timer). This parameter should prevent processing
of host reply commands that are not related to the customer that has initiated
the transaction request.
Parameter name: GO_OFFLINE_AFTER_TIMEOUT
Section in *.PPF: [HARDWARE_CONFIGURATION]
Valid range: 0, 1
Value description: 0 - stay online; 1 - go offline after reply timeout
Default value: 0 - stay online
[APPLICATION_XXX][1]
[1] ’XXX’ represents the protocol type which can be NDC or DDC.
This parameter can be used to set whether the hardware fitness should be
cleared or remain as before after leaving the SOP session. If you have
ProCash/NDC installed, the Hardware Fitness will allways be cleared if SOP
function "Display Supplies Status" is called.
Parameter name: CLEAR_HWFITNESS
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0-1
Value description: 0 - use current fitness after exiting supervisor mode;
1 - clear fitness after exiting supervisor mode
Default value: 1 - clear fitness after exiting supervisor mode
Resend Power Up
This parameter is used to set what time cycle the power up message should be
repeated to the host.
Parameter name: RESEND_POWER_UP
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0-99999
Value description: time value in seconds
Default value: 0 - no power up repetition
This parameter can be used to set the time in seconds how long the suspend
mode stays active if an error with the suspend mode severity 3 has occurred. If
the parameter is configured with time value zero, the suspend mode option is
switched off.
Parameter name: SUSPEND_TIMEOUT
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0-99999
Value description: time value in seconds. (0 = suspend mode is switched off)
Default value: 30 - suspend mode timeout after 30 seconds
This parameter is used to specify in which ATM mode the power up message
should be sent.
Parameter name: SEND_POWER_UP
Section in *.PPF: [APPLICATION_XXX]
Valid range: NEVER, ONCE, ALWAYS
Value description: NEVER no power up message.
ONCE send power up message during startup only.
ALWAYS send power up after every online
Default value: ONCE
This parameter is used to specify for which terminal doors (Cash and Operator
door) an alarm or sensor change message has to be sent. This parameter also
influences the parameter "SVRMODE_WHEN_DOOR_OPEN".
Parameter name: SEND_DOOR_CHANGE
Section in *.PPF: [APPLICATION_XXX]
Valid range: GENERAL, SAFE, OPERATOR
Value description: GENERAL - Send door open message if one of the doors
has been opened, and send close message if both doors
are closed.
SAFE - Send open/closed message if safe door has been
opened/closed.
OPERATOR - Send open/closed message if operator door
has been opened/closed.
This parameter can be used to specify if the terminal should go into supervisor
mode after the time specified when the safe or operator door has been opened.
Supervisor mode will be automatically exited (without time delay) when the door
is closed and you have not entered the supervior mode via the SOP menu.
See also section “Sensor messages for terminal doors” on page 162 for door
configuration options.
Parameter name: SVRMODE_WHEN_DOOR_OPEN
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 999 seconds delay time
Value description: 0 - do not enter SV mode
>0 - enter SV mode after the specified time delay.
Default value: 0 - option disabled
The parameters in this section are used to configure message queuing for
events within transactions or for during offline which generates a message to
the host. The message will be queued until a transaction has been finished or
the line status changes from offline to online.
These parameters can be used to set default values for the Miscellaneous
Features 1, 2 and 3. Those default values will be ORed together with the values
of Write Command III (Configuration download). If there is a configuration
download from the host, where the values are less than the default setting, the
bits which are set locally in the default parameters remain active.
Parameter names: DEFAULT_MISC_FEATURE_1
DEFAULT_MISC_FEATURE_2
DEFAULT_MISC_FEATURE_3
This parameter can be used to set if the logo light should be switched on/off
together with the ready indicator.
Parameter name: SWITCH_LOGO
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 1
Value description: 0 - switch on/off ready indicator only
1- switch on/off logo light together with the ready indicator
Default value: 0
With this parameter you can switch on bits for the Ready/Supply/Amount Buffer
Options if the Configuration Parameters Load message is downloaded from
host and the bits are switched off. Bits which are set in this parameter will be
AND with the downloaded bits from the host. This could be useful if you want to
set locally required bits which are not downloaded by the network.
Parameter name: DEFAULT_SUPPLY_READY_AMOUNT_OPTIONS
Section in *.PPF: [APPLICATION_XXX]
Valid range:
VALUES DESCRIPTION
0 No options selected
1 Separate READY (B) status sent in response to Transaction Reply
2 Auto return to previous mode from supply mode
8 12 digit amount buffer (if not set 8 digit amount buffer)
Value description: The values of each option can be added together if you
want to set more than one option.
Example: Value 3 sets "Separate Ready (B)" and
"Auto return to previos mode from supply mode".
Default value: 0 - No option is set
This parameter allows you to set default treshold values for card read/write
errors which are downloaded with the Enhanced Configuration Parameters or
the Configuration Parameters load command (Write Command III for DDC).
With this parameter you are able to set locally a minimum limit which cannot be
overloaded with a lower value from the host.
Parameter name: DEFAULT_CARD_READ_THRESHOLD
DEFAULT_CARD_WRITE_THRESHOLD
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 99
Value description: Sets the number of read/write errors which can occur before
a message is sent to the network.
Default values: 10 - for read errors; 3 - for write errors
This parameter can be used to specify if the terminal should enter "Out of
Service" mode after reestablishing the line if the previous mode before offline
was "In Service" mode.
Parameter name: OOS_AFTER_ONLINE
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 1
Value description: 0 - return to "In Service" mode if previous mode was
"In Service" before offline.
1 - enter "Out of Service" mode after reconnection
Default value: 0
This parameter can be used to specify the time the application waits for the "Go
in Service" command after the Rear Balancing function has been executed and
the terminal has exited supervisor mode. If the terminal does not receive the
"Go in Service" command within the specified time, the rear balancing function
will not performed.
Parameter name: REAR_BALANCE_TIMEOUT
Section in *.PPF: [APPLICATION_XXX]
Valid range: 10, 9999
Value description: specifies the time in seconds the application waits for the
"Go in service" command from host.
Default value: 30
The following parameters are used to configure Customer Relays (1-4) control
of the Special Electronic (SEL) and the Status Indicators of the Operator Panel.
You can configure which status lights should be switched on/off during following
ATM modes or device status:
ATM is in service mode
Customer transaction active (card inserted by consumer)
ATM is in Supervisor Mode
ATM requires technical service or maintanance
Low or out status on cash cassettes
Printer paper low
For Status Indicators of the Operator Panel you have to enter OPL for
IndicatorType. Range 0-4 of Number (ON/OFF behaviour see Relay
description) represents the control of the Status Indicators in following order:
EXAMPLE 1:
Assume you like to switch ON the Customer Relay 2 and the Customer Indicator
of the Operator Panel when the ATM mode is in service. In addition you like to
configure to switch OFF the tech. Service Indicator of Operator Panel:
Following parameter setting in CUSTOM.PPF is required:
LED_IN_SERVICE = REL:2,OPL:0,OPL:-4
EXAMPLE 2:
Assume you like to configure Customer Relay 3 and 4 and the tech. Service
Indicator on the Operator Panel when the ATM mode is in Supervisor Mode.
Following parameter setting in CUSTOM.PPF is required:
LED_SVR_MODE = REL:3,REL:4,OPL:4
The LED configuration parameters are preset with following defaults if the
parameters are not set in the registry:
The Remote Sensor Indicators (RSI) consist of three different status lights of
following colors:
GREEN (Relay 3): ATM is In Service and all devices are ok.
On Wincor Systems the RSI status can only be GREEN or YELLOW or RED.
Multiple lights cannot be enabled.
RSI is connected to the Relay output 1-3 of the Special Electronic. The colors
Red, Yellow and Green are assigned to fixed Relay positions, RELAY1 = Red,
RELAY2 = Yellow, RELAY3 = Green. To configure RSI you can use the same
parameters (but with some restrictions), as used to configure Customer Relays
(see also Abschnitt ”Configure Customer Relays 1 - 4” on page 167).
On Wincor Nixdorf systems the Remote Status Monitor handling can be enabled
via IndicatorType RSM. As described in Abschnitt ”Configure Remote Sensor
Indicators (RSI)” on page 171, you can configure multiple parameters and
multiple Indicator Types in a comma separated list.
Example: LED_CASH = RSM,OPL:2
For Multivendor environments on NCR Systems the Indicator Type has to be set
to IndicatorType RSMNCR.
Example: LED_CASH = RSMNCR
The LED control for the Operator Panel (OPL) is slightly different on for
hardware systems other than Wincor Nixdorf. Some LED’s do not exist or the
LED numbers are in a different order. This section describe how the Operator
Panel LED’s can be mapped (as an example) for NCR, Diebold and DeLaRue
systems.
The following table shows the difference of the Operator Panel LED’s between
Wincor Nixdorf and NCR:
Parameter LED Wincor NCR DeLaRue Diebold
No. Nixdorf
LED_IN_SERVICE 0 In Service Supervisor
LED_CUSTOMER 1 Customer Ready
LED_CASH 2 Cash Error
LED_PAPER 3 Paper Not available
LED_SERVICE 4 Service Not available
LED_SVR_MODE - Supervisor - - -
This parameter can be optionally used to individually specify the flash intervall
for the guideance light of a device. The flash rate can be configured in multiple
ways as described later on.
Parameter name: GUIDE_FLASH_RATE
Section in *.PPF: [APPLICATION_XXX]
Valid range: 1. single value in range of: 0-4
2. comma spearated list of values: 0-4
Value description: The flash rate can be configured in multiple ways:
The 1st way is to specify the flash rate equally for all
devices.
Example 1: GUIDE_FLASH_RATE = "3" specifies quick flash for all devices.
Important Note: Please make sure that the guide light control of all other
software layers like XFS or the driver layer underneath are
being switched off to prevent concurrent calls of these
layers.
This parameter can be used to initiate a system reboot if the ATM mode
changes from online to offline and remain offline longer than the time configured
via this parameter. In addition you can specify the time the ATM is waiting for
line connection after restart before a system reboot is initiated after timer expiry.
This parameter can be useful if host and terminal have reconnect problems in a
non-stable network or because of hardware problems with network cards.
Parameter name: OFFLINE_REBOOT_TIMER
Section in *.PPF: [APPLICATION_XXX]
Valid range: -545, 545 minutes (max. 9 hours)
Value description: Positive value: If the ATM has been started and the line
connection is online up to know the ATM mode is triggered.
If the ATM mode changes to offline, the timer is started.
If the ATM remains offline and the timer expires, the reboot
flag is set.
Dependency Restart Manager:
- If parameter SHUTDOWN_ACTIVE is set to "1",
a system reboot takes place.
- If the value is "0" the application will be just killed.
Negative value: Immediately if the ATM has been started,
the connection is checked for online. The timer starts when
the application is in offline mode. If the ATM mode does not
change from offline to online within the specified time, the
reboot flag is set. If ATM gets line connection after
restart. The behavior is the same as described in the
section above (Positive value).
Dependency Restart Manager:
- If parameter SHUTDOWN_ACTIVE is set to "1",
a system reboot takes place. This cycle will be repeated
until we get line connection and number of times
configured in MAXREBOOT.
- If the value of SHUTDOWN_ACTIVE is "0" the application
will be just killed.
Default value: not configured in registry
This parameter can be used to specify if the General Purpose Buffer B and C
should be preset with zeros as it is already done for the Amount Buffer.
This option effects for the Enhanced Amount Entry state for NDC, the Copy
Buffer state and the Enhanced Copy Buffer state for DDC.
Parameter name: ADJ_GEN_BUF_FROM_AMT
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 1
Value description: 0 - General Purpose buffers are NOT zero filled.
1 - Preset General Purpose buffers with leading zeros.
With the following parameters you can define your own cassette names for the
journal logging when a cassette has been inserted or removed.
You can overwrite following default names:
REJECT CASSETTE
TOP CASSETTE SECOND CASSETTE
THIRD CASSETTE BOTTOM CASSETTE
Configuration Option 1:
Parameter names: JOU_NAME_REJECT
JOU_NAME_CASSx [1]
Section in *.PPF: [APPLICATION_XXX]
Valid range: character string (max. 40 characters)
Value description: specifies the cassette names for the reject cassette and for
each single cash out cassette.
Default value: not configured in registry
[1] - x = physical cassette number beginning with 1 for the first
dispense cassette. The parameters JOU_NAME_CASS1,
JOU_NAME_CASS2, JOU_NAME_CASS3 and
JOU_NAME_CASS4 define the names of 4 cassettes.
Configuration Option 2:
Parameter names: JOU_NAME_REJECT
JOU_NAME_CASSN
Section in *.PPF: [APPLICATION_XXX]
Valid range: For parameter JOU_NAME_CASSN you have to include
in addition to a unique cassette name the characters $N$
that are replaced with the physical cassette number.
Range for parameter JOU_NAME_REJECT as defined in
Configuration Option 1.
Value description: specifies the cassette names for the reject cassette and
cash out cassettes.
Default value: not configured in registry
With the following two parameters you can define your own journal text for
number of rejects and retracts for the counter changed messages
"Cash Counters before SOP" and "Cash Counters after SOP".
You can overwrite following default text:
RETRACTS: (represents the retract counter)
REJECTS: (represents the reject counter sum of all dispense cassettes)
ADRS options
This parameter can be used to set specific ADRS options to optimize the ADRS
behaviour. By default ProCash/NDC and ProCash/DDC starts the ADRS run
after each consumer transaction. If a consumer inserts his card, the application
waits as long as a previous ADRS run has been finished. In error situations
(cash dispenser time-outs, or shutter jams, dispenser resets, etc.) the waiting
time to finish the ADRS run can cause a long delay time to the next FDK
selection or PIN entry screen for a customer that has already inserted his card.
Parameter names: ADRS_OPTIONS
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0 - 15
Value description: 0 - wait until previous ADRS run has been finsihed after a
consumer has inserted a card (can cause a delay during
consumer input)
1 - Do NOT wait for a previous ADRS run. Proceed with the
consumer transaction with the risk that the delay
happens (through a dispenser problem) after the
transaction reply has been received and a dispense
function has been initiated.
2 - Do NOT allow a consumer transaction if after a previous
ADRS run a cash dispenser error has not been repaired.
Display OOS screen in this phase if the dispenser is still
not operational.
Repeat the ADRS run as long as the dispenser is not
repaired. If the dispenser is again operational, stop
ADRS run and allow further consumer transactions.
4 - Run ADRS additionally in Out of Service mode. This
option can be ORed together with one of the other
options.
8 - Run ADRS in OpenCustomerService() to force ADRS
after SOP exit or if the ATM mode changes from offline
to online and previous mode was In Service or the host
sends a Go In Service command. This option can be
ORed together with one of the other options.
This parameter can be used to set the maximum repetitions the ADRS should
be repeated.
Parameter name: ADRS_MAX_RETRIES
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0 - 9999
Value description: 0 - 3 retries during in service mode (1 minute delay).
>0 - number of repetitions the ADRS is repeated until the
device is repaired.
Default value: not configured in registry
This parameter activates displaying the "Your card has been captured" screen
defined in the Close State (J), if the card was retained by the application (but
retain flag not set in host reply) in case of a jam or a consumer timeout.
Parameter name: CARD_RETAIN_DISPLAY
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0-1
Value description: 0 - do not display card retain screen, if card is retained by
the application (default).
1 - display retain screen if card was captured through the
application and not by retain flage from host reply.
Default value: not configured in registry
This parameter can be used to specify in which ATM mode a print immediate
host reply command (FID ’4’) is accepted by the ATM.
Parameter name: PRINT_IMMEDIATE_OPTIONS
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0-3
Value description: Bit order
0x01 -Allow print immediate in Supervisor mode
0x02 -Allow print immediate in In Service mode
3 X 1. Specify StClass/StCodeDevStaDeviceName
This field can be used to set a specific class and error code that can
be set for a specific device name. If DeviceName is not specified,
the device name of parameter position 1 is used.
Example entry 1: 64340050
Example entry 2: 643A0060CCCdmFW
Note: Please make sure that the error section exist in registry
location:
..\Wincor Nixdorf\ProTopas\CurrentVersion\CCERRMAP
Example2:
"1:TAMPER_SENSOR:2000:-.CCCardFW.4:T2HUnsolicitedAlarmStateChange,
10:INPUT_SENSOR1:2001:-.CCCardFW.0:T2HUnsolicitedMyOwnDefinedMessage"
Example3:
"1:TAMPER_SENSOR:2000:64340050:T2HUnsolicitedAlarmStateChange,
10:INPUT_SENSOR1:2001:64340051:T2HUnsolicitedMyOwnDefinedMessage"
Example4:
"1:TAMPER_SENSOR:2000:643A0060CCCdmFW:T2HUnsolicitedAlarmStateChange,
10:INPUT_SENSOR1:2001:643A0061CCCdmFW:T2HUnsolicitedMyOwnDefinedMessage"
ProDevice (WOSA) uses sensor type WFS_SIU_TAMPER (1) for status indication.
Please refer to "Generation Tools" User Guide CSC-W32 2.1/80 or higher for detailed information.
Refer also to ProDevice CEN document "Part 10: Sensors and Indicators Unit Device Class Interface" and
"Part4: Identification Card Device Class Interface".
Example4:
The following just configures the applicationn reactions on disconnect:
"ALARM_SENSORS"="1:MY_SENSOR:::::::2011:64340048.CCCardFW.4:T2HUnsolicitedMySkimming"
Note: For the journal log entry, variable expression $DCVAR_APPL_ASKIM_STATE$ can be used, if the
ASKIM_STATE value should be logged.
The following table describes the "Active" and "Inactive" status that is set as
initial status after application start, depending on how the current status of the
XFS sensor device is set. Depending on the "ALARM_SENSORS" parameter
configuration, an unsolicited alarm message can be sent under following
conditions described in the table.
Example1: SIU_INPUT1
ALARM_SENSORS =
"10:INPUT_SENSOR1:2000::T2HUnsolicitedOnMessage,2001::T2HUnsolicitedOffMessage"
Description: In case the SIU_INPUT status has status OFF, the journal message 2001 is generated and
the unsolicited message "T2HUnsolicitedOffMessage" is sent to the host.
If this message contains a device definition of a dcDevSta device, the Sensor Status is
set depending on the configuration in POS 1 of the parameter.
Example2: SIU_TAMPER
ALARM_SENSORS =
"1:INPUT_SENSOR1:2000::T2HUnsolicitedOnMessage,2001::T2HUnsolicitedOffMessage"
Description: In case the SIU_TAMPER status has status ON, the journal message 2000 is generated
and the unsolicited message "T2HUnsolicitedOnMessage" is sent to the host.
If this message contains a device definition of a dcDevSta device, the Sensor Status is
set depending on the configuration in POS 1 of the parameter.
Note: If the negative option is configured, only the sensor status of the
dcDevSta device is changed to the opposite status.
With this parameter can be configured which screen should be displayed in the
close state when a receipt was printed or not printed. If the parameter is
enabled, always state index 0 (transaction record form delivered screen) of the
close state (J) is used if the printer has successfully printed and delivered a
receipt. If a receipt was not printed, always state index 2 (no transaction record
form delivered screen) is displayed. If DDC FID ’H’ or ’D’ is used in the host
reply, always state index 2 is used.
Parameter name: RECEIPT_DELIVERED
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 1
Value description: 0 - use state index 0 if receipt already delivered in the reply
function (form feed (FF) included in printer data).
Use state index 2 if receipt will be deliverd in the close
state.
1 - use state index 0 only if receipt could be printed and
delivered but not if reply DDC FID ’H’ or ’D’ is used in
host reply.
Default value: not configured in registry
If this parameter is enabled the close Timer 02 is always used. By default when
the parameter is not set, the close Timer 02 is used only if the next state is a
000 state.
Parameter name: USE_CLOSE_TIMER_ALWAYS
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 1
Value description: 0 - use close timer only if the next state is a 000 state
specified in the close state (J).
1 - use close timer always
Default value: not configured in registry, default is 0
This parameter is used to sepecify a delay time how long the application should
wait for the Transaction Reply procesing after the Transaction Request
message has been sent to the host.
Parameter name: TRAN_DELAY_TIME
Section in *.PPF: [APPLICATION_XXX]
Valid range: -999-999
Value description: Positive value: delay as long as the Transaction Request
dialog returns, but maximum deleay as specified.
Negative value: delay the specified time in any case
Default value: not configured, default is 0
This parameter can be used to specify a screen delay time (in seconds) for the
screen that is sent via function identifier ’Z’ (do nothing) of a DDC Function
Command message.
Parameter name: FID_Z_WAIT_TIME
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0-5
Value description: the value specifies the time in seconds how long the screen
of FID ’Z’ should be displayed.
Default value: not configured, delay time is 0
This parameter can be used to set special PAN handling that is required in
some project environments.
Parameter name: PAN_HANDLING
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 1
Value description: 0 - standard PAN handling
1 - specific PAN handling for ANSI PIN block. Use PANLN
and PANDX. Skip field separator und take next PAN
digits up to the number of digits specified by PANLN.
Default value: not configured, use standard PAN handling
This parameter can be used to disable safe door monitoring. This parameter is
useful in case the XFS layer returns an undefined door open status because the
physical door sensor connection is missing.
Parameter name: MONITOR_SAFE_DOOR
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 1
Value description: 0 - disable safe door monitoring
1 - enable safe door monitoring
Default value: not configured, (default = 1)
This parameter can be used to specify the delay time between the connection
attempts when the application tries to establish the line connection in offline
conditions.
Parameter name: RECONNECT_DELAY
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 9999
Value description: 0 - connection attempts without delay
1 - 9999 delay time between each connection attempt
Default value: not configured, (default = 0)
This parameter can be used to specify the delay time when the Power Save
Mode should be activated after a consumer transaction has been finished.
Parameter name: POWER_SAVE_DELAY
Section in *.PPF: [APPLICATION_XXX]
Valid range: 0, 65535
Value description: 0 - not configured
1 - 65535 delay time in seconds
Default value: not configured, (default = 0)
Important Note: Power Save Mode is supported only on CMD-V4 with
firmware that supports ECO mode.
This parameter specifies the timeout value for the screen that is displayed if
CAS for the cash dispenser is active. If the consumer performs a withdrawal
transaction, screen 907 is displayed after the terminal has received the
transaction reply and CAS is active. The consumer has the choice to wait until
CAS is finished or to press CANCEL to abort the transaction. If the consumer
does not press CANCEL and CAS is still active after the timer has expired, the
transaction will be aborted and the terminal responds to the host with a solicited
timeout message. If the consumer press CANCEL, the terminal responds to the
host with a solicited CANCEL message. If CAS will be finished within the time
specified via this parameter, the withdrawal transaction will be processed.
Parameter name: CAS_WAIT_TIME
Section in *.PPF: [CASH_DISPENSER]
Valid range: Tnn, 0, 1-999, ""
Value description: 0 - infinite
1-999 - Number of seconds the screen remain.
Tnn - Use timer value that is downloaded from host.
nn = downloaded timer number stored in
..\LYNXCI\TIMER section.
"" - Timer 04 is used (Diebold compatible)
Default value: not configured - 120 seconds (Diebold compatible)
This parameter specifies the timeout value for the screen that is displayed if
CAS for the deposit module is active. If the consumer performs a deposit
transaction, screen 906 is displayed after the terminal has received the
transaction reply and CAS is active. The consumer has the choice to wait until
CAS is finished or to press CANCEL to abort the transaction. If the consumer
does not press CANCEL and CAS is still active after the timer has expired, the
transaction will be aborted and the terminal responds to the host with a solicited
timeout message. If the consumer press CANCEL, the terminal responds to the
host with a solicited CANCEL message. If CAS will be finished within the time
specified via this parameter, the deposit transaction will be processed.
Parameter name: CAS_WAIT_TIME
Section in *.PPF: [DEPOSIT]
Valid range: Tnn, 0, 1-999, ""
Value description: 0 - infinite
1-999 - Number of seconds the screen remain.
Tnn - Use timer value that is downloaded from host.
nn = downloaded timer number stored in
..\LYNXCI\TIMER section.
"" - Timer 04 is used (Diebold compatible)
Default value: not configured - Timer 04 is used (Diebold compatible)
This parameter specifies the timeout value for the screen that is displayed if
CAS for the receipt printer is active. After the consumer has inserted the card it
will be checked if CAS for the receipt printer is active. If CAS is active, screen
903 is displayed. Within this screen (FDK selection screen) the consumer has
the choice whether to continue or to abort the transaction. If the consumer press
CONTINUE, the transaction will be processed without getting a receipt. If the
consumer press CANCEL or after consumer timeout, the card will be returned
and screen 904 is displayed.
Parameter name: CAS_WAIT_TIME
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 0, 1-999
Value description: 0 - infinite
1-999 - Number of seconds the screen remain.
Default value: not configured - infinite
This parameter specifies the timeout value for the screen that is displayed if
CAS for the document printer is active. If the consumer performs a
transaction and the transaction reply contains statement print data, screen 906
is displayed if CAS is active. The consumer has the choice to wait until CAS is
finished or to press CANCEL to abort the transaction. If the consumer does not
press CANCEL and CAS is still active after the timer has expired, the
transaction will be aborted and the terminal responds to the host with a solicited
timeout message. If the consumer press CANCEL, the terminal responds to the
host with a solicited CANCEL message. If CAS will be finished within the time
specified via this parameter, statement printer data will be processed as
received in the transaction reply.
Parameter name: CAS_WAIT_TIME
Section in *.PPF: [DOCUMENTPRINTER]
Valid range: 0, 1-999
Value description: 0 - infinite
1-999 - Number of seconds the screen remain.
Default value: not configured - infinite
This parameter can be set to inform the consumer that CAS for the deposit
module is active when a withdrawal transaction has been selected by the
consumer. This parameter prevents that dispense operations fail because of an
open safe door while CAS of the deposit module is processed. This parameter
is not needed on terminals which accept dispense operations with an open safe
door.
Parameter name: CAS_WAIT_DEPOSIT
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - Do not check CAS for deposit module within a
withdrawal transaction.
1 - Check CAS for deposit module within a
withdrawal transaction.
Default value: not configured - Check CAS for deposit module within a
withdrawal transaction.
[CASH_DISPENSER]
This parameter can be used to specify the number of notes loaded count for
each cassettes denomination. This parameter will also be used by SOP function
"STD CASH".
Parameter name: DEFAULT_NUM_NOTES_X [1]
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0-9999
Value description: represents the number of notes loaded count.
Default value: “”
[1] ’X’ represents the logical cassette position from 1 to 4 for NDC and up to 8
for DDC, where 1 - 8 are assigned to denomination ’A’ - ’H’.
This parameter can be used to configure automatic logon features for cash
cassettes and also for the reject and retract cassette. This allows cassettes
exchange without entering the SOP session. The cassettes are set to
operational automatically after reinsertion. In addition you can specify the
counter behavior of the cassettes. This parameter can also be used to logon
cash in cassettes and retract cassette on CCDM.
Parameter name: AUTO_LOGON_CASSETTES
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0 - 31
Value description:
Bit value Description
1 Logon the cassettes if they are inserted and the safe door has
been closed after cassettes insertion
2 Only if parameter AUTO_LOGON_NOTES is non zero:
- Sets the dispensed to customer counter to zero
- Sets the dispensed counter to zero
4 Sets the counter of the reject cassette to zero
8 Sets the counter of the retract cassette to zero
16 Logon cassettes during safe door open. (Dangerous if
cassettes are qickly shuffled; could cause counter mismatch)
This parameter activates the automatic logon feature for cash out cassettes and
also for the reject cassette within supervisor mode and without entering the
cassette exchange function. The cassettes will be automatically logged on just
before SOP exit.
Parameter name: AUTO_LOGON_IN_SOP
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - logon in SOP off; 1 - logon in SOP on
Default value: 0
This parameter can be used to set initial number of notes for cassettes which
are logged on via the automatic logon feature. This makes the cassettes
immediately operational without entering any counters via the SOP "Set cash
counters" menu.
Parameter name: AUTO_LOGON_NOTES
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0 - 9999
Value description: initial number of notes for each cassette which is logged on
Default value: 0
This parameter should be used only if the host and operators do not
care about the local calculated cash counters. If a host or other ATM
monitoring programs like ProAgent ask for the local counters they will
get wrong cash counters.
This parameter can be set if the solicited low message should be sent only if the
whole denomination gets low. This is useful if you have configured multiple
cassettes with the same cash type and the solicited low message should be
sent only once for each denomination. If this parameter is not set, the solicited
low message will be sent for each physical cassette.
Parameter name: DENOMINATION_LOW_MSG
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - send message for each physical inserted cassette
1 - send low message only if the whole denomination
becomes low [1].
Default value: DDC: 0, NDC: not configured
[1] - If in a DDC environment parameter SEND_CASSETTE_LOW_ALWAYS is not configured, the low
message is sent after each transaction. If you like to send the low message only once, you have to
configure SEND_CASSETTE_LOW_ALWAYS = 0.
This parameter can be used to set how the cassettes should be emptied. You
can specify if the cassettes should be emptied equally or from top to bottom. If
you have for example four cassettes with the same denomination, it might be
useful to set empty cassettes equally, because a cassettes low message is sent
not until the last cassette gets empty. This parameter can also be combined with
parameter "DENOMINATION_LOW_MSG". If the value is zero, the cassettes
low message is immediately sent if the first cassette gets empty. If the value is
one, the low message is sent not until the last cassette gets empty. On Cash
Recycling Systems (CRS) is supported only value "0" (top to bottom algorithm).
Parameter name: DISPENSE_ALGO
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - top to bottom algorithm
1 - empty cassettes equally
Default value: 0
This parameter can be used to configure that the cash counters of removed
cassettes are reported as zero counters to the host. Additionally the counters
are set to zero in the SOP "Display/Print Supply Counters" functions. Also after
cassettes exchange the cassettes counters for removed cassettes are printed
as zero counters on journal after supervisor exit.
Parameter name: CLEAR_MISS_COUNTER
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - cash counters remain after cassettes removal
1 - cash counters are set to zero after cassettes removal
Default value: 0
The cash counters for removed cassettes in the SOP functions are
still available !!
This parameter can be used to force sending an unsolicited cash low message
after each consumer transaction if the supply status of one or more cassettes is
low. That is usually used in the NDC environment.
In DDC you can additionally combine bit 0x04 and bit 0x08 if these options are
required by the host. In this case bit 0x01 and bit 0x02 should be switched off.
Parameter name: SEND_CASSETTE_LOW_ALWAYS
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1, 2, 4, 8, 12
Value description: 0 - low message is sent only once after supply status
change from "good" to "low".
1- send low message after each transaction only if
current cassettes supply status of a used cassette is
low.
2- send low message after each transaction if one or
more cassettes have low supply status also if a low
cassette is not used in current cash transaction.
4 - send low message only for used cassettes that have
the low status and set the MDS low status bit only for
the used ones (not the accumulated value).
8 - send low message after first consumer transaction if
one or more cassettes have a low status after exit
supervisor mode. In this case the MDS low status
bits are accumulated.
12 - enables above options 4 and 8.
This parameter can be used to specify after how many cash transactions the
application should stop the dispense operation if the application has received
the same error multiple times in the money present operation from the cash
dispenser module. In addition the application is generating a different device
error message for the host where at least the host can decide to not send any
cash out transaction replies any more until the error is fixed (after exit superviser
mode).
Parameter name: MAX_PRESENT_ERRORS
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 999
Value description: 0 - Counting of money present errors disabled
>0 - After how many times the application should stop the
dispense operation if it has received the same error
in the money present operation of previous cash out
transactions.
Default value: 0 - Counting of money present errors disabled
This parameter can be used to specify after how many consecutive dispense
errors the cash dispenser device should be set to severity 4 (fatal).
Parameter name: MAX_DISPENSE_ERRORS
Section in *.PPF: [CASH_DISPENSER]
Valid range: 1, 99
Value description: number of dispense errors after the cash dispenser will be
set to fatal (severity 4)
Default value: not configured in registry, internal default is 10
If this parameter is enabled the transaction ready message is sent after the
consumer has successfully taken the money. If the money has not been taken
by the customer during the time-out period, the terminal sends a solicited status
message to the host after the retract operation has been initiated by the
application (only on retract systems if retract operation is enabled).
Parameter name: SEND_SOL_RETRACT
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - Send transaction ready immediately when presenting
the cash. Send unsolicited status message after cash
retract if the money was not taken by the consumer
during the time-out period.
1 - Send ready after money has been taken. Send solicited
message after cash present consumer time-out.
Default value: not set in registry
This parameter can be set if presented cash should be retracted by the host
through function command ’Q’ and not by the cash terminal if the cash present
timer has expired. If the cash retract time-out timer (Timer 05) has expired, a
solicited message is sent to the host. Then the host can respond with the
Presenter Dump function command ’Q’, which initiates a cash retract operation.
Parameter MAXRETRACT has to be non-zero.
Parameter name: SOLICITED_IF_RETRACT_INHIBIT
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - Retract is initiated by the terminal after present timeout.
After retract the terminal generates a solicited message.
1 - Retract is NOT initiated by the terminal, but a solicited
message is sent to the host and the terminal waits for a
new host function command message.
Default value: not configured in registry
This parameter can be used to allow dispense operations for those cassettes,
which have still notes physically available, but the logical counter "number of
notes remaining" in cassette has reached a value below zero. If the counter
"Number of notes remaining" is below zero, the value is set fix to 65535 and
remain unchanged until you have entered SOP to set or add new cash counters
via the SOP function.
Parameter name: DISPENSE_BELOW_ZERO
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - Dispense below zero disabled. Do not use any more
those cassettes where the counter "Number of notes
remaining in cassette" has reached zero.
1 - Dispense below zero enabled. Allow dispensing for
those cassettes which have still money available in the
cassette, but cash counter is < 0.
Default value: 0 - Dispense below zero disabled.
This parameter can be used to set a time interval that specifies within what time
a present money operation is allowed after a dispense operation. If a present
money operation is not initiated within the specified time, the present money
function returns with "Order not allowed". This option prevents unexpected
money delivery after possible hanging situations or if an outstanding job does
not return.
Parameter name: PRESENT_TIMER
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0 - 999 (time in seconds)
Value description: 0 - Money present security timer off
1 - 999 - Money present security time. Sets the time
within what time a present money operation has
to be initiated after a dispense operation.
Default value: not configured, default time used by application is 180 sec.
This parameter is needed to be set if the application has to run on an ATM that
has a dispenser with 6 dispense cassettes. If this parameter is enabled 4 logical
cassette types are built of 6 physical cassettes.
ProCash/DDC
If this parameter is enabled, following standard protocol characteristics of
ProCash/DDC are changed:
Cassettes in sol./unsol. cash dispenser device fault messages are reported
in logical order as configured in ..\LYNXPAR\CASH_DISPENSER and NOT
as physically inserted. The available cassettes, which will be assigned to a
logical type are searched from top to bottom. Physical cassettes that are not
configured as a logical type are skipped. Only the first 4 physical cassette
types (top to bottom search) that match with the configured logical types are
taken. Remaining physical cassettes are ignored. The 912 cassette specific
dispense error code will be calculated in logical order.
The four denomination ID’s in the Hardware Configuration message are
reported in logically.
Cassettes supply counters in Supply Counters and Enhanced Supply
Counters messages are sent in logical order (four logical types only).
ProCash/NDC
For ProCash/NDC following characteristics are changed:
TI Sensor messages of the cassettes are reported logically and NOT as
physically inserted. If multiple physical cassette types are assigned to one
logical type, the sensor status changes only from IN to OUT if all physical
cassettes of the same type are removed.
Parameter name: LOGICAL_MAPPING
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - Logical mapping off (4 or less cassettes)
1 - Logical mapping on (needed on 6 cassettes ATM’s)
Default value: not configured - Logical mapping off (4 or less cassettes)
This parameter can be used to specify whether the shutter status of the cash
dispenser should be checked or not after the money has been taken by the
consumer.
Parameter name: CHECK_STATUS_AFTER_MONEY_TAKEN
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - shutter status check is OFF after money was taken
1 - shutter status check is ON after money was taken
Default value: not configured, shutter status check is ON
This parameter can be used to specify if the denomination ID’s for dispense
cassettes should be sent as upper case letters in solicited status messages, if
the supply status of a cassette is still GOOD, but the cassette has other errors
that prevents dispensing from it, like (pick failure, fatal status, no reference
value, double picks, etc.).
Parameter name: DENOM_ID_UPPERCASE
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - send always lower case letters for cassettes it cannot be
dispensed from, even the supply is GOOD.
1 - send lower case letters only if the supply status of a
cassette is LOW or OUT.
Default value: not configured, send always lower case letters for cassettes
that have dispense problems.
With the following parameter you can configure a specific screen that will be
displayed if the cash present function has failed (note jams, blocked shutter,
consumer manipulations). Additionally this parameter enables to perform the
following retract operation synchronously. For NDC this parameter activates
also sending a solicited device error message instead of sending an unsolicited
message.
Parameter name: PRESENT_FAILURE_SCREEN
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0 - 999
Value description: 0 - perform synchrous retract and send solicited
message, but do NOT display an additional screen.
010 - 999 - behaviour as value 0 and display the
configured screen.
Default value: not configured, perform the retract operation
asynchronously without sending a device status
message.
This parameter can be used to configure, whether the screen of the host
function reply should be displayed before the present cash function or after the
present cash function.
Parameter name: DISPLAY_PRESENT_SCREEN
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - "TAKE CASH" screen is displayed when money is
accessible after present.
1 - "TAKE CASH" screen is shown before the present is
issued
Default value: not configured, default is 0
This parameter can be used to force setting the severity 4 (fatal) for the device
Cash Dispenser, if the reject bin status from the cash dispenser framework is
not operational. Severity 4 is also set if the reject bin is removed.
Parameter name: REJECT_FATAL_STATUS
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0-1
Value description: 0 - leave status of device Cash dispenser unchanged
1 - set device Cash dispenser to severity 4 (fatal)
Default value: not configured
Dispense retries
This parameter can be used to specify how many dispense retries should be
performed if the dispense function returns with an error.
Parameter name: DISPENSE_RETRIES
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0 - 99
Value description: 0 - no retries, one dispense call only
>0 - set number of dispense retries
Default value: not configured, 4 dispense tries is done by default
This parameter can be used to specify how many dispense retries should be
performed if the dispense function returns HARDWARE_ERROR (-14). This
parameter has to be combined with parameter DISPENSE_RETRIES (see
previous section). The value of this parameter should be less or equal as
parameter DISPENSE_RETRIES.
Parameter name: HWERR_DISPENSE_RETRIES
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0 - 99
Value description: 0 - no retries, one dispense call only
>0 - set number of dispense retries
Default value: not configured, 3 retries is done by default
If this parameter is enabled, the WOSA exponent value will be adjusted to the
exponent value that is needed for dispense operations and status messages in
the NDC or DDC environment.
Parameter name: EXPONENT_CORRECTION
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0, 1
Value description: 0 - no exponent correction, the value from WOSA is used
1 - exponent value will be adjusted for NDC and DDC
Default value: 1
This parameter specifies how many cash retracts can be performed by the cash
dispenser. If the specified limit has been reached the dispenser will be locked.
Parameter name: MAXRETRACT
Section in *.PPF: [CCCDMFW]
Valid range: -1; 0 - 99
Value description: -1 sets defined number of retracts (hardware
dependent). The money of the second retract
remain on the stacker. On ProCash Compact
ATM’s without a retract tray the number of
allowed retracts is one. The money remains on
the stacker area and has to be removed manually
by the operator.
0 no retract operations
1 - 99 number of retracts allowed
Default value: -1
This parameter can be used to specify a low threshold for physical cassettes. If
the physical number of notes become lesser than the specified value, the
physical cassette status changes from GOOD to LOW. This parameter can be
useful to over control the physical status of recycling cassettes in cases when
the LOW status is set too early.
Parameter name: PHYS_GOOD_NOTES
Section in *.PPF: [CASH_DISPENSER]
Valid range: 0-9999
Value description: number of notes threshold.
Default value: not configured
This parameter can be used to specify a time frame in seconds at what time a
single dispense operation should return. This configuration secures the
dispense operation where in case, the dispenser has a connection problem, the
application stops dispense retries to avoid long delays of communication
time-outs at this time (application would hang for a while). The maximum
dispense time can differ between each dispenser type (RM2, CRS, NG, V4) and
the number of notes.
Parameter name: MAX_DISPENSE_TIME
Section in *.PPF: [CASH_DISPENSER]
Valid range: n-999
Value description: time in seconds at what time a single dispense operation
should return. The value ’n’ should be greater than the line
communication time-out timer specified in the CSC-W32
layer.
Default value: not configured
Dependency:
If retract recycling is enabled on ProCash/NDC you have to set parameter
SEND_SOL_RETRACT = 1 in CUSTOM.PPF.
This parameter is used to set the low condition of the cassettes. This parameter
has no effect if cassettes with a low switch are installed. This value is just an
initial value that is set during the first application start.
Parameter name: MINIMUMITEMS
Section in *.WN: [CDM30]
Valid range: 0 - 255
Value description: integer value sets the „money low“ limit.
Default value: 50
This WOSA parameter specifies how many bills are allowed to be stored in the
rejected cassette. If the limit has been reached, the WOSA status of the reject
cassette changes to WFS_CDM_STATCUFULL (overfilled).
Parameter name: REJECTCASSFULL
Section in *.WN: [CDM30]
Valid range: 0 - 9999
Value description: specifies how many bills are allowed to be rejected
Default value: 0 - value not checked, rejects allowed up to physical limit
This parameter is used to set the low condition of the cassettes. This parameter
has no effect if cassettes with a low switch are installed. This value is just an
initial value that is set during the first application start.
Parameter name: MINIMUMBILLS
Section in *.WN: [CASH_DISPENSER]
Valid range: 0 - 255
Value description: integer value sets the „money low“ limit.
Default value: 50
This WOSA parameter specifies how many bills are allowed to be stored in the
rejected cassette. If the limit has been reached, the WOSA status of the reject
cassette changes to WFS_CDM_STATCUFULL (overfilled).
Parameter name: REJECTCASSFULL
Section in *.WN: [CASH_DISPENSER]
Valid range: 0 - 9999
Value description: specifies how many bills are allowed to be rejected
Default value: 0 - value not checked, rejects allowed up to physical limit
This parameter specifies how many cash retracts can be performed by the cash
dispenser. If the specified limit has been reached the dispenser will be locked.
Parameter name: MAXRETRACT
Section in *.WN: [CASH_DISPENSER]
Valid range: -1; 0 - 99
Value description: -1 sets defined number of retracts (hardware
dependent). The money of the second retract
remain on the stacker. On ProCash Compact
ATM’s without a retract tray the number of
allowed retracts is one. The money remains on
the stacker area and has to be removed manually
by the operator.
0 no retract operations
1 - 99 number of retracts allowed
Default value: -1
This parameter is just an initial value after installation for the first
time when the application will be started and the WOSA data file
C:\WOSASSP\CONF\CASSDATA.BIN does not exist.
NOTE: After installation the change of this value is only allowed
via SOP function.
[COIN_DISPENSER]
This parameter specifies the maximum number of coin hoppers available for the
application to use, when the host requests for a coin dispense.
Parameter name: NUM_LOG_HOPPERS
Section in *.PPF: [COIN_DISPENSER]
Valid range: 0-4 (for NDC); 0-8 (for DDC)
Value description: integer value sets the number of logical coin hoppers.
Default value: 0
This parameter can be used to set specific conditions how the coin dispense
should be performed if a coin dispense is requested by the host.
Parameter name: DISPENSE_FLAGS
Section in *.PPF: [COIN_DISPENSER]
Valid range: 0-7
Value description: 0 - no option set
1 - always try to dispense coins even if only partial dispense
is possible
2 - Dispense from coin hoppers with status LOW.
4 - Dispense from coin hoppers where the minimum coin
threshold is not specified. This threshold can be
configured via XFS parameter MINIMUMITEMS of
section COUT30 in CUSTOM.WN
The values are optional bits and can be set in any combination as required
Default value: 2 - Dispense from coin hoppers with status LOW
This parameter can be used to configure how many logical coin hopper types
should be reported to the host. In the standard protocol definition of NDC and
DDC only 4 different logical hopper types are allowed to be reported. If the host
is able to handle more than 4 logical types, this parameter can be used to report
up to 8 different hopper types.
Parameter name: NUM_HOST_HOPPERS
Section in *.PPF: [COIN_DISPENSER]
Valid range: 4 or up to 8 if the NDC or DDC protocol has been extended
on the host side.
Value description: integer value sets the number of logical coin hoppers.
Default value: not configured (use 4 by default)
[DEPOSIT]
1 "" Envelope is dispensed asynchronously during processing the "C" state, no specifc
screen is displayed but state flow continues.
1 HOST Envelope is dispensed during processing the "C" state but state flow continues and
screen of host reply function will be displayed if the envelope was not already taken.
1 nnn Envelope is dispensed during processing the "C" state, but state flow continues.
Displays a specific screen "nnn" in deposit reply function if the envelope was not
already taken by the customer.
2 "" Envelope is dispensed asynchronously during processing the "C" state, no specifc
screen is displayed but state flow continues (behaviour as option 1).
2 HOST Envelope is dispensed during processing the "C" state but state flow continues and
screen of host reply function is displayed (behaviour as option 1).
2 nnn Envelope is dispensed during processing the "C" state, displays specific screen
"nnn" and waits until the envelope has been taken during processing the "C" state.
State flow continues when the envelope has been taken or captured after timeout.
3 --- Envelopes will not be dispensed and no screen is displayed
This parameter can be used to enable displaying a specific screen while the
consumer is waiting for an envelope.
Parameter name: DISPENSE_WAIT_SCREEN
Section in *.PPF: [DEPOSIT]
Valid range: "", 010 - 999
Value description: specifies the screen number of the screen that should be
displayed during an envelope dispense.
Default value: not configured
This parameter can be set so that a deposit transaction can be canceled within
the envelope dispense.
Parameter name: CANCEL_ACTIVE
Section in *.PPF: [DEPOSIT]
Valid range: 0, 1
Value description: 0 - no, deposit transaction cannot be canceled
1 - yes, deposit transaction can be canceled
Default value: 1
This WOSA parameter can be used to control when the Envelope Entry job
should be returned. If the parameter is enabled the Entry job returns
immediately when the envelope has been inserted. If the parameter is disabled,
the Entry job returns when the envelope was fully transported into the safe. The
activation of this parameter speeds up the transaction time of envelope deposits
up to approx. 4 seconds.
Parameter names: ENTRYSPLIT
Section in *.PPF: [DEP]
Valid range: 0, 1
Value description: 0 - no entry splitting, job returns when envelope is in safe
1 - entry splitting enabled, job returns immediately when the
envelope has been inserted.
Default value: 0 - no entry splitting
[CARD_READER]
The following parameters are used to set which ID card tracks should be pre-
read after the card has been inserted independent of settings defined in the
Card Read State (A or T).
Parameter names: DEFAULT_READ_TRACK1
DEFAULT_READ_TRACK2
DEFAULT_READ_TRACK3
The following parameter can be used to force reading the chip data in any case
before reading the ID card tracks (if needed to read).
Parameter name: DEFAULT_READ_CHIP
Section in *.PPF: [CARD_READER]
Valid range: 0-2
Value description: 0 - read chip data only if specified in the read conditions of
the Card Read State.
1 - after card insertion read chip data in any case.
(not supported for NCR smart DIP readers)
2 - contact chip, but do not read magnetic track data on
insertion.
Default values: not configured - read chip data only if specified in the
read conditions of the Card Read State.
This parameter is used to set the time after which the card is briefly moved back
and forth to get the consumer attention. This occurs while the card eject timer
is running (card is returned to the customer). For the activation of wake up, the
time range should be within the time of the card eject timeout timer. If you set a
higher value, the wake up procedure is switched off.
Parameter name: EJECT_IN_OUT_TIMER
Section in *.PPF: [CARD_READER]
Valid range: 0, -999 - 9999
Value description: zero value - wake up after half eject time
positive values - time after eject timer start
negative values - time before eject timer end
Default value: 0
For DIP readers this wake up function has to be switched off (value
9999), because insert/eject operations with a remaining card in a DIP
reader will cause undefined error situations
This parameter is used to specify a screen to be displayed when the card has
not been removed during the previous transaction. Here you can configure a
screen that can be displayed after the close state. This screen is displayed as
long as the card is still in the DIP reader.
Parameter name: IDLE_REMOVE_SCREEN
Section in *.PPF: [CARD_READER]
Valid range: 010 - 999
Value description: screen number of screen to be displayed
Default value: "" - no separate screen is not displayed
The following (WOSA) parameter is used to specify if the tracks should be read
during card insertion or card removal. This parameter is useful to set especially
for SWIPE card readers(ID24), to minimize read errors. For motorized readers
this parameter must be always zero.
Parameter name: WAITFORREMOVE
Section in *.PPF: [CARD_READER]
Valid range: 0, 1
Value description: 0 - tracks are read during insert (motorized readers)
1 - tracks are read during removal (SWIPE readers)
This parameter can be used to set a threshold how often the application should
call a card reader reset command to move an ID card or/and repair the card
reader device before the application goes out of service.
Parameter name: MANIP_THRESHOLD
Section in *.PPF: [CARD_READER]
Valid range: 0-99
Value description: 0 - application goes immediately OOS if the card reader is
not operational.
>0 - sets the number of reset retries before the application
goes OOS
Default: 0 - not configured
This parameter is required for DIP readers with chip card capability. It configures
a screen that is shown when a latched DIP card could not be contacted and is
now unlatched so that the track data is read on card removal. It must be set on
Wincor systems when XFS parameter USELATCH is set to 2.
Parameter name: DIP_EJECT_SCREEN
Section in *.PPF: [CARD_READER]
Valid range: three digit screen number
Value description: specifies the screen that is displayed in the described
situation
Default: "" - not configured
[BARCODE]
The following parameters are used to set up the barcode reader.
The following parameter configures the barcode types that should be accepted
by the barcode reader.
Parameter name: ACCEPT_CODE_FORMAT
Section in *.PPF: [BARCODE]
Valid range: comma separated list; Syntax: n1,n2,n3,n4,..
Each value in the list indicates the type of barcode that
should be accepted by the barcode reader.
Value description:
1 - EAN 128
2 - EAN-8/13
3 - JAN-8/13
4 - EAN-8/13 with 2 digit add-on
5 - EAN-8/13 with 5 digit add-on
6 - UPC-A/E
7 - UPC-A/E with 2 digit add-on
8 - UPC-A/E with 5 digit add-on
9 - NW-7 (CODABAR)
10 - Interleaved 2 of 5 (ITF)
11 - CODE 11 (USD-8)
12 - CODE 39
13 - CODE 49 (NS with BR02)
14 - CODE 93
15 - MSI/PLESSEY (NS with BR02)
16 - STANDARD 2 of 5 (NS with BR02)
17 - INDUSTRIAL 2 of 5 (NS with BR02)
18 - POSNET (NS with BR02)
19 - PDF-417 (NS with BR02)
20 - DATAMATRIX (NS with BR02)
21 - MAXICODE (NS with BR02)
22 - CODE ONE (NS with BR02)
23 - CHANNEL CODE (NS with BR02)
[OPERATOR_SCREENS]
If the parameter(s) does/do not exist in the registry, the default setting
is CPI15 and LPI6. If the parameter(s) is/are empty the last actual
setting is used.
[JOURNALPRINTER]
This parameter is used to set the journal output on paper of the journal printer.
This parameter has to be set to zero if no journal printer is physically connected
and not configured in the registry.
Parameter name: PAPER_JOURNAL
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0, 1
Value description: 0 - Printing on journal printer disabled
1 - Printing on journal printer enabled
Default value: 1 - Printing on journal printer enabled
This parameter is used to set the CPI size for the journal printer.
Parameter name: CPI
Section in *.PPF: [JOURNALPRINTER]
Valid range: 8, 10, 12, 15, 17, 25
Value description: integer value sets number of characters per inch
Default value: 15
This parameter is used to set the LPI size for the journal printer.
Parameter name: LPI
Section in *.PPF: [JOURNALPRINTER]
Valid range: 6, 8, 10
Value description: integer value sets number of lines per inch
Default value: 6
Double Width
This parameter is used to specify if the printer should print the characters in
double width by default.
Parameter names: DOUBLE_WIDTH
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0, 1
Value description: 0 - Double Width off, 1 - Double width on
Condensed Print
This parameter is used to specify if the printer should print the characters in
condensed mode by default.
Parameter names: CONDENSED
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0, 1
Value description: 0 - Condensed off, 1 - Condensed on
Electronic journal
This parameter is used to set the electronic journal log destination for host print
data. Depending on the setting of the parameters TOP_JOURNAL_PATH and
CUST_JOURNAL_PATH in section [ELECTRONIC_JOURNAL], the host print
data can be stored optional into the journal files of the specified path locations.
Parameter name: ELECTRONIC_JOURNAL
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0-3
Value description: 0 - no logging of host print data
1 - log host print data to TOPMSG destination
2 - log host print data to CUSTMSG destination
3 - log host print data to both destinations
This parameter can be used if the host should receive the original journal printer
error in the unsolicited status message instead of spooler active message
(StClass: 6434, Stcode: 000E).
Parameter name: SEND_SPOOLER_ERROR
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0, 1
Value description: 0 - send original journal printer error message
1 - send spooler active message
This parameter can be set if the host should receive the original hardware and
supply status of the journal printer when the journal spooler is configured. If this
parameter is NOT configured or the value is ZERO, the journal printer severity
never reaches fatal (4) and the supply status never is set to empty (3), thus the
journal printer is out of paper or/and not operational. This behavior can prevent
that the host takes the ATM out of service.
Parameter name: SPOOLER_KEEP_PRINTER_STATUS
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0, 1
Value description: 0 - The printer highest severity condition is WARNING (2)
and highest supply condition is LOW (2).
1 - use original journal printer severity and supply status.
Fall down to FATAL (4) and supply OUT (3)
Example:
Assume ESC%850 is included in the host print data for the journal printer.
If you specify CP_JOURNAL_FONT_TYPE_850 = "2", all font parameters in
the JOURNAL_FONT_XXX section are selected where parameter setting
JOURNAL_FONT_TYPE = "2" is found.
This parameter can be used to specify if the journal print data sent from host
should be printed immediately after the host reply has been received before any
function ID has been processed.
Parameter name: PRINT_JOURNAL_ALWAYS
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0, 1
Value description: 0 - print journal host data through function ID
1 - print journal host data prior function ID’s
Default value: not configured, print journal host data through function ID.
This parameter specifies the hard disk low threshold. If lesser bytes on hard disk
are available as it is specified via this parameter, the terminal sends an
unsolicited warning (CCERRMAP: 6434\0043_WARNING) message to the host
after each consumer transaction. If lesser than 1MB is available on hard disk,
the terminal sends an unsolicited error (CCERRMAP: 6434\0043_ERROR)
message to the host. In this case the host should take the terminal out of
service.
Parameter name: HDD_SPACE_LOW_LIMIT
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0 - 4000 (MB)
Value description: hard disk free space low threshold.
If the value is zero, the hard disk space is not checked.
Default value: not configured, hard disk free space is not checked.
This parameter specifys the filename where all the electronic journal data are
stored, which can be sent up to the host via Electronic Journal Upload in NDC
or sent up to the host through Store And Forward message sequences in DDC
Parameter name: EJU_SAF_FILE_NAME
Section in *.PPF: [JOURNALPRINTER]
Valid range: file path
Value description: specifies the path and filename for EJU or SAF.
This parameter specifys the maximum file size (in kilobytes) of the EJU or SAF
share mapping file.
Parameter name: EJU_SAF_MAX_FILE_SIZE
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0 - 99999
Value description: specifies the file size in kilobytes plus additional 5 KB
header size.
Default value: not configured - size 0, EJU or SAF disabled
This parameter can be used to configure the EJU journal log format in NCR
compatible mode. If this parameter is enabled specific control sequences like
SO and LF or converted in the same way how the original NCR system it does.
Parameter name: EJU_CONVERT_HOST_DATA
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0, 1
Value description: 0 - NCR conversion off (default)
1 - NCR conversion on
Default value: not configured
[ELECTRONIC_JOURNAL]
These two parameters are used to specify the journal file creation cycle for the
TOPMSG and CUSTMSG journal files. It specifies for how many days a new
journal file should be new created. (Note: These parameters replace PPF
parameter MAX_JOURNAL_FILES (registry parameter MAX_JFILES)).
Parameter names: TOP_MAX_FILES
CUST_MAX_FILES
Section in *.PPF: [ELECTRONIC_JOURNAL]
Valid range: 0 - 549 (maximum 1.5 years)
Value description: number of journal files to be created
Default value: 10
This parameter can be used to send printer macro sequences to the journal
printer when the journal printer framework sends a reset command to the
printer. This is useful if the printer is loosing the default settings after reenabling
the journal printer during hardware error conditions.
Parameter name: SPOOLER_RESET
Section in *.PPF: [ELECTRONIC_JOURNAL]
Valid range: ASCII character string (max. 255 characters)
Value description: The string can contain valid printer macros or single
ASCII characters in range 20H - 7FH.
Default value: ""
The following example entry initialize the journal printer with CPI15 and LPI8
during a printer reset initiated by the journal spooler framework.
Example:
SPOOLER_RESET = "#CPI15##LPI8#"
This parameter specifies in which time cycle the spooler checks the spooler file
contents that should be printed out to the journal printer.
Parameter name: SPOOLER_PRINT_CACHE_TIMER
Section in *.PPF: [ELECTRONIC_JOURNAL]
Valid range: 0 - 255 seconds
Value description: time in what cycle the spooler checks if spooler data exist
Default value: 2
This parameter specifies the number of print jobs be collected before the
Journal Spooler starts printing.
Parameter name: SPOOLER_PRINT_CACHE_THRESHOLD
Section in *.PPF: [ELECTRONIC_JOURNAL]
Valid range: 0 - 255 seconds
Value description: number of collected print jobs before the spooler starts
printing
Default value: 10
This parameter can be used to encrease or decrease the maximum spool file
size in kilobytes.
Parameter name: SPOOLER_MAX_SPOOL_FILE
Section in *.PPF: [ELECTRONIC_JOURNAL]
Valid range: 0 - 9999 (kilobytes)
Value description: spool file size in kilobytes
Default value: not configured - size of 2000 kilobytes is used
[RECEIPTPRINTER]
This parameter is used to set the CPI size for the receipt printer.
Parameter name: CPI
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 8, 10, 12, 15, 17, 25
Value description: integer value sets number of characters per inch
Default value: 15
This parameter is used to set the LPI size for the receipt printer.
Parameter name: LPI
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 6, 8, 10
Value description: integer value sets number of lines per inch
Default value: 6
This parameter is used to specify which character set should be used by default.
Parameter name: USER_CHARSET
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 0, 1
Value description: 0 - standard character set; 1 - user defined character set
Default value: 0
Double Width
This parameter is used to specify if the printer should print the characters in
double width by default.
Parameter names: DOUBLE_WIDTH
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 0, 1
Value description: 0 - Double Width off, 1 - Double width on
Condensed Print
This parameter is used to specify if the printer should print the characters in
condensed mode by default.
Parameter names: CONDENSED
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 0, 1
Value description: 0 - Condensed off, 1 - Condensed on
This parameter can be used to initialise the receipt printer with special settings
via printer macros or text which should be printed at the beginning of the receipt.
Parameter name: RECEIPT_PAGE_HEADER
Section in *.PPF: [RECEIPTPRINTER]
Valid range: ASCII characters in range of 20H - 7FH
Value description: macros and characters can be used as init sequences or to
print header lines in front of the host print data.
Default value: no value
Example:
The following entry sets “Variable Receipt length” (macro #VLM#) and two “Line
Feeds” (macro #LF#) for every receipt.
RECEIPT_PAGE_HEADER = “#VLM##LF##LF#”
This parameter can be used to append local defined printer data inclusive
macros together with the print data that are sent by the host. If parameter
RECEIPT_FOOTER_LINE (see description on the next page) is configured, the
footer data can be placed at a specific line after the host print data.
If RECEIPT_FOOTER_LINE is not configured or zero, the footer will be directly
appended to the host data print raw data stream.
Parameter name: RECEIPT_PAGE_FOOTER
Section in *.PPF: [RECEIPTPRINTER]
Valid range: ASCII characters in range of 20H - 7FH
Value description: appends or inserts print data or macros to the print raw data
stream of host print data.
Default value: not configured
This parameter can be used to define a specific line where the local defined
footer data should be appended after the host print data. If for example the host
print data consists of 15 lines and the parameter is set to 20, the footer will be
appended at the 20th line. If the host print data consists of 25 lines, the footer
will be directly appended after the host print data.
Parameter name: RECEIPT_FOOTER_LINE
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 0 - 999
Value description: specifies the line where the footer will be appended.
Default value: not configured
This parameter is used to set the LED blinking time during the receipt delivery.
Parameter name: LEDTIMER
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 0, 99999
Value description: number of time in milli seconds the guide light is blinking on
receipt eject.
Default value: 5000 - blinking time of 5 seconds
This parameter has to be set if the receipt printer does not support the carriage
return (#CR#) command. Then the R01 line is not correctly mixed together with
the host print line. If this parameter is enabled, the R01 and host print data are
merged together via a software algorithm and not just inserting a #CR# after the
R01 line.
Parameter name: MERGE_R01
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 0, 1
Value description: enables host and R01 data merging via software algorithm.
Default value: not configured
Example:
Assume ESC%850 is included in the host print data for the receipt printer.
If you specify CP_RECEIPT_FONT_TYPE_850 = "2", all font parameters in the RECEIPT_FONT_XXX
section are selected where parameter setting RECEIPT_FONT_TYPE = "2" is found.
This parameter can be used to activate the receipt delivery for every trans-
action reply. This might be useful if a consumer can perform multiple transac-
tions (transaction chaining with Balance enquiry, withdrawal, transfer, deposit),
and the print data of each transaction should be printed on single receipts. The
setting of this parameter is always necessary if no formfeed (FF) is sent for each
transaction reply but single receipts are required.
Parameter name: SINGLE_RECEIPT
Section in *.PPF: [RECEIPTPRINTER]
Valid range: 0, 1
Value description: 0 - do not append formfeed (FF).
1 - append formfeed (FF) to host printer data for each host
reply.
Default value: 0
This parameter can be used to set specific print options in a Rear Balancing
transaction regarding Header/Footer and R00/R01 printing. The options can be
enabled or disabled via setting the bit that is assigned to the requested option.
Parameter name: REAR_BAL_OPTIONS
Section in *.PPF: [RECEIPTPRINTER]
Valid range: Bit order
0x01 - Do not print contents of PAGE_HEADER
0x02 - Do not print contents of PAGE_FOOTER
0x04 - Do not print contents of R00
0x08 - Do not print contents of R01
Value description: The bit options can be set in any combination you like.
Default value: not configured - all options are off
[DOCUMENTPRINTER]
This parameter is used to set the CPI size for the document printer.
Parameter name: CPI
Section in *.PPF: [DOCUMENTPRINTER]
Valid range: 8, 10, 12, 15, 17, 25
Value description: integer value sets number of characters per inch
Default value: 15
This parameter is used to set the LPI size for the document printer.
Parameter name: LPI
Section in *.PPF: [DOCUMENTPRINTER]
Valid range: 6, 8, 10
Value description: integer value sets number of lines per inch
Default value: 6
This parameter is used to specify which character set should be used by default.
Parameter name: USER_CHARSET
Section in *.PPF: [DOCUMENTPRINTER]
Valid range: 0, 1
Value description: 0 - standard character set; 1 - user defined character set
Default value: 0
Double Width
This parameter is used to specify if the printer should print the characters in
double width by default.
Parameter names: DOUBLE_WIDTH
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0, 1
Value description: 0 - Double Width off, 1 - Double width on
Condensed Print
This parameter is used to specify if the printer should print the characters in
condensed mode by default.
Parameter names: CONDENSED
Section in *.PPF: [JOURNALPRINTER]
Valid range: 0, 1
Value description: 0 - Condensed off, 1 - Condensed on
This parameter can be used to initialise the document printer with special
settings via printer macros or text which should be printed at the beginning of
the document.
Parameter name: DOC_PAGE_HEADER
Section in *.PPF: [DOCUMENTPRINTER]
Valid range: ASCII characters in range of 20H - 7FH
Value description: macros and characters can be used as init sequences or to
print header lines in front of the host print data.
Default value: no value
This parameter can be used to insert or append local defined printer data
inclusive macros together with the print data that are sent by the host. If
parameter DOC_FOOTER_LINE (see description) is configured, the footer data
are inserted in the specified line. If DOC_FOOTER_LINE is not configured or
zero, the footer will be appended to the host data print raw data stream.
Parameter name: DOC_PAGE_FOOTER
Section in *.PPF: [DOCUMENTPRINTER]
Valid range: ASCII characters in range of 20H - 7FH
Value description: appends or inserts print data or macros to the print raw data
stream of host print data.
Default value: not configured
This parameter specifies the line position where the footer specified by
DOC_PAGE_FOOTER should be inserted. If the parameter is zero, the footer
data will be appended.
Parameter name: DOC_FOOTER_LINE
Section in *.PPF: [DOCUMENTPRINTER]
Valid range: 0 - 999
Value description: specifies the line where the footer will be inserted.
Default value: not configured
This parameter can be used to set the cancel activation within the document
printing process.
Parameter name: CANCEL_ACTIVE
Section in *.PPF: [DOCUMENTPRINTER]
Valid range: 0 - not active; 1 - cancel active
Value description: currently not used by ProCash/NDC-DDC
Default value: 0
Font type
This parameter is used to specify which NDC or DDC font type should be used
for this font section
Parameter names: JOURNAL_FONT_TYPE
RECEIPT_FONT_TYPE
DOCUMENT_FONT_TYPE
Section in *.PPF: [JOURNAL_FONT_XXX] [1]
[RECEIPT_FONT_XXX]
[DOCUMENT_FONT_XXX]
Valid range: 1, 2, >, ?, 7, B (NDC)
1, A, V, X, S, Y (DDC)
[1] ’XXX’ represents the font section number from 001-006
The following tables show what Font type is used by ProNDC or ProDDC
depending on which character set is selected by the NDC or DDC protocol:
Double Width
This parameter is used to specify if the printer should print the characters in
double width for the selected font.
Parameter names: JOURNAL_DOUBLE_WIDTH
RECEIPT_DOUBLE_WIDTH
DOCUMENT_DOUBLE_WIDTH
Section in *.PPF: [JOURNAL_FONT_XXX] [1]
[RECEIPT_FONT_XXX]
[DOCUMENT_FONT_XXX]
Valid range: 0, 1
Value description: 0 - Double Width off, 1 - Double width on, 2 - unchanged
[1] ’XXX’ represents the font section number from 001-006
Condensed Print
This parameter is used to specify if the printer should print the characters in
condensed mode for the selected font.
Parameter names: JOURNAL_CONDENSED
RECEIPT_CONDENSED
DOCUMENT_CONDENSED
Section in *.PPF: [JOURNAL_FONT_XXX] [1]
[RECEIPT_FONT_XXX]
[DOCUMENT_FONT_XXX]
Valid range: 0, 1
Value description: 0 - Condensed off, 1 - Condensed on, 2 - unchanged
[1] ’XXX’ represents the font section number from 001-006
This parameter is used to specify if the printer should print the characters from
the user defined character set or from the standard character set.
Parameter names: JOURNAL_USER_CHARSET
RECEIPT_USER_CHARSET
DOCUMENT_USER_CHARSET
Section in *.PPF: [JOURNAL_FONT_XXX] [1]
[RECEIPT_FONT_XXX]
[DOCUMENT_FONT_XXX]
Valid range: 0, 1
Value description: 0 - print from standard character set
1 - print from user defined character set
2 - unchanged, stay in current character set
[1] ’XXX’ represents the font section number from 001-006
The following parameter can be used to insert additional macros or/and text in
front of the print data.
Parameter names: JOURNAL_MACRO
RECEIPT_MACRO
DOCUMENT_MACRO
Section in *.PPF: [JOURNAL_FONT_XXX] [1]
[RECEIPT_FONT_XXX]
[DOCUMENT_FONT_XXX]
Valid range: character string or macros (e.g. #LOGO1#)
Value description: Character string that will be inserted in front of the print
data. The character string can be one or multiple macros
or/and additional text.
[1] ’XXX’ represents the font section number from 001-006
This parameter is used to define a printer character table. This character table
can be used to map characters to another hex position of the printer if
neccessary. The mapping position of each character depends on the printer
data from the host.
The printer character table is divided into a low part which contain positions from
000-127 (00H-7FH) and a high part which contains hex positions from 128 - 255
(80H-FFH).
Parameter names: RECEIPT_USER_CHARSET_LOW
JOURNAL_USER_CHARSET_LOW
DOCUMENT_USER_CHARSET_LOW
RECEIPT_USER_CHARSET_HIGH
JOURNAL_USER_CHARSET_HIGH
DOCUMENT_USER_CHARSET_HIGH
[VIEWER_FONT]
Font name
The following parameter is used to specify the NDC or DDC font name which is
used by ProCash/NDC or ProCash/DDC.
Parameter name: NAME
Section in *.PPF: [VIEWER_FONT_XXX] [1]
Valid range: char value eight digits maximum in uppercase letters. This
name has to match exactly with the name specified within
the Windows font file (*.FON).
Value description: NDC or DDC font name
Default values: See table “Default NDC font names” and
table “Default DDC font names”
[1] ’XXX’ represents the section number from 001 - 009.
See default settings of table “Default NDC font names” and table “Default DDC
font names” on the next page.
Font size
The following parameter is used to specify the font size for NDC and DDC fonts
in pixels.
Parameter name: SIZE
Section in *.PPF: [VIEWER_FONT_XXX] [1]
Valid range: See table 18 and table 19 on page 267
Value description: font size in pixels. The value depends on the created font.
The value for fixed size fonts has to match exactly with the
size of the Windows font.
Default values: See table 18 and table 19 on page 268
[1] ’XXX’ represents the section number from 001 - 009.
Font height
The following parameter is used to specify the font size for NDC and DDC in
pixels.
Parameter name: HEIGHT
Section in *.PPF: [VIEWER_FONT_XXX] [1]
Valid range: See table 18 and table 19 on page 268
Value description: font height in pixels. The value depends on the created font.
The value for fixed size fonts has to match exactly with the
size of the Windows font.
Default values: See and on
[1] ’XXX’ represents the section number from 001 - 009.
Table 18: DDC resolution dependent values for "SIZE" and "HEIGHT"
Table 19: NDC resolution dependent values for "SIZE" and "HEIGHT"
The following parameter identifies the NDC or DDC font type. The font identifier
is the specification which type of font is selected in the ’ESC(’ sequence for NDC
or ’ESC’ for DDC.
Parameter name: NDC_FONT
Section in *.PPF: [VIEWER_FONT_XXX] [1]
Valid range: single character
Value description: one character for NDC or two characters for DDC
Default values: See table “Standard NDC and DDC font identifiers”
[1] ’XXX’ represents the section number from 001 - 009.
Refer to section “Font and Graphic utilities” on page 380 for detailed
description CPYNTFNT.EXE.
The following parameters are used to specify the primary and secondary Server
name and Port number. The Server name and Port number has to match with
the settings on the ProAgent Server station. If the primary server cannot pe
reached, the secondary server is taken to establish the connection.
Parameter name: NAME
Sections in *.PPF: [PRIMARYSERVER]
[SECONDARYSERVER]
Valid range: character string (any TCP/IP host name or IP address)
Value description: specifies the ProAgent Server station name (usually the
computer name) or the TCP/IP address of the server.
Default value: ""
The following parameter is used to specify the terminal ID from the ATM. The
terminal name can be any name you like to set. Usually the computer name
should be used. The computer name is default is the parameter value is an
empty string.
Parameter name: TERMINALID
Sections in *.PPF: [PROVIEW_SSTPAGENT]
Valid range: any string without blanks
Value description: This entry is the name which displayed on the ProAgent
Server desktop window if the Agent is connected with the
server.
Default value: ""
To enable clear text messages for the ProAgent Server log window you can
replace journal text variable $DCMC_DEVICE_ERROR$ against
$DCMC_DEVICE_ERROR_INFO$. This variable contains the error message
description specified in parameter INFO of the CCERRMAP table.
EMV parameters
The following sections describe some important parameters that can be set in
configuration file CUSTOM.PPF.
Completion Objects
This parameter specifies the default Data Object list (list of TAGs) to be used in
Solicited Status Message extension, Last Transaction Status Extension and
Logical EMV error messages.
Parameter name: COMPLETION_OBJECTS
Sections in *.PPF: [LYNXCI_EMV]
Valid range: ASCII character string (max. 64)
Value description: list of TAGs to be sent
Default value: 9F27959B9F06
Contact Threshold
This parameter specifies after how many failed contact attempts an unsolicited
error message should be sent up to the network.
Parameter name: CONTACT_THRESHOLD
Sections in *.PPF: [LYNXCI_EMV]
Valid range: 0 - 99
Value description: number of chip contact attempts
Default value: 9
Language support
The following parameter can be used to configure the merchant category, which
classifies the type of business being done by the merchant, represented
according to ISO 8583: 1993 for Card Acceptor. Please refer to the EMV2000
Integrated Circuit Card Specification for Payment Systems Book1-4 for detailed
description.
Parameter name: MERCHANT_CATEGORY_CODE_9F15
Sections in *.PPF: [EMV_TAGS]
Valid range: ASCII character string in byte value notation of 2 bytes.
Value description: Two numeric digits with a preceding backslash represents
one byte (example entry: \11\22).
Default value: not configured
The following parameter is used to specify the country code, which indicates the
country of the terminal, represented according to ISO 3166. Please refer to the
EMV2000 Integrated Circuit Card Specification for Payment Systems Book1-4 for
detailed description.
Parameter name: TERMINAL_COUNTRY_CODE_9F1A
Sections in *.PPF: [EMV_TAGS]
Valid range: ASCII character string in byte value notation of 2 bytes.
Value description: Two numeric digits with a preceding backslash represents
one byte (example entry: \11\22).
Default value: not configured
The following parameter is used to set the Terminal Type, which indicates the
environment of the terminal, its communications capability, and its operational
control. Please refer to the EMV2000 Integrated Circuit Card Specification for
Payment Systems Book1-4 for detailed description.
Parameter name: TERMINAL_TYPE_9F35
Sections in *.PPF: [EMV_TAGS]
Valid range: ASCII character string in byte value notation of 1 byte.
Value description: Two numeric digits with a preceding backslash represents
one byte (example entry: \11).
Default value: not configured in CUSTOM.PPF, but set to default value
\14 in registry during installation.
The following parameter specifys how many physical cassettes names are
reported by the NCR or Diebold WOSA.
Parameter name: NUM_PHYS_NAMES
Section in *.NCR: [CASH_DISPENSER]
Section in *.DIB:
Valid range: 0 - 16
Value description: specifies the number of physical units provided by the NCR
or Diebold WOSA.
Default value: set to 4 on NCR or Diebold systems
The following parameters specify the physical names of the cassette units that
are reported from NCR or Diebold WOSA.
Parameter name: PHYS_NAME_X [1]
Section in *.NCR: [CASH_DISPENSER]
Section in *.DIB:
Valid range: ASCII character string
Value description: physical cassette unit name
Default NCR: PHYS_NAME_1 = Unit 1 (top)
PHYS_NAME_2 = Unit 2 (next to top)
PHYS_NAME_3 = Unit 3 (next to bottom)
PHYS_NAME_4 = Unit 4 (bottom)
The following parameter is required on NCR systems. This parameter sets the
number of maximum rejected notes in the cash unit structure. By default NCR
Wosa returns a zero value in the cash unit structure for the maximum rejected
notes. This has the effect that the application reports always an overfilled status
for the reject cassette because the current rejected notes counter is equal or
higher than the maximum rejected notes counter. This parameter will be
configured by default on DIEBOLD systems as well.
Parameter name: MAX_REJECT_NOTES
Section in *.NCR: [CASH_DISPENSER]
Section in *.DIB:
Valid range: 0 - 999
Value description: specifies the limit of maximum number of rejected notes.
Default value: 300
The following parameter is required on NCR systems. This parameter sets the
number of maximum allowed retract operations in the cash unit structure. By
default NCR Wosa returns a zero value in the cash unit structure for the
maximum allowed retracted notes. This has the effect that the application never
performs a cash retract operation, because for a ProCash/NDC or
ProCash/DDC application a zero value means retract inhibit.
Parameter name: MAX_RETRACT
Section in *.NCR: [CASH_DISPENSER]
Section in *.DIB:
Valid range: 0 - 99
Value description: specifies the maximum allowed retracts.
Default value: 99
This parameter can be used to devide the logical number of notes remaining in
cassette equally to all existing physical cassettes units of the same
denomination. This parameter can be used only if parameter PHYS_NAME_X
is configured.
Parameter name: EQUAL_PHYS_CASS_COUNTERS
Sections in *.NCR: [CASH_DISPENSER]
Section in *.DIB:
Valid range: 0, 1
Value description: 0 - logical number of remaining notes not devided
1 - devide logical number of remaining notes
Default value: not configured
Parameter Management
The fourth pop up window is a PARAC error window with an example error
return code. All finish pop up windows with return codes other than 0 or 7 come
up with a second line in red color as a short description of the error. (The only
exception is return code 7. This is only a warning: Missing parameter restored).
After J/Install installation the sub folders like \BAS, \BATCH, etc. located
in "C:\PROTOPAS\CONF" will not be used any more during the runtime.
ProCash/NDC parameters
The following table gives a short description about the configuration files and
batch routines that are compressed in file update.z on the Update Disk:
ProCash/DDC parameters
The following table gives a short description about the configuration files and
batch routines that are compressed in file update.z from the Update Disk:
PARAMETER DESCRIPTION
[CLASS\643A\0002_ERROR] CSC-W32 or LYNX Error class and error code section
TD_STATUS [1] Transaction Device status (see underlined Note)
SEVERITY [1] Error Severity
[1]
M_STATUS Maintenance Status
M_DATA [1] Maintenance Data (see section “Variables in M-Data status
field” on page 312)
REBOOT Reboot flag. System reboots if this error occurs and flag is 1
SYSMSG_NUMBER See section [TOPMSG] in CUSTOM.PPF for definition
DDC_STATUS [2] Diebold 911 or 912 status code
DDC_MDS_STATUS [2] Diebold MDS i series status (see section “Variables in MDS i
series status:” on page 311
INFO Error short description. This description can be journaled
(TOPMSG) via variable $DCMC_DEVICE_ERROR_INFO$
For cash dispenser errors (only) you can define multiple Error Reasons for the
DDC911/912 status and DDC MDS i series status. The background why
multiple error reason configuration for some errors is neccessary can be
declared as follows:
In some cash dispenser error situations just the pure controller status will be
sent up via an error event to the application without logic in what function the
error has occurred. So, there could be situations where the same CSC-W32
error is sent up after a:
1. General dispense error (first entry)
2. Cassette pick failure (second entry)
3. Money present function with consumer access (third entry)
4. Money present function without consumer access (fourth entry)
That means for the ProCash/DDC application, that for the same CSC-W32 error
4 different DDC911/912 and DDC MDS i series status codes needs to be
configured. This parameterisation is optionally and can be used for those errors
where it is required.
Example: Assume you need to configure for CSC-W32 extended error
001D\1028 multiple 911/912 and MDS status codes.
The entries can be set as follows:
DDC_STATUS = "?3002,?0B75,@04,@00"
DDC_MDS_STATUS = "000DI01:3F:00:01,000DI01:3F:31p37,
000DR01:3A:41:40,000DR01:3A:37:41"
This section describes the variable that can be set if the specific DDC912 error
code is cassette specific. The variable set in parameter DDC_STATUS is
replaced by ProCash/DDC at runtime.
The following parameter value contains the specific error code ’B7’, which is
replaced to the number that represents the physical cassette position.
DDC_STATUS = "?0B75"
If for example the third cassette gets an error during a dispense, ProCash/DDC
replaces the B7 to 19. The DDC912 error code ?0195 is sent to the host.
This section describes the field variables of parameter M_DATA, which are
replaced by ProCash/NDC during runtime. See the following figure for the
meaning of the variables:
M_DATA = "XXCCPPPPPPPPXXXXXXXXXXXXXXXXXX"
"PP" can be replaced with the pick error code for all four cassette
types. Depending on which position the error occurs only the error
code of one cassette type will be sent to the network. All other fields
are set to zero.
The following table illustrates which CSC-W32 and XFS error classes are
currently assigned to the internal generated device class.
Some error events generated from the XFS30 layer, especially from the cash
dispenser and cash recycler service, are necessarily remapped internally to an
existing CSC-W32 StClass and StCode by the Device Status framework
(dcDevSta.dll).
The following table illustrates which XFS30 classes and error codes are
currently remapped.
Error Suppression
During the runtime ist can happen that one of the application level generates
error codes which have no influence to the device operation. Those errors are
just non relevant warnings. To prevent confusions by the service operators the
Device Status Framework (dcDevSta.dll) ignors error A200 (Software Error) of
class 0018 (class Cash Dispenser).
Furthermore for specific errors you can configure in CCERRMAP.INA to
suppress sending a message to the host and displaying the error on the SOP
panel if you set parameter SEVERITY = "0" and TD_STATUS = "0".
For ProCash/DDC you can suppress sending an error to the host if you set
parameter DDC_STATUS = "" (as empty value) in the requested error section.
To set the hardware configuration for Diebold 911 mode you have to set the
following parameters in ’CUSTOM.PPF’:
Section in *.PPF: [PROTOCOL\DDC\T2HHWConfigurationStatus]
Parameters: PREP_FIELD_22 = PREP_FIXED,0C
NUM_FIELDS = 27
The cash dispenser configuration for Diebold 911 mode can be done via the
installation dialog or the direct setting in ’CUSTOM.PPF’. For 911 mode there
are only two denominations possible (HI and LO indication). Therefore you have
to set following parameters:
Section in *.PPF: [CASH_DISPENSER]
Parameters: NUM_LOG_CASS = 2
CURRENCY_1 = "USD"
VALUE_1 = 10
CURRENCY_2 = "USD"
VALUE_2 = 20
[Wincor Nixdorf\ProTopas\CurrentVersion\CCOPEN\JOURNAL]
[Wincor Nixdorf\ProTopas\CurrentVersion\CCOPEN\RECEIPT]
Macro activation
Parameter name: MACRO_TABLE_ACTIVE
Value Range: 0, 1
Value description: Activates or deactivates the user defined macro
table.
Default value: 0
Macro interpretation
Parameter name: HALF_DOUBLE_NUMBER_SIGNS
Value Range: 0, 1
Value description: 0 - two ## are reduced to one # or #MACRO# is
interpreted as a macro;
1 - two ## characters are printed has normal
characters and will not be interpreted as a macro.
This parameter usually has to be enabled if the Protopas environment is running
on an NCR or Diebold ATM where no CSCW32 application is installed.
Default value: 0
Printer INIT
Parameter name: INIT
Value Range: any legal macro name
Value description: This parameter can be used to send additional
macro sequences to the printer during printer
initialisation in the startup phase.
Default value: ""
Example:
If you like to enable variable receipt length and no black dot mark recognition
for the Receipt printer, you have to set the following:
[Wincor Nixdorf\ProTopas\CurrentVersion\CCOPEN\RECEIPT]
INIT = #VLM##MRKC#
The user defined macros for each printer type has to be defined in the sub
section that is defined via parameter "MACRO_TABLE".
Example:
If you like to set a specific initialisation sequence for the ND9A or ND9E, the
entries could be the following:
[Wincor Nixdorf\ProTopas\
CurrentVersion\CCOPEN\CCPRTFW\RECEIPT_MACROS]
USERINIT = "1b2b011b5834001b76"
If you have wrongly enabled the Triple DES configuration environment, and you
want to switch back to the single DES configuration, you have to do the
parameterisation manually.
Following steps have to be performed (application has to be killed):
Call "InitEpp.EXE" with options -D -E (locationC:\PROTOPAS\TOOLS).
This tool deletes all keys (single and triple DES keys) from the EPP.
Set parameter DOUBLE_LENGTH_KEYS to "0" in "CUSTOM.PPF".
Call PARAC.EXE (can be done via Configuration Manager)
Copy "Epp1Des.INI" to "Epp.INI" (overwrite old file if exists)
Start application
Enter keys via ProTopas/SOP-NDC, ProTopas/SOP-DDC
If you like to set the single or triple DES configuration via SOP, you can set up
the file SOPCOPY.TXT where executables and batch commands can be
integrated. Refer to section ”Software updates via SOP” on page 343.
Automatic Installation
GDI Windows printer can be automatically installed via J/Install installation. For
printers, which can operate as GDI Windows printer or in raw print mode (see
table), you have to specify the GDI mode in configuration file CUSTOM.CUS.
Refer to section ”GDI Windows name for receipt printer” on page 263 and
section ”GDI Windows name for document printer” on page 263 for detailed
description how to enable GDI windows printer. Pure GDI printer like ND9G are
installed automatically as a Windows printer.
A detailed description of GDI operation, GDI print architecture and all possible
configuration parameters are described in ProTopas Module Construction Kit
Programming Guide Version 4.2/xx.
The document is stored as file name ProTopas_Modul Construction Kit.pdf
in folder \DOC\ProTopas\Kit\V4201 on Install CD NDC/DDC V2.1/10.
..\Wincor Nixdorf\ProTopas\Currentversion\LYNXCI\SCREEN\XXX]
where the parameters can be configured for each single screen.
XXX = represents the screen number subsection.
IDLE_ENTER allows to start the card less transaction via pressing the Enter KEY
IDLE_CANCEL allows to start the card less transaction via pressing the Cancel KEY
IDLE_TIMEOUT specifies the TIMEOUT and the TIMEOUT NEXT STATE
IDLE_A allows to start the card less transaction via pressing the A KEY
IDLE_B allows to start the card less transaction via pressing the B KEY
IDLE_C allows to start the card less transaction via pressing the C KEY
IDLE_D allows to start the card less transaction via pressing the D KEY
IDLE_F allows to start the card less transaction via pressing the F KEY
IDLE_G allows to start the card less transaction via pressing the G KEY
IDLE_H allows to start the card less transaction via pressing the H KEY
IDLE_I allows to start the card less transaction via pressing the I KEY
Parameter fields
The parameters in table “Card less transaction parameters” on page 325 except
the parameter IDLE_TIMEOUT (see description in section ”Timeout parameter” on
page 327), use following parameter values:
Timeout parameter
These parameters specify the parameter values for the timeout handling how long
this card less transaction should be taken.
Example:
IDLE_TIMEOUT = "30,555"
The following parameter can be used to define a specific screen and next state
number to force control of the screen that should be displayed and the next state
number in the case a card is inserted and the consumer has pressed an FDK at the
same time.
Parameter name: CARDLESS_PARALLEL_FDK_CARD_EXIT
Section in Registry: ..\LYXPAR\APPLICATION
or ..\LYNXCI\SCREEN\xxx
Valid range: "sss,eee"
Value description: sss = Screen to display
eee = Next state exit
Dependent parameters
The following parameters are required to assign the key code 5 for the left side
key from the ’0’ key. Usually on Wincor Nixdorf systems for this key the decimal
key code is assigned be default. Please refer to the vendor specific
documentation how to assign key codes to EPP keys.
Parameter name: PINKEY_11
Registry Key: [HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\WOSAKEYS\ASC_KEY]
Valid range: numeric values
Value description: specifies the key code for the left side key
Default value: “” - not configured
Example value: 5
The following parameters specify the character sequences for the keys
0 - 9 on the EPP:
"ALPHA_0_SEQ"="0_+-"
"ALPHA_1_SEQ"="1QZ"
"ALPHA_2_SEQ"="2ABC"
"ALPHA_3_SEQ"="3DEF"
"ALPHA_4_SEQ"="4GHI"
"ALPHA_5_SEQ"="5JKL"
"ALPHA_6_SEQ"="6MNO"
"ALPHA_7_SEQ"="7PRS"
"ALPHA_8_SEQ"="8TUV"
"ALPHA_9_SEQ"="9WXY"
Value description: specifies for which state the input timer restart handling is
enabled.
Default value: 15 - input restart enabled for all states
Protocol Type
The following parameter specifies the path and filename of the protocol type
specific framework that should be used by the dial up communication.
Parameter name: COMPROT1_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\ProtVisa.DLL”
The following parameter specifies the path and filename of the framework that
communicates with the modem interface.
Parameter name: COM50_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\ComModem.DLL”
The following parameter specifies the path and filename of the framework that
communicates with the serial interface protocol.
Parameter name: COM51_FRAME
Section in *.PPF: [STARTUP]
Valid range: character string (path)
Value description: path location
Default value: “C:\PROTOPAS\BIN\ComSerial.DLL”
The following parameter specifies the path and filename of the communication
yield framework.
Parameter names: COM52_FRAME
COM53_FRAME
COM54_FRAME
The following parameter contains the Restart Manager command line with
frameworks that are needed to be loaded to enable the dial up environment.
Parameter name: DIAL_UP
Section in *.PPF: [STARTUP]
Valid range: Parameter,Parameter,Parameter,...,...,...
Value description: Each Parameter contains a program with execution
parameters which are loaded in the specified order from left
to right.
Default value: “C:\PROTOPAS\BIN\FwLoadPm.EXE,4,1,21,,,
CCCommProtocol1 CCCommunication50
CCCommunication51 CCCommunication52
CCCommunication53 CCCommunication54"
Project settings
COM channel
Protocol channel
Protocol type
Route ID
Terminal ID
$UPDATE$.Z
The compressed file $UPDATE$.Z can be created with ICOMP.EXE. You need
to call ICOMP.EXE with option "subdirectories included". The modules have to
be compressed in the same directory structure as on the harddrive.
CUSTOM.PPF
The configuration file CUSTOM.PPF can be created or modified with PCedt.exe
$UPDATE$.REG
WINNT Registry configuration file, called via REGEDIT -S in "startupappl.bat".
To the example above the diskette consists of following files:
SOPCOPY.TXT
$UPDATE$.Z
CUSTOM.PPF
$UPDATE$.REG
The automatic PARAC call, the call of REGEDIT and the extraction routine are
defined in batch file STARTUPAPPL.BAT located in \PROTOPAS\BIN folder.
The second option to start the application manually is using the batch file
"FWSTRT.BAT" located in C:\PROTAPAS. FWSTRT.BAT contains just the
application start routines without any preceding application update steps.
The following table lists ProTopas return codes from the Cash Dispenser device
Framework which are mapped to the hexadecimal error codes assigned to class
643A.
HW_CONF_35_RESERVED HW_CONF_35_RESERVED
HW_CONF_36_RESERVED HW_CONF_36_RESERVED
HW_CONF_37_RESERVED HW_CONF_37_RESERVED
MESSAGE_LOGGING MESSAGE_LOGGING
SEND_TVN_MAC SEND_TVN_MAC
CHECK_TVN_MAC CHECK_TVN_MAC
SEND_MACHINE_NO SEND_MACHINE_NO
CHECK_MACHINE_NO CHECK_MACHINE_NO
SEND_TVN_MAC_SOL SEND_TVN_MAC_SOL
MAC_FLD_SELECTED MAC_FLD_SELECTED
MAC_ASCII MAC_ASCII
STATUS_CODE_HANDLING STATUS_CODE_HANDLING
GO_OFFLINE_AFTER_TIMEOUT GO_OFFLINE_AFTER_TIMEOUT
DEFAULT_NUM_NOTES_2 DEFAULT_NUM_NOTES_2
DEFAULT_NUM_NOTES_3 DEFAULT_NUM_NOTES_3
DEFAULT_NUM_NOTES_4 DEFAULT_NUM_NOTES_4
DEFAULT_NUM_NOTES_5 DEFAULT_NUM_NOTES_5
DEFAULT_NUM_NOTES_6 DEFAULT_NUM_NOTES_6
DEFAULT_NUM_NOTES_7 DEFAULT_NUM_NOTES_7
DEFAULT_NUM_NOTES_8 DEFAULT_NUM_NOTES_8
AUTO_LOGON_CASSETTES AUTO_LOGON_CASSETTES
AUTO_LOGON_IN_SOP AUTO_LOGON_IN_SOP
AUTO_LOGON_NOTES AUTO_LOGON_NOTES
DENOMINATION_LOW_MSG DENOMINATION_LOW_MSG
CLEAR_MISS_COUNTER CLEAR_MISS_COUNTER
DISPENSE_ALGO DISPENSE_ALGO
SEND_CASSETTE_LOW_ALWAYS SEND_CASSETTE_LOW_ALWAYS
MAX_PRESENT_ERRORS MAX_PRESENT_ERRORS
SEND_SOL_RETRACT SEND_SOL_RETRACT
SOLICITED_IF_RETRACT_INHIBIT SOL_RETRACT_INHIBIT
CAS_WAIT_TIME CAS_WAIT_TIME
FATAL_CASS_AS_MISSING FATAL_CASS_AS_MISSING
DISPENSE_BELOW_ZERO DISPENSE_BELOW_0
LOGICAL_MAPPING LOGICAL_MAPPING
DENOM_ID_UPPERCASE DENOM_ID_UPPERCASE
CHECK_STATUS_AFTER_MONEY_TAKEN CHECK_STATUS_AFTER_MONEY_TAKEN
CASH_RETRACT_SCREEN CASH_RETRACT_SCREEN
PRESENT_FAILURE_SCREEN PRESENT_FAILURE_SCREEN
NUM_PHYS_NAMES NUM_PHYS_NAMES
PHYS_NAME_X PHYS_NAME_X
DISPENSE_RETRIES DISPENSE_RETRIES
PRESENT_TIMER PRESENT_TIMER
MAX_REJECT_NOTES MAX_REJECT_NOTES
REJECT_FATAL_STATUS REJECT_FATAL_STATUS
MV_TESTDISPENSE MV_TESTDISPENSE
EQUAL_PHYS_CASS_COUNTERS EQUAL_PHYS_CASS_COUNTERS
CHECK_FATAL_BEFORE_DISPENSE CHECK_FATAL_BEFORE_DISPENSE
MAX_DISPENSE_ERRORS MAX_DISPENSE_ERRORS
HWERR_DISPENSE_RETRIES HWERR_DISPENSE_RETRIES
EXPONENT_CORRECTION EXPONENT_CORRECTION
DISPLAY_PRESENT_SCREEN DISPLAY_PRESENT_SCREEN
PHYS_GOOD_NOTES PHYS_GOOD_NOTES
MAX_DISPENSE_TIME MAX_DISPENSE_TIME
DO_CIN_RETRACT DO_CIN_RETRACT
XFS20
USER AREA in"CUSTOM.WN" REGISTRY LOCATION
[CASH_DISPENSER] [HKEY_CLASSES_ROOT\WOSA/XFS_ROOT\
PHYSICAL_SERVICES\ATM]
USER NAME REGISTRY PARAMETER
REJECTCASSFULL RejectCassFull
MAXRETRACT MaxRetract
MINIMUMBILLS MinimumBills
XFS30
USER AREA in"CUSTOM.PPF" REGISTRY LOCATION
[CDM30] [HKEY_LOCAL_MACHINE\SOFTWARE\
PHYSICAL_SERVICES\CDM30]
USER NAME REGISTRY PARAMETER
REJECTCASSFULL RejectCassFull
MINIMUMITEMS MinimumItems
ProTopas
USER AREA in"CUSTOM.PPF" REGISTRY LOCATION
[CCCDMFW] [HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
CurrentVersion\CCOPEN\CCCdmFW]
USER NAME REGISTRY PARAMETER
MAXRETRACT MaxRetract
JOURNAL_CHARTABLE_HIGH CHARTABLE_HIGH
JOURNAL_USER_CHARSET USER_CHARSET
JOURNAL_MACRO MACRO
FON2ASC.EXE
Fon2asc.exe is used to extract WINNT font files to ASCII matrix font files.
The ASCII file can be used to modify or enhance characters of a font file via any
standard text editor. The modificated file can be reconverted to the *.FON
format via ASC2FON.EXE.
The ASCII file must have following header parameter:
Font - sets the font name which must match (case sensitive)
with parameter "NAME" of section [VIEWER_FONT_XXX]
Width - sets the character width
Height - sets the character Height.
Character XX - sets the character ASCII position (XX represents the hex
value of the position) and must exist for each defined
character.
Syntax:
FON2ASC fontfile > ASCIIfile
ASC2FON.EXE
Asc2Fon.exe converts ASCII matrix font files to WINNT font files. The file name
of the new font file is the same as the name specified behind the header
parameter ’Font’ of the ASCII file but included with extension *.FON.
Syntax:
ASC2FON ASCIIfile
CPYNTFNT.EXE
Cpyntfnt.exe detects the current Windows display resolution than it copies and
registers fonts of the detected resolution in the Windows environment. Font files
(*.FON) will be automatically copied from directory
C:\PROTOPAS\FONTS\XXX (’XXX’ stands for 640x480, 800x600, 1024x768)
to the \WINNT\FONTS directory. Afterwards they will be automatically
registered for immediate access. Furthermore you can enable copying
resolution dependent Bitmaps or Icons from the C:\PROTOPAS\BITMAPS\XXX
resolution sub folder to C:\PROTOPAS\BITMAPS. The register and copy
processes are protocolled in log file "CPYNTFNT.INF" located in
C:\PROTOPAS. Optionally this tool registers GDI printer fonts that are required
for GDI print operation.
Syntax:
CPYNTFNT [-R] [-B] [-0] [-1] [-2] [-G] [fontfile]
Options:
-R Enables font installation with automatic detection
-B Enables copying Bitmaps or Icons in the selected or detected
resolution.
-G Registers all GDI printer fonts located in
C:\PROTOPAS\FONTS\GDI_PRT
-W Registers all kind of windows fonts located in
C:\PROTOPAS\FONTS\WEB
-F Enables copying resolution depended Bitmaps used by FOnet.
-0 Sets resolution 640x480
-1 Sets resolution 800x600
-2 Sets resolution 1024x768
fontfile Registers a single font in the selected or detected resolution.
ASC2ICN.EXE
Description:
ASC2ICN is used to convert an ASCII icon file into a *.icn file.
Syntax:
ASC2ICN sourcefile [destfile]
ICN2ASC.EXE
Description:
Icn2asc.exe can be used to extract ICN icon files to ASCII matrix files for modifi-
ations.
Syntax:
ICN2ASC.EXE ICNfile > destfile
EXAMPLE:
ICN2ASC.EXE 0000.ICN > 0000.txt
If you change the 'X's of the matrix file to 0 - F (1 digit hex value) you
get the specific color for the modified pixels. See also Table 7-3 Color
table for the color definitions.
ASC2PCC.EXE
Description:
ASC2PCC is used to convert an ASCII icon file into a *.PCC or *.PCX file.
Syntax:
ASC2PCC [-V] [-Wwidth] [-Hheight] [-Ttop] [-Lleft]
sourcefile [destfile]
MFCFONT.EXE
This Utility can be used to create own Windows fonts that can be used for
screen display and GDI printing. Please press F1 button for detailed help
description how to use this tool.
Analyzing utilities
PROTLOG.EXE
ProtLog.exe analyzes the messages of the log file ’CCProt.LOG’ and inserts
structured descriptions of the message types and its fields.
Syntax:
PROTLOG CCProt.LOG > destinationfile
Options:
-D analyzes ProCash/DDC messages (DIEBOLD)
-S extracts messages for simulation
-L extracts download messages only (3...) useful for ndc-sim.dll
Prt-Dof.exe can be used with the dot matrix printers ND71, ND98,
ND9A and the new series printers ND9x, TH21, TH22, TP06, TP07
and TH30 printers.
IMPORTANT NOTE: If the TP07 is installed as a GDI Windows
printer, user defined characters cannot be loaded into TP07.
Syntax:
prt-dof <DEVICE ID> filename.dof [-Z]
Option: -Z This option is needed if you get time-out errors from CSC-W32 because
of large printer data. If this option is in use, the CSC-W32 command
TraPrint is called for each singe line. Without -Z option only one single
TraPrint command is called for the whole contents of the DOF file.
Important Note: You also have to create the DOF file with -Z option
if you use utility ASC-DOF.EXE or ND9C-DOF.EXE.
NOTE: Do NOT use the -Z option for TP06 and TP07.
Structure and description of a download file for needle printers ND71 and ND9x:
First line:
In the first line you must enter the load command ESC &, then set 02 for 2 bytes
(9 needles for each column) The next two digits specify the start position; the
last two digits specify the last character.
For example the entry 4141 means: Load one character to position 41H.
Next lines:
The next lines are the pixel control of each character. You can create 95 user-
defined characters from hex position 20H to 7EH in any style you like.
ND71: Use 9 columns for 10 and 12 cpi; 7 columns for 15 cpi.
ND9x: Use 5 columns for 10, 12 and 25 cpi; 7 columns for 15 cpi.
Note: Thermal printers ND9C, ND99, TP06, TP07, TH21, TH22 and
TH30 need different formats. Those formats are described in
following sections.
The bit matrix of a 9-column character is shown here:
Columns 1 2 3 4 5 6 7 8 9
-------------------------
Needle 1 Byte1 7 0 0 0 0 0 0 0 0 0
Needle 2 Byte1 6 0 0 0 0 0 0 0 0 0
Needle 3 Byte1 5 0 0 0 0 0 0 0 0 0
Needle 4 Byte1 4 0 0 0 0 0 0 0 0 0
Needle 5 Byte1 3 0 0 0 0 0 0 0 0 0
Needle 6 Byte1 2 0 0 0 0 0 0 0 0 0
Needle 7 Byte1 1 0 0 0 0 0 0 0 0 0
Needle 8 Byte1 0 0 0 0 0 0 0 0 0 0
Needle 9 Byte2 7 0 0 0 0 0 0 0 0 0
Example 1:
Creation of the character A with 9 columns:
Columns 1 2 3 4 5 6 7 8 9
-------------------------
Needle 1 Byte1 7 0 0 0 0 1 0 0 0 0
Needle 2 Byte1 6 0 0 0 1 0 1 0 0 0
Needle 3 Byte1 5 0 0 1 0 0 0 1 0 0
Needle 4 Byte1 4 0 1 0 0 0 0 0 1 0
Needle 5 Byte1 3 0 1 0 0 0 0 0 1 0
Needle 6 Byte1 2 0 1 0 1 0 1 0 1 0
Needle 7 Byte1 1 0 1 0 0 0 0 0 1 0
Needle 8 Byte1 0 0 1 0 0 0 0 0 1 0
Needle 9 Byte2 7 0 1 0 0 0 0 0 1 0
When the bits are set in the desired positions, you should count in the following
way. For example in column two byte 1, the bits 0, 1, 2, 3, 4 are set.
Count 1+2+4+8+16 = 31 decimal = 1FH. In byte 2 only bit 7 is used. That means
128 in decimal and 80H. The needle control code is 1F80 for column two.
Two needles may not be set directly after another in the horizontal
line. The printer will, however, correct that itself.
code = set /h before each command line
col = how many columns
1b = byte 1
2b = byte 2
1 2 3 4 5 6 7 8 9
code col 1b2b 1b2b 1b2b 1b2b 1b2b 1b2b 1b2b 1b2b 1b2b
---------------------------------------------------------
/h 09 0000 1f80 2000 4400 8000 4400 2000 1f80 0000
For the ND9x printers the number of columns (col) must be specified
only for the first character.
Example 2:
Creation of the character 'A' with 7 columns:
Columns 1 2 3 4 5 6 7
-------------------
Needle 1 Byte1 7 0 0 0 1 0 0 0
Needle 2 Byte1 6 0 0 1 0 1 0 0
Needle 3 Byte1 5 0 1 0 0 0 1 0
Needle 4 Byte1 4 0 1 0 0 0 1 0
Needle 5 Byte1 3 0 1 0 0 0 1 0
Needle 6 Byte1 2 0 1 0 1 0 1 0
Needle 7 Byte1 1 0 1 0 0 0 1 0
Needle 8 Byte1 0 0 1 0 0 0 1 0
Needle 9 Byte2 7 0 1 0 0 0 1 0
1 2 3 4 5 6 7
code col 1b2b 1b2b 1b2b 1b2b 1b2b 1b2b 1b2b
----------------------------------------------
/h 07 0000 3f80 4000 8400 4000 3f80 0000
ASC2DOF.EXE
Asc2dof.exe converts characters which are created in an ASCII matrix file to the
hexa decimal byte definition of the *.DOF (DownLoadFile) which can be used
to load them with prt-dof.exe. The style of the ASCII files are the same as the
screen font files which are stored in C:\PROTOPAS\TOOLS\FONTS. The only
change is the number of columns and lines (needles) represented in the file as
"Width" and "Height". "Height" is divided in two bytes. The first byte has the
range from line 1-8 and the second byte is the ninth line. This results in Height
9 for a two byte character definition. The needle printer ND71 permits 9 and 7
columns and the printers ND98/ND9A/ND9E permit 5 and 7 columns. This utility
cannot be used for ND9C. See section “Font and Logo tools for printers” on
page 392 for ND9C utilities.
Syntax:
ASC2DOF [-Z] ASCIIfile > DOFfile
Example:
ASC2DOF ND98_7 > ND98_7.DOF
Example:
Creation of character 'A' in 7 and 5 columns:
Structure of the ASCII file with 7 Structure of the ASCII file with 5
columns characters: columns characters:
Font 7 columns Font 5 columns
Width 7 Width 5
Height 9 Height 9
Character 41 Character 41
..X.X.. .XXX.
.X...X. X...X
X.....X X...X
X.....X X...X
X.X.X.X XXXXX
X.....X X...X
X.....X X...X
....... .....
....... .....
DOF2ASC.EXE
Dof2asc.exe can be used to convert hexadecimal font files (*.dof), which are used
to load characters into the printer with utility prt-dof.exe, to an ASCII matrix file.
The matrix file can be edited with any standard editor.
Syntax:
DOF2ASC [-Z] doffile > filename
Example:
DOF2ASC ND9A.DOF > ND9A.ASC
This utility cannot be used for ND9C printer. For the ND9C printer you
have to use dof-nd9c.exe or nd9c-dof.exe. See section “Font and Logo
tools for printers” on page 392.
Font files with extension *.FNT are standard fonts which are loaded
in the standard area of the printer.
Fonts for the userdefined area can be created with the ASCII to DOF
utilities and must be loaded via PRT-DOF.EXE.
The space for Logos and Fonts are limited and can be read from the
test printout of the ND99. If a font or Logo reaches the maximum
space during the load process, it will not be recognised during the
load. But it can be verified after the load if you make a test printout
where you can see how many Fonts and Logos are successfully
loaded.
ND99 logos can be controlled via macros #LOGO1# - #LOGO9#.
User defined Fonts can be activated via macro #CCT#.
Standard Fonts can be set via macro #NCT#.
Options:
-ND99 need to be set for ND99 printer
-ND9X need to be set for ND9C, ND9D, ND9E or TH30 printers
-TP07 need to be set for TP07 receipt printer (non GDI mode)
-TP06 need to be set for TP06 journal printer (requires option -J too)
-L deletes and loads Fonts
-G deletes and loads Logos (not supported for TH30)
-D deletes Fonts only (ND99 only)
-E deletes Logos only (ND99 only)
-J specifies device JOURNAL1
NOTE1: Logo loading via this utility is supported for ND99, ND9C, TP07
and TP06 printer.
NOTE2: For TP07 only option -G (loading a LOGO) is supported. For TP06
only options -G together with -J are supported. As example for a
450 x 100 BMP, the printed size corresponds to 5,5cm * 1cm.
The TP07 and TP06 printers support loading of one Logo only.
Therefore only macros #LOGO# or #LOGO1# are supported for
the logo print.
ND99LOGO.EXE
Nd99logo.exe extracts binary logo files of ND99 into an ASCII matrix file. This text
file can be modified with any standard text editor. This utility is useful to make
modifications for some pixels of an existing logo to obtain a better logo quality.
The typical way to create Logos will be to draw a PCX graphic with a graphic
program. This utility can help you to tune your Logo.
Syntax:
ND99LOGO logofile > filename
ASC2LOGO.EXE
Asc2logo.exe converts ASCII logo files to the binary logo format for ND99
printers. See also utility ND99LOGO.EXE for the structure of the ASCII logo file
format.
Syntax:
ASC2LOGO ASCIIfile logofile
PCX2ASC.EXE
Pcx2asc.exe is used to convert *.pcc or *.pcx files into ASCII matrix files. This
ASCII file can be used as a source file for the conversion of ASC2LOGO.EXE
to a logo file format for the ND99 printer.
Options:
-D On CGF icons double horizontal pixels. On VGA icons
compress every 2 lines (24 -> 12 lines)
-E On CGF icons double lines 5 and 9 (12 -> 14 lines). On VGA
icons do not compress lines 9 and 17 if -D option is set
(24 -> 14 lines)
-Wsize Set horizontal size in characters.
ND99-ASC.EXE
Description:
Nd99-asc.exe extracts characters stored in *.swf format to ASCII format which
can be modified by the customer.
Syntax:
ND99-ASC FONTfile > ASCII file
Example:
ND99-ASC ARIAL10.SWF >ARIAL10
ASC-ND99.EXE
Description:
Asc-nd99.exe converts extracted characters stored in ASCII format back to the
*.swf format which has to be used to download the font to the ND99 printer.
Syntax:
ASC-ND99 ASCIIfile FONTfile
Example:
ASC-ND99 ARIAL10 ARIAL10.SWF
DOF-ND9C.EXE
Description:
Dof-nd9c.exe can be used to convert hexadecimal font files (*.dof) to an ASCII
matrix file. The ASCII matrix file can be edited with any standard text editor.
The ND9C and TH30 printer can load 5 character sizes: 10, 12, 14, 16, 20
with fixed Height = 22 pixels. The TH21 or TH22 needs three sizes: 10, 13, 18
with the fixed Height = 24 pixels.
Syntax:
DOF-ND9C [-Z] FONTfile > ASCIIfile
Example:
DOF-ND9C USR_CPI12.DOF > USR_CPI12.ASC
Example contents of a DOF file (character ’B’) for the ND9C printer:
/h 1c2603424210
/h 10000000c000c0ffffc0ffffc0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0
f3f3c07f3f803f3f000c0c00000000000000000000
If you have a printer that has a firmware version loaded older than
December 1999 the load sequence is /h 1b26 instead of /h 1c26.
DOF-ND9C.EXE supports /h 1b26 and /h 1c26 within a DOF file.
ND9C-DOF.EXE
Description:
Nd9c-dof.exe converts characters from an ASCII matrix file to the hexa decimal
byte definition of the *.DOF (DownLoadFile), which can be used to load them
with prt-dof.exe. Use utility dof-nd9c.exe to reconvert characters from the
hexadecimal format of a DOF file to an ASCII matrix format. The ND9C printer
needs five sizes to be loaded: Width = 10, 12, 14, 16, 20. The Height is fixed
and always 22 pixels. The TH21 or TH22 needs three sizes: 10, 13, 18 with fixed
height of 24 pixels. This makes shure that for all cpi sizes the characters are
able to be printed. Parameter "Character" represents the character postion. The
range of the character positions is between 21H - 7FH. Position 20H (SPACE)
is not allowed to be overloaded. This utility can be used for TH21, TH22 or TH30
as well.
Syntax:
ND9C-DOF [-Z] ASCIIfile > FONTfile
Example:
ND9C-DOF USR_CPI12.ASC > USR_CPI12.DOF
Example contents of an ASCII matrix file (character ’B’) for the ND9C printer:
Width 16
Height 22
Character 42
.XXXXXXXXX...... CPI macro reference:
.XXXXXXXXXX..... Width CPI macro
..XX.....XXX.... 10 17
..XX.....XXX.... 12 15
..XX......XXX... 14 14
..XX......XXX... 16 12
..XX.....XXX.... 20 10
..XX.....XXX....
..XXXXXXXX......
..XXXXXXXX......
..XX.....XXX....
..XX.....XXX....
..XX......XXX...
..XX......XXX... User defined character sets can be deleted via
..XX.....XXX.... ESC ’ (1B 27) with sequence "/h 1b27" using
..XX.....XXX....
.XXXXXXXXXX..... utility PRT-DOF.EXE.
.XXXXXXXXX......
................ (Supported with firmware since Dec. 1999)
................
................
................
If you have a printer that has a firmware version loaded older than
December 1999 the old load sequence /h 1b26 has to be used
instead of /h 1c26. ND9C-DOF.EXE always converts to /h 1c26.
The ND9E printer is able to print one logo that can be stored into the E-PROM
of the printer. The utility ND9E-DOF.EXE can be used to create hexa decimal
sequences that can be loaded via PRT-DOF.EXE into the printer.
ND9E-DOF.EXE
Description:
Nd9e-dof.exe can be used to convert logo data from ASCII format to hexa
decimal sequences in a DOF file.
Syntax:
ND9E-DOF ASCIIfile > DOFfile
Example:
ND9E-DOF STDLOGO.ASC > STDLOGO.DOF
How to Load one logo:
You can load two different kinds of logos either standard or extended format:
Standard format: Width: 144; Height: 104 (13 lines x 8 pixel or smaller)
Extendend format: Width: 200; Height: 144 (18 lines x 8 pixel or smaller)
Step1: Create a 16 color PCX graphic in Z-Soft Paintbrush format for
standard logo within range 144 x104 or extended logo within
200 x 144 (width x height).
Step2: Use utility PCX2ASC.EXE to convert the PCX graphic to an ASCII file.
Step3: Use utility ND9E-DOF.EXE to convert the ASCII matrix file to a DOF
that contains hexa decimal sequences for the printer.
Step4: Use utility PRT-DOF.EXE to load the DOF contents into the printer.
NOTE: See also detailed descriptions of PRT-DOF.EXE and PCX2ASC.EXE
in the previous sections.
DOF-RJ03.EXE
Description:
Dof-rj03.exe can be used to convert hexadecimal font files (*.dof) to an ASCII
matrix file. The ASCII matrix file can be edited with any standard text editor.
The thermal printers TP06 (journal) and TP07 (receipt) need two character sets
with pixel format: 10x17 and 14x24 (width x height). The dot matrix (needle)
printers NP06 (journal) and NP07 (receipt) need two character sets with pixel
format: 7x9 and 9x9 (width x height) (see option -N). The RJ03 series printers
accept loading of user defined characters in range 0x20H - 0xFFH.
IMPORTANT NOTE: If the TP07 is installed as a GDI Windows printer,
user defined characters cannot be loaded into TP07.
Syntax:
DOF-RJ03 [-N] FONTfile > ASCIIfile
Options:
-N must be set for 7x9 or 9x9 fonts needed for dot matrix printers
NP06 or NP07.
Example 1:
DOF-RJ03 USR10x17.DOF > USR10x17.ASC
Example 2:
DOF-RJ03 -N USR7x9.DOF > USR7x9.ASC
RJ03-DOF.EXE
Description:
Rj03-dof.exe converts characters from an ASCII matrix file to the hexa decimal
byte definition of the *.DOF (DownLoadFile), which can be used to load them
with prt-dof.exe. Use utility dof-rj03.exe to reconvert characters from the
hexadecimal format of a DOF file to an ASCII matrix format. The RJ03 series
thermal printers TP06 (journal) and TP07 (receipt) need two character sets,
which needs to be loaded: 10x17 and 14x24 (width x height). The dot matrix
(needle) printers NP06 (journal) and NP07 (receipt) need two character sets in
pixel format: 7x9 and 9x9 (width x height).
The printers accept to load characters in range 20H - FFH.
IMPORTANT NOTE: If the TP07 is installed as a GDI Windows printer,
user defined characters cannot be loaded into TP07.
Syntax:
RJ03-DOF [-N] ASCIIfile > DOFfile
Options:
-N must be set for 7x9 or 9x9 fonts needed for dot matrix printers
NP06 or NP07.
Example 1:
RJ03-DOF USR14x24.ASC > USR14x24.DOF
Example contents of an ASCII matrix file (character ’B’) for the TP07 printer:
Width 14
Height 24
Character 42
..............
..............
.XXXXXXXXX....
.XXXXXXXXXX...
..XX.....XXX..
..XX.....XXX..
..XX......XXX.
..XX......XXX.
..XX.....XXX..
..XX.....XXX..
..XXXXXXXX....
..XXXXXXXX....
..XX.....XXX..
..XX.....XXX..
..XX......XXX.
..XX......XXX.
..XX.....XXX..
..XX.....XXX..
.XXXXXXXXXX...
.XXXXXXXXX....
..............
..............
..............
..............
Example 2:
RJ03-DOF -N USR7x9.ASC > USR7x9.DOF
Example contents of an ASCII matrix file (character ’B’) for the NP06 printer:
Width 7
Height 9
Character 42
.......
.XXXX..
.X...X.
.X...X.
.XXXX..
.X...X.
.X...X.
.XXXX..
.......
Miscellaneous tools
WRITE-ID.EXE
Write-ID.exe can be used to write data on track1,2 or/and 3 of ID cards.
Therefore you need a card reader which is able to write on the ID card tracks.
The data definition of the tracks has to be edited in a batch file e.g.
’write_id.cmd’. The batchfile must contain the path of the program and as
parameters 3 string definitions which indicates the track data.
Example:
You want to write track 2 data on the card but track 1 and 3 are empty:
Syntax of the batch file:
c:\protopas\tools\Write-Id "" "99999999999=999999999" ""
MDS2WNC.EXE
MDS2WNC.exe can be used to replace MDS i series status codes or/and
Maintenance Data of parameter DDC_MDS_STATUS or/and M_DATA of
configuration file CCERRMAP.INA to CSCW32 StClass and StCodes for Wincor
Nixdorf ATM’s. Error Class and Error Code (StClass, StCode) will be copied and
concatenated from the section line and will be inserted in the value field of
parameter DDC_MDS_STATUS or M_DATA.
Syntax:
MDS2WNC [-M] [-D] sourcefile destfile
Options:
-D Inserts CSCW32 StClass & StCode to DDC_MDS_STATUS
-M Inserts CSCW32 StClass & StCode to M_DATA
Example:
MDS2WNC -M -D C:\PROTOPAS\CONF\CCERRMAP.INA CCERRMAP.NEW
COMPREGF.EXE
COMPREGF.exe compares an extracted Regfile (REGEDIT4 format) with the
contents of the Windows registry.
Syntax:
COMPREGF -Rregfile [-Llogfile]
Options:
-Rregfile specifies the extracted registry file
(must be extracted in ASCII text (REGEDIT4) format)
-Llogfile specifies the logfile name where the differencies are stored
Example:
COMPREGF -Rwincor.reg -Lwincor.log
PRT-RAW.EXE
PRT-RAW.exe uses the CSCW32 interface to print macros and printer data from
an ASCII file to the selected printer station (BON1, JOURNAL1 or BELEG1). It
can be used to preset printers with default settings before application start or if
you like to test the printer functionality.
Syntax:
PRT-RAW -PDEVICE -Ffilename
Options:
-PDEVICE DEVICE specifies the device station:
BON1 - receipt printer
JOURNAL1 - journal printer
BELEG1 - document printer
Example:
PRT-RAW -PBON1 -Ftest-bon.txt
Contents of the print data file (test-bon.txt) could be:
#CPI12#TEST DATA TO PRINT#CR##LF##FF#
PRINTRAW.EXE
PrintRaw.exe calls the "Print" or "PrintRaw" method of the ProTopas API to print
macro sequences and printer data configured via a formular number or from an
ASCII file to the requested printer destination specified via parameters.
Syntax:
PRINTRAW [-Fnnn][-E] -Pprinter
Options:
Parameter -Fnnn is optional and enables the formular "Print" method of
ProTopas. If the parameter is NOT set, the "PrintRaw" method of the ProTopas
API is used (on the document printer "Eject" is called after the print).
-Fnnn nnn - specifies a formular number that has to be configured via
parameter MSGnnn in follwing registry locations depending on
which printer type has been selected:
..\LYNXPAR\PRINTER\RECEIPT
..\LYNXPAR\PRINTER\JOURNAL
..\LYNXPAR\PRINTER\DOCUMENT
Example 1:
The following command line initiates a formular "Print" on receipt using printer data
defined via parameter MSG400 in section ..\LYNXPAR\PRINTER\RECEIPT.
PRINTRAW -F400 -PREC
Contents of parameter MSG400 could be (max. 1024 characters):
#CPI12#FORMULAR PRINT DATA#CR##LF##FF#
Example 2:
The following command line initiates a "PrintRaw" on the journal printer using the
printer data defined in C:\PROTOPAS\RAWDATA.TXT.
PRINTRAW -PJRN
Contents of file rawdata.txt could be (max. 1024 characters):
#CPI12#TEST RAWDATA PRINT#CR##LF#
SETHWPPF.EXE
SETHWPPF.exe is called once during the installation phase in the batch file
UPDCONF.CMD. Depending on the configured WOSA device service it
disables the paper journal if the WOSA journal printer service is not configured
to be loaded.
It supports following WOSA service names: PRJ,PRR,PRD,DEP.
Syntax:
SETHWPPF -DWOSA-SERVICE1,WOSA-SERVICE2,WOSA-SERVICEn,...
Options:
-DWOSA-SERVICEx specifies the WOSA service names that can be
configured in parameter CCBase in section
..\CCOPEN\RESTART\APPLICATION_1
-T Sets parameters for Triple DES
-GND9G,TH21,TH22,TH97 Checks if the printers în the list are installed as
GDI printers and sets the required parameters for
GDI print operation in ProCash/NDC or
ProCash/DDC.
Example:
SETHWPPF -DPRJ,PRR,PRD,DEP -T -GND9G,TH21,TH22,TH97
INITEPP.EXE
InitEpp.exe initializes the EPP and deletes all loaded keys. After INITEPP.EXE
has been called with option -D and -E, the security keys have to be entered via
SOP function.
If INITEPP.EXE is called with option -I, just EPP information is displayed, the
status of the EPP will not be changed.
Syntax:
INITEPP [-D -E] [-I]
Options:
-D calls CSC-W32 function CscEdmInit() to initialize the EPP
-E calls CSC-W32 function CscEdmExport() after CscEdmInit() to
remove the key names from the EPP. This function returns
successfully if an EPP V4 or higher is installed.
"EPP export error" is returned if the function call is not supported
because of an old EPP version. This parameter has to be set
together with parameter -D
-I displays detailed information about EPP Type, Status, Capabilities
and the loaded Firmware Version
EXTERRMP.EXE
ExtErrMp.exe can be used to convert the sections of CCERRMAP.INA to a new
registry structure where the different error classes from section [CLASS] are
grouped to devices in a new section [DEVICES]. The tool can also be used to
split all error classes from an existing CCERRMAP.INA to multiple files. Each
file is named as the class name.
Syntax:
EXTERRMP [-Soldfile -Eoldfile] > newfile
Options:
-S Creates a new errmap file where the old error mapping
registry format is converted to section [CLASS\...] and
[DEVICES\...]
-E In addition to option -S, multiple files of each class are created,
where the filename is the class name.
Simulation utilities
HOSTSIM.EXE
Hostsim.exe is a windows program which can be started parallel to the running
application to simulate several host messages and ’Online’ - ’Offline’ events.
After the program has been called, the following window appears on the screen:
If you select "Enter Message" you get a text input field on the bottom line. Any
valid host to terminal message can be entered.
Example entry: 1\1c\1c\1c4
The backslash (\) for the field separator (1c) must be entered via
[STRG] + [ALT] + [\]
After entering the message you have to click on the ’Send Message’ button,
then the message is send to the communication framework.
If you press "Select Message" you get a new dialog window where you can
select a message that you like to be sent. You have to create your own message
list in a separate ASCII file named "NDC-SIM.MSG" stored in "C:\PROTOPAS".
Each line should contain one host command (without leading spaces) only.
MFCDLG.EXE
MfcDlg.exe is a dialog window where you can enter a screen number which is
displayed immediately parallel to the running customer application. This is
useful to check specific screens for its contents and availability.
The program shows the following dialog window on the screen:
MFCVAR.EXE
MfcVar.exe is a windows program which shows the entered steps and contents
of variables (e.g. Operation Code buffer) for the actual step.
The program shows the following window on the screen:
Installation of communication SW
This section describes how to install and configure the software of network
cards and communication add on products.
Internet links
EICON TECHNOLOGY
http://www.eicon.com/
Installation
The INSERT DISK window appears and prompts for a path to the EICON
software:
The next window lets you choose a software variant. Just click OK.
The next dialog box is just an information window in case if you have selected
"Automatic" installation. Just click OK. If the card could not be detected
automatically you have to use the manual setup for configuration.
Now you will be asked for the destination directory and Installation Group:
After selecting ’OK’ the software will be installed on your hard disk.
The results of the automatic detection are displayed in the dialog window
"DETECTION RESULTS". If the parameters for IRQ and/or I/O address are not
shown, manual installation is recommended. Comments in the lower part
maybe helpful for error analysis.
Now run the EICON configuration program by clicking Yes in the following
window.
Now you can configure your EICON card and the protocols. Specific sections
can be selected inside the directory structure. The dependent data is displayed
on the right side and can be changed. Please ask your network administrator
for the relevant parameters of protocol configuration. The protocol configuration
of the card can be saved with the function "FILE-IMPORT". By doing this, the
configuration set can be used in other systems.
Note: Hardware settings, like I/O address and IRQ, are not overwritten.
In the next dialog box you have to set the physical line settings. An important
setting is the field "DATA ENCODING", where you have to set NRZ or NRZI.
The clocking setting is usually "EXTERNAL".
After the configuration changes it is neccessary to save the data.
The last dialog asks you if you want to install the EICON WAN services for
Routers, PAD's and so on. Select the NO button at this time.
Several settings have to be done from the application side. These are for
instance Local and remote address, buffer sizes and call user data.
Testing connection
From the DOS command prompt you can call some test programs. The call
"ECCARD START" is used to start the EICON service.
"ECCARD STOP" disables the EICON service.
With command "ECCARD STATUS" you get information of the line activity.
Tables
Table 1: External Products . . . . . . . . . . . . . . . . . . . . . . 32
Table 18: DDC resolution dependent values for "SIZE" and "HEIGHT" 267
Table 19: NDC resolution dependent values for "SIZE" and "HEIGHT" 268
Table 21: Default settings for NDC and DDC fonts . . . . . . . . . . . 270
Figures
Figure 1: Product Overview . . . . . . . . . . . . . . . . . . . . . 31
CI Customization Image
ID IDentification
PC Personal Computer
PU Physical Unit
LU Logical Unit
Available manuals
Basically all the manuals you need to get information about configurations and
functionality of ProCash/DDC, ProConsult/DDC, ProDevice (WOSA),
CSC-W32 and AddOn products are available on the product cd.
Sub folder: \DOC\NDC-DDC\