Você está na página 1de 432

ProCash/NDC - ProCash/DDC

V3.0/21
Installation Manual

Edition June 2015

Copyright and Trademarks


Copyright Wincor Nixdorf International GmbH 2015.
All rights, including rights of translation by printing, copying or similar methods, even of parts, are reserved.
All rights, including rights created by patent grants or registration of a utility model or design, are reserved. Delivery
subject to availability; right of technical modifications reserved.
All names of hardware and software products mentioned in this manual are trade names and/or trademarks of
their respective manufacturers.
All hardware and software names used are trademarks of their respective manufacturers.
Reliant is a registered trademark of Pyramid Technology Corporation.
SINIX is the UNIX System derivative of Wincor Nixdorf International GmbH
UNIX is a registered trademark in the United States and other countries, licensed exclusively through
X/Open Company Limited.
Base: OSF/Motif, Copyright Open Software Foundation, Inc.
X Window System, Copyright Massachusetts Institute of Technology.
OSF/Motif is a trademark of Open Software Foundation, Inc.
X Window System is a registered trademark of Massachusetts Institute of Technology.
MS-DOS and Windows are registered trademarks of Microsoft Corporation in the United States and other
countries.

This manual is printed on paper treated with chlorine-free bleach.

Introduction

Software Product Overview

J/Install Installation

Installation Steps

Parameter Configuration Dialog

Parameters in "CUSTOM.PPF"

Parameter Management

Start and Stop Application services

Application Error Classes

Registry Cross Reference

Continued

Installation and Configuration Tools

Installation of Communication SW

Contents

Contents
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Whats new ? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Software Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Product short description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
ProBase/C Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hardware Configuration Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customization File for ProBase/C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PROBASE.CUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customization Files for ProSetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PROSETUP.CUS and PROSETUP.PAR . . . . . . . . . . . . . . . . . . . . . . . .

37
39
39
39
39
39

J/Install Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Registration Key Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Product Updates via J/Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customizing Media for J/Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enable ProAgent Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rich Client Manager Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creation of Installation Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multi Vendor Installation capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation subfolders of custom/update files . . . . . . . . . . . . . . . . . . . . .
The Installation Disk Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IInstallation of Terminal Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Run application as "Non Administrator" user . . . . . . . . . . . . . . . . . . . . . . . .
Installation restriction with NCR Aptra 05.01.xx . . . . . . . . . . . . . . . . . . .

41
42
42
43
45
46
47
47
47
48
50
50
51

Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 1 - Windows Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Windows 7 + SP1 , Windows XP + SP3 or POSReady2009 . . . . . . . . .
Step 2 - Communication Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 3 - J/Install Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PROEINFO installation log folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53
53
53
54
55
60

Parameter Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

June 2015

Contents
Dialog main and sub menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Parameters in CUSTOM.PPF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[START_APPLICATION] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Program list called by the Restart Manager . . . . . . . . . . . . . . . . . . . . . .
[STARTUP] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Communication framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operator panel framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EPP framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Special Electronics framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cash Dispenser framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Coin Dispenser framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Card Reader framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Journal framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service Handler framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dialog framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Variable framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Converter framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Presentation framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Protocol framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Control framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Receipt Printer framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Journal Printer framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document Printer framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Device Status framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deposit framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transaction framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Script framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Utility framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ProCash/XDC-SOP dialog framework . . . . . . . . . . . . . . . . . . . . . . . . . . .
Barcode Reader framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
System Restart settings of the Restart Manager . . . . . . . . . . . . . . . . . . . . .
Automatic System shut down & restart . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximum system reboots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Power up period timer to clear actual reboot counter . . . . . . . . . . . . . . .
Configurable screen during system shut down . . . . . . . . . . . . . . . . . . . .

June 2015

63
64
64
65
65
65
66
67
67
68
68
69
69
70
70
70
71
71
71
72
72
73
73
74
74
75
75
75
76
76
76
77
78
78
78
79
79

Contents
[CCPROTFW1] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Character Conversion Table location . . . . . . . . . . . . . . . . . . . . . . . . . . .
Messages log file location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Size of Messages log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Append ETX character to the end of a message . . . . . . . . . . . . . . . . . .
Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[SNA] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SNA Communication Framework . . . . . . . . . . . . . . . . . . . . . . . . . . .
Strip Function Management Header (FMH) . . . . . . . . . . . . . . . . . . .
SNA open timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NAUTYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logical Unit Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Communication response timer . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Receive buffer size of project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OPMODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Destination Logical Unit Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OPUID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OPPASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OPLIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[X25] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
X.25 Communication Framework . . . . . . . . . . . . . . . . . . . . . . . . . . .
Number of Virtual Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Short hold mode time delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Waiting time for Call Accept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Waiting time for Call Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Waiting time for Clear Request . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Number of calling retries to open X.25 connection . . . . . . . . . . . . . .
Calling delay timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Receive buffer size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
X.25 connection index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Type of Virtual Circuit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Suppress TLS trace output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Buffer size in send direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Buffer size in receive direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Permanent Virtual Circuit (PVC) number . . . . . . . . . . . . . . . . . . . . .
Delivery control for send and receive direction . . . . . . . . . . . . . . . . .
Activate Short Hold Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Short Hold Mode passive configuration . . . . . . . . . . . . . . . . . . . . . .
June 2015

80
80
80
81
81
81
82
82
82
82
83
83
84
84
85
85
85
86
86
86
87
87
87
88
88
89
89
90
90
90
91
91
92
92
92
93
93
94
94
7

Contents
Start Short Hold Mode passive connection . . . . . . . . . . . . . . . . . . . . 95
Connection reconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Diagnostic code setting for SHM clear cause . . . . . . . . . . . . . . . . . . 96
Closed user group selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Closed user group outgoing call assignment . . . . . . . . . . . . . . . . . . . 97
Add Reversed Charging Facility to Call Request packets . . . . . . . . 97
Accept Reversed Charging Facility of incoming calls . . . . . . . . . . . . 98
Add Call User Data to Call Request packets . . . . . . . . . . . . . . . . . . 98
Check Call User Data of incoming calls . . . . . . . . . . . . . . . . . . . . . . . 99
Local station address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Remote station (host) address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
[TCPIP] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
TCP/IP Communication Framework . . . . . . . . . . . . . . . . . . . . . . . . 101
Remote station (host) address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
TCP port number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Keep Alive mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
TCP/IP open timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Connection retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Send timeout timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Close timeout timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Local port address configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Coding DLL location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Size of memory blocks need to allocate . . . . . . . . . . . . . . . . . . . . . 106
TCP/IP parameters used by Windows . . . . . . . . . . . . . . . . . . . . . . . . . 107
KeepAliveTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
TcpKeepTries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
TcpKeepCnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
KeepAliveInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
TcpMaxDataRetransmissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
[SSL_PROJECT] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Remote station (host) address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
SSL port number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
SSL Coding DLL location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
SSL Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
SSL Message length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
[LYNXCI_PARAMETER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Optional Parameters (NDC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Miscellaneous Features I (DDC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Miscellaneous Features II (DDC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
8

June 2015

Contents
Miscellaneous Features III (DDC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logical Unit Number (LUNO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Identification (Config ID) . . . . . . . . . . . . . . . . . . . . . . . . . . .
[LYNXCI_TIMER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Keyboard response time (Timer 00) . . . . . . . . . . . . . . . . . . . . . . . . . . .
Additional time (Timer 01) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Close state time delay (Timer 02) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Communication response time (Timer 03) . . . . . . . . . . . . . . . . . . . . . .
Envelope insertion time (Timer 04) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cash retract time-out ( Timer 05) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Poll/select time (Timer 06) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Take cash time (Timer 07) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Card capture time (Timer 09) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Additional cash present time (Timer 10) . . . . . . . . . . . . . . . . . . . . . . . .
Document/Envelope present timeout (Timer 94) . . . . . . . . . . . . . . . . .
Statement retract (Timer 95) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Statement present (Timer 96) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Vandal guard close (Timer 98) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Vandal guard close time (Timer 99) . . . . . . . . . . . . . . . . . . . . . . . . . . .
Unsupported timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[LYNXCI_SCREEN] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen default foreground color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen default background color . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen transparent mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Blink rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic file location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure MacroMedia Flash Animations . . . . . . . . . . . . . . . . . . . . . . .
Palette file location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Character Width screen global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Character Height screen global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen horizontal offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen vertical offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen background picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Play videos in full screen mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ESC substitution character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic and Video file extension mapping . . . . . . . . . . . . . . . . . . . . . .
Stop Video after screen delay sequence (NDC only) . . . . . . . . . . . . . .
Touch zone support in PIN entry dialogs (EPP only) . . . . . . . . . . . . . .
Assign "Confirm" FDK in PIN entry dialogs (EDM only) . . . . . . . . . . . .
June 2015

118
119
119
120
120
120
121
121
121
122
122
122
123
123
123
124
124
124
125
125
126
126
127
127
128
129
130
132
133
133
133
134
134
135
135
136
137
137
138
9

Contents
Configure default Audio path for NDC . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure default Audio path for DDC . . . . . . . . . . . . . . . . . . . . . . . . . .
Configurable substitution character on display . . . . . . . . . . . . . . . . . . .
Specific supervisor mode screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure number of PIN digits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[SCREEN_XXX] [1] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Foreground Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen idle next screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen idle time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Character Width screen specific . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Character Height screen specific . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen horizontal offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen vertical offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen transparent mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen background picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen display contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set Curser position for consumer inputs locally . . . . . . . . . . . . . . . . . .
Upper left offset of the input rectangle . . . . . . . . . . . . . . . . . . . . . . .
Upper top offset of the input rectangle . . . . . . . . . . . . . . . . . . . . . . .
Lower right offset of the input rectangle . . . . . . . . . . . . . . . . . . . . . .
Lower bottom offset of the input rectangle . . . . . . . . . . . . . . . . . . . .
Input adjustment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Language bank screen parameters (DDC only) . . . . . . . . . . . . . . . . . . . . .
[TOP_MSG] and [CUST_MSG] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event and Error message definitions . . . . . . . . . . . . . . . . . . . . . . . . . .
Format Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event and Error message destination . . . . . . . . . . . . . . . . . . . . . . . . . .
[HARDWARE_CONFIGURATION] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hardware Configuration Parameters (NDC) . . . . . . . . . . . . . . . . . . . . .
Unsol./Sol. message logging on journal . . . . . . . . . . . . . . . . . . . . . . . .
Expanded Hardware Configuration Parameters (DDC) . . . . . . . . . . . .
MACing configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Send TVN and MAC in Transaction Request messages . . . . . . . . .
Check TVN and MAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Send Machine Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Check Machine Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Send TVN and MAC in solicited status . . . . . . . . . . . . . . . . . . . . . .
10

June 2015

138
139
139
140
140
141
141
141
142
142
143
143
143
144
144
145
145
146
146
146
147
147
147
148
149
150
150
151
152
153
153
154
155
156
156
156
156
157
157

Contents
Field selected MACing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ASCII MACing activation in EBCDIC line environments . . . . . . . . .
M-Data and MDS i series status code handling . . . . . . . . . . . . . . . . . .
Go offline after host reply timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RKL message encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SAF Machine Number (DDC only) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[APPLICATION_XXX][1] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hardware Fitness Fitness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Resend Power Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Suspend Mode timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Resend Power up message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sensor messages for terminal doors . . . . . . . . . . . . . . . . . . . . . . . . . .
Force Supervisor Mode when door open . . . . . . . . . . . . . . . . . . . . . . .
Solicited and Unsolicited message queuing . . . . . . . . . . . . . . . . . . . . .
Default Miscellaneous Features (DDC only) . . . . . . . . . . . . . . . . . . . .
Switch on/off logo light together with ready indicator . . . . . . . . . . . . . .
Ready/Supply/Amount option defaults (NDC) . . . . . . . . . . . . . . . . . . .
Card Read/Write error threshold defaults . . . . . . . . . . . . . . . . . . . . . . .
Enter "Out of service" mode after line reconnect . . . . . . . . . . . . . . . . .
Rear Balancing host timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure Customer Relays 1 - 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LED_IN_SERVICE (ATM is in service mode) . . . . . . . . . . . . . . . . .
LED_CUSTOMER (transaction active) . . . . . . . . . . . . . . . . . . . . . .
LED_CASH (cash cassette(s) has/have low or out status) . . . . . . .
LED_PAPER (printer paper low) . . . . . . . . . . . . . . . . . . . . . . . . . . .
LED_SERVICE (technical service required) . . . . . . . . . . . . . . . . . .
LED_SVR_MODE (ATM in supervisor mode) . . . . . . . . . . . . . . . . .
Configure Remote Sensor Indicators (RSI) . . . . . . . . . . . . . . . . . . . . .
RSI Status GREEN (RELAY3) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RSI Status YELLOW (RELAY2) . . . . . . . . . . . . . . . . . . . . . . . . . . .
RSI Status RED (RELAY1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure Remote Status Monitor (RSM) . . . . . . . . . . . . . . . . . . . . . . .
LED Mapping for systems of other vendors . . . . . . . . . . . . . . . . . . . . .
Guide Light flash rate control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Offline Reboot timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enable double length keys for triple DES . . . . . . . . . . . . . . . . . . . . . . .
Zero filled General Purpose Buffer B and C . . . . . . . . . . . . . . . . . . . . .
Configurable cassette names on journal . . . . . . . . . . . . . . . . . . . . . . .
Configurable text for reject/retract counter on journal . . . . . . . . . . . . .
June 2015

157
158
158
159
159
160
161
161
161
162
162
163
163
164
165
165
166
167
167
168
168
170
170
170
171
171
171
172
173
174
174
175
176
177
178
179
179
180
181
11

Contents
ADRS options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ADRS max retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Store downloaded COM key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Force displaying "Card captured" screen in close state . . . . . . . . . . . .
Print immediate processing options . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure anti skimming, mouthpiece and alarm sensors . . . . . . . . . . .
Initial Status after application start . . . . . . . . . . . . . . . . . . . . . . . . . .
Display receipt delivered screen in close state . . . . . . . . . . . . . . . . . . .
Use Close (J) state Timer 02 always . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delay after Transaction Request processing . . . . . . . . . . . . . . . . . . . . .
Screen delay time for FID Z (DDC only) . . . . . . . . . . . . . . . . . . . . . . .
Options for PAN handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Monitor SEL boot switch (Wincor only) . . . . . . . . . . . . . . . . . . . . . . . . .
Monitor Safe door . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reconnection delay time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Power Save Mode delay time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NDC LTS Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Host Protocol (HP) Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CAS dialog timer parameters (DDC only) . . . . . . . . . . . . . . . . . . . . . . . . . .
Time-out for CAS of cash dispenser . . . . . . . . . . . . . . . . . . . . . . . . . . .
Time-out for CAS of deposit module . . . . . . . . . . . . . . . . . . . . . . . . . . .
Time-out for CAS of receipt printer . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Time-out for CAS of document printer . . . . . . . . . . . . . . . . . . . . . . . . . .
Check CAS of deposit module during dispense . . . . . . . . . . . . . . . . . .
[CASH_DISPENSER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Number of logical cassettes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set cassettes currencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set cassettes values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default number of notes loaded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Automatic cassettes logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Automatic cassettes logon in SOP session . . . . . . . . . . . . . . . . . . . . . .
Set initial number of notes for auto logon cassettes . . . . . . . . . . . . . . .
Send cash low message only if whole denomination low . . . . . . . . . . .
Set dispense algorithm (ATMs only) . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ignore cash counters for removed cassettes . . . . . . . . . . . . . . . . . . . .
Send unsol. Cash low message not only once . . . . . . . . . . . . . . . . . . .
Stop dispensing after max. number of present errors . . . . . . . . . . . . . .
Set fatal after max. number of failed dispenses . . . . . . . . . . . . . . . . . .
Send sol. message on Cash present time-out (NDC only) . . . . . . . . . .
12

June 2015

182
183
183
184
184
185
189
190
190
191
191
192
192
193
193
194
194
195
196
196
197
198
199
200
201
201
201
202
202
203
203
204
205
205
206
207
208
209
210

Contents
Cash retract through Presenter Dump Q (DDC only) . . . . . . . . . . . . .
Send missing (@) for fatal cassettes (DDC only) . . . . . . . . . . . . . . . .
Allow dispense if cassettes counter < 0 (NDC only) . . . . . . . . . . . . . . .
Security timer between dispense and presenting money . . . . . . . . . . .
Logical cassettes mapping for 6 cassettes ATMs . . . . . . . . . . . . . . . .
Check cash dispenser shutter status after money taken . . . . . . . . . . .
Upper case Denomination ID for cassettes (DDC only) . . . . . . . . . . . .
Present failure screen and synchronous retract . . . . . . . . . . . . . . . . . .
Screen display options during cash present . . . . . . . . . . . . . . . . . . . . .
Cash Dispenser fatal if reject bin not operational . . . . . . . . . . . . . . . . .
Dispense retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dispense retries after hardware error . . . . . . . . . . . . . . . . . . . . . . . . . .
Currency Exponent correction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximum cash retracts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Low threshold for physical cassettes . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximum dispense time (watch dog) . . . . . . . . . . . . . . . . . . . . . . . . . .
Withdrawal Retract logging and recycling on RM3 . . . . . . . . . . . . . . . .
WOSA XFS30 Parameters (Wincor Nixdorf only) . . . . . . . . . . . . . . . .
Number of minimum bills (money low limit) . . . . . . . . . . . . . . . . .
Number of maximum bills to be rejected . . . . . . . . . . . . . . . . . . . . .
[COIN_DISPENSER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Number of coin hoppers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set coin hopper currency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set coin hopper values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set coin dispense flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Number of coin hoppers reported to the host . . . . . . . . . . . . . . . . . . . .
[DEPOSIT] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Options to dispense envelopes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen to be displayed during envelope dispense . . . . . . . . . . . . . . . .
Screen "Please wait for an envelope" . . . . . . . . . . . . . . . . . . . . . . . . .
Allow to cancel deposit transaction . . . . . . . . . . . . . . . . . . . . . . . . . . .
Disable printing on retracted envelopes . . . . . . . . . . . . . . . . . . . . . . . .
Deposit print character mapping table . . . . . . . . . . . . . . . . . . . . . . . . .
Deposit entry splitting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Prepare envelope dispense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[CARD_READER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default track read definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default chip data read on Smart Cards . . . . . . . . . . . . . . . . . . . . . . . .
Card insert/eject wake up time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
June 2015

210
211
212
212
213
214
214
215
215
216
217
217
218
218
219
219
220
221
221
221
222
222
222
223
223
224
225
225
226
227
227
228
228
229
229
230
230
230
231
13

Contents
"Remove Card" screen for left cards in DIP reader . . . . . . . . . . . . . . . .
Read tracks during insert or remove direction (SWIPE) . . . . . . . . . . . .
Card manipulation threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Card jam threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DIP eject screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contactless Reader Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[BARCODE] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure barcode type formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[OPERATOR_SCREENS] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Printer header for Operator screens . . . . . . . . . . . . . . . . . . . . . . . . . . .
[JOURNALPRINTER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set journal destination on paper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Journal printer CPI setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Journal printer LPI setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Double Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Condensed Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Electronic journal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Send Spooler active or journal printer error message . . . . . . . . . . . . . .
Keep original printer status if Spooler is configured . . . . . . . . . . . . . . .
Force to send "Paper Out" message on paper out supply . . . . . . . . . .
Assign codepage control sequence to NDC font type . . . . . . . . . . . . . .
Print journal host data always prior function IDs . . . . . . . . . . . . . . . . .
Hard disk free space low threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enable journal file writing error messages . . . . . . . . . . . . . . . . . . . . . .
Configure EJU or SAF shared mapping file . . . . . . . . . . . . . . . . . . . . .
Configure EJU or SAF maximum file size . . . . . . . . . . . . . . . . . . . . . . .
EJU journal NCR compatible mode . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Extended range of characters in file journal . . . . . . . . . . . . . . . . . . . . .
Print unicode (GDI only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[ELECTRONIC_JOURNAL] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximum journal files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Journal Spooler reset sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Journal Spooler check timer for Spooler data . . . . . . . . . . . . . . . . . . . .
Journal Spooler threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximum spool file size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximum unprinted spool data size . . . . . . . . . . . . . . . . . . . . . . . . . . .
[RECEIPTPRINTER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Receipt printer CPI setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Receipt printer LPI setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14

June 2015

231
232
232
233
233
234
235
235
237
237
238
238
238
238
239
239
240
240
241
241
242
242
243
243
244
244
245
245
246
247
247
247
248
248
248
249
250
250
250

Contents
Receipt printer character set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Double Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Condensed Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Receipt printer page header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Receipt printer page footer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Receipt footer line position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LED timer during receipt delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enable R01 print data merging (NDC only) . . . . . . . . . . . . . . . . . . . . .
Assign codepage control sequence to NDC font type . . . . . . . . . . . . .
Force receipt delivery after each host reply . . . . . . . . . . . . . . . . . . . . .
Force to send "Paper Out" message on paper out supply . . . . . . . . . .
Options during Rear Balancing print . . . . . . . . . . . . . . . . . . . . . . . . . . .
Print unicode (GDI only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[DOCUMENTPRINTER] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document printer CPI setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document printer LPI setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document printer character set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Double Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Condensed Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document printer page header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document printer page footer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document footer line position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximum documents to be collected before delivery . . . . . . . . . . . . . .
Cancel document processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Print unicode (GDI only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Printer Font parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Font type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Double Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Condensed Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User defined Character set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Printer initialization macros or characters . . . . . . . . . . . . . . . . . . . . . . .
Printer character mapping table . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Print unicode font specific (GDI only) . . . . . . . . . . . . . . . . . . . . . . . . . .
GDI Windows name for receipt printer . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GDI Windows name for document printer . . . . . . . . . . . . . . . . . . . . . . . . .
Screen Font configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[VIEWER_FONT] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Number of screen fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Font name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
June 2015

250
251
251
252
252
253
253
254
254
255
255
256
257
258
258
258
258
259
259
259
260
260
261
261
262
263
263
265
265
266
266
267
268
269
269
270
270
270
270
15

Contents
Font size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Font height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Font Resolution tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NDC font identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NDC double size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Display characters in proportional mode . . . . . . . . . . . . . . . . . . . . . . . .
Resolution dependent WINNT Font installation . . . . . . . . . . . . . . . . . . . . .
Resolution dependent Bitmap/Icon installation . . . . . . . . . . . . . . . . . . . . . .
User defined WINNT fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enable and preconfigure ProAgent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set Primary/Secondary Server and Port . . . . . . . . . . . . . . . . . . . . . . . .
Terminal ID of ATM client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enable Application Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error description for ProAgent Server log window . . . . . . . . . . . . . .
VDM Activation for ProAgent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMV parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Completion Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contact Threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Language support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMV Protocol Vendor Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Acquirer Identifier 9F01 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Merchant Category Code 9F15 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Terminal Country Code 9F1A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Terminal Capabilities 9F33 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Terminal Type 9F35 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Additional Terminal Capabilities 9F40 . . . . . . . . . . . . . . . . . . . . . . . . . .
Vendor specific parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Number of physical cassettes names . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure physical names of cassettes units . . . . . . . . . . . . . . . . . . . .
Set number of maximum rejected notes . . . . . . . . . . . . . . . . . . . . . . . .
Set number of maximum retracts . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enable test dispense function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Devide remaining notes equally to physical cassettes . . . . . . . . . . . . .

272
272
273
275
276
277
278
278
279
280
280
281
281
281
281
282
282
282
283
283
284
284
285
285
286
286
287
287
287
288
288
289
289

Parameter Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The PARAC run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter update process via PARAC . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PCEDT - PARAC Parameter Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Vendor and AddOn depended configuration . . . . . . . . . . . . . . . . . . . . . . .

291
291
292
293
294

16

June 2015

Contents
ProCash/NDC parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ProCash/DDC parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customize Error Mapping Table CCERRMAP . . . . . . . . . . . . . . . . . . . . . .
Configure multiple CDM Error Reasons for DDC . . . . . . . . . . . . . . . . .
Variables in MDS i series status: . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cassette specific variable in DDC912 status: . . . . . . . . . . . . . . . . . . . .
Variables in M-Data status field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Class mapping of CSC-W32 and XFS classes . . . . . . . . . . . . . .
Error mapping of XFS30 (WOSA) error events . . . . . . . . . . . . . . . . . .
Error Suppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure DDC 911 protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Use CCERRMAP.INA for 911 mode . . . . . . . . . . . . . . . . . . . . . . . . . .
Setup hardware configuration status fields for 911 mode . . . . . . . . . . .
Dispenser configuration for HI and LO denomination bills . . . . . . . . . .
Diebold 911 compatible HI and LO denomination mode . . . . . . . . . . .
Specific Step for dispense FID 8 in 911 Mode . . . . . . . . . . . . . . . . . .
Printer initialisation via macro tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Macro parameters for Journal and Receipt printer . . . . . . . . . . . . . . . .
User defined Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configurable ESC xx mapping to Macros . . . . . . . . . . . . . . . . . . . . . . .
Enable Secure Key Entry (SKE) mode . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enable Triple DES operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Triple DES enabled via J/Install installation . . . . . . . . . . . . . . . . . . . . .
Triple DES activation manually on a running system . . . . . . . . . . . . . .
Switch back to Single DES operation . . . . . . . . . . . . . . . . . . . . . . . . . .
Switch to triple or single DES via SOP . . . . . . . . . . . . . . . . . . . . . . . . .
Enable GDI Windows print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Automatic Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GDI operation and configuration parameters . . . . . . . . . . . . . . . . . . . .
Configuration settings for TH23 on Cineo 4090 . . . . . . . . . . . . . . . . . .
Enable card less transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Repository configuration of CLTSTTFW.DLL . . . . . . . . . . . . . . . . . . . .
Dialog configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Timeout parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen display and exit for parallel FDK press . . . . . . . . . . . . . . . . . . .
Alpha numeric SMS key input style on EPP . . . . . . . . . . . . . . . . . . . . . . .
Assign values for Left/Right keys of the 0 key . . . . . . . . . . . . . . . . . . . . .
Dependent parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
June 2015

295
301
306
307
308
309
309
310
311
311
312
312
312
313
314
315
316
316
318
319
320
320
320
321
321
321
322
322
322
323
324
324
324
325
326
326
327
327
328
17

Contents
Specify cursor character for input position . . . . . . . . . . . . . . . . . . . . . . . . .
Specify cursor character for input position . . . . . . . . . . . . . . . . . . . . . . . . .
Set up character sequences for single EPP keys . . . . . . . . . . . . . . . . . . . .
Input options for SMS input (NDC only) . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dialog options for SMS input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Allowed alpha numeric characters for SMS input . . . . . . . . . . . . . . . . . . . .
Enable timer restart for input dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure Dial Up communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Repository section [STARTUP] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Protocol Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modem Interface DLL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Serial Interface DLL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Communication Yield DLL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Restart Manager section [START_APPLICATION] . . . . . . . . . . . . . . .
Load dial up frameworks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Specific communication settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modem automatic dial up number . . . . . . . . . . . . . . . . . . . . . . . . . .
Modem initialisation command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Serial interface line attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Serial interface port name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Project settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COM channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Protocol channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Protocol type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Route ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Terminal ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Changing Network settings under restricted User . . . . . . . . . . . . . . . . . . .
Parameters for Forms printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rich Client Manager (RCM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Journal Event handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Free Journal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Joker Journal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Client Settlement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

328
329
329
330
331
332
333
334
334
334
334
335
335
336
336
337
337
337
338
338
339
339
339
339
340
340
341
341
342
342
342
342
343

Software updates via SOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345


Update diskette creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Automatic update process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Start and Stop Application services . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

18

June 2015

Contents
Start application services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Stop application services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Application Error Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transaction Framework (Class 6434) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cash Dispenser Framework (class 643A) . . . . . . . . . . . . . . . . . . . . . . . . .
Security Overlay Framework (Class 643C) . . . . . . . . . . . . . . . . . . . . . . . .

349
349
352
354

Registry Cross Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355


Installation and Configuration Tools . . . . . . . . . . . . . . . . . . . . . . . . . . .
ProCash/NDC-DDC Configuration Manager . . . . . . . . . . . . . . . . . . . . . . .
Font and Graphic utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Analyzing utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Font tools for journal and receipt printers . . . . . . . . . . . . . . . . . . . . . . . . .
Font and Logo tools for printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logo print with ND9E . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Font utilities for RJ03 series printers . . . . . . . . . . . . . . . . . . . . . . . . . .
Miscellaneous tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Simulation utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

381
381
382
388
388
394
402
403
406
411

Installation of communication SW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413


Installation of Eicon Wan Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Related publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

June 2015

19

Contents

20

June 2015

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.

June 2015

21

Introduction

22

June 2015

Whats new ?

Whats new ?
This section lists a summery of documentation changes and extensions of the
ProCash/NDC - ProCash/DDC Installation Manual.
Since November 2014 until June 2015:

New section Client Settlement on page 282

Since October 2013 until November 2014:

New section Configuration settings for TH23 on Cineo 4090 on page 323

New section Rich Client Manager (RCM) on page 342

New section Host Protocol (HP) Handling on page 195

New section Rich Client Manager Installation on page 46

New section Contactless Reader Handling on page 234

New section NDC LTS Options on page 194

Parameter PRINT_UNICODE documented

Since December 2012 until October 2013:

New section Configurable ESC xx mapping to Macros on page 319

Description for obsolete FOnet configuration removed

2D Barcode types documented

New section Parameters for Forms printing on page 341

Since June 2012 until December 2012:

SSL description updated

Windows 7 support

product version update

Since May 2011 until June 2012:

New section SAF Machine Number (DDC only) on page 160

June 2015

23

Whats new ?

New section EMV Protocol Vendor Specification on page 283

New section Reconnection delay time on page 193

Since March 2011 until May 2011:

New section Reconnection delay time on page 193

New section Withdrawal Retract logging and recycling on RM3 on


page 220

New section Changing Network settings under restricted User on


page 341

New section Power Save Mode delay time on page 194

New section Installation restriction with NCR Aptra 05.01.xx on page 51

Since November 2010 until March 2011:

Changed section ProBase/C Installation on page 37

Changed section J/Install Installation on page 41

Since October 2010 until November 2010:

Changed section RKL message encoding on page 159

Since April 2010 until October 2010:

J/Install name introduced

New section Guide Light flash rate control on page 177

New section IInstallation of Terminal Protection on page 50

Since January 2010 until April 2010:

Update process description extended and corrected

Since June 2009 until January 2010:

24

June 2015

Whats new ?

New section [SSL_PROJECT] on page 110

New section Alpha numeric SMS key input style on EPP on page 327

New section Monitor Safe door on page 193

New section DIP eject screen on page 233

Since August 2008 until June 2009:

New section Monitor SEL boot switch (Wincor only) on page 192

New section RKL message encoding on page 159

New section Enable Secure Key Entry (SKE) mode on page 320

Since May 2007 until August 2008:

New section Default number of notes loaded on page 202

New section ProBase/C Installation on page 37

Extended section Configure anti skimming, mouthpiece and alarm sensors


on page 185

New section Maximum dispense time (watch dog) on page 219

June 2015

25

Whats new ?
Since July 2006 until May 2007:

New section IInstallation of Terminal Protection on page 50

New section Run application as "Non Administrator" user on page 50

New section Low threshold for physical cassettes on page 219

New section Card manipulation threshold on page 232

New section Card jam threshold on page 233

New section Delay after Transaction Request processing on page 191

New section Screen delay time for FID Z (DDC only) on page 191

New section Options for PAN handling on page 192

Since September 2005 until July 2006:

Extended section Font and Graphic utilities on page 382

New section Extended range of characters in file journal on page 245

New section EJU journal NCR compatible mode on page 245

New section Screen display options during cash present on page 215

New section Error mapping of XFS30 (WOSA) error events on page 311

New section PROEINFO installation log folder on page 60

New section Configure Remote Status Monitor (RSM) on page 175

New section [COIN_DISPENSER] on page 222

New section [BARCODE] on page 235

Extended section Miscellaneous tools on page 406

New section Configure Dial Up communication on page 334

Since October 2004 until September 2005:

Extended section Parameter Management on page 291

New section EMV parameters on page 282

New section Currency Exponent correction on page 218

New section Enable card less transactions on page 324

26

June 2015

Whats new ?

Since March 2004 until October 2004:

Extended section Automatic cassettes logon on page 203

New section Deposit entry splitting on page 229

New section Prepare envelope dispense on page 229

Changed section Parameter Management on page 291

New section Use Close (J) state Timer 02 always on page 190

New section Vendor specific parameters on page 287

New section Display receipt delivered screen in close state on page 190

Extended section Font utilities for RJ03 series printers on page 403

New section Go offline after host reply timeout on page 159

New section The Installation Disk Manager on page 48

Changed section Creation of Installation Media on page 47

New section Configure EJU or SAF shared mapping file on page 244

New section Configure EJU or SAF maximum file size on page 244

New section Print immediate processing options on page 184

New section Configure anti skimming, mouthpiece and alarm sensors on


page 185

New section Enable journal file writing error messages on page 243

New section Force displaying "Card captured" screen in close state on


page 184

New section Present failure screen and synchronous retract on page 215

Extended section ADRS options on page 182

Changed section ADRS max retries on page 183

Since November 2003 until March 2004:

New section Configure MacroMedia Flash Animations on page 130

New section Font utilities for RJ03 series printers on page 403

June 2015

27

Whats new ?

New section Configure number of PIN digits on page 140

New section Deposit print character mapping table on page 228

Since March 2003 until November 2003:

New section Store downloaded COM key on page 183

New section Enable R01 print data merging (NDC only) on page 254

New section Screen "Please wait for an envelope" on page 227

New section ESC substitution character on page 135

New section Options during Rear Balancing print on page 256

Changed section Options to dispense envelopes on page 225

Changed section Screen to be displayed during envelope dispense on


page 226

New section Receipt printer page footer on page 252

New section Receipt footer line position on page 253

New section Document printer page footer on page 260

New section Document footer line position on page 260

New section Hard disk free space low threshold on page 243

New section Configure multiple CDM Error Reasons for DDC on page 307

New section Check cash dispenser shutter status after money taken on
page 214

New section Specific supervisor mode screen on page 140

New section Print journal host data always prior function IDs on page 242

New section ADRS options on page 182

New section ADRS max retries on page 183

New section Upper case Denomination ID for cassettes (DDC only) on


page 214

New section Assign codepage control sequence to NDC font type on


page 242 and 254.

28

June 2015

Whats new ?
Since April 2002 until March 2003:

Changed section [TOP_MSG] and [CUST_MSG] on page 150

New section Maximum unprinted spool data size on page 249

New section Maximum spool file size on page 248

New section Printer initialization macros or characters on page 266

New section Configurable text for reject/retract counter on journal on


page 181

New section Configurable cassette names on journal on page 180

New section Enable GDI Windows print on page 322

New section GDI Windows name for document printer on page 269

New section GDI Windows name for receipt printer on page 269

New section Security timer between dispense and presenting money on


page 212

New section Default chip data read on Smart Cards on page 230

New section Logical cassettes mapping for 6 cassettes ATMs on


page 213

New section Configurable substitution character on display on page 139

Extended section Options to dispense envelopes on page 225

New section Disable printing on retracted envelopes on page 228

New section Force to send "Paper Out" message on paper out supply on
page 241 and 255.

New section Zero filled General Purpose Buffer B and C on page 179

New section Enable Triple DES operation on page 320

Description of section Font and Logo tools for printers on page 394
extended for TH30 and TH21/TH22.

Extended section Miscellaneous tools on page 406. Extensions for


SetHwPPF.EXE and CpyNtFnt.EXE

June 2015

29

Whats new ?
Since October 2001 until April 2002:

Changed section Creation of Installation Media on page 47

New section Send missing (@) for fatal cassettes (DDC only) on
page 211

Changed section Automatic System shut down & restart on page 78

New section CAS dialog timer parameters (DDC only) on page 196

New section Configure Customer Relays 1 - 4 on page 168

New section Configure Remote Sensor Indicators (RSI) on page 172

New section Offline Reboot timer on page 178

New section Cash retract through Presenter Dump Q (DDC only) on


page 210

Enhanced section Miscellaneous tools on page 406.


New tool PRINTRAW.EXE

New section Keep original printer status if Spooler is configured on


page 241

New section Configure default Audio path for NDC on page 138

New section Configure default Audio path for DDC on page 139

New section Logo print with ND9E on page 402

New section Enable double length keys for triple DES on page 179

30

June 2015

Whats new ?
Since March 2001 until October 2001:

Enhanced section Printer Font parameters on page 263

New section Graphic and Video file extension mapping on page 136

New section Touch zone support in PIN entry dialogs (EPP only) on
page 137

section Assign "Confirm" FDK in PIN entry dialogs (EDM only) on


page 138

New section Send sol. message on Cash present time-out (NDC only) on
page 210

section Miscellaneous tools on page 406 enhanced.


New tool PRT-RAW.EXE

Since December 2000 until March 2001:

New section Local port address configuration on page 104

New section Printer initialisation via macro tables on page 316

New section TCP/IP parameters used by Windows on page 107

New section Stop dispensing after max. number of present errors on


page 208

Since September until December 2000:

New section Creation of Installation Media on page 47

New section System Restart settings of the Restart Manager on page 78

New section Rear Balancing host timeout on page 168

Changed section Force Supervisor Mode when door open on page 163

Changed section Product short description on page 34

Changed section Cash Dispenser framework on page 67

June 2015

31

Whats new ?

32

June 2015

Software Product Overview

Software Product Overview


ProCash/NDC and ProCash/DDC itself need a couple of external software
components which are assembled during the installation. The following figure
shows the software products which are neccessary to build up the whole
ProCash/NDC or ProCash/DDC application.
Figure 1: Product Overview

Windows 7 or

CD

CD

CD

Windows XP

Communication Packets
EICON
Software

SNA
Workstation

CD

ProBase/C 1.2/00
Device Drivers

CD

CD

Firmware CSC-W32
ProDevice (XFS)

CD

J
/
I
N
S
T
A
L
L

3.0/21 NDC/DDC
ProCash/NDC
ProCash/DDC
ProTopas Manager
AddOn Products
ProAgent

June 2015

J
/
I
N
S
T
A
L
L

CD

33

Product short description

Software Product Overview

Product short description


The following two tables give a short description about the software components shown in Figure 1: Product Overview. Table External Products
describes external products delivered on separate CDs.
Since introduction of release 2.0/00, The CSC-W32 operating system,
ProDevice (XFS) and Firmware are delivered separately as own installation CD
that has to be ordered as product ProBase/C.
Table Components on "ProBase/C CD" describes the companys proprietary
product components up to XFS available on the ProBase/C CD.
Table Core products and AddOns on "J/Install CD" describes the companys
application products available on the J/Install CD.
Table 1: External Products

NAME

VERSION DESCRIPTION

MEDIAS

Windows 7 or
Windows XP

SP1
SP3

CD
CD

SNA
Workstation

MS Windows 7
MS Windows XP

SNA Workstation needs to be CD


installed if the ATM has to
communicate via SNA-SDLC
or SNA-QLLC with the host.

Table 2: Components on "ProBase/C CD"

34

NAME

VERSION DESCRIPTION

MEDIAS

CSC-W32

---

CSC Operating System


communicates directly with
the firmware of the hardware
devices.

CD

ProDevice
(WOSA)
XFS 3.x

---

This component contains the CD


WOSA services used by
ProTopas.

Firmware

---

Service and Operating


functions for CSC applications on Windows.

June 2015

CD

Software Product Overview

Product short description

Table 3: Core products and AddOns on "J/Install CD"

NAME

VERSION DESCRIPTION

ProCash/NDC

3.0/21

MEDIAS

3.0/21

Contains the specific frameworks CD


and neccessary accessoires
which completes the
ProCash/NDC-DDC products.

ProAgent

1.2/21

ProAgent

PARAC NT

3.2/30

PARAC is a parameter customis- CD


ation utility which provides the
Windows registry with parameters of the products.
All defined parameters of each
product are merged together and
will be set into the registry in a
predefined sequence.

ProTopas
Manager

5.1/30

Contains ProTopas device frame- CD


works and core components
required for the application

AddOn
Products

---

The AddOn Products are optional CD


components (exp. ProChip/EMV)
that can be installed with
additional Registration Keys

ProTopas/SOP-NDC

ProCash/DDC
ProTopas/SOP-DDC

June 2015

CD

35

Product short description

36

Software Product Overview

June 2015

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 33,
the CSC-W32 Operating System, T-SOP, Firmware, ProDevice (XFS) and
drivers are separated in a new Product CD named ProBase/C.

ProBase/C needs to be installed on Wincor hardware systems only.


ProBase/C should be installed in folder C:\ProBase only. Please do
not change the destination folder in the input selection dialog of
ProBase.

ProBase/C CD 1.2/00 is a non bootable medium and requires a ready installed


Windows 7 or Windows XP on the hard disk. Additional Windows device drivers
have to be installed from the Driver Utility CD that is delivered together with the
hardware system.
If you want to install Windows 7 or Windows XP, ProBase/C and application
layer on a clean formatted hard disk, you have to use ProSetup for the
installation.

Installation on existing Windows 7 or Windows XP:


ProBase/C can also be installed on an existing Windows 7 or Windows XP
operating system. The installation window automatically appear if you insert the
ProBase/C or if you call AUTORUN.BAT from the CD root folder.

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 47 for detailed description.

Refer to figure ProBase/C Installation Medias on page 38

June 2015

37

Product short description

ProBase/C Installation

Figure 2: ProBase/C Installation Medias

CD

CD

ProBase/C

1.

2.

Hardware
Media

Customization
Media

Note: Instead of floppy diskettes you can use CDs, USB or HDD medias

Please refer to ProBase Installation 1.2/00 User manual for detailed descriptions
how to install and customize the ProBase/C product.
Detailed descriptions about ProSetup configuration are described in
ProSetup User Manual.

38

June 2015

ProBase/C Installation

Hardware Configuration Media

Hardware Configuration Media


The Hardware Configuration Media contains the hardware configuration for the
self service system that you need to set up. The hardware configuration file
HW_CONF.INI contains device specific settings like specific hardware components, driver settings, type of device communication (V.24, USB, COM) and that
has to be configured in the Windows registry for the present devices.

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.

Customization File for ProBase/C


PROBASE.CUS
The Customization File PROBASE.CUS contains the parameter configuration
settings for the ProBase/C Operating system and XFS services.
The Customizing File will be automatically copied to the Customizing Media via
the "Installation Disk Manager". Refer to section Creation of Installation Media
on page 47 for detailed description.

Customization Files for ProSetup


PROSETUP.CUS and PROSETUP.PAR
The files PROSETUP.CUS and PROSETUP.PAR are configuration files used by
ProSetup. They will be automatically copied to the Customizing Media via the
"Installation Disk Manager". Refer to section Creation of Installation Media on
page 47 for detailed description.

June 2015

39

Customization Files for ProSetup

40

June 2015

ProBase/C Installation

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 installation concept and configuration possibilities.
Figure 3: J/Install Installation medias

CD

CD

J/Install

1.

2.

Registration Key
Medias

Customization
Media

3.
Update
Medias

Note: Instead of floppy diskettes you can use CDs, USB or HDD medias

June 2015

41

Registration Key Media

J/Install Installation

Registration Key Media


In the Registration Key Media the key file REG_KEY.INI is included. This file
contains the registered products and release versions which are automatically
set with each new order of ProCash/DDC or ProCash/NDC. J/Install verifies the
contents of the file REG_KEY.INI compares it with the contents of the CD and
installs those products only that are defined in this file.

The Registration Key Media is delivered from the factory and it is


strictly prohibited to change it contents. The file REG_KEY.INI will
be created with a generated random security key. Even if anybody
modifies this file after the key generation from factory side, J/Install
cannot install the products any more.
In case of questions or problems related to all Wincor Nixdorf
Software products you should open a ticket via:
iSupport:www.wincor-nixdorf.com/service

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.

Product Updates via J/Install


Please refer to J/Install User Guide to get detailed information how to update
application software.

42

June 2015

J/Install Installation

Customizing Media for J/Install

Customizing Media for J/Install


The Customizing Media is used to perform customer specific installations. With
this media the operator can specify the products and update versions and what
parameter settings should be installed.
The Customizing Media will be automatically prepared via the "Installation Disk
Manager". Refer to section Creation of Installation Media on page 47 for
detailed description.
The following table shows the structure of the Customizing Media:
Table 4: Structure of the Customizing Media

File Structure
\ BMP\prondc.bmp
or
\ BMP\proddc.bmp
\ VENDORS\
WN\XFS30\custom.wn
or
NCR\XFS30\custom.ncr
or
DIEBOLD\XFS30\
custom.dib
or
DELARUE\XFS30\
custom.dlr
or
GRG\XFS30\
custom.grg
or
NAUTILUS\XFS30\
custom.nhy

Description
Customer specific bitmap which is displayed when
the part ProCash/NDC or ProCash/DDC is
installed during the J/Install run.
Vendor specific parameters:
specific parameters for Wincor systems
specific parameters for NCR systems

specific parameters for Diebold systems

specific parameters for DeLaRue systems

specific parameters for GRG systems

specific parameters for Nautilus Hyosung systems


The vendor specific files are automatically copied
from the vendor specific sub folder to the root
folder of the Customizing Disk.

June 2015

43

Customizing Media for J/Install

File Structure
\ ADDON.PPF\
custom.emv
custom.ccd
custom.crs
custom.rm2
custom.chq
custom.p36
custom.web
custom.rxe
custom.rkl
custom.coi
custom.coo
custom.snd
custom.flx
custom.rcc
custom.fui
\ custom.ppf

\ jinstall.cus

\ dialog.ctl

\ probase.cus

44

J/Install Installation

Description
Specific parameters for AddOn products:
ProChip/EMV
ProCashIn/Online with CCDM
ProCashIn/Online with CRS
Recycling Module 2 (PC4000)
ProChequeIn
CashIn/Signature
Web-Extensions
Specific for CRSxe
ProRKL
CoinIn
CoinOut
Specific for SlimCash (obsolete)
Parameter settings for ProTopas/Flow-Extensions
Rich Client Manager parameters
Flex UI parameters
customer parac parameter file - contains basic
parameters that are set during the PARAC run. All
parameters defined in this file must be known by
PARAC. The PCEDT (PARAC PARAMETER
EDITOR) utility should be used to modify the file
custom.ppf.
customizing control file - contains sections of
product names, versions and definitions for update
diskettes. This file is automatically copied from the
vendor specific sub folder from the J/Install CD to
the root folder of the Customizing Disk.
dialog control file - contains the dialog definition of
the installation dialog for the purpose of presetting
parameters during the J/Install run. This file is
automatically copied from the vendor specific sub
folder from the J/Install CD to the root folder of the
Customizing Disk.
customizing file for ProBase/C - contains
parameters for CSCW32 and XFS services. This
file is automatically copied from the J/Install CD to
the root folder of the Customizing Disk.

June 2015

J/Install Installation

File Structure
\ prosetup.cus

\ prosetup.par

\ POST\
update.zip

Customizing Media for J/Install

Description
customizing file for ProSetup - contains global
parameters and network settings. This file is
automatically copied from the J/Install CD to the
root folder of the Customizing Disk.
parameter definition file for ProSetup - contains
some environment variables and the link to the
JInstall.xml script.
Sub folder for UPDATE file(s)
update file with additional parameter configuration
files (INA files) and batch routines which are called
during the installation process. The update.zip will
be automatically extracted by during the JInstall
installation process.
Note: If you need to add additional customizing,
you can add addditional ZIP files to the POST
folder. They will be extracted in alphabetical order.

Please refer to the J/Install reference manual for detailed descriptions


how to create customizing disks.

Enable ProAgent Installation


The installation of ProAgent needs to be manually activated in
JINSTALL.CUS.
Following parameter must be modified in JINSTALL.CUS:
product.PROAGENT.VERSION
Default setting: NONE - ProAgent will not be installed
To enable the ProAgent installation, the parameter value has to be
configured with the two digit minor version of ProAgent as stored on
the product CD.
Example entry in JINSTALL.CUS for ProAgent\R12.21:
product.PROAGENT.VERSION = 21

June 2015

45

Customizing Media for J/Install

J/Install Installation

Rich Client Manager Installation


The Rich Client Manager (RCM) can be used to perform transactions to a PC/E
WEB-Server via SOAP WEB Service communication.
This AddOn Product has to be installed with a separate Registration Key
together with the NDC or DDC core product.

The Rich Client Manager is supported with ProFlex only.

Please refer to ProFlex4 RichClientManager 1.2/00 User Manual for detailed


description.

46

June 2015

J/Install Installation

Creation of Installation Media

Creation of Installation Media


The Customizing Media has to be created via the "Installation Disk Manager".
The "Installation Disk Manager" automatically assembles all required files from
the product subfolder \PRONDC\R30.21 for ProCash/NDC and
\PRODDC\R30.21 for ProCash/DDC and copies them to the Customizing
Media destination. The destination can be either USB, HDD, or floppy drive. The
"Installation Disk Manager" garantees that all neccessary files are stored on the
right place on the selected destination.

Multi Vendor Installation capability


ProCash/NDC and ProCash/DDC V3.0/21 can also be installed on other
hardware vendors than Wincor Nixdorf.
The Installation of ProCash/NDC and ProCash/DDC is supported on following
hardware vendors:

Wincor Nixdorf

NCR

Diebold

DeLaRue

Nautilus Hyosung

GRG

Installation subfolders of custom/update files


The relevant files for the Customizing Media are stored in subfolder
\INSTALL\PRONDC\R30.21\CUSTOM
or
\INSTALL\PRODDC\R30.21\CUSTOM

June 2015

47

Creation of Installation Media

J/Install Installation

The Installation Disk Manager


The Installation Disk Manager (dskmanag.exe) is used to create the
Customizing media for the installation needed by J/Install. Within the main
dialog window you have to select one of the requested hardware vendor
(Wincor Nixdorf, NCR, Diebold, or others), where you want to install the
software. If no removable drives are available you can use the "Browse" button
(see description on the next page) to specify a hard disk or network directory,
where the customizing files and update file are copied to sub folder \CUSTOM
of the folder you have specified via the Installation Disk Manager.
Installation Disk Manager dialog:
Main dialog display after program start:

F1 short help infos


product depended dynamic text.
Program was called from folder
INSTALL\PRONDC\R30.21

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\R30.21. For ProCash/NDC
you have to start it from \INSTALL\PRONDC\R30.21.
See further steps on the next page ...

48

June 2015

J/Install Installation

Creation of Installation Media

The "Browse" button:


After pressing the "Browse" button the following dialog appears where you can
specify a hard disk or network directory where the customizing files will be
copied. These folders can be used during installation when J/Install is
requesting the Customizing 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.

June 2015

49

IInstallation of Terminal Protection

J/Install Installation

IInstallation of Terminal Protection


Since release 2.1/20 ProTect/One is not longer part of the installation CD.
Please refer to the documentation for the PC/E Terminal Security CD how to
install the terminal security components.

Run application as "Non Administrator" user


J/Install automatically installs ProCash/NDC - ProCash/DDC on a specific
Windows 7 or Windows XP user und group that has restricted file and registry
access.
The configuration of the application user is configurable in customizing file
JINSTALL.CUS. By default J/Install creates a new group WNUsers0 (if the
group does not exist already ), and a new user ProClassic. The password for
the user ProClassic has to be entered during the installation. For unattended
installations the password has to be set encrypted in JINSTALL.CUS.
IMPORTANT NOTE:
For security reasons we strongly advise against using default user ProClassic
and password for running ProCash/NDC and ProCash/DDC. Please follow the
PCI recommended security rules for user and password settings.

Please refer to manual J/Install User Guide section


"Operation without administrative rights (PRC section)" to get
detailed information about relevant parameters for non administrator
installations.

50

June 2015

J/Install Installation

Run application as "Non Administrator" user

Installation restriction with NCR Aptra 05.01.xx


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.

June 2015

51

Run application as "Non Administrator" user

52

June 2015

J/Install Installation

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 7, Windows XP or POSReady2009 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.

Hardware systems of other vendors


If you want to install the application on hardware of other vendors
(NCR, DIEBOLD, DELARUE, NAUTILUS, GRG), it is mandatory to install first
the vendor specific software (exp. Aptra, Agilis, etc.) before you start the
J/Install installation.

Step 1 - Windows Installation


Windows 7 + SP1 , Windows XP + SP3 or POSReady2009
If you like to install Microsoft Windows 7, Windows XP Professional or
POSReady2009 on an Embedded PC, you have to use the installation CD
provided by Wincor Nixdorf. Please refer to the installation description for
details on how to install Windows. It is highly recommended to install the latest
Microsoft security patches after the Windows installation.

June 2015

53

Step 2 - Communication Installation

Installation Steps

Step 2 - Communication Installation


Depending on the requested communication type you have to install the
physical drivers of the communication board and the protocol specific drivers.
Wincor Nixdorf uses communication boards from EICON. Please refer to the
online help on the CDs and additional handouts for detailed descriptions of the
installation and configuration settings.
For all communication types you need to install:

WAN Services for Windows (V4R2S1) (CD media)

(This CD installs the physical drivers for the EICON board)


If SNA-SDLC (SNA_LU0) or SNA-QLLC is requested you need in addition:

SNA Workstation 3.0 (CD media)

For X.25 Native and TCP/IP all drivers are included on the J/Install CD.

54

June 2015

Installation Steps

Step 3 - J/Install Installation

Step 3 - J/Install Installation


With the J/Install CD you will install all neccessary self service products which
are defined on the Customization Disk and Registration Disk.
1. After you have inserted the CD into the CDROM drive, you have to call:
AUTORUN.BAT
2. Please select one of the requested product. On the bottom a SETUP
button will appear. The installation will be started if you enter SETUP.

June 2015

55

Step 3 - J/Install Installation

Installation Steps

3. After product selection the next J/Install Dialog asks for the
Customizing Disk or Customizing folder:

Note:

56

The predefined folder C:\JINSTALL can be changed through the drive


and/or folder where your customizing files can be located.

June 2015

Installation Steps

Step 3 - J/Install Installation

4. This Dialog can be used to set specific device configurations or options


for the line communication during the installation phase. If you already
have set all required values in CUSTOM.PPF, you can ignore this dialog
where you can enable "Configuration is already prepared":

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.

This Parameter Configuration Dialog is build via a step table stored in


file DIALOG.CTL located in the customisation disk. This step table
can be tested separately with PCDialog. Refer to the J/Install user
manual for detailed descriptions how to create your own installation
dialog.

June 2015

57

Step 3 - J/Install Installation

Installation Steps

5. When J/Install has finished reading the Customizing Disk or


Customizing folder, the following dialog asks for the Registration Key
Disk(s):

Note:

58

The predefined folder C:\JINSTALL can be changed through the drive


and/or folder where your customizing files can be located.

June 2015

Installation Steps

Step 3 - J/Install Installation

6. The following dialog is optional. It instructs you to insert the Update


Disk(s) if specified in JINSTALL.CUS. Alternatively you can select a
subfolder on the harddisk or another medium where the ZIP compressed
data can be located. Make sure 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.

After J/Install has successfully finished the Installation you will see the installation finished screen. Please read the notes in the background around the
dialog window of the screen.

June 2015

59

PROEINFO installation log folder

Installation Steps

PROEINFO installation log folder


During the J/Install installation process all installation steps are stored in log file
PROEINFO.LOG, error situations are stored in PROEINFO.ERR located in
subfolder C:\PROEINFO. For detailed information about PROEINFO, please
refer to document J/Install User Guide.

If the J/Install installation fails, it is useful to provide the international


support with all files from subfolder C:\PROEINFO in addition to
SUPPORT.ZIP.

60

June 2015

Parameter Configuration Dialog

Dialog main and sub menus

Parameter Configuration Dialog


As shortly described in the previous section you can set specific parameter
values in the Parameter Configuration Dialog during the J/Install installation.
This chapter describes the main and sub submenus which can be selected
during the installation with J/Install. Refer to Abschnitt Parameters in
CUSTOM.PPF on page 63 for detailed parameter descriptions.

Dialog main and sub menus


The main menu has the following menu items:

Communication
SNA
X.25
TCPIP
Back to Main Menu

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)

June 2015

61

Dialog main and sub menus

62

Parameter Configuration Dialog

June 2015

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,
where XFS settings are defined in XFS30 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.

June 2015

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.

Program list called by the Restart Manager


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

June 2015

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 which communication framework should be started.
Parameter name: COM_FRAME
Section in *.PPF:

[STARTUP]

Valid range:

character string (path)

Value description: path location


Default value:
[1]

C:\PROTOPAS\BIN\dcSimCom.dll [1]

The default setting is the host simulator framework

Protopas provides following communication frameworks:

ComSnaSr.dll

- SNA Server with EICON Card.

ComTcpIP.dll

- TCP/IP via Ethernet card.

ComX25Ei.dll

- X.25 Native with Eicon card.

Operator panel 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\CCOpl30.DLL

June 2015

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 section Enable Triple DES operation on
page 320 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:

66

C:\PROTOPAS\BIN\CCEpp30.DLL

June 2015

Parameters in CUSTOM.PPF

[STARTUP]

Special Electronics framework


This parameter specifies the location of the Special Electronics framework
which has to be started.
Parameter name: SEL_FRAME
Section in *.PPF:

[STARTUP]

Valid range:

character string (path)

Value description: path location


Default value:

C:\PROTOPAS\BIN\CCSel30.DLL

Cash Dispenser framework


This parameter specifies the location of the Cash Dispenser framework which
has to be started.
Parameter name: CDM_FRAME
Section in *.PPF:

[STARTUP]

Valid range:

character string (path)

Value description: path location


Default value:

C:\PROTOPAS\BIN\CCCdm30.DLL;
C:\PROTOPAS\BIN\dcCdmFw.DLL

June 2015

67

[STARTUP]

Parameters in CUSTOM.PPF

Coin Dispenser framework


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

Card Reader framework


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:

68

C:\PROTOPAS\BIN\CCCard30.DLL

June 2015

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\CCJOUREX.DLL

Service Handler framework


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

June 2015

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:

70

C:\PROTOPAS\BIN\CCDATAFW.DLL

June 2015

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

June 2015

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

Message Control framework


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:

72

C:\PROTOPAS\BIN\dcMsgCFw.DLL

June 2015

Parameters in CUSTOM.PPF

[STARTUP]

Receipt Printer framework


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\CCPrt30.DLL;
C:\PROTOPAS\BIN\ndcPrtFw.DLL
Default value (DDC):C:\PROTOPAS\BIN\CCPrt30.DLL;
C:\PROTOPAS\BIN\ddcPrtFw.DLL

Journal Printer framework


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\CCPrt30.DLL;
C:\PROTOPAS\BIN\ndcPrtFw.DLL
Default value (DDC):C:\PROTOPAS\BIN\CCPrt30.DLL;
C:\PROTOPAS\BIN\ddcPrtFw.DLL
Journal Spooler activation:
To enable the Journal Spooler you have to insert the overlay framework
between the Protopas basic framework and the NDC or DDC specific printer
framework. See example entry for NDC in the following lines:
C:\PROTOPAS\BIN\CCPrt30.DLL;C:\PROTOPAS\BIN\CCJSpool.DLL;
C:\PROTOPAS\BIN\ndcPrtFw.DLL

June 2015

73

[STARTUP]

Parameters in CUSTOM.PPF

Document Printer framework


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\CCPrt30.DLL;
C:\PROTOPAS\BIN\ndcPrtFw.DLL
Default value (DDC):C:\PROTOPAS\BIN\CCPrt30.DLL;
C:\PROTOPAS\BIN\ddcPrtFw.DLL

Device Status framework


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:

74

C:\PROTOPAS\BIN\dcDevSta.DLL

June 2015

Parameters in CUSTOM.PPF

[STARTUP]

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\CCDepo30.DLL

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

June 2015

75

[STARTUP]

Parameters in CUSTOM.PPF

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

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

ProCash/XDC-SOP dialog framework


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:

76

CCSopDiaJFW@C:\Protopas\java\lib\
JVMPROPERTIES.TXT;C:\ProTopas\bin\ccsopdia.DLL

June 2015

Parameters in CUSTOM.PPF

[STARTUP]

Barcode Reader framework


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"

June 2015

77

System Restart settings of the Restart ManagerParameters in CUSTOM.PP

System Restart settings of the Restart Manager


Automatic System shut down & restart
This parameter specifies if the Restart Manager (RM) should initiate an
automatic system reboot if the application has run in a trapp situation. If the
terminal is connected to a ProAgent server this parameter needs to be enabled
if the system should be restarted via the reboot command from the ProAgent
server. If the parameter is zero (disabled), the application is just stopped (killed)
and no automatic reboot takes place.
Parameter name: SHUTDOWN_ACTIVE
Section in *.PPF:

[DEFAULT]

Valid range:

0-1

Value description: disables or enables an automatic system restart


Default value:

1" - automatic system restart option enabled

Maximum system reboots


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:

78

3"

June 2015

Parameters in CUSTOM.PPFSystem Restart settings of the Restart Mana

Power up period timer to clear actual reboot counter


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
0 - 999
Default value:

parameter ignored
number of minutes the system must run properly
before the actual reboot counter is set to zero

20" - cleares the actual reboot counter if the application


longer than 20 minutes is up.

Configurable screen during system shut down


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

June 2015

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

Character Conversion Table location


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

Following Character Conversion tables are available:


C:\PROTOPAS\CONF\CCVTABLE.FIL (ASCII-ASCII conversion default table)
C:\PROTOPAS\CONF\CCVTABLE.ASC (ASCII-ASCII conversion table)
C:\PROTOPAS\CONF\CCVTABLE.EBC (ASCII-EBCDICI conversion)

80

June 2015

Parameters in CUSTOM.PPF

[CCPROTFW1]

Messages log file location


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

Size of Messages log file


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

Append ETX character to the end of a message


This parameter is used to append/remove an ETX (03H) character for each
terminal to host and host to terminal message. Some host environments using
SNA line communication needs an ETX character at the end of the message.
Parameter name: HANDLE_ETX
Section in *.PPF:

[CCPROTFW1]

Valid range:

0, 1

Value description: 0 - do not append/remove ETX


1 - append/remove ETX
Default value:

June 2015

81

Communication

Parameters in CUSTOM.PPF

Communication
[SNA]
SNA Communication Framework
This parameter is used to specify the SNA communication framework including
the path location. This setting is stored in the Repository section of the Registry.
Parameter name: COM_FRAME
Section in *.PPF:

[STARTUP]

Valid range:

256 characters

Value description: specifies the location of the framework for the Repository
manager
Default value:

C:\PROTOPAS\BIN\ComSnaSr.dll

Strip Function Management Header (FMH)


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:

82

NO

June 2015

Parameters in CUSTOM.PPF

Communication

SNA open timer


This parameter is a duration time in seconds. In case of a LU-LU session the
meaning of this parameter depends on the setting of parameter
SENDINITSELF. If this parameter has the value YES or OTHER, parameter
OPENTIME means the maximum time within the LU-LU session must have
been opened for data exchange after the communication framework Open()
method was called. If INITSELF has the value NO, the parameter OPENTIME
means the maximum time where the SSCP-LU session has to be opened after
the Communication framework Open() method was called. The LU-LU session
for data exchange may be established sometime after termination of the Open()
method in this case. In PU case OPENTIME means the maximum waiting time
where the SSCP-PU session has to be attached from the communication
framework. The attachment succeeds if the SSCP-PU session was established.
If the OPENTIME timer expires without the establishment of the corresponding
SNA session, the Open() method returns with an error.
Parameter name: OPENTIME
Section in *.PPF:

[SNA]

Valid range:

0-255

Value description: integer value in seconds


Default value:

60

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

June 2015

83

Communication

Parameters in CUSTOM.PPF

Logical Unit Name


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

Communication response timer


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:

84

20

June 2015

Parameters in CUSTOM.PPF

Communication

Receive buffer size of project


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:

Destination Logical Unit Name


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:

June 2015

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

June 2015

Parameters in CUSTOM.PPF

Communication

[X25]
X.25 Communication Framework
This parameter is used to specify the X.25 communication framework including
the path location. This setting is stored in the Repository section of the Registry.
Parameter name: COM_FRAME
Section in *.PPF:

[STARTUP]

Valid range:

256 characters

Value description: specifies the location of the framework


Default value:

C:\PROTOPAS\BIN\ComX25Ei.dll

Number of Virtual Circuits


This parameter is used to set the maximum number of simultaneously usable
VCs. If it is omitted an internal default value of 1 is assumed. This number
should not be larger than the number of VCs that is configured by the X.25
network for this line.
Parameter name: CONTABSIZE
Section in *.PPF:

[X25]

Valid range:

1 - 255

Value description: number of usable VCs


Default value:

June 2015

87

Communication

Parameters in CUSTOM.PPF

Short hold mode time delay


This parameter is used to set a timer value in seconds for those X.25 communication 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

Waiting time for Call Accept


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:

88

20

June 2015

Parameters in CUSTOM.PPF

Communication

Waiting time for Call Request


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

Waiting time for Clear Request


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

June 2015

89

Communication

Parameters in CUSTOM.PPF

Number of calling retries to open X.25 connection


The Open method of the communication framework tries at maximum many
times to open the X.25 connection than the value of CALLRETRY indicates. If
there was no connection established on all tries an error is reported. The value
can be a maximum of 5 times. If the value is greater, it is reset to 5.
Parameter name: CALLRETRY
Section in *.PPF:

[X25]

Valid range:

0-5

Value description: integer time value


Default value:

Calling delay timer


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

Receive buffer size


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:

90

2048

June 2015

Parameters in CUSTOM.PPF

Communication

X.25 connection index


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:

Type of Virtual Circuit


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

June 2015

91

Communication

Parameters in CUSTOM.PPF

Suppress TLS trace output


This parameter is used to suppress the TLS trace.
Parameter name: NOTRACE
Section in *.PPF:

[X25_PROJECT]

Valid range:

0, 1

Value description: 0 - trace output is on, 1 - trace output is off


Default value:

Buffer size in send direction


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

Buffer size in receive direction


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:

92

2048

June 2015

Parameters in CUSTOM.PPF

Communication

Permanent Virtual Circuit (PVC) number


This parameter is used to set the PVC number if a PVC connection is
configured. The number has to concur with the PVC number setting on the
EICON card. The EICON card settings can be viewed with the EICON card
support software.
Parameter name: PVCNO
Section in *.PPF:

[X25_PROJECT]

Valid range:

0-255

Value description: integer value


Default value:

Delivery control for send and receive direction


This parameter can be used to activate a so called Delivery Procedure. If the
X.25 network supports this procedure, every X.25 data packet is acknowledged
by the remote DCE (that is the X.25 network node where the remote DTE is
connected to) instead of the local DCE (that is the X.25 network node where the
local DTE is connected to). This guarantees, that the data was transported
correctly through the X.25 network but not (!) that it was processed correctly by
the remote DTE.
Parameter name: D_BIT_PROC
Section in *.PPF:

[X25_PROJECT]

Valid range:

0, 1

Value description: 0 - no delivery control, 1 - delivery control active


Default value:

June 2015

93

Communication

Parameters in CUSTOM.PPF

Activate Short Hold Mode


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:

Short Hold Mode passive configuration


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 communication 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:

94

June 2015

Parameters in CUSTOM.PPF

Communication

Start Short Hold Mode passive connection


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:

Connection reconnect
This parameter can be used to define how the communication framework
behaves if a CALL CLEAR packet is received while data is sent. If the value is
0, an error is returned in the Send() method. If the value is 1, it is tried to
reestablish the VC without error reporting to the communication framework user
by the return code of the Send() method. This parameter is used only in SVC
connections.
Parameter name: SEND_RECONNECT
Section in *.PPF:

[X25_PROJECT]

Valid range:

0, 1

Value description: 0 - reconnect is on, 1 - no reconnect


Default value:

June 2015

95

Communication

Parameters in CUSTOM.PPF

Diagnostic code setting for SHM clear cause


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

Closed user group selection


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:

96

100 - no closed user group defined

June 2015

Parameters in CUSTOM.PPF

Communication

Closed user group outgoing call assignment


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

Add Reversed Charging Facility to Call Request packets


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

June 2015

97

Communication

Parameters in CUSTOM.PPF

Accept Reversed Charging Facility of incoming calls


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

Add Call User Data to Call Request packets


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:

98

00 00 00 00 - no user data

June 2015

Parameters in CUSTOM.PPF

Communication

Check Call User Data of incoming calls


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

Local station address


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:

June 2015

99

Communication

Parameters in CUSTOM.PPF

Remote station (host) address


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]

100

x represents the remote address number from 1 up to 5.

June 2015

Parameters in CUSTOM.PPF

Communication

[TCPIP]
TCP/IP Communication Framework
This parameter is used to specify the TCP/IP communication framework
inclusive of the path location.
Parameter name: COM_FRAME
Section in *.PPF:

[STARTUP]

Valid range:

256 characters

Value description: specifies the location of the framework


Default value:

C:\PROTOPAS\BIN\ComTcpIp.dll

Remote station (host) address


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

June 2015

101

Communication

Parameters in CUSTOM.PPF

TCP port number


This parameter is needed to specify the remote destination TCP port.
Applications above the TCP/IP protocol stack that use TCP communication are
identified by their TCP port. This is a WORD sized number that has to be unique
for every application using the TCP layer. For a successful communication both
client and server have to use the same port number. The port value should be
greater than 1024 because ports below could be reserved for the so-called well
known ports that are assigned to specific protocols for applications like telnet,
ftp or smtp.
Parameter name: PORTNUMBER
Section in *.PPF:

[TCPIP_PROJECT]

Valid range:

00000 - 99999

Value description: 5 digit port number


Default value:

99999

Keep Alive mode


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:

102

YES

June 2015

Parameters in CUSTOM.PPF

Communication

TCP/IP open timer


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:

June 2015

103

Communication

Parameters in CUSTOM.PPF

Send timeout timer


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

Close timeout timer


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

Local port address configuration


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:

104

not set in registry and CUSTOM.PPF

June 2015

Parameters in CUSTOM.PPF

Communication

Coding DLL location


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:

ProCash/NDC-DDC provides following coding DLLs:

dcTcp2H.dll - to be used if the TCP/IP stream has a 2 Bytes binary


header to specify the length of the packet excluding the header length.

dcTcp4A.dll - to be used if the TCP/IP stream has a 4 Bytes ASCII header


to specify the length of the packet excluding the header length.

dcTcp4AI.dll - to be used if the TCP/IP stream has a 4 Bytes ASCII


header to specify the length of the packet including the header length.

dcTcp2HI.dll - to be used if the TCP/IP stream has a 2 Bytes binary


header to specify the length of the packet including the header length.

ccTcpEds.dll - to be used if no header is required in both directions.

June 2015

105

Communication

Parameters in CUSTOM.PPF

Size of memory blocks need to allocate


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:

106

8200

June 2015

Parameters in CUSTOM.PPF

Communication

TCP/IP parameters used by Windows


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
Parameter name: KeepAliveTime
Valid range:

00000000-FFFFFFFF in milliseconds (REG_DWORD)

Value description: This parameter controls how often TCP attempts to verify
that an idle connection is still intact by sending a keep alive
packet. If the remote system is still reachable and
functioning, it will acknowledge the keep alive transmission.
Default value:

This parameter is not set in the registry by default.


The default value used by Windows is set to:
7200000 (two hours)

TcpKeepTries
Parameter name: TcpKeepTries
Valid range:

Number (REG_DWORD)

Value description: Specifies the maximum number of times that TCP/IP will
attempt to deliver keep-alive traffic before marking a
connection as down.
Default value:

This parameter is not set in the registry by default.


The default value used by Windows is set to 20 tries.

June 2015

107

Communication

Parameters in CUSTOM.PPF

TcpKeepCnt
Parameter name: TcpKeepCnt
Valid range:

Number in seconds (REG_DWORD)

Value description: Specifies how often TCP/IP will generate keep-alive traffic.
When TCP/IP determines that no activity has occurred on
the connection within the specified time, it generates
keep-alive traffic to probe the connection.
After trying TcpKeepTries number of times to deliver the
keep-alive traffic without success, it marks the connection
as down.
Default value:

This parameter is not set in the registry by default.


The default value used by Windows is 20 attempts.

KeepAliveInterval
Parameter name: KeepAliveInterval
Valid range:

Number in milliseconds (REG_DWORD)

Value description: This parameter determines the interval separating keep


alive retransmissions until a response is received. Once a
response has been received, the delay until the next keep
alive transmission is again controlled by the value of
KeepAliveTime. The connection will be end after the
number of retransmissions specified by
TcpMaxDataRetransmissions were unanswered.
Default value:

This parameter is not set in the registry by default.


The default value used by Windows is 1 second.

Please see description for parameter "TcpMaxDataRetransmissions"


on the following page.

108

June 2015

Parameters in CUSTOM.PPF

Communication

TcpMaxDataRetransmissions
Parameter name: TcpMaxDataRetransmissions
Valid range:

Number in milliseconds (REG_DWORD)

Value description: This parameter controls the number of times TCP will
retransmit an individual data segment (non connect
segment) before ending the connection. The retransmission
timeout is doubled with each successive retransmission on
a connection. It is reset when responses resume. The base
timeout value is dynamically determined by the measured
round-trip time on the connection.
Default value:

This parameter is not set in the registry by default.


The default value used by Windows is 5 times.

Example configuration in Windows registry:


[HKEY_LOCAL_MACHINE\
SYSTEM\CurrentControlSet\Services\Tcpip\Parameters]
"KeepAliveTime"=dword:00003a98
"TcpKeepTries"=dword:0000000a
"TcpKeepCnt"=dword:0000000a
"TcpMaxDataRetransmissions"=dword:0000000a
"KeepAliveInterval"=dword:00003a98
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.

June 2015

109

Communication

Parameters in CUSTOM.PPF

[SSL_PROJECT]
The following parameters can be set in CUSTOM.PFF under section
[SSL_PROJECT].

For detailed descriptions of SSL configuration and additional parameters which


are not defined via PARAC, refer to manual:
ProTopas Host Protocol and Communication Frameworks Programming Guide
Version 5.0/00

Remote station (host) address


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"

110

June 2015

Parameters in CUSTOM.PPF

Communication

SSL port number


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

SSL Coding DLL location


This is the absolute pathname of the DLL that processes the conversion
between the bytestream 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 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:

June 2015

111

Communication

Parameters in CUSTOM.PPF

SSL Protocols
This optional comma separated parameter specifies the protocol versions in
order to enable them for the use of the connection. The default value is
"Default". If this parameter does not exist or you use the default value, the client
and the host will negotiate a protocol for the connection.
Parameter name: PROTOCOLS
Section in *.PPF:

[SSL_PROJECT]

Valid range:
Value description: The following table lists the valid protocol values:

Default value:

SSLv3
TLSv1
TLSv1.1
TLSv1.2
TCPIP
Default

SSL version 3 protocol


TLS version 1 protocol
TLS version 1.1 protocol
TLS version 1.2 protocol
pure TCPIP connection (no encryption!)

It is strongly advised to use at least strong encryption with TLSv1.2 or


higher.
SSL Message length
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:

112

8000

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_PARAMETER]

[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.

Optional Parameters (NDC)


These parameters contain NDC specific customization parameters which can
be downloaded from the host through the Enhanced Customization Table load
command.
Parameter names: PARAMETER_XX [1]
Section in *.PPF:

[LYNXCI_PARAMETER]

Valid range:

0 - 255

Value description: Option Code bits for each Option Number


Default value:
[1]

see table 5 on the next page.

XX represents the two digit Option Number in table 5.

June 2015

113

Optional Parameters (NDC)

Parameters in CUSTOM.PPF

Table 5: Optional Parameters (NDC)


Option
number

Option
code

00

Camera Control (not supported)

01

02

Description

Ready/Supply options
000

No options selected

001

Separate READY (B) status sent in response to Transaction Reply

002

Auto return to previous mode from supply mode

008

12 digit amount buffer

002

Auto voice (not supported) default off

03

Date format for supervisor/journal messages


001

MMDD(YY) (default condition)

002

DDMM(YY)

003

(YY)MMDD

004

(YY)DDMM

04

001-040

Roll width (Defines the number of receipt and journal columns used to print
messages from the host. Default for NDC = 040 and for DDC = 099)

05

001-040

Left print column (Defines the leftmost print column for receipt and journal
messages. Default is 001)

06

Vandal Guard Open Condition


000
001

07

Open vandal guard when card detected (default condition)


Open vandal guard when keyboard is enabled
Track 1 format

001

ISO format (default condition)

002

VISA format

003

????

004

????

08

Reserved for future use

09

Diebold status reporting for vandal guard (not supported)

10

Tamper Indicator Control option (not supported)

11

Extended status control (not supported)

12

Specific Command Reject option)


000

13

Do not transmit Specific Command Reject (default condition)

001

Transmit Specific Command Reject

001-255

Card reader error thresholds (Default value is 010)

14

Track 3 write error thresholds

15-22

Codes reserved for future use

23

Envelope dispener status option


000
001

24-30

Send unsolicited envelope dispenser messages


Codes reserved for future use

31

114

Do not send unsolicited dispenser messages (default condition)

Enable Audio Echo on Keyboard


000

Do not echo the keyboard (default condition)

001

Echo the keyboard, except in PIN states or * is pressed

June 2015

Parameters in CUSTOM.PPF

32-33

Codes reserved for future use

34

Message Coordination Number range


000
001

50-99

Optional Parameters (NDC)

31H-3FH (default condition)


31H-7EH
Codes reserved for ATM/E private use

June 2015

115

Miscellaneous Features I (DDC)

Parameters in CUSTOM.PPF

Miscellaneous Features I (DDC)


This parameter contains DDC specific customization options which can be
downloaded from the host through Write Command III (Customization Table
load).
Parameter names: PARAMETER_01
Section in *.PPF:

[LYNXCI_PARAMETER]

Valid range:

0 - 255

Value description: The value of this parameter represents the activated bits of
the Miscellaneous Features I. (See table 6 for available
options).
Default value:

Table 6: Miscellaneous Features I (DDC)


BIT

Description

128

Append rollover counts

64

Decimal Style

32

Deposit cancel status bit [1]

16

Dollar decimal places

Dollar buffer size ( if enabled 12 digits instead of 8 )

Fault status bit [1]

Automatic return to previous mode

Separate ready response

[1]

116

These options are not supported or neccessary to set by ProCash/DDC.

June 2015

Parameters in CUSTOM.PPF

Miscellaneous Features II (DDC)

Miscellaneous Features II (DDC)


This parameter contains the second part of DDC specific customization options
which can be downloaded from the host through Write Command III.
Parameter names: PARAMETER_100
Section in *.PPF:

[LYNXCI_PARAMETER]

Valid range:

0 - 255

Value description: The value of this parameter represents the activated bits of
the Miscellaneous Features II. (See table 7 for available
options).
Default value:

Table 7: Miscellaneous Features II (DDC)


BIT

Description

128

Reserved

64

Reject Reason codes to network

32

Send MDS status to network

16

Send Maintanance Mode log to network [1]

Change MMD mispick timer from 2 minutes to 30 seconds [1]

Send Expanded Hardware Configuration status [1]

Reserved

Reserved

[1]

These options are not supported or neccessary to set by ProCash/DDC.

June 2015

117

Miscellaneous Features III (DDC)

Parameters in CUSTOM.PPF

Miscellaneous Features III (DDC)


This parameter contains the third part of DDC specific customization options
which can be downloaded from the host through Write Command III.
Parameter names: PARAMETER_101
Section in *.PPF:

[LYNXCI_PARAMETER]

Valid range:

0 - 255

Value description: The value of this parameter represents the activated bits of
the Miscellaneous Features II. (See table 8 for available
options).
Default value:

Table 8: Miscellaneous Features III (DDC)


BIT

Description

128

Reserved [1]

64

Transaction verification status

32

No retract [1]

16

Send all status [1]

Message sequence number in solicited status [1]

Extended range for message coordination number field [1]

Doubling timer 03 feature [1]

Double Expanded hardware configuration status [1]

[1]

118

These options are not supported or neccessary to set by ProCash/DDC.

June 2015

Parameters in CUSTOM.PPF

Logical Unit Number (LUNO)

Logical Unit Number (LUNO)


This parameter contains the three digit Logical Unit Number which is included
in host and terminal messages.
Parameter name: LUNO
Section in *.PPF:

[LYNXCI_PARAMETER]

Valid range:

000-999

Value description: three digit LUNO


Default value:

000

Configuration Identification (Config ID)


This parameter contains the four digit Config ID. Typically the Config ID will be
set through the Config ID load command from the host after a successful
Customization Image (CI) download. At the first connection between the ATM
and the host the Config ID is 0000 which indicates an empty configuration. In
general a 0000 Config ID forces a CI download from the host.
Parameter name: CONFIG_ID
Section in *.PPF:

[LYNXCI_PARAMETER]

Valid range:

0000-9999

Value description: four digit Config ID


Default value:

0000 - No CI present

June 2015

119

[LYNXCI_TIMER]

Parameters in CUSTOM.PPF

[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.

Keyboard response time (Timer 00)


Number of seconds allowed for the client to make a keyboard entry.
Parameter name: TIMER_00
Section in *.PPF:

[LYNXCI_TIMER]

Valid range:

0-255

Value description: number of seconds, 0 - infinity


Default value:

30

Additional time (Timer 01)


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:

120

30

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_TIMER]

Close state time delay (Timer 02)


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:

Communication response time (Timer 03)


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

Envelope insertion time (Timer 04)


Number of seconds allowed for the client to insert an envelope.
Parameter name: TIMER_04
Section in *.PPF:

[LYNXCI_TIMER]

Valid range:

0-255

Value description: number of seconds, 0 - infinity


Default value:

50

June 2015

121

[LYNXCI_TIMER]

Parameters in CUSTOM.PPF

Cash retract time-out ( Timer 05)


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

Poll/select time (Timer 06)


Number of seconds allowed for the terminal to respond to a poll or select
sequence received from the host.
Parameter name: TIMER_06
Section in *.PPF:

[LYNXCI_TIMER]

Valid range:

0-255

Value description: not used by ProCash/NDC-DDC


Default value:

60

Take cash time (Timer 07)


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:

122

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_TIMER]

Card capture time (Timer 09)


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

Additional cash present time (Timer 10)


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:

Document/Envelope present timeout (Timer 94)


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

June 2015

123

[LYNXCI_TIMER]

Parameters in CUSTOM.PPF

Statement retract (Timer 95)


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

Statement present (Timer 96)


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:

Vandal guard close (Timer 98)


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:

124

10

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_TIMER]

Vandal guard close time (Timer 99)


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:

Table 9: SUnsupported timers by ProCash/NDC-DDC


Timer

Description

Protocol

06

Communication message timeout (Poll select timeout)

NDC/DDC

15

Card Reader enabled timer

DDC

18

Swipe or DIP Card Reader error screen timer

DDC

22

Not used

DDC

23

Dip Card Reader prompt for removal timer

DDC

86

Rear Settlement timeout

NDC

87

DPM document captured screen timeout

NDC

88

Reserved

NDC

89

Reserved

NDC

90

Reserved

NDC

91

EJ inspection timeout

NDC

92

SOH/TM-Alert cyclial display timeout

NDC

93

SOH/TM-Alert next/previous timeout

NDC

97

Door access open timeout

NDC

June 2015

125

[LYNXCI_SCREEN]

Parameters in CUSTOM.PPF

[LYNXCI_SCREEN]
Screen default foreground color
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) components 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

RED

GREEN

BLUE

COLOR

black

170

dark blue

170

dark green

170

170

dark cyan

170

dark red

170

170

dark magenta

170

85

dark yellow

170

170

170

light grey

85

85

85

dark grey

85

85

255

light blue

85

255

85

light green

85

255

255

light cyan

255

85

85

light red

255

85

255

light magenta

255

255

85

light yellow

255

255

255

white

126

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_SCREEN]

Screen default background color


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) components 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

Screen transparent mode


This parameter activates transparent mode for every screen by default. Transparent 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:

June 2015

127

[LYNXCI_SCREEN]

Parameters in CUSTOM.PPF

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:

128

1000 - 1 second

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_SCREEN]

Graphic file location


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.
The following table describes which kind of picture controls can be
configured via parameter PICTURE_XXXX:

Table 11: Screen parameters reference table


Protocol

Description

Screen
Sequence

Parameter Name

NDC

Picture Control

\1bP2999\1b\ PICTURE_2999

NDC

Picture Control

\1bP299\1b\

NDC

Picture Control

\1bP29\1b\

PICTURE_29

NDC

Logo Control

\1bP199\1b\

PICTURE_199

DDC

Animation

\1bA1002004 PICTURE_100; (101, 102)

DDC

Display Icon

\1bP9990

PICTURE_999

DDC

Select DAC

\1bO999

PALETTE_999

PICTURE_299

June 2015

129

[LYNXCI_SCREEN]

Parameters in CUSTOM.PPF

Configure MacroMedia Flash Animations


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

path location of the Flash file

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

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

Specifies the window name (case sensitive) of the Flash movie.


Default if not specified: ShockwaveFlash

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

reserved

file name of the Flash movie inclusive .EXE extension

Default value:

not specified

Example:

"C:\PROTOPAS\BITMAPS,650,,,,,010.exe

[1]

XXXX represents the graphic number which is defined in the downloaded screen. The number can
represent icons, logos, or picture sequences. See also section Graphic file location on page 129.

130

June 2015

Parameters in CUSTOM.PPF
Note:

[LYNXCI_SCREEN]

If you stop the application without rebooting the system,


you have to kill a running flash movie separately.
Please add following lines in FWKILL.BAT:
c:\protopas\tools\kilflash.exe > c:\protopas\kilflash.bat
call kilflash.bat

June 2015

131

[LYNXCI_SCREEN]

Parameters in CUSTOM.PPF

Palette file location


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.

ProCash/DDC provides following default DAC files:

DAC000.DAT - contains the default color palette

DAC001.DAT - contains color black.

132

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_SCREEN]

Character Width screen global


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

Character Height screen global


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

Screen horizontal offset


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:

June 2015

133

[LYNXCI_SCREEN]

Parameters in CUSTOM.PPF

Screen vertical offset


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:

Screen background picture


This parameter can be used to specify a full screen graphic as a background
picture with the mixture of screen contents which is displayed in all screens. If
the background picture is smaller than the screen size, the picture is stretched
to full screen.
Parameter name: PICTURE_BACKGROUND
Section in *.PPF:

[LYNXCI_SCREEN]

Valid range:

character string (valid path)

Value description: path location of the graphic file


Default value:

""

Example:

"C:\PROTOPAS\BITMAPS\EXAMPLE.PCX"

134

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_SCREEN]

Play videos in full screen mode


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
Default value:

not configured in Registry

ESC substitution character


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


Default value:

not configured

June 2015

135

[LYNXCI_SCREEN]

Parameters in CUSTOM.PPF

Graphic and Video file extension mapping


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_PCX
PICTURE_EXT_DDU
PICTURE_EXT_MOV
PICTURE_EXT_FLI
PICTURE_EXT_TIF
PICTURE_EXT_JPG
PICTURE_EXT_BMP

PICTURE_EXT_DAT
PICTURE_EXT_PCC
PICTURE_EXT_AVI
PICTURE_EXT_FLC
PICTURE_EXT_GIF
PICTURE_EXT_MPEG
PICTURE_EXT_MPG

Section in *.PPF:

[LYNXCI_SCREEN]

Parameters:

character string (valid file extension),display method

Value description: The first parameter specifies a graphic or video file


extension that should be processed instead of the
extension specified in the host download or specified via
param. PICTURE_BACKGROUND or PICTURE_XXXX.
The second parameter specifies the display method:
0 - use Presentation Framework of Protopas for Bitmaps
1 - use CCMCIPLY.EXE to play Videos repeatedly
3 - use CCMCIPLY.EXE to play Videos once
Default value:

not configured in Registry

Example:

The following parameter setting assigns a FLC extension to


an AVI extension using display method of CCMCIPLY.EXE
to play videos repeatedly:
PICTURE_EXT_FLC = "AVI,1"

136

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_SCREEN]

Stop Video after screen delay sequence (NDC only)


This parameter can be used to configure whether videos (AVIs or MPGs)
should be terminated after the elapsed delay time specified via a screen delay
control sequence (ESC[dddz) or if the AVi should play further as long as no new
screen is called.
Parameter name: STOP_VIDEO_AFTER_DELAY
Section in *.PPF:

[LYNXCI_SCREEN]

Valid range:

0, 1

Value description: 0 - Play AVI infinite


1 - Stop AVI after delay as specified in the screen
Default value:

not configured in Registry

Touch zone support in PIN entry dialogs (EPP only)


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
Default value:

not configured in Registry

On Wincor Nixdorf ATMs this parameter works only if EPP hardware


is installed or EDS is in use.

June 2015

137

[LYNXCI_SCREEN]

Parameters in CUSTOM.PPF

Assign "Confirm" FDK in PIN entry dialogs (EDM only)


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

Configure default Audio path for NDC


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.

138

June 2015

Parameters in CUSTOM.PPF

[LYNXCI_SCREEN]

Configure default Audio path for DDC


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.

Configurable substitution character on display


This parameter can be used to exchange the substitution character of customer
input characters in the PIN entry and Information Entry states. By default the
customer input on the screen appears as X characters in the PIN entry state.
If you like to exchange the X against a * (star) character, you can specify a star
character in the following parameter.
Parameter name: SUBST_CHAR_SCREEN
Section in *.PPF:

[LYNXCI_SCREEN]

Valid range:

one character input in range 0x20H - 0x7FH

Value description: specifies the substitution character in PIN entry and


Information Entry states
Default value:

not configured in Registry, use X as substitution character

Example entry:

SUBST_CHAR_SCREEN = *

June 2015

139

[LYNXCI_SCREEN]

Parameters in CUSTOM.PPF

Specific supervisor mode screen


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.

Configure number of PIN digits


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:

140

not configured in registry

June 2015

Parameters in CUSTOM.PPF

[SCREEN_XXX] [1]

[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.

June 2015

141

[SCREEN_XXX] [1]

Parameters in CUSTOM.PPF

Screen idle next screen


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

Screen idle time


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:

142

-1 - no time

June 2015

Parameters in CUSTOM.PPF

[SCREEN_XXX] [1]

Character Width screen specific


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.

Character Height screen specific


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 should be set in CUSTOM.PPF only if no screen contents are
downloaded from host. You can use this parameter just in case if you like to
configure a screen locally that is not downloaded from host.
Parameter name: SCREEN_CONTENTS
Section in *.PPF:

[SCREEN_XXX]

Valid range:

valid ASCII screen sequences (NDC or DDC specific)

Value description: contains screen contents to be displayed


Default value:

not set in Registry

June 2015

143

[SCREEN_XXX] [1]

Parameters in CUSTOM.PPF

Screen horizontal offset


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:

Screen vertical offset


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:

144

June 2015

Parameters in CUSTOM.PPF

[SCREEN_XXX] [1]

Screen transparent mode


This parameter is used to set transparent mode for a specific downloaded
screen.
Parameter name: TRANSPARENT_MODE
Section in *.PPF:

[SCREEN_XXX]

Valid range:

0-1

Value description: 0 - no; 1 - yes


Default value:

0 - no

Screen background picture


This parameter can be used to specify a full screen graphic as a background
picture with the mixture of screen contents of a specific downloaded screen or
as a picture instead of screen contents which are downloaded from host.
Parameter name: PICTURE_BACKGROUND
Section in *.PPF:

[SCREEN_XXX]

Valid range:

character string (valid path)

Value description: path location of the graphic file


Default value:

""

Example:

"C:\PROTOPAS\BITMAPS\EXAMPLE.PCX"

June 2015

145

[SCREEN_XXX] [1]

Parameters in CUSTOM.PPF

Screen display contents


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

Set Curser position for consumer inputs locally


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.
Upper left offset of the input rectangle
Parameter name: INPUT_FIELD_LEFT
Section in *.PPF:

[SCREEN_XXX]

Valid range:

0-9999 (pixel)

Value description: Specifies the left offset of the upper left corner of the
input rectangle.
Default value:

146

not used (remarked)

June 2015

Parameters in CUSTOM.PPF

[SCREEN_XXX] [1]

Upper top offset of the input rectangle


Parameter name: INPUT_FIELD_TOP
Section in *.PPF:

[SCREEN_XXX]

Valid range:

0-9999 (pixel)

Value description: Specifies the top offset of the upper left corner of the
input rectangle.
Default value:

not used (remarked)

Lower right offset of the input rectangle


Parameter name: INPUT_FIELD_RIGHT
Section in *.PPF:

[SCREEN_XXX]

Valid range:

0-9999 (pixel)

Value description: Specifies the right offset of the lower right corner of the
input rectangle.
Default value:

not used (remarked)

Lower bottom offset of the input rectangle


Parameter name: INPUT_FIELD_BOTTOM
Section in *.PPF:

[SCREEN_XXX]

Valid range:

0-9999 (pixel)

Value description: Specifies the bottom offset of the lower right corner of the
input rectangle.
Default value:

not used (remarked)

June 2015

147

[SCREEN_XXX] [1]

Parameters in CUSTOM.PPF

Input adjustment
This parameter controls the character adjustment of the consumer input.
Parameter name: INPUT_FIELD_ADJUST
Section in *.PPF:

[SCREEN_XXX]

Valid range:

0, 1, 2

Value description: 0 - character input from left to right


1 - character input from right to left
3 - character input centered, characters are moving to right
and to left
Default value:

not used (remarked)

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.

148

June 2015

Parameters in CUSTOM.PPFLanguage bank screen parameters (DDC onl

Language bank screen parameters (DDC only)


The following table lists all local parameters that can be used in language
specific screen bank sub sections (BANK_001, BANK_002, etc.). Those screen
sub sections are created if in the screen download the ESCLxxx (set language
bank) sequence is downloaded by the host.
Table 12: Parameters supported in language banks (DDC only)

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".

Parameters needed in language bank sub sections can not be


configured in CUSTOM.PPF used by PARAC.
Please use the way via creating an *.INA file. See also
section Vendor and AddOn depended configuration on page 294.

June 2015

149

[TOP_MSG] and [CUST_MSG]

Parameters in CUSTOM.PPF

[TOP_MSG] and [CUST_MSG]


Event and Error message definitions
Parameters of section [TOP_MSG] contain formats, variables and text
messages which are transferred to the destinations defined in parameter
DESTXXXX. Electronic journal files are stored by default in directory
C:\JOURNAL as defined with parameter TOP_JOURNAL_PATH. Electronic
journal files defined in section [CUST_MSG] are stored by default in directory
C:\CUSTOMER as defined with parameter CUST_JOURNAL_PATH. The
advantage of this two parallel journal sections is that you can filter the journal
messages. You can decide which message should be stored to the JOURNAL,
and which message should be stored to the CUSTOMER path.
Parameter name: MSGXXXX [1]
Sections in *.PPF: [TOP_MSG] and [CUST_MSG]
Valid range:

ASCII string (max. 128 characters)

Value description: Defines the message string for the journal printer
Default value:

[1]

150

see definitions in CUSTOM.PPF

XXXX represents a fixed four digit definition number which is related to


the error map table (CCErrMap) together with DESTXXXX.

June 2015

Parameters in CUSTOM.PPF

[TOP_MSG] and [CUST_MSG]

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
Variable

Description

Output format

@2

prints the current day in two integer digits

dd

@3

prints the current month in two integer digits

mm

@4

prints the current year in four integer digits

yyyy

@5

prints the current time

hh:mm:ss

@6

Inserts a three digit security number (000-999) ddd

#NL#

macro - initiates a new line

$XXX$

defines a variable name from the variable


framework (ccvarfw.dll)

variable

%XXX%

defines a variable name from the data


dictonary framework (ccdatdic.dll) if it is
loaded via FwLoadPM.exe

variable

June 2015

151

[TOP_MSG] and [CUST_MSG]

Parameters in CUSTOM.PPF

Event and Error message destination


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:
Bit Value Description
0

none

journal file

journal printer

journal event with journal data

reserved

32

journal events for data monitoring (ProAgent)

Default value:
[1]

152

see entries in CUSTOM.PPF

XXXX represents a fixed four digit definition number which is related to


the error map table (CCERRMAP) together with MSGXXXX.

June 2015

Parameters in CUSTOM.PPF

[HARDWARE_CONFIGURATION]

[HARDWARE_CONFIGURATION]
Hardware Configuration Parameters (NDC)
The following table describes the hardware device configuration which is sent
in the NDC solicited status message Send Configuration Information.
Table 14: Hardware Configuration Parameters (NDC)
Parameter

Description

Default Value

HW_CONF_0_PROD_CLASS

Product Class

11

HW_CONF_1_NOCONFIG

No Configuration

7F

HW_CONF_2_DISK

System Disk

00

HW_CONF_3_CARD_READER

Card Reader/Writer

03

HW_CONF_4_CASH_HANDLER

Cash Handler

01

HW_CONF_5_DEPOSIT

Depository

02 [1]

HW_CONF_6_REC_PRINTER

Receipt Printer

01 [1]

HW_CONF_7_JRN_PRINTER

Journal Printer

01 [1]

HW_CONF_8_RESERVED

Reserved

00

HW_CONF_9_RESERVED

Reserved

00

HW_CONF_10_NIGHT_DEPOSIT

Night Safe Depository

00

HW_CONF_11_ENCRYPTOR

Encryptor

01

HW_CONF_12_CAMERA

Security Camera

00

HW_CONF_13_DOOR_ACCESS

Door Access

00

HW_CONF_14_FLEX_DISK

Flex Disk

00

HW_CONF_15_TAMPER_BINS

Tamper Indicating Bins

00

HW_CONF_16_CARDHOLDER_KEYB

Cardholder Keyboard

00

HW_CONF_17_OPERATOR_KEYB

Operator Keyboard

00

HW_CONF_18_DISPLAY_VOICE

Cardholder Display/Voice

02

HW_CONF_19_NOCONFIG

No Configuration

7F

HW_CONF_20_NOCONFIG

No Configuration

7F

HW_CONF_21_STATEMENT_PRT

Statement Printer

7F [1]

HW_CONF_22_SIG_DISPLAY

Signage Display

HW_CONF_23_RESERVED

Reserved

HW_CONF_24_COIN_DISP

Coin Dispenser

HW_CONF_25_SYSTEM_DISPLAY

System Display

HW_CONF_26_MED_ENT_IND

Media Entry Indicators

June 2015

153

[HARDWARE_CONFIGURATION]

Parameters in CUSTOM.PPF

HW_CONF_27_ENV_DISP

Envelope Dispenser

HW_CONF_28_DOC_PROC_MOD

Document Processing Module

HW_CONF_29_COIN_TAMP_IND

Coin Tamper Indication

HW_CONF_30_DOC_TAMP_IND

Document Tamper Indication

HW_CONF_31_RESERVED

Reserved

HW_CONF_32_DIG_AUDIO_SERV

Digital Audio Service

HW_CONF_33_RESERVED

Reserved

HW_CONF_34_RESERVED

Reserved

HW_CONF_34_BNA_CASH

Bunch Note Acceptor

HW_CONF_35_CPM_CHEQUE

Cheque Processing Module

HW_CONF_37_RESERVED

Reserved

[1] - Depending on the available hardware, this value will be modified by utility
"SETHWPPF.EXE" during installation.

Unsol./Sol. message logging on journal


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:

154

June 2015

Parameters in CUSTOM.PPF

[HARDWARE_CONFIGURATION]

Expanded Hardware Configuration Parameters (DDC)


The following table describes the hardware device configuration which is sent
in the DDC solicited status message Send Configuration Information.
See ProCash/DDC User Guide section Expanded Hardware Configuration
and Double Expanded Hardware Configuration for detailed description of the
optional bits for each parameter.
Table 15: Hardware Configuration Parameters (DDC)
Parameter

Default Parameter
Value

Default
Value

EXPANDED_HW_CONF_BYTE_0 02

EXPANDED_HW_CONF_BYTE_10

see Note1

EXPANDED_HW_CONF_BYTE_1 00

EXPANDED_HW_CONF_BYTE_11

00

EXPANDED_HW_CONF_BYTE_2 00 [1]

EXPANDED_HW_CONF_BYTE_12

00

EXPANDED_HW_CONF_BYTE_3 00

EXPANDED_HW_CONF_BYTE_13

00

EXPANDED_HW_CONF_BYTE_4 00

EXPANDED_HW_CONF_BYTE_14

00

EXPANDED_HW_CONF_BYTE_5 00

EXPANDED_HW_CONF_BYTE_15

00

EXPANDED_HW_CONF_BYTE_6 00

DOUBLE_EXPANDED_HW_CONF_BYTE_16 00

EXPANDED_HW_CONF_BYTE_7 00 [1]

DOUBLE_EXPANDED_HW_CONF_BYTE_17 00

EXPANDED_HW_CONF_BYTE_8 00

DOUBLE_EXPANDED_HW_CONF_BYTE_18 00

EXPANDED_HW_CONF_BYTE_9 28

[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

36H

3CH

<

31H

37H

3DH

32H

38H

3EH

>

33H

39H

3FH

34H

3AH

35H

3BH

June 2015

155

[HARDWARE_CONFIGURATION]

Parameters in CUSTOM.PPF

MACing configuration
Send TVN and MAC in Transaction Request messages
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

Check 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

Send Machine Number


This parameter is used to set if the Machine Number (Security Terminal
Number) has to be sent in terminal to host messages.
Parameter name: SEND_MACHINE_NO
Section in *.PPF:

[HARDWARE_CONFIGURATION]

Valid range:

0-1

Value description: 0 - do not send the Machine number


1 - include the Machine number in the messages
Default value:
156

0 - do not send the Machine Number


June 2015

Parameters in CUSTOM.PPF

[HARDWARE_CONFIGURATION]

Check Machine Number


This parameter is used to set if the Machine Number (Security Terminal
Number) has to be checked in Transaction Reply messages.
Parameter name: CHECK_MACHINE_NO
Section in *.PPF:

[HARDWARE_CONFIGURATION]

Valid range:

0-1

Value description: 0 - do not check the Machine number


1 - check the Machine number
Default value:

0 - do not check the Machine Number

Send TVN and MAC in solicited status


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

Field selected MACing


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)

June 2015

157

[HARDWARE_CONFIGURATION]

Parameters in CUSTOM.PPF

ASCII MACing activation in EBCDIC line environments


This parameter is used to force MACing calculation in ASCII. This parameter is
only needed if the line communication is EBCDIC and the MAC has to be calculated in ASCII.
Parameter name: MAC_ASCII
Section in *.PPF:

[HARDWARE_CONFIGURATION]

Valid range:

0-1

Value description: 0 - MAC calculation as received from line


1 - MAC calculation always in ASCII
Default value:

0 - MAC calculation as received from line

M-Data and MDS i series status code handling


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.

See also section Miscellaneous tools on page 406 utility


MDS2WNC.EXE.

158

June 2015

Parameters in CUSTOM.PPF

[HARDWARE_CONFIGURATION]

Go offline after host reply timeout


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

RKL message encoding


This parameter is used to specify the type of encoding for RKL
(Remote Key Loading) message fields. RKL message fields can be
send/received in hexa decimal, BASE64 or BASE94 encoded format.
Base94 encoding is used automatically if NCR native RKL messages are used.
The parameter specifies how RKL fields have to be handled in receive and send
direction. The format has to be agreed with the switch provider.
Parameter name: RKL_ENCODING
Section in *.PPF:

[HARDWARE_CONFIGURATION]

Valid range:

0, 1

Value description: 0 - encoding off, hexa decimal field values


1 - BASE64 encoding enabled
Default value:

0 - encoding off

June 2015

159

[HARDWARE_CONFIGURATION]

Parameters in CUSTOM.PPF

SAF Machine Number (DDC only)


This parameter needs to be configured with the local machine number if it
should be sent in the SAF response message.
Parameter name: SAF_MACH_NO
Section in *.PPF:

[HARDWARE_CONFIGURATION]

Valid range:

6 alpha numeric digits

Value description: valid machine number


Default value:

160

not configured

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

[APPLICATION_XXX][1]
[1]

XXX represents the protocol type which can be NDC or DDC.

Hardware Fitness Fitness


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

If the parameter is not set in the Registry, the hardware


fitness is cleared after exiting supervisor mode (like value 1).

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

June 2015

161

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Suspend Mode timeout


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

Resend Power up message


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


ONCE
ALWAYS
Default value:

162

no power up message.
send power up message during startup only.
send power up after every online

ONCE

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Sensor messages for terminal doors


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.
Default value:

GENERAL

Force Supervisor Mode when door open


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 163 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

June 2015

163

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Solicited and Unsolicited message queuing


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.

The following parameter activates queuing for unsolicited messages within


transactions. If a transaction request message has been sent to the host,
unsolicited messages will be queued until the ready response is sent after the
host reply. Unsolicited sensor messages (doors, cassettes change) or device
fault messages are sent to the host after the transaction ready message.
Parameter name: Q_UNSOL_IN_TRAN_REQ
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

0, 1

Value description: 0 - message immediately sent to host.


1 - queue message within transactions and send it after
transaction ready.
Default value:

0 - NDC; 1 - DDC

The next parameter activates queuing of solicited messages during offline


mode. Solicited messages unable to be sent to the host during offline mode are
queued until the terminal is again online.
Parameter name: Q_OFFLINE_TRAN_READY
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

0, 1

Value description: 0 - ignore solicited messages during offline.


1 - queue message during offline and sent it when online.
Default value:

164

0 - NDC; 1 - DDC

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Default Miscellaneous Features (DDC only)


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
Section in *.PPF:

[APPLICATION_DDC]

Valid range:

0-255

Value description: see table 6, table 7 and table 8 for detailed value
description.

Switch on/off logo light together with ready indicator


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:

June 2015

165

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Ready/Supply/Amount option defaults (NDC)


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

Separate READY (B) status sent in response to Transaction Reply

Auto return to previous mode from supply mode

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

Refer to ProCash/NDC User Guide for detailed field description of the


Configuration Parameters Load message (13). See also
section Optional Parameters (NDC) on page 113 of this manual.

166

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Card Read/Write error threshold defaults


This parameter can be used to overwrite the threshold values for card read/write
errors from the NDC Enhanced Configuration Parameters load (1A) message.
Parameter name: DEFAULT_CARD_READ_TRESHOLD
DEFAULT_CARD_WRITE_TRESHOLD
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

0, 99

Value description: Sets the number of allowed read/write errors before


a device error message is sent to the network.
Default values:

10 - for read errors; 3 - for write errors

Refer to ProCash/NDC User Guide for detailed description of


parameter option "13" and "14" in the Enhanced Configuration
Parameters Load (1A) message.
If the card read /write threshold values are not downloaded from the
network, the default values (also valid for ProCash/DDC) can be set
in CUSTOM.PPF exp. thresholds (read) 10, (write) 3:
[LYNXCI_PARAMETER]
PARAMETER_13 = 10
PARAMETER_14 = 3

Enter "Out of service" mode after line reconnect


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:

June 2015

167

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Rear Balancing host timeout


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

Configure Customer Relays 1 - 4


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

See detailed description of the parameters on the following pages.

168

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

All parameters can be configured in the same parameter syntax as follows:


IndicatorType:Number,IndicatorType:Number,IndicatorType:Number, ...
For the Customer Relays you have to enter keyword REL for IndicatorType.
A positive value in range 1-4 of Number indicates to switch ON the specified
Relay number.
A negative value (preceding minus character) in range 1-4 of Number indicates
to switch OFF (inverted logik) the specified Relay number.
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:

OPL Status Indicators

Color

Number

In Service Indicator

green

Customer Indicator

yellow

Cash Indicator

yellow

Paper Indicator

red

tech. Service Indicator

red

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

NOTE:

REL configuration requires OPL configuration too.

June 2015

169

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

LED_IN_SERVICE (ATM is in service mode)


Parameter name: LED_IN_SERVICE
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

IndicatorType:Number,IndicatorType:Number, ...

Value description: specifies which Relay Indicator(s) and Operator


Panel Indicator(s) should be switched on/off during in
service mode.
Default value:

not configured in registry (internal default handling of


transaction framework is used)

LED_CUSTOMER (transaction active)


Parameter name: LED_CUSTOMER
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

IndicatorType:Number,IndicatorType:Number, ...

Value description: specifies which Relay Indicator(s) and Operator


Panel Indicator(s) should be switched on/off if a consumer
transaction is active.
Default value:

not configured in registry (internal default handling of


transaction framework is used)

LED_CASH (cash cassette(s) has/have low or out status)


Parameter name: LED_CASH
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

IndicatorType:Number,IndicatorType:Number, ...

Value description: specifies which Relay Indicator(s) and Operator


Panel Indicator(s) should be switched on/off when the cash
cassette(s) has/have a low or out status.
Default value:

170

not configured in registry (internal default handling of


transaction framework is used)

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

LED_PAPER (printer paper low)


Parameter name: LED_PAPER
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

IndicatorType:Number,IndicatorType:Number, ...

Value description: specifies which Relay Indicator(s) and Operator


Panel Indicator(s) should be switched on/off if the printers
has/have paper low status.
Default value:

not configured in registry (internal default handling of


transaction framework is used)

LED_SERVICE (technical service required)


Parameter name: LED_SERVICE
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

IndicatorType:Number,IndicatorType:Number, ...

Value description: specifies which Relay Indicator(s) and Operator


Panel Indicator(s) should be switched on/off if technical
service or maintanance is required for one or more ATM
devices.
Default value:

not configured in registry (internal default handling of


transaction framework is used)

LED_SVR_MODE (ATM in supervisor mode)


Parameter name: LED_SVR_MODE
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

IndicatorType:Number,IndicatorType:Number, ...

Value description: specifies which Relay Indicator(s) and Operator


Panel Indicator(s) should be switched on/off when the ATM
is in supervisor mode
Default value:

not configured in registry (internal default handling of


transaction framework is used)

June 2015

171

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

The LED configuration parameters are preset with following defaults if the
parameters are not set in the registry:
Parameter

Relay

Number

LED_IN_SERVICE

OPL

LED_CUSTOMER

OPL

LED_CASH

OPL

LED_PAPER

OPL

LED_SERVICE

OPL

LED_SVR_MODE

Configure Remote Sensor Indicators (RSI)


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.
YELLOW (Relay 2):ATM is In Service but one or more devices need(s) to
be serviced.
RED (Relay 1):

ATM is currently in Supervisor mode or


ATM is in Offline mode or
ATM is Out of Service mode.

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 section Configure Customer Relays 1 - 4 on page 168).

172

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

All parameters can be configured in the same parameter syntax as follows:


IndicatorType:Number,IndicatorType:Number,IndicatorType:Number, ...
For RSI you have to enter keyword REL for IndicatorType.
The value of Number has to be zero which enables the RSI processing.
You have to set Status Indicators of the Operator Panel together with RSI lights.
See section Configure Customer Relays 1 - 4 on page 168 for detailed
description about Status Indicator configuration of Operator Panel.
EXAMPLE:
The following parameters in CUSTOM.PPF configure RSI and the belonging
Status Indicators of the Operator Panel.
LED_IN_SERVICE =
LED_CASH =
LED_PAPER =
LED_SERVICE =

REL:0,OPL:0
REL:0,OPL:2
REL:0,OPL:3
REL:0,OPL:4

RSI Status GREEN (RELAY3)


Parameter name: LED_IN_SERVICE
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

REL:0,IndicatorType:Number, ...

Value description: enables green RSI for In Service mode and as an option
Operator Panel Indicator(s).
Default value:

not configured in registry (internal default handling of


transaction framework is used)

June 2015

173

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

RSI Status YELLOW (RELAY2)


Parameter name: LED_CASH
LED_PAPER
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

REL:0,IndicatorType:Number, ...

Value description: enables yellow RSI for cash low/out and paper low
status and as an option Operator Panel Indicator(s).
Default value:

not configured in registry (internal default handling of


transaction framework is used)

RSI Status RED (RELAY1)


Parameter name: LED_SERVICE
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

REL:0,IndicatorType:Number, ...

Value description: enables red RSI if the ATM is offline, out of service or in
supervisor mode and as an option Operator Panel
Indicator(s).
Default value:

174

not configured in registry (internal default handling of


transaction framework is used)

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Configure Remote Status Monitor (RSM)


On Wincor Nixdorf systems the Remote Status Monitor handling can be enabled
via IndicatorType RSM. As described in section Configure Remote Sensor
Indicators (RSI) on page 172, 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

June 2015

175

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

LED Mapping for systems of other vendors


The LED control for the Operator Panel (OPL) is slightly different on for
hardware systems other than Wincor Nixdorf. Some LEDs do not exist or the
LED numbers are in a different order. This section describe how the Operator
Panel LEDs can be mapped (as an example) for NCR, Diebold and DeLaRue
systems.
The following table shows the difference of the Operator Panel LEDs between
Wincor Nixdorf and NCR:
Parameter

LED
No.

Wincor
Nixdorf

NCR

LED_IN_SERVICE

In Service

Supervisor

LED_CUSTOMER

Customer

Ready

LED_CASH

Cash

Error

LED_PAPER

Paper

Not available

LED_SERVICE

Service

Not available

LED_SVR_MODE

Supervisor

DeLaRue

Diebold

Parameter entries in CUSTOM.PPF for NCR systems:


LED_IN_SERVICE = "OPL:1"
LED_SERVICE = "OPL:2"
LED_SVR_MODE = "OPL:0"

176

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Guide Light flash rate control


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:


2. comma spearated list of values:

0-4
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.

The 2nd way specifies the flash rate individually for a


specific device. The value position in the comma separated
list automatically specifies the device where the flash value
is assigned to.
The positions are assigned to the devices as follows:
0 - Card Reader
2 - Notes Dispenser
4 - Receipt Printer
6 - Deposit Module
8 - Bill Acceptor[2]
10 - Document Printer
12 - Scanner Module[2]
14 - Coin Acceptor Out[1]

1 - Pin Pad
3 - Coin Dispenser
5 - Passbook Printer
7 - Cheque Module[2]
9 - Envelope Dispenser
11 - Coin Acceptor
13 - Coin Acceptor Reject[1]

[1]
[2]

Wincor only
- Parameter GUIDE_LIGHT_CONTROL needs to be configured.
Refer to CashIn and ChequeIn Inst. & Conf. manuals.

Example 2:

GUIDE_FLASH_RATE = "3,0,0,1,0,0,0,0,0,0,0,0,2,0,0"
Configures quick flash for the Card Reader, slow flash for
the Coin Dispenser and medium flash for the Scanner Module.

The flash rate values 0 - 4 are defined are follows:


0 = off; 1 = slow flash; 2 = medium flash; 3 = quick flash; 4 = continueous

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.

June 2015

177

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Offline Reboot timer


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:

178

not configured in registry

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Enable double length keys for triple DES


This parameter has to be set if ProCash/NDC or ProCash/DDC has to work with
triple DES keys and has to accept encryption key loads from host that contain
double length keys (48 digits), which are needed to perform triple DES
encryption. Hardware requirement for triple DES encryption mode is an installed
EPP of version 4.
Parameter name: DOUBLE_LENGTH_KEYS
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

0, 1, 10, 11,12[1]

Value description: 0 - Encryption key load with double length keys are rejected.
Send command reject message to the host.
1 - Encryption key load with double length keys are
accepted. Send ready message to the host.
Default value:

not configured in registry

[1] - Please refer to document PCI-PED-NDC-DDC_V21XX.PDFfor detailed


descriptions of parameter values 10, 11 and 12.

Zero filled General Purpose Buffer B and C


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.
Default value:

not configured in registry

June 2015

179

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Configurable cassette names on journal


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:

180

not configured in registry

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Configurable text for reject/retract counter on journal


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)

Parameter names: JOU_TXT_REJECTS


JOU_TXT_RETRACTS
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

character string (max. 40 characters)

Value description: specifies the journal text that is logged on journal for the
number of cash retracts and rejects. The counter with the
size of 4 digits for each parameter will be appended to the
new defined text separated with one space to the right.
Default value:

not configured in registry

June 2015

181

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

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.

Default value:

182

not configured in registry

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

ADRS max retries


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

Store downloaded COM key


This parameter is needed if you have to configure whether the downloaded
COM key should be still available after system reboot or if it should be lost after
power failure. The parameter can be used to simulate the behavior of Diebold
systems. They lose the downloaded COM key after power failure.
Parameter name: STORE_COM_KEY
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

0, 1

Value description: 0 - Downloaded COM key is lost after system reboot.


1 - COM key is stored and available after system reboot.
Default value:

not configured - COM key is stored power secure

June 2015

183

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Force displaying "Card captured" screen in close state


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

Print immediate processing options


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
Default value:

184

not configured in registry

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Configure anti skimming, mouthpiece and alarm sensors


The following parameter is used to configure anti skimming, mouthpiece or/and
alarm sensor recognition. This parameter consists of a comma (,) separated list
for each sensor that you like to define. The single options of each sensor in the
list are grouped through a colon (:), where it can be defined a journal message,
error code, and unsolicited message name.
Parameter name: ALARM_SENSORS
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

SensorValue1:..:..:..:,SensorValue2:..:..:..:,...

Value description: the parameter value consists of one or more Sensor


definitions, where each Sensor definition is separated
through a comma (,). Within each sensor definition, the
mandatory and optional fields are separated through a
colon (:):
POS

Optional

Description
Sensor number that represents the WOSA sensor type:
Value
Sensor Type
1
SIU_TAMPER
2
SIU_INTTAMPER
3
SIU_SEISMIC
10
SIU_INPUT1
11
SIU_INPUT2
12
SIU_INPUT3
13
SIU_INPUT4

Device name that represents the device class that will be created in the
Device Status Framework (dcDevsta.dll)
Example: If you enter the name TAMPER_SENSOR, all device state
changes will be assigned to this device name.
The current sensor state can be received in method
PREP_SENSOR_STATUS of the Message Control
Framework (value: 1 = ON (alarm), 0 = OFF).
Set opposite logic:
If you append .1 after the device name the sensor status value is
reported in the opposite way (value: 0 = ON (alarm), 1 = OFF).
Example: TAMPER_SENSOR.1
Sensor State changes from OFF to ON (alarm active) and skimming
device is connected (operational)

4 digit Journal (TOPMSG/CUSTMSG) message number. If configured


the status change can be journalled to file or/and printer.

June 2015

185

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

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
2. Specify DevstaDeviceName and Status
The second option how to set this filed is to specify the device name
and the the Status (Severity) that should be set for the current alarm
state. The field consists of 3 dot separated fields. The first field is
reserved and has to contain a bar (-), the second field specifies the
device name and the third field specifies the status value.
Example: -.CCCardFW.4

Name of the unsolicited message that should be sent in case if the


sensor status has changed from OFF to ON
Example: T2HUnsolicitedAlarmStateChange
Sensor State changes from OFF to ON (alarm active) and the
skimming device is disconnected or defective
(ASKIM_STATE keyword is set in szExtras of XFS SIU30 service)

4 digit Journal (TOPMSG/CUSTMSG) message number. If configured


the status change can be journalled to file or/and printer.

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
2. Specify DevstaDeviceName and Status
The second option how to set this filed is to specify the device name
and the the Status (Severity) that should be set for the current alarm
state. The field consists of 3 dot separated fields. The first field is
reserved and has to contain a bar (-), the second field specifies the
device name and the third field specifies the status value.
Example: -.CCCardFW.4

10

186

Name of the unsolicited message that should be sent in case if the


sensor status has changed from OFF to ON and the skimming device
is disconnected or defective
Example: T2HUnsolicitedAlarmStateChange

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Sensor State changes from ON to OFF (alarm inactive)


5

4 digit Journal (TOPMSG/CUSTMSG) message number. If configured


the status change can be journalled to file or/and printer

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
2. Specify DevstaDeviceName and Status
The second option how to set this filed is to specify the device name
and the the Status (Severity) that should be set for the current alarm
state. The field consists of 3 dot separated fields. The first field is
reserved and has to contain a bar (-), the second field specifies the
device name and the third field specifies the status value.
Example: -.CCCardFW.4

Name of the unsolicited message that should be sent in case if the


sensor status has changed from ON to OFF
Example: T2HUnsolicitedAlarmStateChange

Default value:not configured in registry

See the following configurations:


Example1:
"1:TAMPER_SENSOR:2000::T2HUnsolicitedAlarmStateChange,
10:INPUT_SENSOR1:2001::T2HUnsolicitedMyOwnDefinedMessage"
This configuration example sets WOSA sensor device SIU_TAMPER, device name TAMPER_SENSOR
for dcDevSta.dll, journal message 2000, no StClass and StCode, and message
T2HUnsolicitedAlarmStateChange if the sensor state changes from OFF to ON (alarm).
The second field (after the comma separator) configures SIU_INPUT1, device name INPUT_SENSOR1
for dcDevsta.dll, journal message 2001, , no StClass and StCode, and message
T2HUnsolicitedMyOwnDefinedMessage if the sensor state changes from OFF to ON (alarm).
Please note that own defined messages have to be configured in registry section
..\CCOPEN\PROTOCOL\NDC\.. or ..\CCOPEN\PROTOCOL\DDC\..

See next examples on the next page ...

June 2015

187

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

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"

Anti Skimming module connection on Wincor ATMs:


The Anti Skimming module is connected to contact "Reserve In 2" of the special electronic.
For activation of this sensor, following registry parameter settings are required:
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\CSC-W32\CurrentVersion\CSCSEL]
"RSRVI2"="ANTI_SKIMMING"
"MAGDOOR3"="ANTI_SKIMMING"
Alternatively: Card reader mouthpiece connection on Wincor ATMs:
As an alternative solution to the anti skimming module, a specific mouthpiece can be connected to the
"Reserve In 2" contact of the special electronic.
For activation of this sensor, following registry parameter settings are required:
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\CSC-W32\CurrentVersion\CSCSEL]
"RSRVI2"="ID_ENTRY"
ProDevice (WOSA) uses sensor type WFS_SIU_TAMPER (1) for status indication.
Please refer to ProBase/C 1.1/30 User Guide "Generation Tools" 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".

Note:

If WOSA parameter "CheckSkimming" is configured in section


HKEY_CLASSES_ROOT\WOSA/ XFS_ROOT\PHYSICAL_SERVICES\SSI
and skimming is active, a running card insert job will be cancelled. The card reader state is set to
not operational and an unsolicited card reader message with a fatal status is sent to the host.

Anti Skimming module defective detection on Wincor ATMs:


Since release 2.1/10 the ALARM_SENSORS parameter can be configured with POS 8-10. Refer to the table
of the Value description. POS 8-10 can be used if the application should react on disconnect conditions of
the Skimming Module. The disconnect condition will be detected through the next alarm ON event.
This feature is supported for XFS sensor type SIU_TAMPER only.
Dependency on XFS: $MOD$ 110401 5112 PSSIU30.DLL 3.10 or higher
The PSSIU30 service sets keyword ASKIM_STATE with an 8 digit hex value that reflects the status bits of
the skimming interface. Example: ASKIM_STATE = 0x01000051

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.

188

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Initial Status after application start


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.

WOSA XFS
Sensor Type

WOSA XFS
Status

dcDevSta
Sensor Status

dcDevSta
Sensor Status (negative)

SIU_TAMPER ( 1)

ON

INACTIVE (0)

ACTIVE (1)

SIU_INTTAMPER (2)

ON

INACTIVE (0)

ACTIVE (1)

SIU_SEISMIC (3)

ON

INACTIVE (0)

ACTIVE (1)

SIU_INPUT1 (10)

OFF

INACTIVE (0)

ACTIVE (1)

SIU_INPUT2 (11)

OFF

INACTIVE (0)

ACTIVE (1)

SIU_INPUT2 (12)

OFF

INACTIVE (0)

ACTIVE (1)

SIU_INPUT2 (13)

OFF

INACTIVE (0)

ACTIVE (1)

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.

June 2015

189

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Display receipt delivered screen in close state


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

Use Close (J) state Timer 02 always


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:

190

not configured in registry, default is 0

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Delay after Transaction Request processing


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

Screen delay time for FID Z (DDC only)


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

June 2015

191

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Options for PAN handling


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

Monitor SEL boot switch (Wincor only)


This parameter can be used to disable monitoring of the boot switch
(ON/OFF button) from the operator panel or special electronics panel (the black
boot button of the old special electronic is not involved). That means, if
monitoring is disabled, a button press through an operator has no effect.
Parameter name: MONITOR_BOOT_SWITCH
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

0, 1

Value description: 0 - disable boot switch monitoring


1 - boot switch monitoring enabled
Default value:

192

not configured, (default = 1)

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Monitor Safe door


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)

Reconnection delay time


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)

June 2015

193

[APPLICATION_XXX][1]

Parameters in CUSTOM.PPF

Power Save Mode delay time


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.

NDC LTS Options


This parameter can be used to specify options for the Last Transaction Status
(LTS) of the Transaction Request message.
Parameter name: NDC_LTS_OPTIONS
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

0, 1

Value description: 0 - not configured


1 - Append always status of five coin out hoppers in LTS
even a coin out module is not configured.
Default value:

not configured, (default = 0)

Important Note:

This parameter might be required to set if NDC BNA mode


is enabled and BNA LTS is also appended.

194

June 2015

Parameters in CUSTOM.PPF

[APPLICATION_XXX][1]

Host Protocol (HP) Handling


This parameter is needed to specify how the Application Framework handles
the Start behavior of the Host Protocol Framework. If the Rich Client Manager
(RCM) is in use, this parameter has to be zero and should never be changed or
removed.
Parameter name: HP_HANDLING
Section in *.PPF:

[APPLICATION_XXX]

Valid range:

0, 1

Value description: 0 - sets HP start behavior for RCM (mandatory for RCM)
1 - Standard behavior for non RCM applications
Default value:

not configured, (default = 1)

June 2015

195

CAS dialog timer parameters (DDC only)

Parameters in CUSTOM.PPF

CAS dialog timer parameters (DDC only)


If the terminal uses Continuous Availability Services (CAS), you have to specify
timeout values for each CAS screen dialog that is displayed when the operator
has selected one of the Continuous Availablity Service. These timeout values
specify how long the CAS specific function selection screen is displayed where
the consumer can select to continue or to abort the transaction if CAS is active.

CAS is supported with ProTopas/SOP-DDC. To use CAS, parameter


SYNCHRONIZE_IMMEDIATE has to be set to "N" in configuration file
CCSOPSTEP.INA. To set the default CAS screens in registry you
have to call the batch routine CAS_SCR.BAT located in
"C:\PROTOPAS\CONF".

Time-out for CAS of cash dispenser


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
1-999
Tnn

""
Default value:

196

- infinite
- Number of seconds the screen remain.
- Use timer value that is downloaded from host.
nn = downloaded timer number stored in
..\LYNXCI\TIMER section.
- Timer 04 is used (Diebold compatible)

not configured - 120 seconds (Diebold compatible)

June 2015

Parameters in CUSTOM.PPF

CAS dialog timer parameters (DDC only)

Time-out for CAS of deposit module


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
1-999
Tnn

""
Default value:

- infinite
- Number of seconds the screen remain.
- Use timer value that is downloaded from host.
nn = downloaded timer number stored in
..\LYNXCI\TIMER section.
- Timer 04 is used (Diebold compatible)

not configured - Timer 04 is used (Diebold compatible)

June 2015

197

CAS dialog timer parameters (DDC only)

Parameters in CUSTOM.PPF

Time-out for CAS of receipt printer


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
1-999
Default value:

198

- infinite
- Number of seconds the screen remain.

not configured - infinite

June 2015

Parameters in CUSTOM.PPF

CAS dialog timer parameters (DDC only)

Time-out for CAS of document printer


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
1-999
Default value:

- infinite
- Number of seconds the screen remain.

not configured - infinite

June 2015

199

CAS dialog timer parameters (DDC only)

Parameters in CUSTOM.PPF

Check CAS of deposit module during dispense


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:

200

not configured - Check CAS for deposit module within a


withdrawal transaction.

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

[CASH_DISPENSER]
Number of logical cassettes
This parameter specifies the number of logical cassettes.
Parameter name: NUM_LOG_CASS
Section in *.PPF:

[CASH_DISPENSER]

Valid range:

0-7 (for NDC); 0-8 (for DDC)

Value description: integer value sets the number of logical cassettes.


Default value:

For NDC values above 4 are used only if up to 7 denomination


support is enabled on the host side.

Set cassettes currencies


This parameter sets the currency of the cassettes.
Parameter name: CURRENCY_X [1]
Section in *.PPF:

[CASH_DISPENSER]

Valid range:

3 digit char string (uppercase)

Value description: represents the cassette currency.


Default value:
[1]

X represents the logical cassette position from 1 to 7 for NDC and up to 8


for DDC, where 1 - 8 are assigned to denomination A - H.

For NDC parameters configured above X > 4 are used only if up to


7 denomination support is enabled on the host side.

June 2015

201

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Set cassettes values


This parameter sets the bill values of the cassettes.
Parameter name: VALUE_X [1]
Section in *.PPF:

[CASH_DISPENSER]

Valid range:

0 - 9999999

Value description: represents the cassette values.


Default value:
[1]

X represents the logical cassette position from 1 to 7 for NDC and up to 8


for DDC, where 1 - 8 are assigned to denomination A - H.

For NDC parameters configured above X > 4 are used only if up to


7 denomination support is enabled on the host side.

Default number of notes loaded


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 7 for NDC and up to 8


for DDC, where 1 - 8 are assigned to denomination A - H.

For NDC parameters configured above X > 4 are used only if up to


7 denomination support is enabled on the host side.

202

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

Automatic cassettes logon


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:

Default value:

Bit value

Description

Logon the cassettes if they are inserted and the safe door has
been closed after cassettes insertion

Only if parameter AUTO_LOGON_NOTES is non zero:


- Sets the dispensed to customer counter to zero
- Sets the dispensed counter to zero

Sets the counter of the reject cassette to zero

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)

1 - logon the cassettes

Automatic cassettes logon in SOP session


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:

June 2015

203

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Set initial number of notes for auto logon cassettes


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:

The initial configured counter is ignored if the actual counter of the


cassette has a higher value.

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.

204

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

Send cash low message only if whole denomination low


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.

Set dispense algorithm (ATMs only)


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:

June 2015

205

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Ignore cash counters for removed cassettes


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:

The cash counters for removed cassettes in the SOP functions are
still available !!

206

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

Send unsol. Cash low message not only once


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 1-

2-

4 -

8 -

12 -

Default value:

low message is sent only once after supply status


change from "good" to "low".
send low message after each transaction only if
current cassettes supply status of a used cassette is
low.
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.
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).
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.
enables above options 4 and 8.

DDC: not configured


NDC: 1 - send low message after each transaction

June 2015

207

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Stop dispensing after max. number of present errors


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:

208

0 - Counting of money present errors disabled

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

Set fatal after max. number of failed dispenses


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

June 2015

209

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Send sol. message on Cash present time-out (NDC only)


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

Cash retract through Presenter Dump Q (DDC only)


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:

210

not configured in registry

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

Send missing (@) for fatal cassettes (DDC only)


This parameter can be used to set the denomination ID to missing (@) in
solicited status messages for those cassettes, which have status fatal. Fatal
conditions can be physically or logically empty, no reference value, note jams,
pick failures or the cassette is not initialized.
This option enabled prevents repeated dispense commands from host for
cassettes, which are reported to the host as a lower case denomination ID
status but the cassette cannot be used anymore because of a fatal status.
In the Diebold protocol the lower case denomination ID a, b, c, d, e, f, g,
or h can be fatal, empty or low. The disadvantage of this option is, that missing
and fatal cassettes cannot be found out on the host side, because they are
reported as the same status @.
The denomination ID status in the SOP User Exit function display or print
Supply Counters remain unchanged.
Parameter name: FATAL_CASS_AS_MISSING
Section in *.PPF:

[CASH_DISPENSER]

Valid range:

0, 1

Value description: 0 - Disabled, send lower case denomination ID in solicited


cash dispenser status message for fatal cassettes.
1 - Enabled, send missing denomination ID @ in solicited
cash dispenser status message for fatal cassettes.
Missing status also effects to Hardware Configuration
status and Enhanced Supply Counters status message.
Default value:

Disabled, not configured in registry.

June 2015

211

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Allow dispense if cassettes counter < 0 (NDC only)


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.

Security timer between dispense and presenting money


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 1 - 999

Default value:

212

Money present security timer off


- Money present security time. Sets the time
within what time a present money operation has
to be initiated after a dispense operation.

not configured, default time used by application is 180 sec.

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

Logical cassettes mapping for 6 cassettes ATMs


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 IDs 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 ATMs)
Default value:

not configured - Logical mapping off (4 or less cassettes)

June 2015

213

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Check cash dispenser shutter status after money taken


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

Upper case Denomination ID for cassettes (DDC only)


This parameter can be used to specify if the denomination IDs 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:

214

not configured, send always lower case letters for cassettes


that have dispense problems.

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

Present failure screen and synchronous retract


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.

Screen display options during cash present


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

June 2015

215

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Cash Dispenser fatal if reject bin not operational


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:

216

not configured

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

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

Dispense retries after hardware error


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

Example: Assume parameter DISPENSE_RETRIES is set to 5 and


HWERR_DISPENSE_RETRIES is set to 1. In case the dispense
operation returns with HARDWARE_ERROR (-14) the dispense
operation stops after the first retry. If HWERR_DISPENSE_RETRIES
is not set, 5 dispense retries would be done.

June 2015

217

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Currency Exponent correction


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:

Maximum cash retracts


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

0
1 - 99
Default value:

218

sets defined number of retracts (hardware


dependent). The money of the second retract
remain on the stacker. On ProCash Compact
ATMs 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.
no retract operations
number of retracts allowed

-1

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

Low threshold for physical cassettes


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

Maximum dispense time (watch dog)


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

June 2015

219

[CASH_DISPENSER]

Parameters in CUSTOM.PPF

Withdrawal Retract logging and recycling on RM3


If this parameter is enabled, the CCCdmFW uses the CCCashInFW to perform
retract operations for cash withdrawal transactions. On RM3 (Cineo) systems
the retract recycling feature has to be enabled in the XFS layer.
Parameter name: DO_CIN_RETRACT
Section in *.RM2: [CASH_DISPENSER]
Valid range:

0, 1

Value description: 0 - retract logging off


1 - retract logging on, optionally recycling on RM3
Default value:

Enable Retract Recycling on RM3:


The following parameter has to be set in PROBASE.CUS:
prodevice.spec30.CRS30.retractRecycleModeCashOut = ALL_OR_NOTHING

Dependency:
If retract recycling is enabled on ProCash/NDC you have to set parameter
SEND_SOL_RETRACT = 1 in CUSTOM.PPF.

220

June 2015

Parameters in CUSTOM.PPF

[CASH_DISPENSER]

WOSA XFS30 Parameters (Wincor Nixdorf only)


Number of minimum bills (money low limit)
This parameter is used to set the low condition of the cassettes. It has no effect
if cassettes with a low switch sensor are installed. The value is just an initial
value which is set during the first application start.
Parameter name: prodevice.spec30.CDM30.MINIMUMITEMS
Parameter file:

PROBASE.CUS

Valid range:

0 - 999

Value description: integer value sets the money low limit.


Default value:

50

Number of maximum bills to be rejected


This XFS parameter specifies how many bills are allowed to be stored in the
rejected cassette. If the limit has been reached, the XFS status of the reject
cassette changes to WFS_CDM_STATCUFULL (overfilled).
Parameter name: prodevice.spec30.CDM30.REJECTCASSFULL
Parameter file:

PROBASE.CUS

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

June 2015

221

[COIN_DISPENSER]

Parameters in CUSTOM.PPF

[COIN_DISPENSER]
Number of coin hoppers
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:

Set coin hopper currency


This parameter specifies the currency for each coin hopper.
Parameter name: CURRENCY_X [1]
Section in *.PPF:

[COIN_DISPENSER]

Valid range:

3 digit char string (uppercase)

Value description: represents the currency of one coin hopper in the specified
position.
Default value:
[1]

X represents the coin hopper position from 1 to 4 for NDC and up to 8


for DDC, where 1 - 8 are assigned to denomination A - H.

222

June 2015

Parameters in CUSTOM.PPF

[COIN_DISPENSER]

Set coin hopper values


This parameter sets the coin values of each coin hopper.
Parameter name: VALUE_X [1]
Section in *.PPF:

[COIN_DISPENSER]

Valid range:

0 - 9999999

Value description: represents the cassette values.


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.

Set coin dispense flags


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:
prodevice.spec30.COUT30.MINIMUMITEMS
defined in PROBASE.CUS
The values are optional bits and can be set in any combination as required
Default value:

2 - Dispense from coin hoppers with status LOW

June 2015

223

[COIN_DISPENSER]

Parameters in CUSTOM.PPF

Number of coin hoppers reported to the host


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:

224

not configured (use 4 by default)

June 2015

Parameters in CUSTOM.PPF

[DEPOSIT]

[DEPOSIT]
Options to dispense envelopes
This parameter is used to specify when an envelope should be dispensed to the
customer. Envelopes can be either dispensed during the envelope "C" state or
later when the terminal has received the deposit transaction reply function.
In combination to the dispense options you can configure specific screens via
parameter DISPENSE_SCREEN (see description on the next page) that can be
displayed during the envelope dispense operation. In addition this parameter
can be used to disable the envelope dispenser device.
Parameter name: DISPENSE_ENVELOPE
Section in *.PPF:

[DEPOSIT]

Valid range:

0, 1, 2, 3

Value description: 0 123-

Default value:

Dispense envelope in deposit host reply


function.
Dispense envelope in "C" state.
dispense envelope in "C" state but not in reply
function.
Disable envelope dispenser device.
Envelopes will not be dispensed and
envelope dispenser status messages are not
sent.

Refer to parameter description of parameter DISPENSE_SCREEN


section Screen to be displayed during envelope dispense on
page 226.

June 2015

225

[DEPOSIT]

Parameters in CUSTOM.PPF

Screen to be displayed during envelope dispense


This parameter is used to specify which screen is displayed during envelope
dispense when the customer is waiting for an envelope that has to be taken
during processing the "C" state or in the deposit host reply function.
Parameter name: DISPENSE_SCREEN
Section in *.PPF:

[DEPOSIT]

Valid range:

"", 010 - 999, HOST

Value description: The following table illustrates the behavior of dispensing


envelopes in combination with parameter
DISPENSE_ENVELOPE and parameter
DISPENSE_SCREEN.
O[1]

S[2]

DESCRIPTION

""

Envelope will be dispensed in deposit reply function. No specifc screen will be


displayed. Typically the "Please Wait" screen of the transaction request state
remains displayed.

HOST

Envelope will be dispensed in deposit reply function. Screen of host reply function
is displayed

nnn

Envelope will be dispensed in deposit reply function. Displays specific screen "nnn"
instead of downloaded screen defined in the deposit transaction reply function.

""

Envelope is dispensed asynchronously during processing the "C" state, no specifc


screen is displayed but state flow continues.

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.

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.

""

Envelope is dispensed asynchronously during processing the "C" state, no specifc


screen is displayed but state flow continues (behaviour as option 1).

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).

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.

---

Envelopes will not be dispensed and no screen is displayed

[1] = value of parameter DISPENSE_ENVELOPE


[2] = value of parameter DISPENSE_SCREEN
Default value:

226

""

June 2015

Parameters in CUSTOM.PPF

[DEPOSIT]

Screen "Please wait for an envelope"


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

Allow to cancel deposit transaction


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:

This parameter is currently not used by ProCash/NDC or


ProCash/DDC

June 2015

227

[DEPOSIT]

Parameters in CUSTOM.PPF

Disable printing on retracted envelopes


This parameter can be used to disable printing on retracted envelopes. If the
parameter will be configured and set to "0", dispensed envelopes are left blank
in the retract operation when the consumer has not taken the envelope after the
envelope dispense timeout.
Parameter name: PRINT_ON_ENVELOPE
Section in *.PPF:

[DEPOSIT]

Valid range:

0, 1

Value description: 0 - do not print on retracted envelopes


1 - print data on retracted envelopes
Default value:

not configured, data on retracted envelopes will be printed.

Deposit print character mapping table


These parameters can be used to map print characters to another hexadecimal
postion as the default print position. This can be useful if the print characters
from host need to be mapped to another hex code. For example if the host
sends the character 60H () to print the pound character (), the value 60H in
the hex position 60 has to be replaced with value 9CH.
Parameter names: DEPOSIT_CHARTABLE_LOW
DEPOSIT_CHARTABLE_HIGH
Section in *.PPF:

[DEPOSIT]

Valid range:

see description

Value description: you can use the same character definition as for receipt,
journal or document printers (defined in CUSTOM.PPF).
Default value:

228

not configured

June 2015

Parameters in CUSTOM.PPF

[DEPOSIT]

Deposit entry splitting


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

Prepare envelope dispense


If this WOSA parameter is enabled, empty envelopes from the envelope
dispenser will be automatically transported in the near of the input shutter. The
transport operation will be initiated directly at the end of a previous deposit
transaction or after application start if no envelope is found in the transport
position. This feature has the advantage that the consumer does not need to
wait the long time (approx. 4 seconds) while the envelope is transported the
long distance from the safe to the input shutter.
Parameter names: PREPAREDISPENSE
Section in *.PPF:

[DEP]

Valid range:

0, 1

Value description: 0 - prepare dispense OFF


1 - prepare dispense ON
Default value:

0 - prepare dispense OFF

June 2015

229

[CARD_READER]

Parameters in CUSTOM.PPF

[CARD_READER]
Default track read definitions
The following parameters are used to set which ID card tracks should be preread 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
Section in *.PPF:

[CARD_READER]

Valid range:

0, 1

Value description: 0 - pre-read off; 1 - pre-read on


Default values:

DEFAULT_READ_TRACK1 = 0
DEFAULT_READ_TRACK2 = 0
DEFAULT_READ_TRACK3 = 0

Default chip data read on Smart Cards


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:

230

not configured - read chip data only if specified in the


read conditions of the Card Read State.

June 2015

Parameters in CUSTOM.PPF

[CARD_READER]

Card insert/eject wake up time


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:

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

"Remove Card" screen for left cards in DIP reader


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

June 2015

231

[CARD_READER]

Parameters in CUSTOM.PPF

Read tracks during insert or remove direction (SWIPE)


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)

Card manipulation threshold


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:

232

0 - not configured

June 2015

Parameters in CUSTOM.PPF

[CARD_READER]

Card jam threshold


This parameter can be used to configure a threshold for the number of
consecutive card insert jams. If the jam threshold is exceeded, the application
sends an unsolicited card reader status message (StClass\StCode 6434\0049)
to the host.
Parameter name: JAM_THRESHOLD
Section in *.PPF:

[CARD_READER]

Valid range:

0-99

Value description: sets a jam threshold, an unsol. message will be sent when
the threshold is exceeded.
Default:

0 - not configured, unsolicited message will never be sent

DIP eject screen


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

June 2015

233

[CARD_READER]

Parameters in CUSTOM.PPF

Contactless Reader Handling


This parameter is used to enable contactless reader support. If this parameter
is enabled and a contactless reader is installed, the application is starting the
Insert job with track access.
Parameter name: CONTACTLESS_HANDLING
Section in *.PPF:

[CARD_READER]

Valid range:

0,1

Value description: 0 - contactless reader support off


1 - contactless reader track, starts the insert job with Track1
and Track2 access (but no chip and Track3 access)
Default:

234

0 - contactless reader support off

June 2015

Parameters in CUSTOM.PPF

[BARCODE]

[BARCODE]
The following parameters are used to set up the barcode reader.

Configure barcode type formats


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:
1D Barcode types:
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)

2D Barcode types are listed on the next page ...

June 2015

235

[BARCODE]

Parameters in CUSTOM.PPF
2D Barcode types:
113 - UPCE1
114 - UPCE1/2
115 - UPCE1/5
124 - 128
126 - PLESSEY
128 - STD2 OF 5IATA
130 - MICRO PDF 417
135 - TELEPEN ORIGINAL
136 - TELEPEN AIM
137 - RSS
138 - RSS EXPANDED
139 - RSS RESTRICTED
140 - COMPOSITE CODE A
141 - COMPOSITE CODE B
142 - COMPOSITE CODE C
143 - POSICODE A
144 - POSICODE B
145 - TRIOPTIC CODE 39
146 - CODABLOCK F
147 - CODE 16K
148 - QR CODE
149 - AZTEC
150 - UK POST
151 - PLANET
152 - POST NET
153 - CANADIAN POST
154 - NETHERLANDS POST
155 - AUSTRALIAN POST
156 - JAPANESE POST
157 - CHINESE POST
158 - KOREAN POST

Default values:

not configured

Example entry:

"1,2,4,5,12,14,20"

236

June 2015

Parameters in CUSTOM.PPF

[OPERATOR_SCREENS]

[OPERATOR_SCREENS]
Printer header for Operator screens
These parameters can be used to set predefined macro sequences as a header
for operator screens of the SOP user exit functions to be printed on the journal
or/and receipt printer. This permits the setting of a special CPI or/and LPI size
and additional presettings for the operator screens
Parameter names: PRINTER_HEADER_RECEIPT
PRINTER_HEADER_JOURNAL
PRINTER_HEADER_DOCUMENT
Section in *.PPF:

[OPERATOR_SCREENS]

Valid range:

valid macro sequences or/and text

Value description: the macro sequences must be available by CSCW32 and


be supported by the printer.
Default value:

#NCT##CPI15##LPI6#
(Sets standard character set, CPI15 and LPI6)

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.

June 2015

237

[JOURNALPRINTER]

Parameters in CUSTOM.PPF

[JOURNALPRINTER]
Set journal destination on paper
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

Journal printer CPI setting


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

Journal printer LPI setting


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:
238

6
June 2015

Parameters in CUSTOM.PPF

[JOURNALPRINTER]

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

June 2015

239

[JOURNALPRINTER]

Parameters in CUSTOM.PPF

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
Default value:

0 - no electronic journal log

Send Spooler active or journal printer error message


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
Default value:

240

not configured - send spooler active message

June 2015

Parameters in CUSTOM.PPF

[JOURNALPRINTER]

Keep original printer status if Spooler is configured


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)
Default value:

not configured

Force to send "Paper Out" message on paper out supply


If this parameter is enabled, the application always sends a "Paper Out"
message to the host if the Device Status framework reports a paper out status,
even the previous print job could be successfully finished. If this parameter is
disabled, paper out status messages or more likely jam status messages are
sent to the host only if the journal print job fails to print the host data.
Parameter name: FORCE_PAPER_OUT_SUPPLY
Section in *.PPF:

[JOURNALPRINTER]

Valid range:

0, 1

Value description: 0 - send printer error to the host only if the journal print job
fails.
1 - send paper out message on paper out supply status.
Default value:

not configured - send printer error to the host only if the


journal print job fails.

June 2015

241

[JOURNALPRINTER]

Parameters in CUSTOM.PPF

Assign codepage control sequence to NDC font type


This parameter can be used to assign the codepage control sequence
ESC%nnn (nnn = codepage number) to a local defined NDC font type. The
codepage control sequence can be included in the host print data which is sent
from the central to the terminal. See also section Font type on page 263. This
parameter is supported for NDC journal and receipt print.
Parameter name: CP_JOURNAL_FONT_TYPE_NNN [1]
Section in *.PPF:

[JOURNALPRINTER]

Valid range:

one valid NDC font type character

Value description: NDC font type character, which is already, or has to be new
specified via parameter JOURNAL_FONT_TYPE in the
JOURNAL_FONT_XXX [2] section.
Refer to section Font type on page 263.
[1] NNN represents the codepage number specified via ESC%
[2] XXX represents the font section number

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.

Print journal host data always prior function IDs


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 IDs
Default value:

242

not configured, print journal host data through function ID.

June 2015

Parameters in CUSTOM.PPF

[JOURNALPRINTER]

Hard disk free space low threshold


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.

Enable journal file writing error messages


This parameter activates sending unsolicited journal error messages if journal
information cannot be stored in the journal file. It is related to journal Write() calls
to write the journal data into the dayly journal files initiated by the ProTopas
Journal framework (CCJourna.dll). If file writing fails, the journal framework
sends an error event to the application. If the parameter is enabled and the
journal data could not be stored into the file, the application sends an unsolicited
journal error message to the host in the next ADRS run at the end of the current
consumer transaction. This parameter should also be enabled if for NDC
Electronic Journal Upload (EJU), or for DDC Store And Forward (SAF) is
configured.
Parameter name: CHECK_FILE_JOURNAL
Section in *.PPF:

[JOURNALPRINTER]

Valid range:

0, 1

Value description: 0 - do not send unsolicted messages if file writing fails


1 - send unsolicited journal message if journal data cannot
be stored into the file.
Default value:

not configured - do not send journal error messages

June 2015

243

[JOURNALPRINTER]

Parameters in CUSTOM.PPF

Configure EJU or SAF shared mapping file


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.
Important Note: Please make sure that all sub directories
exist if the file will be configured in a sub folder of the hard
disk.
Default value:

not configured - EJU or SAF disabled

Example entry:

C:\JOURNAL\EJU_SAF.JRN

Configure EJU or SAF maximum file size


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:

244

not configured - size 0, EJU or SAF disabled

June 2015

Parameters in CUSTOM.PPF

[JOURNALPRINTER]

EJU journal NCR compatible mode


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

Extended range of characters in file journal


This parameter can be used to enable printing of characters in range
20-FF hex. Be default the journal files are printed in the restricted character
range 20-7F hex.
Parameter name: ALL_CHARS_IN_EJRN
Section in *.PPF:

[JOURNALPRINTER]

Valid range:

0, 1

Value description: 0 - character range 20-7F hex (default)


1 - extended character range 20-FF hex
Default value:

not configured

June 2015

245

[JOURNALPRINTER]

Parameters in CUSTOM.PPF

Print unicode (GDI only)


This parameter can be used to enable unicode character printing based on a
local configured unicode character table configured via registry parameter
UNICODE_XX (XX = hexadecimal start index for the definition of the next 16
unicode characters). This parameter can be set as global option and individually
for each font section.
Parameter name: PRINT_UNICODE
Section in *.PPF:

[JOURNALPRINTER]

Valid range:

mode:font:width:height

Value description: The value consists of 4 optional parameters:


mode
- value range:
UTF8
sets UTF-8 mode
UTF7
sets UTF-7 mode
font
- valid facia name of a windows font
width
- character width in pixel
height
- character height in pixel
Default value:

not configured

Example Values:

"UTF8" or "UTF8:SimHei" or "UTF8:SimHei:15:30"

[1] XXX represents the font section number from 001-006

246

June 2015

Parameters in CUSTOM.PPF

[ELECTRONIC_JOURNAL]

[ELECTRONIC_JOURNAL]
Maximum journal files
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

Journal Spooler reset sequence


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#"

June 2015

247

[ELECTRONIC_JOURNAL]

Parameters in CUSTOM.PPF

Journal Spooler check timer for Spooler data


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:

Journal Spooler threshold


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

Maximum spool file size


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:

248

not configured - size of 2000 kilobytes is used

June 2015

Parameters in CUSTOM.PPF

[ELECTRONIC_JOURNAL]

Maximum unprinted spool data size


This parameter can be used to encrease or decrease the maximum unprinted
data size within the spool file in kilobytes.
Parameter name: SPOOLER_MAX_SPOOL_AREA
Section in *.PPF:

[ELECTRONIC_JOURNAL]

Valid range:

0 - 9999 (kilobytes)

Value description: unprinted spool data size in kilobytes


Default value:

not configured - size of 1000 kilobytes is used

June 2015

249

[RECEIPTPRINTER]

Parameters in CUSTOM.PPF

[RECEIPTPRINTER]
Receipt printer CPI setting
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

Receipt printer LPI setting


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:

Receipt printer character set


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:

250

June 2015

Parameters in CUSTOM.PPF

[RECEIPTPRINTER]

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

June 2015

251

[RECEIPTPRINTER]

Parameters in CUSTOM.PPF

Receipt printer page header


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#

Receipt printer page footer


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:

252

not configured

June 2015

Parameters in CUSTOM.PPF

[RECEIPTPRINTER]

Receipt footer line position


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

LED timer during receipt delivery


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

June 2015

253

[RECEIPTPRINTER]

Parameters in CUSTOM.PPF

Enable R01 print data merging (NDC only)


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

Assign codepage control sequence to NDC font type


This parameter can be used to assign the codepage control sequence
ESC%nnn (nnn = codepage number) to a local defined NDC font type. The
codepage control sequence can be included in the host print data which is sent
from the central to the terminal. See also section Font type on page 263. This
parameter is supported for NDC receipt and journal print.
Parameter name: CP_RECEIPT_FONT_TYPE_NNN [1]
Section in *.PPF:

[RECEIPTPRINTER]

Valid range:

one valid NDC font type character

Value description: NDC font type character, which is already, or has to be new
specified via parameter RECEIPT_FONT_TYPE in the
RECEIPT_FONT_XXX [2] section.
Refer to section Font type on page 263.
[1] NNN represents the codepage number specified via ESC%
[2] XXX represents the font section number

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.

254

June 2015

Parameters in CUSTOM.PPF

[RECEIPTPRINTER]

Force receipt delivery after each host reply


This parameter can be used to activate the receipt delivery for every transaction reply. This might be useful if a consumer can perform multiple transactions (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:

Force to send "Paper Out" message on paper out supply


If this parameter is enabled, the application always sends a "Paper Out"
message to the host if the Device Status framework reports a paper out status,
even the previous print job could be successfully finished. If this parameter is
disabled, paper out status messages or more likely jam status messages are
sent to the host only if the receipt print job fails to print the host data.
Parameter name: FORCE_PAPER_OUT_SUPPLY
Section in *.PPF:

[RECEIPTPRINTER]

Valid range:

0, 1

Value description: 0 - send printer error to the host only if the receipt print job
fails.
1 - send paper out message on paper out supply status.
Default value:

not configured - send printer error to the host only if the


receipt print job fails.

June 2015

255

[RECEIPTPRINTER]

Parameters in CUSTOM.PPF

Options during Rear Balancing print


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:

256

not configured - all options are off

June 2015

Parameters in CUSTOM.PPF

[RECEIPTPRINTER]

Print unicode (GDI only)


This parameter can be used to enable unicode character printing based on a
local configured unicode character table configured via registry parameter
UNICODE_XX (XX = hexadecimal start index for the definition of the next 16
unicode characters). This parameter can be set as global option and individually
for each font section.
Parameter name: PRINT_UNICODE
Section in *.PPF:

[RECEIPTPRINTER]

Valid range:

mode:font:width:height

Value description: The value consists of 4 optional parameters:


mode
- value range:
UTF8
sets UTF-8 mode
UTF7
sets UTF-7 mode
font
- valid facia name of a windows font
width
- character width in pixel
height
- character height in pixel
Default value:

not configured

Example Values:

"UTF8" or "UTF8:SimHei" or "UTF8:SimHei:15:30"

[1] XXX represents the font section number from 001-006

June 2015

257

[DOCUMENTPRINTER]

Parameters in CUSTOM.PPF

[DOCUMENTPRINTER]
Document printer CPI setting
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

Document printer LPI setting


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:

Document printer character set


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:

258

June 2015

Parameters in CUSTOM.PPF

[DOCUMENTPRINTER]

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

Document printer page header


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

June 2015

259

[DOCUMENTPRINTER]

Parameters in CUSTOM.PPF

Document printer page footer


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

Document footer line position


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:

260

not configured

June 2015

Parameters in CUSTOM.PPF

[DOCUMENTPRINTER]

Maximum documents to be collected before delivery


This parameter is used to set the maximum documents to be collected in the
collection tray before the bundle is delivered to the customer.
Parameter name: NO_OF_DOC_BEFORE_EJECT
Section in *.PPF:

[DOCUMENTPRINTER]

Valid range:

1 - 10

Value description: specifies how many documents can be collected in the


collection tray prior to delivery.
Default value:

10

Cancel document processing


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:

June 2015

261

[DOCUMENTPRINTER]

Parameters in CUSTOM.PPF

Print unicode (GDI only)


This parameter can be used to enable unicode character printing based on a
local configured unicode character table configured via registry parameter
UNICODE_XX (XX = hexadecimal start index for the definition of the next 16
unicode characters). This parameter can be set as global option and individually
for each font section.
Parameter name: PRINT_UNICODE
Section in *.PPF:

[DOCUMENTPRINTER]

Valid range:

mode:font:width:height

Value description: The value consists of 4 optional parameters:


mode
- value range:
UTF8
sets UTF-8 mode
UTF7
sets UTF-7 mode
font
- valid facia name of a windows font
width
- character width in pixel
height
- character height in pixel
Default value:

not configured

Example Values:

"UTF8" or "UTF8:SimHei" or "UTF8:SimHei:15:30"

[1] XXX represents the font section number from 001-006

262

June 2015

Parameters in CUSTOM.PPF

Printer Font parameters

Printer Font parameters


ProCash/NDC-DDC can use maximum 8 different fonts for each kind of printer.
All parameters can be set for the receipt, document and journal printer. In
parameter configuration file CUSTOM.PPF you find 6 font sections configured
by default for ProCash/NDC and ProCash/DDC.
The following parameters can be set for each font:

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

June 2015

263

Printer Font parameters

Parameters in CUSTOM.PPF

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:
Font type
1
2
7
>
?
B

Character set defined by NDC


Single Alpha 1
Single Alpha 2
Single Alpha 3
Double Alpha 1
Double Alpha 2
Double Alpha 3

Sequence
ESC(1
ESC(2
ESC(7
ESC(>
ESC(?
ESC(B

Font type
1
A
V
X
S
Y

Character set defined by DDC


Standard char set
Alternate (user) char set
VT chars from standard char set
VT chars from alternate (user) char set
Second alternate (user) char set
VT chars from second alternate (user) char set

Sequence
ESC5
ESC4
ESC5...VT
ESC4...VT
ESCz1
ESCz1...VT

264

June 2015

Parameters in CUSTOM.PPF

Printer Font parameters

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

June 2015

265

Printer Font parameters

Parameters in CUSTOM.PPF

User defined Character set


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

Printer initialization macros or characters


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

266

June 2015

Parameters in CUSTOM.PPF

Printer Font parameters

Printer character mapping table


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
Sections in *.PPF: [JOURNAL_FONT_XXX] [1]
[RECEIPT_FONT_XXX]
[DOCUMENT_FONT_XXX]
Valid range:

0-255

Value description: low and high part of the character table can have a
maximum of 127 hex values which represents 127
characters.
Each character position can be defined in the range from
(00H-FFH)
[1] XXX represents the font section number from 001-006

June 2015

267

Printer Font parameters

Parameters in CUSTOM.PPF

Print unicode font specific (GDI only)


This parameter can be used to enable unicode character printing based on a
local configured unicode character table configured via registry parameter
UNICODE_XX (XX = hexadecimal start index for the definition of the next 16
unicode characters). This parameter can be set as global option and individually
for each font section.
Parameter names: JOURNAL_PRINT_UNICODE
RECEIPT_PRINT_UNICODE
DOCUMENT_PRINT_UNICODE
Sections in *.PPF: [RECEIPT_FONT_XXX] [1]
[JOURNAL_FONT_XXX]
[DOCUMENT_FONT_XXX]
Valid range:

mode:font:width:height

Value description: The value consists of 4 optional parameters:


mode
- value range:
UTF8
sets UTF-8 mode
UTF7
sets UTF-7 mode
font
- valid facia name of a windows font
width
- character width in pixel
height
- character height in pixel
Default value:

not configured

Example Values:

"UTF8" or "UTF8:SimHei" or "UTF8:SimHei:15:30"

[1] XXX represents the font section number from 001-006

268

June 2015

Parameters in CUSTOM.PPF

GDI Windows name for receipt printer

GDI Windows name for receipt printer


This parameter specifies the Windows name of the installed receipt printer. The
Windows printer name (e.g. "Wincor Nixdorf ND9G" which is a pure Windows
printer) is needed if the installed printer should operate as a Windows printer.
During J/Install installation the Windows printer name is automatically set in the
Registry and also CUSTOM.PPF, if CSC-W32 has installed and configured the
receipt printer as a Windows printer.
If the printer TH21, TH22 or TP07 should operate as a Windows printer, you
have to modify the CSC-W32 configuration file CUSTOM.CUS prior installation.
Parameter TH21_GDI_INTERFACE, TH22_GDI_INTERFACE or
TP07_GDI_INTERFACE has to be set to YES.
Parameter name: REC_PRINTER_NAME
Section in *.PPF:

[GDI_REC_PRINTER]

Valid range:

character string (max 128 characters)

Value description: specifies the Windows printer name


Default value:

""

GDI Windows name for document printer


This parameter specifies the Windows name of the installed document printer.
The Windows printer name (e.g. "Wincor Nixdorf TH97/G") is needed if the
installed printer should operate as a Windows printer.
During J/Install installation the Windows printer name is automatically set in the
Registry and also CUSTOM.PPF, if CSC-W32 has installed and configured the
receipt printer as a Windows printer. If the printer TH97/G or TP01 should
operate as a Windows printer, you have to modify the configuration file
CUSTOM.CUS of CSC-W32 prior installation. Parameter TH97_GDI_
INTERFACE or TP01_GDI_INTERFACE has to be set to YES.
Parameter name: DOC_PRINTER_NAME
Section in *.PPF:

[GDI_DOC_PRINTER]

Valid range:

character string (max. 128 characters)

Value description: specifies the Windows printer name


Default value:

""

June 2015

269

Screen Font configuration

Parameters in CUSTOM.PPF

Screen Font configuration


The following parameters are used to set the font types which are used in the
screen download from the host.

[VIEWER_FONT]
Number of screen fonts
This parameter specifies the number of fonts to be used by ProCash/NDC.
Parameter name: TABLE_ENTRIES
Section in *.PPF:

[VIEWER_FONT]

Valid range:

0, 9

Value description: number of used fonts


Default value:

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:
[1]

See table Default NDC font names and


table Default DDC font names

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.

270

June 2015

Parameters in CUSTOM.PPF

[VIEWER_FONT]

Table 16: Default NDC font names


SECTION

NAME

FONT FILE NAME

NDC font description

[VIEWER_FONT_001]

NDC-SA1

NDC-SA1.FON

Single Alpha 1

[VIEWER_FONT_002]

NDC-DA1

NDC-DA1.FON

Double Alpha 1

[VIEWER_FONT_003]

NDC-SA2

NDC-SA2.FON

Single Alpha 2

[VIEWER_FONT_004]

NDC-DA1

NDC-DA1.FON

Double Alpha 2

[VIEWER_FONT_005]

NDC-G1

NDC-G1.FON

Graphic 1

[VIEWER_FONT_006]

NDC-G2

NDC-G2.FON

Graphic 2

[VIEWER_FONT_007]

NDC-G3

NDC-G3.FON

Graphic 3

[VIEWER_FONT_008]

NDC-SARA

NDC-SARA.FON

Single Arabic

[VIEWER_FONT_009]

NDC-DARA

NDC-DARA.FON

Double Arabic

DDC font description

Table 17: Default DDC font names


SECTION

NAME

FONT FILE NAME

[VIEWER_FONT_001]

DDC-NORM

DDC-NORM.FON

Standard Font

[VIEWER_FONT_002]

DDC-HELV

DDC-HELV.FON

Helvetica

[VIEWER_FONT_003]

DDC-ROLL

DDC-ROLL.FON

Rollng

[VIEWER_FONT_004]

DDC-ENGL

DDC-ENGL.FON

English

[VIEWER_FONT_005]

DDC-CENT

DDC-CENT.FON

Century

[VIEWER_FONT_006]

DDC-8X12

DDC-8X12.FON

Border 8x12

[VIEWER_FONT_007]

DDC-8X16

DDC-8X16.FON

Border 8x16

[VIEWER_FONT_008]

DDC-RUSS

DDC-RUSS.FON

Russisch

[VIEWER_FONT_009]

DDC-ARAB

DDC-ARAB.FON

Arabic

June 2015

271

[VIEWER_FONT]

Parameters in CUSTOM.PPF

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 273

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:
[1]

See table 18 and table 19 on page 274

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 274

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:
[1]

272

See and on

XXX represents the section number from 001 - 009.

June 2015

Parameters in CUSTOM.PPF

Font Resolution tables

Font Resolution tables


Since Release 1.0/05 ProCash/NDC and ProCash/DDC delivers fonts in the
resolution 640x480, 800x600 and 1024x768. Therefore parameters "SIZE" and
"HEIGHT" in the [VIEWER_FONT_XXX] sections needs to be changed
depending in which display resolution the application should run.
The following tables show the values of "SIZE" and "HEIGHT" in the dependent
resolution to be set for ProCash/DDC and ProCash/NDC:
Table 18: DDC resolution dependent values for "SIZE" and "HEIGHT"

NAME

640x480
SIZE x HEIGHT

800x600
SIZE x HEIGHT

1024x768
SIZE X HEIGHT

DDC-NORM

16 x 24

20 x 30

25 x 38

DDC-HELV

32 x 48

40 x 60

51 x 76

DDC-ROLL

32 x 48

40 x 60

51 x 76

DDC-ENGL

32 x 32

40 x 40

52 x 51

DDC-CENT

32 x 48

40 x 60

51 x 76

DDC-CHN4

32 x 32

40 x 40

51 x 51

DDC-CHN5

32 x 32

40 x 40

51 x 51

DDC-CHN6

32 x 32

40 x 40

51 x 51

DDC-CHN7

32 x 32

40 x 40

51 x 51

DDC-8X12

16 x 24

20 x 30

25 x 38

DDC-8X16

16 x 32

20 x 40

25 x 51

DDC-RUSS

16 x 24

20 x 30

25 x 38

DDC-RUS4

32 x 32

40 x 40

51 x 51

DDC-THAI

16 x 24

20 x 30

25 x 38

DDC-ARAB

16 x 24

20 x 30

25 x 38

June 2015

273

Font Resolution tables

Parameters in CUSTOM.PPF

Table 19: NDC resolution dependent values for "SIZE" and "HEIGHT"

NAME

640x480
SIZE x HEIGHT

800x600
SIZE x HEIGHT

1024x768
SIZE X HEIGHT

NDC-SA1

20 x 30

25 x 37

32 x 48

NDC-DA1

40 x 30

50 x 37

64 x 48

NDC-SA2

20 x 30

25 x 37

32 x 48

NDC-DA1

40 x 30

50 x 37

64 x 48

NDC-G1

20 x 30

25 x 37

32 x 48

NDC-G2

20 x 30

25 x 37

32 x 48

NDC-G3

20 x 30

25 x 37

32 x 48

NDC-SARA

20 x 21

25 x 26

32 x 33

NDC-DARA

40 x 42

50 x 52

64 x 67

The values of "SIZE" and "HEIGHT" will be automatically set during


J/Install installation or if you register NT fonts via the "Configuration
Manager". Refer to section Resolution dependent WINNT Font
installation on page 278.

274

June 2015

Parameters in CUSTOM.PPF

Font Resolution tables

NDC font identifier


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:
[1]

See table Standard NDC and DDC font identifiers

XXX represents the section number from 001 - 009.

Table 20: Standard NDC and DDC font identifiers


SECTION

NDC
NDC FONT
DEFAULT
NAME
IDENTIFIER

DDC
NDC FONT
DEFAULT
NAME
IDENTIFIER

[VIEWER_FONT_001]

NDC-SA1

F0

[VIEWER_FONT_002]

>

NDC-DA1

F1

DDC-NORM
DDC-HELV

[VIEWER_FONT_003]

NDC-SA2

F3

DDC-ROLL

[VIEWER_FONT_004]

NDC-DA1

FF

DDC-ENGL

[VIEWER_FONT_005]

NDC-G1

F2

DDC-CENT

[VIEWER_FONT_006]

NDC-G2

F@

DDC-8X12

[VIEWER_FONT_007]

NDC-G3

FG

DDC-8X16

[VIEWER_FONT_008]

NDC-SARA

FI

DDC-RUSS

[VIEWER_FONT_009]

NDC-DARA

FE

DDC-ARAB

See also ProCash/NDC and ProCash/DDC User Guide section


Screens for detailed descriptions about screen control sequences.

June 2015

275

Font Resolution tables

Parameters in CUSTOM.PPF

NDC double size


This parameter has to be set for double size fonts.
Parameter name: NDC_DOUBLE
Section in *.PPF:

[VIEWER_FONT_XXX] [1]

Valid range:

0, 1

Value description: 0 - single, 1 - double


Default values:
[1]

See table Default settings for NDC and DDC fonts

XXX represents the section number from 001 - 009.

Table 21: Default settings for NDC and DDC fonts


SECTION

DEFAULT
VALUE

NDC FONT
NAME

DEFAULT
VALUE

DDC FONT
NAME

[VIEWER_FONT_001]

NDC-SA1

DDC-NORM

[VIEWER_FONT_002]

NDC-DA1

DDC-HELV

[VIEWER_FONT_003]

NDC-SA2

DDC-ROLL

[VIEWER_FONT_004]

NDC-DA1

DDC-ENGL

[VIEWER_FONT_005]

NDC-G1

DDC-CENT

[VIEWER_FONT_006]

NDC-G2

DDC-8X12

[VIEWER_FONT_007]

NDC-G3

DDC-8X16

[VIEWER_FONT_008]

NDC-SARA

DDC-RUSS

[VIEWER_FONT_009]

NDC-DARA

DDC-ARAB

276

June 2015

Parameters in CUSTOM.PPF

Font Resolution tables

Display characters in proportional mode


This parameter can be used to display characters in proportional mode. In
proportional mode the distance between each character will be calculated by
the size of each character. This has the effect, that lines become shorter than in
normal mode depending on the characters to be displayed. In this mode
characters from a downloaded screen are read line by line and not character by
character. This speeds up the display time for screens which contain escape
sequences to fill a screen via ESC R or ESC U in DDC mode. This mode is
also useful to set if you like to display WINNT proportional fonts instead of the
standard NDC or DDC fonts.
Parameter name: PROPORTIONAL
Section in *.PPF:

[VIEWER_FONT_XXX] [1]

Valid range:

0, 1

Value description: 0 - proportional off, 1 - proportional on


Default values:
[1]

0 - proportional off

XXX represents the section number from 001 - 009.

June 2015

277

Resolution dependent WINNT Font installationParameters in CUSTOM.PP

Resolution dependent WINNT Font installation


Since Release 1.0/05 ProCash/NDC and ProCash/DDC are able to register
automatically Windows Fonts (*.FON) with the Display Resolution which is
currently set during the installation. ProCash/NDC and ProCash/DDC delivers
a set of default Fonts which are extracted from the J/Install CD and copied to
the C:\PROTOPAS\FONTS\XXX directory (the XXX placeholder stands for
640X480, 800X600 and 1024X768). Within batch program
"C:\PROTOPAS\UPDCONF.CMD" at the end of the batch routines the font
registration utility "CPYNTFNT.EXE" is called that analyzes first the current
Windows display resolution. Than all files are copied from the
C:\PROTOPAS\FONTS\ subfolder of the detected resolution to the
\WINNT\FONTS directory. In addition the utility registers all standard fonts in the
Windows environment for immediate access by ProCash/NDC or
ProCash/DDC. At least the utility updates the values of parameter "SIZE" and
"HEIGHT" in the [VIEWER_FONT_XXX] section of configuration file
"CUSTOM.PPF". The last step is a call to PARAC to set the new values for SIZE
and HEIGHT from "CUSTOM.PPF" into the registry.
Later after the installation if you have decided to change the Windows display
resolution you can use the "Configuration Manager" to register default fonts in
a different resolution. See menu "Update" ->"Install Fonts and Bitmaps" of
"Configuration Manager".

Refer to section Font and Graphic utilities on page 382 for detailed
description CPYNTFNT.EXE.

Resolution dependent Bitmap/Icon installation


Since Release 1.0/05 during the installation all default Bitmaps and Icons are
copied with the currently detected resolution from the resolution dependent
subfolder C:\PROTOPAS\BITMAPS\XXX (the XXX placeholder stands for
640X480, 800X600 and 1024X768) to C:\PROTOPAS\BITMAPS. The Bitmaps
and Icon copy process will be initiated via utility "CPYNTFNT.EXE" in a second
step after the automatic NT font registration during the "UPDCONF.CMD" run.
You are also able to exchange Bitmaps and Icons later after the installation with
the "Configuration Manager". See also section Resolution dependent WINNT
Font installation on page 278.

278

June 2015

Parameters in CUSTOM.PPF

User defined WINNT fonts

User defined WINNT fonts


If you like to create your own Windows fonts (*.FON), you can use utility
"FONTEDIT.EXE" or the procedures as described in section Font and Graphic
utilities on page 382. Very important is that the name of the font you create has
to match with the filename (without extension). This fontname has to be entered
in uppercase letters in section [VIEWER_FONTS_XXX] for parameter "NAME"
in configuration file "CUSTOM.PPF" in directory C:\INSTALL\CUSTOM. The
new created font has to be copied in one of the resolution sub directories of
C:\PROTOPAS\FONTS\XXX. Than you can use function "Install Fonts and
Bitmaps" in menu "Update" of the "Configuration Manager" to register the new
font in the requested resolution. At least you have to make a CUSTOM.PPF
update via the PARAC call (CfgM "Call PARAC for Update" in menu "Update").
The second option is using utility "CPYNTFNT.EXE" via parameter options to
register a new Windows font. The PARAC call after the Windows registration is
needed too. See section Font and Graphic utilities on page 382 the detailed
description of utility "CPYNTFNT.EXE".

IMPORTANT: Depending on the selected Display Resolution you


have to set the correct SIZE and HEIGHT within the Windows fonts.
See table DDC resolution dependent values for "SIZE" and
"HEIGHT" on page 273 and table NDC resolution dependent values
for "SIZE" and "HEIGHT" on page 274. The values of "SIZE" and
"HEIGHT" in configuration file "CUSTOM.PPF" are set
automatically via utility "CPYNTFNT.EXE".
If you are using "FONTEDIT.EXE" you have to check the value of
"Nominal Vert. Resolution" and "Nominal Horiz. Resolution" in menu
"Fonts" function "Header". The value must be 96 for all resolutions.

June 2015

279

Enable and preconfigure ProAgent

Parameters in CUSTOM.PPF

Enable and preconfigure ProAgent


The following parameters are needed to enable and preconfigure the ProAgent.
If you need details of all configuration parameters refer to the ProAgent
(Windows) V1.0 Administration & Management System Manual Version 1.0/30.
A sub set of parameters needed by ProAgent are stored in configuration file
"PROVIEW.INA" located in directory C:\PROTOPAS\CONF. The basic
parameter set will be configured during ProAgent installation.

Set Primary/Secondary Server and Port


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:

""

Parameter name: PORT


Sections in *.PPF: [PRIMARYSERVER]
[SECONDARYSERVER]
Valid range:

00000 - 99999 (any valid port number)

Value description: specifies the ProAgent Server port number the Agent tries
to connect to.
Default values:

280

18988

June 2015

Parameters in CUSTOM.PPF

Enable and preconfigure ProAgent

Terminal ID of ATM client


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:

""

Enable Application Events


To enable displaying the application specific event messages in the event
window of ProAgent Server, you have to activate Bit 32 of parameter DESTxxx
in section [CUSTMSG]. Refer to section section [TOP_MSG] and
[CUST_MSG] on page 150.
Error description for ProAgent Server log window
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.

VDM Activation for ProAgent


For systems which support Vendor Dependend Mode (VDM) please refer to
document ProAgent (Windows) V1.0 Administration & Management System
Manual Version 1.0/30 for detailed description of required registry parameter
settings.

June 2015

281

EMV parameters

Parameters in CUSTOM.PPF

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:

282

June 2015

Parameters in CUSTOM.PPF

EMV parameters

Language support
The following parameter specifies a list of supported languages.
Parameter name: LANGUAGE_SUPPORTED
Sections in *.PPF: [LYNXCI_EMV]
Valid range:

ASCII character string (max 64)

Value description: the string can contain multiple two digit language codes.
Default value:

""

Example:

"endefrsp"
represents the languages "English" (en), "German" (de),
"France" (fr), "Spain" (sp).

EMV Protocol Vendor Specification


This parameter specifies the vendor specific EMV protocol.
Parameter name: PROTOCOL_SPEC
Sections in *.PPF: [LYNXCI_EMV]
Valid range:

WN, NCR CAM II, Diebold D91x

Value description: specifies which EMV vendor protocol should be used.


WN
- Wincor Nixdorf protocol specification
NCR CAM II - NCR protocol specification
Diebold D91x - Diebold protocol specification
Default value:

not configured, WN used as default

June 2015

283

EMV parameters

Parameters in CUSTOM.PPF

Acquirer Identifier 9F01


This parameter is used to configure an Acquirer Identifier, which uniquely
identifies the acquirer within each payment system. Please refer to the
EMV2000 Integrated Circuit Card Specification for Payment Systems Book1-4 for
detailed description.
Parameter name: ACQUIRER_IDENTIFIER_9F01
Sections in *.PPF: [EMV_TAGS]
Valid range:

ASCII character string in byte value notation of 6 bytes.

Value description: Two numeric digits with a preceding backslash represents


one byte (example entry: \11\22\33\44\55\66).
Default value:

not configured

Merchant Category Code 9F15


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:

284

not configured

June 2015

Parameters in CUSTOM.PPF

EMV parameters

Terminal Country Code 9F1A


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

Terminal Capabilities 9F33


The following parameter is used to specify the terminal capabilities, which
indicates the card data input, CVM, and security capabilities of the terminal.
Please refer to the EMV2000 Integrated Circuit Card Specification for Payment
Systems Book1-4 for detailed description.
Parameter name: TERMINAL_CAPABILITIES_9F33
Sections in *.PPF: [EMV_TAGS]
Valid range:

ASCII character string in byte value notation of 3 bytes.

Value description: Two numeric digits with a preceding backslash represents


one byte (example entry: \11\22\33).
Default value:

not configured in CUSTOM.PPF, but set to default value


\60\48\20 in registry during installation.

June 2015

285

EMV parameters

Parameters in CUSTOM.PPF

Terminal Type 9F35


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.

Additional Terminal Capabilities 9F40


This parameter is used to configure the Additional Terminal
Capabilities that indicates the data input and output capablilities of the terminal.
Please refer to the EMV2000 Integrated Circuit Card Specification for Payment
Systems Book1-4 for detailed description.
Parameter name: ADDITIONAL_TERMINAL_CAPABILITIES_9F40
Sections in *.PPF: [EMV_TAGS]
Valid range:

ASCII character string in byte value notation of 5 bytes.

Value description: Two numeric digits with a preceding backslash represents


one byte (example entry: \11\22\33\44\55).
Default value:

286

not configured in CUSTOM.PPF, but set to default value


\80\00\B0\53\FF in registry during installation.

June 2015

Parameters in CUSTOM.PPF

Vendor specific parameters

Vendor specific parameters


Number of physical cassettes names
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

Configure physical names of cassettes units


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)

Default DIEBOLD: PHYS_NAME_1 = BIN1


PHYS_NAME_2 = BIN2
PHYS_NAME_3 = BIN3
PHYS_NAME_4 = BIN4
[1] - X = physical unit number

June 2015

287

Vendor specific parameters

Parameters in CUSTOM.PPF

Set number of maximum rejected notes


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

Set number of maximum retracts


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:

288

99

June 2015

Parameters in CUSTOM.PPF

Vendor specific parameters

Enable test dispense function


The following parameter is required on Diebold systems. This parameter can be
used to enable a test dispense function that can be called from a
ProTopas/SOP-NDC or ProTopas/SOP-DDC function.
Parameter name: MV_TESTDISPENSE
Sections in *.NCR: [CASH_DISPENSER]
Section in *.DIB:
Valid range:

0-2

Value description: 0 - Test dispense switched off


1 - Dispense from all cassettes with the same currency.
Reject the bundle at the end (reject is called through
SOP).
2 - Dispense from each single cassette and reject each
single note after each singel dispense.
Default value:

1 for Diebold systems, all others not configured 0

Devide remaining notes equally to physical cassettes


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

June 2015

289

Vendor specific parameters

290

Parameters in CUSTOM.PPF

June 2015

Parameter Management

The PARAC run

Parameter Management
The PARAC run
During the J/Install installation process, but after installation of PARAC/NT, an
automatic call is initiated to the PARAC interface to preset the Windows registry
with default parameter definitions for each product.
The following graphics show four pop up windows which are indicating the
progress of the update steps. The last window shows the PARAC return code.
If PARAC returns with an error code (other than 0 or 7), an error description in
red color appears in the second line of the last pop up window.
Figure 4: PARAC Start window

Figure 5: PARAC Update window

Figure 6: PARAC Finish window with return code (0)

June 2015

291

Parameter update process via PARAC

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).
Figure 7: PARAC Finish window with error return code

Parameter update process via PARAC


After the installation in most cases some parameters must be additionally set or
changed. All parameters which are included in the Definition Files of PARAC
(located in C:\PARAC\DEF as binary files *.BIN), can be set in the customization
file CUSTOM.PPF. If the PARAC program is called after the installation it looks
for an existing CUSTOM.PPF file in C:\PARAC. If the PPF file exists and a new
parameter is defined or value of an existing parameter has been changed,
PARAC stores the new parameters or changed values into the WINNT Registry.
The correct syntax and value ranges of valid ProCash/NDC or ProCash/DDC
specific parameters for the CUSTOM.PPF can be taken from this manual. But
this is only a very small part of the parameters from the whole ProCash/NDCDDC environment. A huge number of basic parameters for each product like
ProBase/C, Protopas and ProCash/NDC or ProCash/DDC will be installed
automatically during the installation. To avoid any confusion we only have
included the most important parameters which are often changed after
installation.

292

June 2015

Parameter Management

PCEDT - PARAC Parameter Editor

PCEDT - PARAC Parameter Editor


If you want to view the whole set of defined parameters you have to use the
program PCEDT.EXE. This program is a frontend program where you can
search for parameters or select one for modification. With this program you can
create a new CUSTOM.PPF file where you can include parameters selected by
PCEDT. The new CUSTOM.PPF can be stored in C:\PARAC. If you then call
PARAC, the contents of CUSTOM.PPF will be moved into the Registry. After the
parameter move, the CUSTOM.PPF will be deleted.
Figure 8: Workbench of PCEDT

June 2015

293

Vendor and AddOn depended configuration

Parameter Management

Vendor and AddOn depended configuration


After the PARAC configuration was finished, additional batch routines will be
called within "C:\PROTOPAS\UPDCONF.CMD". Depending on what hardware
vendor (Wincor Nixdorf, NCR or Dienbold) and what AddOn product will be
installed different batch routines with specific parameter settings are called. The
vendor- and AddOn depended configuration- and batch routines will be stored
in several sub folders under "C:\PROTOPAS\CONF". During installation the
files from those sub folders are moved up to the working folder
"C:\PROTOPAS\CONF". Please refer to the tables in section ProCash/NDC
parameters on page 295 and section ProCash/DDC parameters on page 301
to get a short description about the contents of the vendor- and AddOn depened
sub folders.
One additional part of parameter configuration will be performed through
"CCRCCONV.EXE". These parameter files (*.INA format) are delivered via the
update diskettes of ProCash/NDC or ProCash/DDC and will be copied to
"C:\PROTOPAS\CONF" and to the vendor- and AddOn depended sub folders.
These parameters are completely independent from PARAC.
The INA files contain SECTIONS and PARAMETERS as we know it from the
Windows INI format. The INA files can be modified with any ASCII or ANSI
editor.
A converter program named "KCONF.EXE" (located in
"C:\PROTOPAS\CONF") converts the INA format to RCK format. The RCK
format can be used by "CCRCCONV.EXE" for the Registry update procedure.
During the installation, comfortable batch routines do the job to update the "INA"
contents automatically.

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.

294

June 2015

Parameter Management

Vendor and AddOn depended configuration

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:
Table 22: List of files in sub folder \BAS
FILE NAME

DESCRIPTION

CONV-ALL.BAT

Batch program which is called during the installation. The batch program
updates the registry with all INA files of directory C:\PROTPAS\CONF using
the batch files described in this table. After the call this file will be renamed to
CONV-ALL.OK

CONV.BAT

1. Calls KCONF.EXE to convert *.INA files to *.RCK


2. Calls CCRCCONV.EXE which uses *.RCK
CONV.BAT can be used to update one particular INA file if you call CONV.BAT
with one INA file as the parameter (without extension).
Example: CONV ccerrmap

CCERRMAP.INA

Parameters of CSC-W32 error codes and NDC/DDC error mapping table

LYNXSOP.INA

Rear balancing step table (header only)

PRTMACRO.INA

Parameter definition for macro settings in the printer INIT phase (see
Protopas "Programmers Reference" for detailed description)

PRTMACRO.BAT

Calls KCONF and CCRCCONV to update parameters from PRTMACRO.INA.

LOGON.INA

Parameters for automatic logon

LOGON.BAT

Calls KCONF and CCRCCONV to update parameters from LOGON.INA.

CSCW32.INA

Parameters to be set for CSCW32.

CSCW32.BAT

Calls KCONF and CCRCCONV to update parameters from CSCW32.INA.

SMI30.INA

Parameters to be set for SMI30

SMI30.BAT

Calls KCONF and CCRCCONV to update parameters from SMI30.INA

PROVIEW.INA

Parameters to be set for the ProAgent.

PROVIEW.BAT

Calls KCONF and CCRCCONV to update parameters from PROVIEW.INA.

CCCDMFW.INA

Parameters for CDM service of Protopas

CCCDMFW.BAT

Calls KCONF and CCRCCONV to update parameters from CCCDMFW.INA.

NDC.INA

Parameters of NDC message protocol

NDC.BAT

Calls KCONF and CCRCCONV to update parameters from NDC.INA.

CCERRDIF.BAT

Used by Configuration Manager only

CFGMANAG.LNK

Connection to the Configuration Manager to call it from the Start Menu

DATADICT.INA

Variable definitions needed for the data dictionary framework

NDCSOPDIA.CFG

Dialog definitions for ProTopas/SOP-NDC

NDCSOPSTP.CFG

Step definitions and common parameters for ProTopas/SOP-NDC

NDCSOPTXT.CFG

SOP Text definitions for ProTopas/SOP-NDC

CCSOPSTEP.BAT

Calls KCONF and CCRCCONV to update parameters of *.CFG files

GDI_PRT.INA

Parameters needed for GDI printing

GDI_PRT.BAT

Calls KCONF and CCRCCONV to update parameters from GDI_PRT.INA

WOSAKEYS.INA

Key definitions for FDKs, EPP and PIN Pad

NDCSOPSKE.INA

Secure Key Entry configuration for ProTopas/SOP-NDC

June 2015

295

Vendor and AddOn depended configuration

Parameter Management

NDCSOPSKE.BAT

Calls KCONF and CCRCCONV to update parameters from


NDCSOPSKE.INA

UNI-CHAR.REG

Default character sets for Unicode journal logging

Table 23: List of files in sub folder \BATCH


FILE NAME

DESCRIPTION

ADDONCHK.BAT

Calls utility ADDONCHK.EXE

RM2.BAT

Called on systems with Recycling Module 2 if CashIn is enabled

CCD.BAT

Called on systems with CCDM if CashIn is enabled

CDM.BAT

Called if the system has a Cash Dispenser

CHQ.BAT

Called on systems with CCDM if Cheque In is enabled

CRS.BAT

Called on CRS systems

COINOUT.BAT

Called on systems with integrated CoinOut module

COININ.BAT

Called on systems with integrated CoinIn module

EMV.BAT

Called if AddOn ProChip/EMV will be installed

P36.BAT

Called if AddOn ProCash/Signature will be installed

REGF.DEF

Definition file for ADDONCHK.EXE

VERS.DEF

Definition file for ADDONCHK.EXE

RKL.BAT

Called if AddOn ProRkl will be installed

RXE.BAT

Called if an CRS 3100xe is found

WEB.BAT

Called if AddOn WEB-Extensionswill be installed

WN.BAT

Called on Wincor Nixdorf hardware platforms

NCR.BAT

Called on NCR hardware platforms

NCRUSB.BAT

Called on NCR hardware platforms that have USB printer devices

NCRF.DEF

Definition file for ADDONCHK.EXE

DIEBOLD.BAT

Called on Diebold hardware platforms

Table 24: List of files in sub folder \CDM

296

FILE NAME

DESCRIPTION

CCERRMAP.INA

Parameters of CSC-W32 error codes and NDC/DDC error mapping table

WOSALATM.INA

Parameters for logical WOSA CDM service

WOSALATM.BAT

Calls KCONF and CCRCCONV to update parameters from WOSALATM.INA.

June 2015

Parameter Management

Vendor and AddOn depended configuration

Table 25: List of files in sub folder \CCD


FILE NAME

DESCRIPTION

NDCCDMDIA.CFG

Specific dialog configuration for CCDM of ProTopas/SOP-NDC

NDCCDMSTP.CFG

Specific step configuration for CCDM of ProTopas/SOP-NDC

NDCCDMTXT.CFG

Specific Text configuration for CCDM of ProTopas/SOP-NDC

NDCCRSDIA.CFG

Specific dialog configuration for CRS + CCDM of ProTopas/SOP-NDC

NDCCRSSTP.CFG

Specific step configuration for CRS + CCDM of ProTopas/SOP-NDC

NDCCRSTXT.CFG

Specific Text configuration for CRS + CCDM of ProTopas/SOP-NDC

CCSOPSTEP.BAT

Calls KCONF and CCRCCONV to update parameters of *.CFG files

LYNXCAIN.INA

CashIn step table (script) for ProTopas CashIn transaction framework

NDCCRS.INA

Parameters with CRS extensions of NDC message protocol

Table 26: List of files in sub folder \CHQ


FILE NAME

DESCRIPTION

NDCCDMDIA.CFG

Specific dialog configuration for CCDM of ProTopas/SOP-NDC

NDCCDMSTP.CFG

Specific step configuration for CCDM of ProTopas/SOP-NDC

NDCCDMTXT.CFG

Specific Text configuration for CCDM of ProTopas/SOP-NDC

NDCCRSDIA.CFG

Specific dialog configuration for CRS + CCDM of ProTopas/SOP-NDC

NDCCRSSTP.CFG

Specific step configuration for CRS + CCDM of ProTopas/SOP-NDC

NDCCRSTXT.CFG

Specific Text configuration for CRS + CCDM of ProTopas/SOP-NDC

CCSOPSTEP.BAT

Calls KCONF and CCRCCONV to update parameters of *.CFG files

June 2015

297

Vendor and AddOn depended configuration

Parameter Management

Table 27: List of files in sub folder \CRS


FILE NAME

DESCRIPTION

CCERRMAP.911

Specific error mapping table for DDC 911 protocol including CRS extensions

CCERRMAP.INA

Specific error mapping table including CRS extensions

CCSOPSTEP.BAT

Calls KCONF and CCRCCONV to update parameters of *.CFG files

NDCCRSDIA.CFG

Specific dialog configuration for CRS + CCDM of ProTopas/SOP-NDC

NDCCRSSTP.CFG

Specific step configuration for CRS + CCDM of ProTopas/SOP-NDC

NDCCRSTXT.CFG

Specific Text configuration for CRS + CCDM of ProTopas/SOP-NDC

LYNXCAIN.INA

CashIn step table (script) for ProTopas CashIn transaction framework

NDCCRS.INA

Parameters with CRS extensions of NDC message protocol

Table 28: List of files in sub folder \EMV

298

FILE NAME

DESCRIPTION

EMVDECRE.INA

Parameters for EMV

EMVDECRE.BAT

Calls KCONF and CCRCCONV to update parameters of EMVDECRE.INA

June 2015

Parameter Management

Vendor and AddOn depended configuration

Table 29: Error class files of folder \CCERRMAP


SUB FOLDER

DESCRIPTION

\BASIC

Basic set of error class files

\COININ

Specific set of error class files for coinin

\COINOUT

Specific set of error class files for coinout

\CCD

Specific set of error class files for CCDM

\RM2

Specific set of error class files for RM2 (PC4000)

\CDM

Specific set of error class files for cash dispenser

\CRS

Specific set of error class files for CRS (PC3100)

Table 30: List of files in sub folder \WEB\CONF


FILE NAME

DESCRIPTION

ACTIVEX.INA

Parameters for ActiveX controls of WEB-Extensions

WEB_ONL.REG

Additional parameters required for WEB-Extensions

Table 31: List of files in sub folder \WN


FILE NAME

DESCRIPTION

MV_CONF.BAT

Specific batch file that contains vendor specific programs or batch routines

Table 32: List of files in sub folder \NCR\XFS30


FILE NAME

DESCRIPTION

MV_CONF.SAV

Saved batch file that can be modified for specific programs or batch routines

CCCDMFW.INA

Specific dispenser settings required on NCR hardware platforms

CCERRNCR.INA

Specific error mapping table required for NCR WOSA

CCSOPNCR.INA

Specific SOP modifications for ProTopas/SOP-NDC for NCR

PRTMANCR.INA

Specific macro mappig table rewquired for NCR WOSA

WOSA-NCR.REG

Specific modifications for NCR WOSA

WOSA-NCR.SAV

Saved REG files contains some default parameters preconfigured

Table 33: List of files in sub folder \DIEBOLD\XFS30


FILE NAME

DESCRIPTION

CCCDMFW.INA

Specific dispenser settings required on diebold hardware platforms

CCERRDIB.INA

Specific error mapping table required for Diebold WOSA

CCSOPDIB.INA

Specific SOP modifications for ProTopas/SOP-DDC for Diebold

PRTMADIB.INA

Specific macro mappig table rewquired for Diebold WOSA

WOSA-DIB.REG

Specific modifications for Diebold WOSA

June 2015

299

Vendor and AddOn depended configuration

Parameter Management

Table 34: List of files in sub folder \FLX

300

FILE NAME

DESCRIPTION

flxScheme.ina

General Scheme parameters

flxScheme.1366

Scheme for resolution 1366x768

flxScheme.1024

Scheme for resolution 1024x768

flxScheme.640

Scheme for resolution 640x480

flxScheme.800

Scheme for resolution 800x600

flx.bat

Batch file for INA configuration files to process

flx.ina

PTFLEX configuration file with general parameters

flxada.INA

Configuration file for ADA voice control

flxddc.ina

DDC specific parameters

flxndc.ina

NDC specific parameters

flxop_eng.ina

Operation Code Buffers function mapping for english language

flxop_ger.ina

Operation Code Buffers function mapping for german language

flxop_spa.ina

Operation Code Buffers function mapping for spanish language

flxprinter.ina

Printer parameters

flxtext.ina

General text parameters

flxtext_eng.ina

Specific text parameters for english language

flxtext_ger.ina

Specific text parameters for german language

flxtext_spa.ina

Specific text parameters for spanish language

flxtrace.ina

Parameters to enable Java Script traces

flxtext_ger_uni.reg

Unicode parameters for german language

June 2015

Parameter Management

Vendor and AddOn depended configuration

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:
Table 35: List of files in sub folder \BAS
FILE NAME

DESCRIPTION

CONV-ALL.BAT

Batch program which is called during the installation. The batch program
updates the registry with all INA files of directory C:\PROTPAS\CONF using
the batch files described in this table. After the call this file will be renamed to
CONV-ALL.OK

CONV.BAT

1. Calls KCONF.EXE to convert *.INA files to *.RCK


2. Calls CCRCCONV.EXE which uses *.RCK
CONV.BAT can be used to update one particular INA file if you call CONV.BAT
with one INA file as the parameter (without extension).
Example: CONV ccerrmap

CCERRMAP.INA

Parameters of CSC-W32 error codes and NDC/DDC error mapping table

LYNXSOP.INA

Rear balancing step table (header only)

PRTMACRO.INA

Parameter definition for macro settings in the printer INIT phase (see
Protopas "Programmers Reference" for detailed description)

PRTMACRO.BAT

Calls KCONF and CCRCCONV to update parameters from PRTMACRO.INA.

LOGON.INA

Parameters for automatic logon

LOGON.BAT

Calls KCONF and CCRCCONV to update parameters from LOGON.INA.

CSCW32.INA

Parameters to be set for CSCW32.

CSCW32.BAT

Calls KCONF and CCRCCONV to update parameters from CSCW32.INA.

SMI30.INA

Parameters to be set for SMI30

SMI30.BAT

Calls KCONF and CCRCCONV to update parameters from SMI30.INA

PROVIEW.INA

Parameters to be set for the ProAgent.

PROVIEW.BAT

Calls KCONF and CCRCCONV to update parameters from PROVIEW.INA.

CCCDMFW.INA

Parameters for CDM service of Protopas

CCCDMFW.BAT

Calls KCONF and CCRCCONV to update parameters from CCCDMFW.INA.

DDC.INA

Parameters of DDC message protocol

DDC.BAT

Calls KCONF and CCRCCONV to update parameters from DDC.INA.

CAS_SCR.INA

Default screens for Countinous Availability (CAS) for DDC

CAS_SCR.BAT

Calls KCONF and CCRCCONV to update parameters from CAS_SCR.INA.

CCERRDIF.BAT

Used by Configuration Manager only

CFGMANAG.LNK

Connection to the Configuration Manager to call it from the Start Menu

DATADICT.INA

Variable definitions needed for the data dictionary framework

DDCSOPDIA.CFG

Dialog definitions for ProTopas/SOP-DDC

DDCSOPSTP.CFG

Step definitions and common parameters for ProTopas/SOP-DDC

DDCSOPTXT.CFG

SOP Text definitions for ProTopas/SOP-DDC

CCSOPSTEP.BAT

Calls KCONF and CCRCCONV to update parameters of *.CFG files

GDI_PRT.INA

Parameters needed for GDI printing

GDI_PRT.BAT

Calls KCONF and CCRCCONV to update parameters from GDI_PRT.INA

WOSAKEYS.INA

Key definitions for FDKs, EPP and PIN Pad

June 2015

301

Vendor and AddOn depended configuration

Parameter Management

DDCSOPSKE.INA

Secure Key Entry configuration for ProTopas/SOP-DDC

DDCSOPSKE.BAT

Calls KCONF and CCRCCONV to update parameters from


DDCSOPSKE.INA

UNI-CHAR.REG

Default character sets for Unicode journal logging

Table 36: List of files in sub folder \BATCH


FILE NAME

DESCRIPTION

ADDONCHK.BAT

Calls utility ADDONCHK.EXE

RM2.BAT

Called on systems with Recycling Module 2 if CashIn is enabled

CCD.BAT

Called on systems with CCDM if CashIn is enabled

CDM.BAT

Called if the system has a Cash Dispenser

CHQ.BAT

Called on systems with CCDM if Cheque In is enabled

CRS.BAT

Called on CRS systems

COINOUT.BAT

Called on systems with integrated CoinOut module

COININ.BAT

Called on systems with integrated CoinIn module

EMV.BAT

Called if AddOn ProChip/EMV will be installed

P36.BAT

Called if AddOn ProCash/Signature will be installed

REGF.DEF

Definition file for ADDONCHK.EXE

VERS.DEF

Definition file for ADDONCHK.EXE

RKL.BAT

Called if AddOn ProRkl will be installed

RXE.BAT

Called if an CRS 3100xe is found

WEB.BAT

Called if AddOn WEB-Extensionswill be installed

WN.BAT

Called on Wincor Nixdorf hardware platforms

NCR.BAT

Called on NCR hardware platforms

NCRUSB.BAT

Called on NCR hardware platforms that have USB printer devices

NCRF.DEF

Definition file for ADDONCHK.EXE

DIEBOLD.BAT

Called on Diebold hardware platforms

Table 37: List of files in sub folder \CDM

302

FILE NAME

DESCRIPTION

CCERRMAP.INA

Parameters of CSC-W32 error codes and NDC/DDC error mapping table

WOSALATM.INA

Parameters for logical WOSA CDM service

WOSALATM.BAT

Calls KCONF and CCRCCONV to update parameters from WOSALATM.INA.

June 2015

Parameter Management

Vendor and AddOn depended configuration

Table 38: List of files in sub folder \CCD


FILE NAME

DESCRIPTION

DDCCDMDIA.CFG

Specific dialog configuration for CCDM of ProTopas/SOP-DDC

DDCCDMSTP.CFG

Specific step configuration for CCDM of ProTopas/SOP-DDC

DDCCDMTXT.CFG

Specific Text configuration for CCDM of ProTopas/SOP-DDC

DDCCRSDIA.CFG

Specific dialog configuration for CRS + CCDM of ProTopas/SOP-DDC

DDCCRSSTP.CFG

Specific step configuration for CRS + CCDM of ProTopas/SOP-DDC

DDCCRSTXT.CFG

Specific Text configuration for CRS + CCDM of ProTopas/SOP-DDC

CCSOPSTEP.BAT

Calls KCONF and CCRCCONV to update parameters of *.CFG files

LYNXCAIN.INA

CashIn step table (script) for ProTopas CashIn transaction framework

Table 39: List of files in sub folder \CHQ


FILE NAME

DESCRIPTION

DDCCDMDIA.CFG

Specific dialog configuration for CCDM of ProTopas/SOP-DDC

DDCCDMSTP.CFG

Specific step configuration for CCDM of ProTopas/SOP-DDC

DDCCDMTXT.CFG

Specific Text configuration for CCDM of ProTopas/SOP-DDC

DDCCRSDIA.CFG

Specific dialog configuration for CRS + CCDM of ProTopas/SOP-DDC

DDCCRSSTP.CFG

Specific step configuration for CRS + CCDM of ProTopas/SOP-DDC

DDCCRSTXT.CFG

Specific Text configuration for CRS + CCDM of ProTopas/SOP-DDC

CCSOPSTEP.BAT

Calls KCONF and CCRCCONV to update parameters of *.CFG files

Table 40: List of files in sub folder \CRS


FILE NAME

DESCRIPTION

CCERRMAP.911

Specific error mapping table for DDC 911 protocol including CRS extensions

CCERRMAP.INA

Specific error mapping table including CRS extensions

CCSOPSTEP.BAT

Calls KCONF and CCRCCONV to update parameters of *.CFG files

DDCCRSDIA.CFG

Specific dialog configuration for CRS + CCDM of ProTopas/SOP-DDC

DDCCRSSTP.CFG

Specific step configuration for CRS + CCDM of ProTopas/SOP-DDC

DDCCRSTXT.CFG

Specific Text configuration for CRS + CCDM of ProTopas/SOP-DDC

LYNXCAIN.INA

CashIn step table (script) for ProTopas CashIn transaction framework

Table 41: List of files in sub folder \EMV


FILE NAME

DESCRIPTION

EMVDECRE.INA

Parameters for EMV

EMVDECRE.BAT

Calls KCONF and CCRCCONV to update parameters of EMVDECRE.INA

Table 42: List of files in sub folder \WEB\CONF


FILE NAME

DESCRIPTION

June 2015

303

Vendor and AddOn depended configuration

Parameter Management

ACTIVEX.INA

Parameters for ActiveX controls of WEB-Extensions

WEB_ONL.REG

Additional parameters required for WEB-Extensions

Table 43: List of files in sub folder \WN


FILE NAME

DESCRIPTION

MV_CONF.BAT

Specific batch file that contains vendor specific programs or batch routines

Table 44: List of files in sub folder \NCR\XFS30


FILE NAME

DESCRIPTION

MV_CONF.SAV

Saved batch file that can be modified for specific programs or batch routines

CCCDMFW.INA

Specific dispenser settings required on NCR hardware platforms

CCERRNCR.INA

Specific error mapping table required for NCR WOSA

CCSOPNCR.INA

Specific SOP modifications for ProTopas/SOP-NDC for NCR

PRTMANCR.INA

Specific macro mappig table rewquired for NCR WOSA

WOSA-NCR.REG

Specific modifications for NCR WOSA

WOSA-NCR.SAV

Saved REG files contains some default parameters preconfigured

Table 45: List of files in sub folder \DIEBOLD\XFS30


FILE NAME

304

DESCRIPTION

CCCDMFW.INA

Specific dispenser settings required on diebold hardware platforms

CCERRDIB.INA

Specific error mapping table required for Diebold WOSA

CCSOPDIB.INA

Specific SOP modifications for ProTopas/SOP-DDC for Diebold

PRTMADIB.INA

Specific macro mappig table rewquired for Diebold WOSA

WOSA-DIB.REG

Specific modifications for Diebold WOSA

June 2015

Parameter Management

Vendor and AddOn depended configuration

Table 46: List of files in sub folder \FLX


FILE NAME

DESCRIPTION

flxScheme.ina

General Scheme parameters

flxScheme.1366

Scheme for resolution 1366x768

flxScheme.1024

Scheme for resolution 1024x768

flxScheme.640

Scheme for resolution 640x480

flxScheme.800

Scheme for resolution 800x600

flx.bat

Batch file for INA configuration files to process

flx.ina

PTFLEX configuration file with general parameters

flxada.INA

Configuration file for ADA voice control

flxddc.ina

DDC specific parameters

flxndc.ina

NDC specific parameters

flxop_eng.ina

Operation Code Buffers function mapping for english language

flxop_ger.ina

Operation Code Buffers function mapping for german language

flxop_spa.ina

Operation Code Buffers function mapping for spanish language

flxprinter.ina

Printer parameters

flxtext.ina

General text parameters

flxtext_eng.ina

Specific text parameters for english language

flxtext_ger.ina

Specific text parameters for german language

flxtext_spa.ina

Specific text parameters for spanish language

flxtrace.ina

Parameters to enable Java Script traces

flxtext_ger_uni.reg

Unicode parameters for german language

June 2015

305

Customize Error Mapping Table CCERRMAP

Parameter Management

Customize Error Mapping Table CCERRMAP


Some of the most important customizing parameters are the NDC/DDC error
mapping definitions for CSC-W32 error codes, WOSA return codes and at least
the ProCash/NDC or ProCash/DDC (LYNX) errors. The file CCERRMAP.INA
contains all these error mapping definitions. This file can be customized with
any standard ASCII or ANSI text editor. To update the CCERMAP.INA after
modification you should use CONV.BAT as described in the previous table.
The following table shows a single parameter block of one error:
Table 47: Error parameter block of CCERRMAP
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

M_STATUS

[1]

Maintenance Status

M_DATA [1]

Maintenance Data (see section Variables in M-Data status


field on page 309)

REBOOT

Reboot flag. System reboots if this error occurs and flag is 1

SYSMSG_NUMBER
DDC_STATUS

[2]

See section [TOPMSG] in CUSTOM.PPF for definition


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 308

INFO

Error short description. This description can be journaled


(TOPMSG) via variable $DCMC_DEVICE_ERROR_INFO$

[1] used by ProCash/NDC only


[2] used by ProCash/DDC only

For ProCash/NDC the TD-Status of solicited cash dispenser status


messages can be modified by the application during runtime. In case
the number of notes dispensed field is ZERO, the TD-Status is set to
2 and for Card before Cash (FC A) the value is set to 4.
(CCERRMAP entry of TD_STATUS remain unchanged).
See ProCashNDC or ProCash/DDC User Guide for detailed descriptions of NDC or DDC status fields. The CSC-W32 error codes are
described in the System Messages manual of CSC-W32.
Refer also to manual Error Mapping Cross Reference Tables for
NDC and DDC status codes.

306

June 2015

Parameter Management

Customize Error Mapping Table CCERRMAP

Configure multiple CDM Error Reasons for DDC


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
DDC_MDS_STATUS

Note:

= "?3002,?0B75,@04,@00"
= "000DI01:3F:00:01,000DI01:3F:31p37,
000DR01:3A:41:40,000DR01:3A:37:41"

The different status codes have to be configured as a comma


separated list, where the first 911/912 error code in the list
corresponds to the first MDS status code, the second 911/912 error
code to the second MDS status code, and so on.
It is only allowed to configure all 4 error codes or just 1 error code.

June 2015

307

Customize Error Mapping Table CCERRMAP

Parameter Management

Variables in MDS i series status:


This section describes the field variables of parameter DDC_MDS_STATUS,
which are replaced by ProCash/DDC at runtime if the parameter
STATUS_CODE_HANDLING is set to 0. See the following figures for the
meaning of the variables:
a) money low (m, n) or money out (M, N)
DDC_MDS_STATUS = "000DI01:2D:0m:0n"
DDC_MDS_STATUS = "000DI01:3D:0M:0N"
cassette type E-H
cassette type A-D
see NOTE
replaced with the function ID index

b) feed failure for specific cassette


DDC_MDS_STATUS = "000DI01:3F:31p37"
value varies on physical cassette position 1-4.
replaced as ':' from DDC-Emulation
if last digit gets zero this value is added plus one
see NOTE
replaced with the function ID index

'I' is set to 9 if the error has to be sent as a solicited status message.

Example 1: money low


If denomination D and E are low, ProCash/DDC sends following MDS status:
000D901:2D:08:01
Example 2: money out
If denomination C and F are low, ProCash/DDC sends following MDS status:
000D901:3D:04:02
Example 3: pick error

If the second physical cassette has a pick error, ProCash/DDC sends following
MDS status: 000D901:3F:31:38

308

June 2015

Parameter Management

Customize Error Mapping Table CCERRMAP

Cassette specific variable in DDC912 status:


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.

Variables in M-Data status field


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"
cassette type 4 (see Note 1)
cassette type 3 (see Note 1)
cassette type 2 (see Note 1)
cassette type 1 (see Note 1)
cassette type 2, 1 are low (see Note 2)
cassette type 4, 3 are low (see Note 2)
only if value 00; 01 or 02 is set, the
cassette low or pick failure fields are
updated !!!

"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.

Value "C" is updated by ProCash/NDC.

June 2015

309

Customize Error Mapping Table CCERRMAP

Parameter Management

Error Class mapping of CSC-W32 and XFS classes


CSC-W32 generates several error classes that cannot be mapped to an NDC
or DDC device class, the same has to be done for some XFS error classes.
Therefore the Device Status Framework (dcDevSta.dll) assigns those errors to
a valid NDC or DDC device class. See also contents of the Error Mapping Table
CCERRMAP.INA located in "C:\PROTOPAS\CONF".

Please refer to the "System Messages" manual of CSC-W32 for detailed


error description of error CSC-W32 error classes.

The following table illustrates which CSC-W32 and XFS error classes are
currently assigned to the internal generated device class.
Table 48: CSC-W32 and XFS class assign table
CSC-W32 class

Assigned
Class

Device description

0005 (V.24 comm.)


0003 (USB comm.)

0008
AA08

Card Reader

0005 (V.24 comm.)


0032 (global PRT class
0003 (USB comm.)

0033

Journal printer

0005 (V.24 comm.)


0032 (global PRT class)
0003 (USB comm.)

0038

0005 (V.24 comm.)


0032 (global PRT class)
0003 (USB comm.)

0039

0005 (V.24 comm.)


0003 (USB comm.)

0018
AA18

Cash dispenser (CDM)

0005 (V.24 comm.)


0003 (USB comm.)

0017
AA17

Deposit module

0003 (USB comm.)


0005 (V.24 comm.)
0018 (CDM basic error)
001D (CDM extended error)

AA18_CIN
0018_CIN
0018_CIN
001D_CIN

CRS (CashIn)

0003 (USB comm.)


0004 (IEEE 1394 class)
0005 (V.24 comm.)
0003 (USB comm.)
0004 (IEEE 1394 class)
0005 (V.24 comm.)

CC1A
BB1A
EE1A
DD1A
AA1A
FF1A

CCDM (CashIn)

005A (RM2)
005E (RM2)

005A_CIN
005E_CIN

RM2 (CashIn)
RM2 (CashIn)

310

AA48
Receipt printer

AA45
Document printer

AA39

CCDM (Cheque In)

June 2015

Parameter Management

Customize Error Mapping Table CCERRMAP

00B9 (XFS 2.0 CDM errors)

00B9_CIN

CRS (CashIn)

6752 (XFS 3.0 CDM errors)


6751 (XFS 3.0 CRS errors)

001D
001D

CDM (CashOut)
CRS (CashOut)

Error mapping of XFS30 (WOSA) error events


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.
Table 49: XFS30 - CSC-W32 class assign table
XFS30
class

Assigned
CSC-W32
class

XFS30
code range

Assigned
CSC-W32
code range

Involved XFS Service

6751

001D

Dxxx

1xxx

PSCDM30 (Cash Dispenser Service)

6752

001D

Dxxx

3xxx

PSCRS30 (Cash Recycler Service)

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.

June 2015

311

Configure DDC 911 protocol

Parameter Management

Configure DDC 911 protocol


This section describes how to setup ProCash/DDC to run in Diebold 911 mode.
The default configuration of ProCash/DDC is based on DDC 912 mode.
The following actions have to be completed to run in Diebold 911 mode:

Use CCERRMAP.INA for 911 mode

Setup hardware configuration status fields for 911 mode

Dispenser configuration for HI and LO denomination bills

Use CCERRMAP.INA for 911 mode


ProCash/DDC will be delivered with a predefined error mapping file named
CCERRMAP.911.
After the installation you will find this file in C:\PROTOPAS\CONF.
To use the Diebold 911 specific device status you have to fill the CCERRMAP
section of the WINNT Registry with the contents of CCERRMAP.911 in the
following way:
1. Rename the existing CCERRMAP.INA to CCERRMAP.912 in directory
C:\PROTOPAS\CONF
2. Copy CCERRMAP.911 to CCERRMAP.INA
3. Call the batch job CONV CCERRMAP

Setup hardware configuration status fields for 911 mode


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 value 0C for parameter PREP_FIELD_22 represents


denomination C and D in the hardware configuration status info.

312

June 2015

Parameter Management

Configure DDC 911 protocol

Dispenser configuration for HI and LO denomination bills


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

The first denomination (CURRENCY_1 and VALUE_1) indicates


the HI denomination. The second denomination (CURRENCY_2
and VALUE_2) indicates the LO denomination (the currency and
value entry are examples only).
To enable the full Diebold 911 compatible mode you have to set
parameter DDC_NINE_ELEVEN_DENOM, and you need to
configure CURRENCY_3, CURRENCY_4 and VALUE_3, VALUE_4.
Please refer to section Diebold 911 compatible HI and LO denomination mode on page 314 for details.

June 2015

313

Configure DDC 911 protocol

Parameter Management

Diebold 911 compatible HI and LO denomination mode


In the standard Diebold 911 protocol the LO and HI denominations are
represented as letter C and letter D, where the LO denomination is assigned to
letter C and the HI denomination is assigned to letter D.
To enable the Diebold 911 compatible mode, the following parameter has to be
set:
Parameter name: DDC_NINE_ELEVEN_DENOM
Section in *.PPF:

[CASH_DISPENSER]

Valid range:

0, 1

Value description: 0 - compatible mode disabled


1 - compatible mode enabled
Default value:

not configured

If the parameter DDC_NINE_ELEVEN_DENOM is set,


the parameters CURRENCY_x and VALUE_x of section
[CASH_DISENSER] have to be set as follows:
Section in *.PPF:

[CASH_DISPENSER]

Parameters:

314

NUM_LOG_CASS = 4
CURRENCY_3 = "USD"
VALUE_3 = 10
CURRENCY_4 = "USD"
VALUE_4 = 20

June 2015

Parameter Management

Configure DDC 911 protocol

Specific Step for dispense FID 8 in 911 Mode


If ProCash/DDC should work in 911 Mode, you have to configure step
"DC_F_DISPENSE_911" for dispense FID 8. In case of a present/retract
failure, this function sends a solicited message to the central.
You can setup this step in configuration file CUSTOM.PPF.
Section in *.PPF:

[FUNC_ID_MAP]

Parameter:

STEP_NAME_X[1] = "DC_F_DISPENSE_911"

[1]

X = represents the number that has to correspond to parameter


REPLY_ID_X, where FID 8 is configured.

June 2015

315

Printer initialisation via macro tables

Parameter Management

Printer initialisation via macro tables


This section describes parameters which can be used to send specific printer
control sequences to the receipt or/and journal printer during the startup phase.
The control sequences can be taken from the printer specification manuals.
Within Protopas it is possible to setup user defined macro tables with your own
defined control sequences. With user defined macros you are able to send any
control sequence (which is supported) to the printers in the startup phase that
you need for your environment.
The following parameters can be set in configuration file "PRTMACRO.INA"
located in "C:\PROTOPAS\CONF".

Macro parameters for Journal and Receipt printer


[Wincor Nixdorf\ProTopas\CurrentVersion\CCOPEN\JOURNAL]
[Wincor Nixdorf\ProTopas\CurrentVersion\CCOPEN\RECEIPT]
Macro sub section
Parameter name:
Parameter values:
Value description:

MACRO_TABLE
JOURNAL_MACROS
RECEIPT_MACROS
specifies the sub section name that is appended to
..\CCOPEN\CCPRTFW\
The sub section specifies the location of the macro
parameters

Macro activation
Parameter name:
Value Range:
Value description:

MACRO_TABLE_ACTIVE
0, 1
Activates or deactivates the user defined macro
table.

Default value:

316

June 2015

Parameter Management

Printer initialisation via macro tables

Macro interpretation
Parameter name:
Value Range:
Value description:

HALF_DOUBLE_NUMBER_SIGNS
0, 1
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:

Printer INIT
Parameter name:
Value Range:
Value description:

INIT
any legal macro name
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#

June 2015

317

Printer initialisation via macro tables

Parameter Management

User defined Macros


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"

"USERINIT" is any macro name.


The value are the control sequences supported by ND9A or ND9E.
1b2b01 = data request
1b583400 = cancel
1b76 = send status to application

Now the parameter "USERINIT" has to be set as macro #USERINIT# in section:


[Wincor Nixdorf\ProTopas\CurrentVersion\CCOPEN\RECEIPT]
INIT = "#USERINIT#"

318

June 2015

Parameter Management

Printer initialisation via macro tables

Configurable ESC xx mapping to Macros


The following parameter can be used to assign printer macros to specific
escape control sequences which are sent in the print data buffer of the NDC or
DDC host reply.
This feature is supported for following ESC sequences:
ProCash/NDC
ESC p

- prints a Cheque Image

ProCash/DDC
ESC R
ESC r
ESC Q

- prints Cheque Image front side


- prints Cheque Image back side
- prints a configurable part of a Cheque Image

Parameter name:

ESC_xxn[1]

Section:

..\LYNXPAR\PRINTER\RECEIPT
..\LYNXPAR\PRINTER\DOCUMENT
..\LYNXPAR\PRINTER\JOURNAL

Value range:

valid macro sequence

Description:

This parameter can be used to set a macro sequence


which will be inserted in the PrintRaw data stream
when the specifc ESC sequence as listed above is
detected.

[1]

XX = hex value of the character after the ESC sign.


n = additional mandator or optional parameters which are additonaly
appended.

Examples:
ESC_51
ESC_52020
ESC_72020
ESC_7000
ESC_7001
ESC_7002
ESC_7010
ESC_7000001

=
=
=
=
=

"%DATDICT_VAR%"
(ESC Q)
"#PIC:WHITEF.JPG#" (ESC Rxxx)
"#PIC:WHITEB.JPG#" (ESC rxxx)
"#PIC:WHITEF.JPG#" (pxx) xx = front with codeline unchanged
"#PIC:WHITEF.JPG;PRT_IMG.JPG,BLACKEND#"
(pxx) xx = front codeline blackend
= "#PIC:WHITEF.JPG;PRT_IMG.JPG,REMOVED#"
(pxx) xx = front codeline removed
= "#PIC:WHITEB.JPG#" (pxx) xx = back
= "#PIC:GREENF.JPG#"
(pxxxxx) xxxxx = front with codeline type index 001

June 2015

319

Enable Secure Key Entry (SKE) mode

Parameter Management

Enable Secure Key Entry (SKE) mode


Secure Key Entry mode SOP function can be enabled via registry configuration
update. The configuration file NDCSOPSKE.INA for NDC or DDCSOPSKE.INA
for DDC and the belonging batch routines are stored in folder
C:\PROTOPAS\CONF. The configuration update can be performed via the
"Configuration Manager" using menu "Update", "Update INA or REG files"
select the required INA file and press the Update button. You can also use the
command prompt if you call the batch routine NDCSOPSKE.BAT or
DDCSOPSKE.BAT.

Enable Triple DES operation


This section describes how to configure Triple DES operation for ProCash/NDC
and ProCash/DDC.

Triple DES enabled via J/Install installation


If you like to enable Triple DES operation immediately during J/Install
installation, you need to set parameter "DOUBLE_LENGTH_KEYS" to "1" in
configuration file "CUSTOM.PPF". This can be automatically set if you say YES
for Triple DES in menu "Encryption Security" of the J/Install installation dialog.
If this parameter is enabled in "CUSTOM.PPF", configuration utility
"SetHwPPF.EXE" (option "-T" required) sets all needed parameters in the
registry and synchronously in "CUSTOM.PPF". "SetHwPPF.EXE" will be called
in batch file "updconf.bat" once at the end of the J/Install process.
Following configuration steps are performed by utility "SetHwPPF.EXE":

320

Creates a new EPP.INI file with empty section [SECURITY] in directory


C:\WOSASSP\CONF.
Note: EPP.INI will not be used any more if WOSA service PSPIN32.DLL
is in use.

June 2015

Parameter Management

Enable Triple DES operation

Triple DES activation manually on a running system


If you have performed a J/Install installation of ProCash/NDC or ProCash/DDC
in single DES mode, and you want to enable the Triple DES
configuration afterwards, you can use utility "SetHwPPF.EXE" with option "-T"
to perform an automatic Triple DES configuration update.
Following steps have to be performed (application has to be killed):

Call "InitEpp.EXE" with options -D -E (location C:\PROTOPAS\TOOLS).


This tool deletes all existing keys from the EPP.

Call utility SetHwPPF.EXE -T (location C:\PROTOPAS\TOOLS).

Switch back to Single DES operation


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

Switch to triple or single DES via SOP


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 345.

June 2015

321

Enable GDI Windows print

Parameter Management

Enable GDI Windows print


Since release 1.2/10 ProCash/NDC and ProCash/DDC support GDI windows
print for receipt and document printers that can be installed as windows printers.
These printers needs to be installed as a Windows printer through a Windows
printer driver.
Following printers provided by Wincor Nixdorf can operate as Windows printers:
Printer Model

Windows Name

supp. Print Mode

ND9G (receipt)

Wincor Nixdorf ND9G

GDI only

TP07 (receipt)

Wincor Nixdorf TP07

GDI / PrintRaw

TH21 (receipt 80 mm width)

WN TH21

GDI / PrintRaw

TH22 (receipt 120 mm width) WN TH22

GDI / PrintRaw

TP23 (receipt/document)

WN TH23

GDI only

TH97/G (document)

Wincor Nixdorf TH97/G GDI / PrintRaw

TP01 (document)

Wincor Nixdorf TP01

GDI / PrintRaw

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 269 and
section GDI Windows name for document printer on page 269 for detailed
description how to enable GDI windows printer. Pure GDI printer like ND9G are
installed automatically as a Windows printer.

GDI operation and configuration parameters


A detailed description of GDI operation, GDI print architecture and all possible
configuration parameters are described in ProTopas Module Construction Kit
Programming Guide Version 5.1/xx.
The document is stored as file name ProTopas_Modul Construction Kit.pdf
in folder \DOC\ProTopas\Kit\V5110 on Install CD NDC/DDC V3.0/21.

322

June 2015

Parameter Management

Enable GDI Windows print

Configuration settings for TH23 on Cineo 4090


The TH23 needs some specific configuration settings for the operation on a
Cineo 4090 system. On the Cineo 4090 system the TH23 is acting like a
document printer in the application layer. Therefore it is mandatory to specify
specific application parameters for the document print processing.
Following parameters and values are mandatory to be configured:
Required settings in GDI_PRT.INA:
[GDI_PRINTER\DOCUMENT]
PRINTER_NAME = "WN TH23"
TEXT_HEIGHT = "0"
MAX_LINES = "0"
MIN_LINES = "54"
[GDI_PRINTER\DOCUMENT\FONT_005]
MAX_LINES = "40"
TEXT_WIDTH = "2000"
TEXT_HEIGHT = "2000"
TEXT_HORZ_OFFSET = "50"
TEXT_VERT_OFFSET = "50"
Note: The above parameters will be stored in registry section:
[..\Wincor Nixdorf\ProTopas\Currentersion\
LYNXPAR\GDI_PRINTER\DOCUMENT\..]

Required settings in CUSTOM.PPF:


[DOCUMENTPRINTER]
NO_OF_DOC_BEFORE_EJECT = 1

Required settings in PROBASE.CUS:


cscw32.CSC-W.TH23_RETRACTCAPACITY = 30
cscw32.CSC-W.TH23_RETRACTHIGHTHRESHOLD = 25
cscw32.CSC-W.TH23_RETRACTTIME = 120000

June 2015

323

Enable card less transactions

Parameter Management

Enable card less transactions


The following parameters can be used to enable cardless transactions. Cardless
transactions means that consumer transactions can be initiated via inserting a
consumer card or via pressing a button on the EPP or through FDKs. The idle
dialog will be configured as a FDK selection dialog where you can enable the
buttons via local parameters. In addition you can locally define card track data and
next state exits.

Repository configuration of CLTSTTFW.DLL


The card less transaction framework overlay CltSttFw.DLL has to be appended to
the framework(s) configured via CUSTOM.PPF parameter TRANSACT_FRAME.
Refer also to section Transaction framework on page 75.

Dialog configuration parameters


The following parameters can be configured either in section
..\Wincor Nixdorf\ProTopas\Currentversion\LYNXPAR\APPLICATION]
where the parameters are valid for all screens, or in section
..\Wincor Nixdorf\ProTopas\Currentversion\LYNXCI\SCREEN\XXX]
where the parameters can be configured for each single screen.
XXX = represents the screen number subsection.
Table 50: Card less transaction parameters
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

324

June 2015

Parameter Management

Enable card less transactions

Parameter fields
The parameters in table Card less transaction parameters on page 324 except
the parameter IDLE_TIMEOUT (see description in section Timeout parameter on
page 326), use following parameter values:
Each parameter value comma separated is a separate parameter.
Table 51: Card less parameter fields
Field Range
Index

Size

Description

VAR

VAR

Track1 data (without start/end sentinel)

VAR

VAR

Track2 data (without start/end sentinel)

VAR

VAR

Track3 data (without start/end sentinel)

VAR

VAR

PIN block buffer


- This field can contain the PIN number in clear text format. The PIN should
NOT be padded.
- If the field is empty, no PIN buffer is sent to the host, unless one of the
following state is a PIN entry state where a PIN number has been entered.

0-999

Good next state number

0-999

Cancel exit next state

0-1

Start transaction flag


0 - using card data which are already loaded (if it isn't set in the Parameter
value list, will be used the default)
1 - using card data which are set in Track1, Track2, ... (default)

Example with predefined PIN 1234:


IDLE_ENTER = ",;5890049999999999=49121200000000000000?,,1234,510"
IDLE_A = ",;5890049999999999=49121200000000000000?,,1234,510"

Example without PIN:


IDLE_A = ",;5890049999999999=49121200000000000000?,,,510"

June 2015

325

Enable card less transactions

Parameter Management

Timeout parameter
The parameter IDLE_TIMEOUT can be used to configure a specific timeout
handling during a card less transaction. This parameter should be configured only if
card less transaction processing should be enabled in the middle of a transaction.
These parameters specify the parameter values for the timeout handling how long
this card less transaction should be taken.
Each parameter value comma separated is a separate parameter. If this parameter
is not set, no timeout will be used.

Table 52: Parameter fields for IDLE_TIMEOUT


Field
Index

Range

Size

Description

0-999

Timer in seconds

0-999

Timeout next state number

Example:
IDLE_TIMEOUT = "30,555"

Screen display and exit for parallel FDK press


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

326

June 2015

Parameter Management

Alpha numeric SMS key input style on EPP

Alpha numeric SMS key input style on EPP


The following parameters can be set to enable alpha numeric SMS key input on
the Electronic Pin Pad (EPP). This can be used to display alpha numeric
characters on the consumer screen and to send alpha numeric letters to the
host. The technique of value input is quiet similar as it is used for mobile phones.
The alpha numeric input will be processed in the Information Entry State H.

Assign values for Left/Right keys of the 0 key


The following parameters can be used to specify, which alpha numeric digits are
set when the left side key or the right side key from the 0 key is pressed.

Parameter name: KEY_LEFT_0_CHARS


Registry Key:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]

Valid range:

character string

Value description: specifies the digits to be padded


Default value:

- not configured

Example value:

00

Parameter name: KEY_RIGHT_0_CHARS


Registry Key:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]

Valid range:

character string

Value description: specifies the digits to be padded


Default value:

- not configured

Example value:

000

June 2015

327

Specify cursor character for input position

Parameter Management

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:

Specify cursor character for input position


The following parameter is used to configure the input cursor character for the
input position o the consumer screen.
Parameter name: ALPHA_CURSOR
Registry Key:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]

Valid range:

single character

Value description: specifies the cursor character for the input position on the
consumer display.
Default value:

- not configured

Example value:

<

328

June 2015

Parameter Management

Specify cursor character for input position

Specify cursor character for input position


The following parameter is used to configure the input cursor character for the
input position o the consumer screen.
Parameter name: ALPHA_CURSOR
Registry Key:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]

Valid range:

single character

Value description: specifies the cursor character for the input position on the
consumer display.
Default value:

- not configured

Example value:

<

Set up character sequences for single EPP keys


The following parameter are used to configure the character sequence, which
is displayed on the consumer screen after EPP keypress.
Parameter names: ALPHA_X_SEQ[1]
Registry Key:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]

Valid range:

1-4 numeric and alpha numeric digits

Value description: specifies the character sequence to display on the


consumer screen. The curser can be moved to the next
position to the right after each key press within the allowed
input time specified via parameter ALPHA_TIMER.
Default value:

- not configured

[1] - X = specifies the numeric key on the EPP (range 0-9)

See configuration parameter examples on the following page ...

June 2015

329

Input options for SMS input (NDC only)

Parameter Management

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"

Input options for SMS input (NDC only)


The following parameter can be used to set specific input options that have
influence to the screen display and input.
Parameter name: INPUT_HANDLING
Registry Key:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]

Valid range:

0-31

Value description: 0 - clear input field and start input from the left hand side if
maximum digits in input field has been reached
1 - ignore further inputs if amount buffer field is full
2 - ignore further inputs if numeric buffer field is full
4 - clear the last input in amount entry state using the clear
key
8 - clear the last input in information entry state using the
clear key
16 - do not show leading zeros in amount entry state
Default value:

330

0 - not configured

June 2015

Parameter Management

Dialog options for SMS input

Dialog options for SMS input


The following parameter can be used to set specific dialog options that have
influence to the screen display. This parameter can be globally set in the
SCREEN section or/and specifically in screen sub sections.
Parameter name: DIALOG_OPTIONS
Registry Keys:
or/and

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN\XXX] [1]

[1] - XXX = screen sub section


Valid range:

0-55

Value description: 0 - no options configured


1 - ignore horizontal and vertical offset when displaying a
picture as cursor @@
2 - auto end numeric input when length reached
4 - do not add extra space when switching to G font
(DDC only)
16 - disable alphanumeric entry
32 - wrap bottom text line overflow to the top screen line
Default value:

0 - no options configured

June 2015

331

Allowed alpha numeric characters for SMS input Parameter Management

Allowed alpha numeric characters for SMS input


The following parameter specifies the range of characters that are allowed to be
used for alpha numeric SMS key inputs in Amount Entry State (F) and
Informatio Entry State (H).
Parameter name: KBD_ALLOW_CHARS
Registry Key:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]

Valid range:

string with valid alpha numeric characters

Value description: see above


Default value:

- not configured

Example value:
01234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ,.-;:=

332

June 2015

Parameter Management

Enable timer restart for input dialogs

Enable timer restart for input dialogs


The following parameter can be used to enable restarting the input timer after
keypress in input dialogs of Amount Entry State (F), PIN Entry State (B),
Information Entry State (H) or Enhanced Information Entry State (@D ) (DDC).
That means with every keypress, the consumer get a specified extra time for a
new input.
Parameter name: RESTART_TIMER_ON_KEYPRESS
Registry Key:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]

Valid range:

Bit order
0x01 - Amount Entry state
0x02 - Pin Entry state
0x04 - Information Entry state
0x08 - Enhanced Information Entry state

Value description: specifies for which state the input timer restart handling is
enabled.
Default value:

15 - input restart enabled for all states

June 2015

333

Configure Dial Up communication

Parameter Management

Configure Dial Up communication


The following parameters are used to configure dial up communication settings in
configuration file CUSTOM.PPF.

Repository section [STARTUP]


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

Modem Interface 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:

334

C:\PROTOPAS\BIN\ComModem.DLL

June 2015

Parameter Management

Configure Dial Up communication

Serial Interface 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

Communication Yield DLL


The following parameter specifies the path and filename of the communication
yield framework.
Parameter names: COM52_FRAME
COM53_FRAME
COM54_FRAME
Section in *.PPF:

[STARTUP]

Valid range:

character string (path)

Value description: path location


Default value:

C:\PROTOPAS\BIN\ComYield.DLL

June 2015

335

Configure Dial Up communication

Parameter Management

Restart Manager section [START_APPLICATION]


Load dial up frameworks
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:

336

C:\PROTOPAS\BIN\FwLoadPm.EXE,4,1,21,,,
CCCommProtocol1 CCCommunication50
CCCommunication51 CCCommunication52
CCCommunication53 CCCommunication54"

June 2015

Parameter Management

Configure Dial Up communication

Specific communication settings


Modem automatic dial up number
Following parameters are configured as default in CUSTOM.PPF:
Parameter name: MODEM_AUTO_NUMBER
Sections in *.PPF: [MODEM_COMMANDS]
[MODEM_EVENTS]
[MODEM_PROJECT]
[MODEM_PROJECT_ALTERNATE]
Valid range:

character string (path)

Value description: Refer to ProTopas "Host Protocol and Communication


Frameworks" Programming Guide for detailed description
Default value:

Modem initialisation command


Parameter name: MODEM_CMD_CONFIG
Section in *.PPF:

[MODEM_COMMANDS]
[MODEM_EVENTS]
[MODEM_PROJECT]
[MODEM_PROJECT_ALTERNATE]

Valid range:

character string (path)

Value description: Refer to ProTopas "Host Protocol and Communication


Frameworks" Programming Guide for detailed description
Default value:

AT&F1E1X3M1

June 2015

337

Configure Dial Up communication

Parameter Management

Serial interface line attributes


Parameter name: SERIAL_LINEATTR
Section in *.PPF:

[SERIAL_COMMANDS]
[SERIAL_EVENTS]
[SERIAL_PROJECT]
[SERIAL_PROJECT_ALTERNATE]

Valid range:

character string (path)

Value description: Refer to ProTopas "Host Protocol and Communication


Frameworks" Programming Guide for detailed description
Default value:

57600,N,8,1

Serial interface port name


Parameter name: SERIAL_PORTNAME
Section in *.PPF:

[SERIAL_COMMANDS]
[SERIAL_EVENTS]
[SERIAL_PROJECT]
[SERIAL_PROJECT_ALTERNATE]

Valid range:

character string (path)

Value description: Refer to ProTopas "Host Protocol and Communication


Frameworks" Programming Guide for detailed description
Default value:

338

COM1

June 2015

Parameter Management

Configure Dial Up communication

Project settings
COM channel
The following parameter specifies modem communication channel.
Parameter name: COM_CHANNEL
Sections in *.PPF: [PROTOCOL_PROJECT]
Valid range:

character string (path)

Value description: Refer to ProTopas "Host Protocol and Communication


Frameworks" Programming Guide for detailed description
Default value:

50

Protocol channel
The following parameter specifies protocol channel.
Parameter name: PROT_CHANNEL
Sections in *.PPF: [PROTOCOL_PROJECT]
Valid range:

character string (path)

Value description: Refer to ProTopas "Host Protocol and Communication


Frameworks" Programming Guide for detailed description
Default value:

Protocol type
The following parameter specifies the protocol type.
Parameter name: COMM_PROTOCOL
Sections in *.PPF: [PROTOCOL_PROJECT]
Valid range:

character string (path)

Value description: Refer to ProTopas "Host Protocol and Communication


Frameworks" Programming Guide for detailed description
Default value:

VS2

June 2015

339

Configure Dial Up communication

Parameter Management

Route ID
This parameter specifies the Route ID.
Parameter name: ROUTE_ID
Sections in *.PPF: [PROTOCOL_PROJECT]
Valid range:

character string (path)

Value description: Refer to ProTopas "Host Protocol and Communication


Frameworks" Programming Guide for detailed description
Default value:

HANCO

Terminal ID
This parameter is used to configure a Terminal ID.
Parameter name: TERMINAL_ID
Sections in *.PPF: [PROTOCOL_PROJECT]
Valid range:

character string (path)

Value description: Refer to ProTopas "Host Protocol and Communication


Frameworks" Programming Guide for detailed description
Default value:

340

99999999

June 2015

Parameter Management Changing Network settings under restricted User

Changing Network settings under restricted User


To allow changing Windows network communication settings (e.g. TCP/IP
settings) under restricted user, you have to add the restricted user (where the
application is running) into user group "Network Configuration Operators".
Add user "Wincor" to user group "Network Configuration Operators":
To add user "Wincor" in user group "Network Configuration Operators" you have
to configure following command lines in JINSTALL.CUS:
execute.end.2.Program = {E:WINDIR}\system32\cmd.exe
execute.end.2.Parameter = /c net localgroup "Network Configuration Operators" /ADD "Wincor"

Activation with PC/E Terminal Security Access Protection:


If you are using PC/E Terminal Security Access Protection you have to extend
the SECURITY.SEC file. Please refer to the documentation of PC/E Terminal
Security Access Protection for details.

Parameters for Forms printing


To enable forms printing for Receipt or/and Document printers, you need to
replace the dcPrtGdi.dll against FormsPrt.dll of the Repository Manager
configuration for the CCRecPrtFW or/and CCDocPrtFW framework. During
installation default parameters are set in sections
..\LYNXPAR\PRINTER\RECEIPT and ..\LYNXPAR\PRINTER\DOCUMENT.
Please refer to manual ProTopas Module Construction Kit Programming Guide
Version 5.1 for detailed description of parameters and functional details.

June 2015

341

Rich Client Manager (RCM)

Parameter Management

Rich Client Manager (RCM)


Journal Event handling
Journal messages (Joker and Free journal), which should be sent to the server
via Rich Client Manager must be configured with the Journal Event destination
flag (bit value 4) in the DESTXXX parameter either in CUSTMSG or TOPMSG
section. In addtion parameter CUST_EVENTS_WITH_NUMBERS or
TOP_EVENTS_WITH_NUMBERS needs to be enabled. Please refer to
ProTopas Module Construction Kit Programming Guide Version 5.1/xx for
parameter details. In customizing file CUSTOM.RCC you will find a default set
of journal messages assigned to section [CUSTMSG], where the journal event
destination flag is enabled.
Free Journal
Free Journal means, the server receives the journal data and formats the
journal contents based on the variables and transaction type as specified for the
journal numbers via parameters MAPXXXX in registry section
..\CCSYSMG\RCCMSG]. Please refer to Rich Client Manager User Manual for
details. Defaults are specified in configuration file RCCMSG.INA.
Joker Journal
Joker Journal means, the server receives the journal data and stores it in the
data base without any formatting rules.

342

June 2015

Parameter Management

Rich Client Manager (RCM)

Client Settlement
If Settlement transactions should be sent via RCM to a PC/E server, you have
to configure the types of Settlement transactions assigned to the operation code
buffer of the Transaction Request and which print data should be used from
Transaction Reply.
Parameter name: RCC_STLMT_OP_CODES
Section in *.RCC: [HARDWARE_CONFIGURATION]
Valid range:

comma separated list with following format:


8 digit Operation Code buffer
: (colon)
Receipt or Journal buffer
: (colon)
Settlement Type
, (comma)
...

Value description: 8 digit Operation Code buffer


This field has to contain the operation code buffer of the
Transaction Request which belongs to the type of
Settlement transaction
Receipt or Journal buffer
Specifies which print data should be parsed from
Transaction Reply.
R - parse receipt data
J - parse journal data
Settlement Type
Specifies the type of Settlement transaction:
TERMINAL_CLOSE, CLEAR_CASH, ADD_CASH
SUBTRACT_CASH, PRINT_TOTALS, ...
(further types can be found in the RCM Programmers
Reference *.CHM manuals)
Default value:

not configured

Exampe:

"IGA :R:TERMINAL_CLOSE,
IGA I :J:TERMINAL_CLOSE"

June 2015

343

Rich Client Manager (RCM)

344

Parameter Management

June 2015

Software updates via SOP

Update diskette creation

Software updates via SOP


This section describes an easy way to transfer new software modules and
parameter settings from a floppy diskette onto the harddisk without an additonal
keyboard. For the data transfer from floppy to harddisk you can use the SOP
function "Copy Files". See also details in the ProTopas/SOP User Guide.

Update diskette creation


For the "Copy Files" function the configuration file "SOPCOPY.TXT" must be
created on a diskette. The "Copy Files" function can copy files from source to
destination. This function can also call *.EXE programs. Therefore the
DESTINATION PATH has to be replaced against "run" instead of the path.
The three parameters have to be separated with one space (blank).
SOPCOPY.TXT contents have the following structure for example:
FILE NAME
$update$.z
custom.ppf
$update$.reg

SOURCE PATH DESTINATION PATH


a:\
c:\protopas
a:\
c:\parac
a:\
c:\protopas

$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

June 2015

345

Automatic update process

Software updates via SOP

Automatic update process


After you have called the function "Copy Files" you have to open the operator
door if necessary. Then you can put the diskette into the floppy drive. If you
confirm the function, all the files defined in SOPCOPY.TXT are transfered to the
harddisk. If the function has been finished correctly, you have to restart the
system via SOP function "Restart System". Now the application shuts down and
the system reboots. Before the application comes up the contents of
CUSTOM.PPF are updated via an automatic call of PARAC.EXE. The second
step is the extraction of UPDATE.Z via ICOMP.EXE. After extraction the file
$UPDATE$.Z will be deleted on the harddisk. The third step is a call of
"regedit -s c:\protopas\$update$.reg" if the file $update$.reg exists in the
c:\protopas harddisk directory.
Now in the last step the application will be started. The automatic update
process also checks for an existing $update$.bat and calls the batch file if it
exists in "C:\PROTOPAS". After the batch call the file $update$.bat will be
deleted.

The automatic PARAC call, the call of REGEDIT and the extraction routine are
defined in batch file STARTUPAPPL.BAT located in \PROTOPAS\BIN folder.

This software update procedure via ProTopas/SOP has the


advantage that no additional keyboard is required for updating
parameters or new software modules which are common for rear load
systems.

346

June 2015

Start and Stop Application services

Start application services

Start and Stop Application services


Start application services
After J/Install has finished the installation the application will be started automatically via batch file "STARTUP.BAT" located in folder C:\PROTOPAS\BIN.
STARTUP.BAT calls several steps for logging and services and finally it calls the
application specific batch file STARTUPAPPL.BAT.
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.

Stop application services


The application can be stopped (killed) via "FWKILL.BAT" located in
C:\PROTOPAS.

June 2015

347

Stop application services

348

Start and Stop Application services

June 2015

Application Error Classes

Transaction Framework (Class 6434)

Application Error Classes


The following sections describe the application specific errors which are
generated by ProCash/NDC or ProCash/DDC. Typically those errors are used
in cases if no CSC-W32 device error is available from the operating system. In
addition the application generates internal error messages for some return
codes of the ProDevice (WOSA) interface. Details about NDC and DDC status
code mapping are described in manual Error Mapping Cross Reference Tables.

Transaction Framework (Class 6434)


The following table lists those errors which are generated by the Transaction
Framework (dcsttfw.dll).
Table 53: Transaction Framework Error Table
Class

Error Code [1]

TOPMSG
Number

Description

6434

0001

1031

Card was captured

6434

0002

1032

Receipt printer not configured

6434

0003

1032

Statement printer not configured

6434

0004

1032

Statement has been retracted

6434

0005

1039

Deposit error

6434

0006

1021

Deposit canceled

6434

0007

1022

Deposit timeout

6434

0008

1023

Deposit not configured

6434

0009

1029

Cash dispenser not configured

6434

000A

1033

Journal printer general error

6434

000B

1036

Receipt printer general error

6434

000C

1035

Document printer general error

6434

000D

1031

Card reader general error

6434

000E

1033

Journal printer error, spooler active

6434

0010

""

Cash has been retracted

6434

0011

1039

Deposit shutter could not be opened

6434

0012

1038

Vandal Guard could not be opened

6434

0013

1031

Card read treshold maximum reached

6434

0014

""

Cassette has low bills

6434

0015

1049

Paper low on journal printer

June 2015

349

Transaction Framework (Class 6434)

Application Error Classes

6434

0016

1050

Paper low on receipt printer

6434

0017

1051

Paper low on document printer

6434

0018

1501

Try to dispense with money in transport

6434

0019

1031

Card write attempt but no data to write

6434

0020

1029

Cash dispenser shutter error

6434

0021

1039

Deposit bin missing

6434

0022

1039

Deposit jam

6434

0023

1039

Deposit envelope jam during dispense

6434

0024

1039

Deposit no envelopes available

6434

0025

1039

Deposit printer failure

6434

0026

1039

Deposit wrong envelope size

6434

0027

1039

Deposit shutter not closed

6434

0028

1039

Deposit bin is overfilled

6434

0029

1031

Card Reader bin is overfilled

6434

002A

1029

CAS: dialog (907) timeout while service dispenser

6434

002B

1029

CAS: dialog (907) cancel while service dispenser

6434

002C

1023

CAS: dialog (906) timeout while service deposit module

6434

002D

1023

CAS: dialog (906) cancel while service deposit module

6434

002E

1035

CAS: dialog (907) timeout while service statement printer

6434

002F

1035

CAS: dialog (907) cancel while service statement printer

6434

0030

1039

Envelope dispenser low

6434

0031

1039

Envelope dispenser empty

6434

0032

1039

Envelope dispenser error

6434

0033

1039

Envelope dispenser jam

6434

0034

1039

Envelope dispenser shutter not close

6434

0035

1039

Envelope dispenser shutter not open

6434

0036

1032

Statement capture bin full

6434

0037

1033

Journal paper nearly empty

6434

0038

1033

Receipt paper nearly empty

6434

0039

1039

Shutter not close or money jam, no dispense operation

6434

003A

1031

Card manipulation detected while waiting for card

6434

003B

1033

Journal printer error, spooler active

6434

003C

1033

Journal printer ok, reprint started

6434

003D

1033

Journal printer ok, reprint finished

6434

003E

1033

Journal printer error, spooler error

6434

003F

1500

GetPIN error, PIN dialog was cancelled via command

350

June 2015

Application Error Classes

Transaction Framework (Class 6434)

6434

0040

1033

Receipt paper jam or paper empty

6434

0041

1033

Journal paper jam or paper empty

6434

0042

1031

Card was captured after jam

6434

0043

1033

Hard disk free space low (warning) / out (error)

6434

0044

1031

Card write attempted but track for writing not installed

6434

0045

1031

Card write command failed

6434

0046

1031

Card trap active (Lebanese Loop)

6434

0047

1031

Mouth piece removed (vandalism)

6434

0048

1031

Card reader skimming active

6434

0049

1031

Too many consecutive card jams

6434

004A

1031

Shutter not close and cash tray not empty, dispense


operation declined

6434

004B

1031

Shutter not close but cash tray empty, dispense operation


declined

6434

004C

1031

Shutter closed but cash tray not empty, dispense


operation declined

6434

004D

1031

Shutter closed, cash tray empty, but transport way not


free, dispense operation declined

6434

004F

1031

DIP Card not taken

6434

0050

1061

CoinOut hopper low or out

6434

0051

1061

CoinOut low condition not set

6434

0052

1061

CoinOut hopper empty, no dispense attempted

6434

0053

1061

CoinOut module inoperative before dispense

6434

0054

1061

CoinOut hopper low, no dispense attempted

6434

0055

1061

CoinOut dispense error, but coins dispensed

6434

0056

1061

CoinOut dispense error, hopper jam, but partial dispense


possible

6434

0057

1061

CoinOut dispense fatal error, no coins dispensed

June 2015

351

Cash Dispenser Framework (class 643A)

Application Error Classes

Cash Dispenser Framework (class 643A)


The following table lists all errors which are generated by the Cash Dispenser
Framework (dccdmfw.dll).
Table 54: Cash Dispenser Framework Error Table
Class

Error Code [1]

TOPMSG
Number

Description

643A

0001

1029

Invalid cassette number

643A

0002

1041

Cash cannot be dispensed

643A

0003

1029

Cash cannot be dispensed while safe door open

643A

0004

1029

Reject cassette or whole dispenser not operational

643A

0005

1029

Reject cassette overfilled

643A

0006

1029

Maximum retracts reached

643A

0007

1029

Reject cassette missing

643A

0008

1029

Maximum consecutive present errors reached

643A

0009

1029

The cash dispenser status is fatal

643A

000B

1029

Partial/short dispense/present

352

June 2015

Application Error Classes

Cash Dispenser Framework (class 643A)

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.
Table 55: Cash Dispenser return code table
Class CDM
return
Code

Error
Code [1]

TOPMSG
Number

Description

643A

-331

FEB5

1029

Order not allowed

643A

-330

FEB6

1029

Shutter not closed

643A

-324

FEBC

1029

Present job active

643A

-323

FEBD

1029

No items to present

643A

-322

FEBE

1029

Unknown present error

643A

-321

FEBF

1029

Error in bills presentation

643A

-320

FEC0

1029

Denomination error

643A

-317

FEC3

1029

No documents (no bills)

643A

-316

FEC4

1029

Invalid cash unit

643A

-315

FEC5

1029

Shutter closed

643A

-314

FEC6

1029

Shutter open

643A

-313

FEC7

1029

Shutter not open

643A

-312

FEC8

1029

Invalid retract

643A

-311

FEC9

1029

Safe door open

643A

-310

FECA

1029

Position locked

643A

-309

FECB

1029

Invalid position

643A

-308

FECC

1029

Documents, bills left in transport

643A

-307

FECD

1029

Too many documents dispensed

643A

-306

FECE

1029

The requested notes are not dispensable

643A

-305

FECF

1029

No currency mix

643A

-304

FED0

1029

Invalid mix type

643A

-303

FED1

1029

Invalid denomination

643A

-302

FED2

1029

Cash unit error

643A

-301

FED3

1029

Invalid teller ID

643A

-300

FED4

1029

Invalid currency

643A

-48

FED0

1029

Error timeout

643A

-14

FFF2

1029

Hardware error, cannot dispense or deliver

643A

-13

FFF3

1029

Hardware error, device not ready

643A

-1

FFFF

1029

General error, device not ready

June 2015

353

Security Overlay Framework (Class 643C)

Application Error Classes

Security Overlay Framework (Class 643C)


The following table lists those errors which are generated by the Security
Overlay Framework (dcsecure.dll).
Table 56: Transaction Framework Error Table
Class

Error Code [1]

TOPMSG
Number

Description

643C

0001

1500

Set key error, possibly wrong security keys loaded

643C

0002

1500

PIN check error, possibly wrong security keys

643C

0003

1500

Error while creating PIN block for remote PIN block buffer
included in transaction request message

643C

0004

1500

The correct MAC could not be calculated

643C

0005

1500

Key error while initializing transaction, possibly no keys


loaded in EDM or EPP

[1]

354

This error code can be interpreted as a WARNING or ERROR class by


the ProCash/NDC or ProCash/DDC application.

June 2015

Registry Cross Reference

Registry Cross Reference


The following tables show the cross link of "User Area" (Section) and
"User Name" (Parameter) defined in "CUSTOM.PPF" to the Windows Registry
section location and parameter name.
Table 57: Registry cross link [STARTUP]
USER AREA in"CUSTOM.PPF"
[STARTUP]

USER NAME
SEL_FRAME
BARCODE_FRAME
JOURNAL_FRAME
SERVICE_FRAME
OPL_FRAME
APPLICATION_FRAME
CDM_FRAME
COINOUT_FRAME
APPL_DATA_FRAME
SMI_FRAME
DLG_FRAME
COM_FRAME
SEC_FRAME
CARD_FRAME
EPP_FRAME
DIALOG_FRAME
SCRIPT_FRAME
CONVERTER_FRAME
SYNC_FRAME
JOURNAL_FRAME
MSGCTRL1_FRAME
RECPRT_FRAME
PROT1_FRAME
PRESS_FRAME
DEVSTA_FRAME
DEPOSIT_FRAME
TRANSACT_FRAME
USEREXIT_FRAME
VARIABLE_FRAME
SECURE_FRAME
DOCPRT_FRAME
CCSOP_DIALOG

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
CCREPMGR\FRM_REPOSITORY]
REGISTRY PARAMETER
CCSelFW
CCBcrFW
CCJournal
CCServiceFW
CCOplFW
CCApplFW
CCCdmFW
CCCoinOutFW
CCDataFW
CCSmiFW
CCDlgFW
CCCommunication1
CCSecFW
CCCardFW
CCEppFW
CCDialog
CCSCRIPTFW
DCConvFW
CCSyncFW
CCJourPrtFW
CCMessageControl1
CCRecPrtFW
CCProtFW1
CCPresFW
CCDeviceStatusFW
CCDepositFW
CCTransactionFW
CCSUEFW
CCVarFW
CCSecureFW
CCDocPrtFW
CCSopDialog

June 2015

355

Registry Cross Reference


Table 58: Registry cross link [START_APPLICATION]
USER AREA in"CUSTOM.PPF"
START_APPLICATION

USER NAME
APPLICATION_SET
PROGRAMLIST

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
CCOPEN\RESTART\APPLICATION_1]
REGISTRY PARAMETER
ApplPM
PROGRAMS

Table 59: Registry cross link [DEFAULT]


USER AREA in"CUSTOM.PPF"
DEFAULT
USER NAME
SHUTDOWN_ACTIVE
MAXREBOOT
POWER_UP_PERIOD
SHUTDOWN_EXE

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\RESTART\DEFAULTS]
REGISTRY PARAMETER
SHUTDOWN_ACTIVE
MAXREBOOT
POWER_UP_PERIOD
SHUTDOWN_EXE

Table 60: Registry cross link [CCProtFW1]


USER AREA in"CUSTOM.PPF"
CCProtFW1
USER NAME
PROTOCOL
CCVTABLE
LOG_FILE
LOG_FILE_SIZE
HANDLE_ETX

356

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\CCProtFW1]
REGISTRY PARAMETER
PROTOCOL
CCVTABLE
LOG_FILE
LOG_FILE_SIZE
HANDLE_ETX

June 2015

Registry Cross Reference


Table 61: Registry cross link [MODEM]
USER AREA in"CUSTOM.PPF"
MODEM_COMMANDS

USER NAME
MODEM_AUTO_NUMBER
MODEM_CMD_CONFIG
USER AREA in"CUSTOM.PPF"
MODEM_EVENTS

USER NAME
MODEM_AUTO_NUMBER
MODEM_CMD_CONFIG
USER AREA in"CUSTOM.PPF"
MODEM_PROJECT

USER NAME
MODEM_AUTO_NUMBER
MODEM_CMD_CONFIG
USER AREA in"CUSTOM.PPF"
MODEM_PROJECT_ALTERNATE

USER NAME
MODEM_AUTO_NUMBER
MODEM_CMD_CONFIG

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\
MODEM\COMMANDS]
REGISTRY PARAMETER
AUTO_NUMBER
CMD_CONFIG
REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\
MODEM\EVENTS]
REGISTRY PARAMETER
AUTO_NUMBER
CMD_CONFIG
REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\
MODEM\PROJECT]
REGISTRY PARAMETER
AUTO_NUMBER
CMD_CONFIG
REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\
MODEM\PROJECT_ALTERNATE]
REGISTRY PARAMETER
AUTO_NUMBER
CMD_CONFIG

June 2015

357

Registry Cross Reference


Table 62: Registry cross link [SERIAL]
USER AREA in"CUSTOM.PPF"
SERIAL_COMMANDS

USER NAME
SERIAL_LINE_ATTR
SERIAL_PORTNAME
USER AREA in"CUSTOM.PPF"
SERIAL_EVENTS

USER NAME
SERIAL_LINE_ATTR
SERIAL_PORTNAME
USER AREA in"CUSTOM.PPF"
SERIAL_PROJECT

USER NAME
SERIAL_LINE_ATTR
SERIAL_PORTNAME
USER AREA in"CUSTOM.PPF"
SERIAL_PROJECT_ALTERNATE

USER NAME
SERIAL_LINE_ATTR
SERIAL_PORTNAME

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\
SERIAL\COMMANDS]
REGISTRY PARAMETER
LINE_ATTR
PORTNAME
REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\
SERIAL\EVENTS]
REGISTRY PARAMETER
LINE_ATTR
PORTNAME
REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\
SERIAL\PROJECT]
REGISTRY PARAMETER
LINE_ATTR
PORTNAME
REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\
SERIAL\PROJECT_ALTERNATE]
REGISTRY PARAMETER
LINE_ATTR
PORTNAME

Table 63: Registry cross link [PROTOCOL\PROJECT]


USER AREA in"CUSTOM.PPF"
PROTOCOL_PROJECT

USER NAME
COM_CHANNEL
COMM_PROTOCOL
PROT_CHANNEL
ROUTE_ID
TERMINAL_ID

358

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\
PROTOCOL\PROJECT]
REGISTRY PARAMETER
ComChannel
ComProtocol
ProtocolChannel
RouteID
TerminalID

June 2015

Registry Cross Reference


Table 64: Registry cross link [HARDWARE_CONFIGURATION] (DDC)
USER AREA in"CUSTOM.PPF"

REGISTRY LOCATION

[HARDWARE_CONFIGURATION]

[HKEY_LOCAL_MACHINE\SOFTWARE\
Wincor Nixdorf\ProTopas\CurrentVersion\
CCOPEN\PROTOCOL\PARAMETER]

USER NAME

REGISTRY PARAMETER

EXPANDED_HW_CONF_BYTE_0

EXPANDED_HW_CONF_BYTE_0

EXPANDED_HW_CONF_BYTE_1

EXPANDED_HW_CONF_BYTE_1

EXPANDED_HW_CONF_BYTE_2

EXPANDED_HW_CONF_BYTE_2

EXPANDED_HW_CONF_BYTE_3

EXPANDED_HW_CONF_BYTE_3

EXPANDED_HW_CONF_BYTE_4

EXPANDED_HW_CONF_BYTE_4

EXPANDED_HW_CONF_BYTE_5

EXPANDED_HW_CONF_BYTE_5

EXPANDED_HW_CONF_BYTE_6

EXPANDED_HW_CONF_BYTE_6

EXPANDED_HW_CONF_BYTE_7

EXPANDED_HW_CONF_BYTE_7

EXPANDED_HW_CONF_BYTE_8

EXPANDED_HW_CONF_BYTE_8

EXPANDED_HW_CONF_BYTE_9

EXPANDED_HW_CONF_BYTE_9

EXPANDED_HW_CONF_BYTE_10

EXPANDED_HW_CONF_BYTE_10

EXPANDED_HW_CONF_BYTE_11

EXPANDED_HW_CONF_BYTE_11

EXPANDED_HW_CONF_BYTE_12

EXPANDED_HW_CONF_BYTE_12

EXPANDED_HW_CONF_BYTE_13

EXPANDED_HW_CONF_BYTE_13

EXPANDED_HW_CONF_BYTE_14

EXPANDED_HW_CONF_BYTE_14

EXPANDED_HW_CONF_BYTE_15

EXPANDED_HW_CONF_BYTE_15

DOUBLE_EXPANDED_HW_CONF_BYTE_16

DOUBLE_EXPANDED_HW_CONF_BYTE_16

DOUBLE_EXPANDED_HW_CONF_BYTE_17

PREP_FIELD_029

DOUBLE_EXPANDED_HW_CONF_BYTE_18

PREP_FIELD_030

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

RKL_ENCODING

RKL_ENCODING

SAF_MACH_NO

SAF_MACH_NO

June 2015

359

Registry Cross Reference


Table 65: Registry cross link [HARDWARE_CONFIGURATION] (NDC)
USER AREA in"CUSTOM.PPF"

REGISTRY LOCATION

[HARDWARE_CONFIGURATION]

[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
CCOPEN\PROTOCOL\PARAMETER]

USER NAME

REGISTRY PARAMETER

HW_CONF_0_PROD_CLASS

HW_CONF_0_PROD_CLASS

HW_CONF_1_NOCONFIG

HW_CONF_1_NOCONFIG

HW_CONF_2_DISK

HW_CONF_2_DISK

HW_CONF_3_CARD_READER

HW_CONF_3_CARD_READER

HW_CONF_4_CASH_HANDLER

HW_CONF_4_CASH_HANDLER

HW_CONF_5_PPD

HW_CONF_5_PPD

HW_CONF_6_REC_PRINTER

HW_CONF_6_REC_PRINTER

HW_CONF_7_JRN_PRINTER

HW_CONF_7_JRN_PRINTER

HW_CONF_8_RESERVED

HW_CONF_8_RESERVED

HW_CONF_9_RESERVED

HW_CONF_9_RESERVED

HW_CONF_10_NIGHT_DEPOSIT

HW_CONF_10_NIGHT_DEPOSIT

HW_CONF_11_ENCRYPTOR

HW_CONF_11_ENCRYPTOR

HW_CONF_12_CAMERA

HW_CONF_12_CAMERA

HW_CONF_13_DOOR_ACCESS

HW_CONF_13_DOOR_ACCESS

HW_CONF_14_FLEX_DISK

HW_CONF_14_FLEX_DISK

HW_CONF_15_TAMPER_BINS

HW_CONF_15_TAMPER_BINS

HW_CONF_16_CARDHOLDER_KEYB

HW_CONF_16_CARDHOLDER_KEYB

HW_CONF_17_OPERATOR_KEYB

HW_CONF_17_OPERATOR_KEYB

HW_CONF_18_DISPLAY_VOICE

HW_CONF_18_DISPLAY_VOICE

HW_CONF_19_NOCONFIG

HW_CONF_19_NOCONFIG

HW_CONF_20_NOCONFIG

HW_CONF_20_NOCONFIG

HW_CONF_21_STATEMENT_PRT

HW_CONF_21_STATEMENT_PRT

HW_CONF_22_SIG_DISPLAY

HW_CONF_22_SIG_DISPLAY

HW_CONF_23_RESERVED

HW_CONF_23_RESERVED

HW_CONF_24_COIN_DISP

HW_CONF_24_COIN_DISP

HW_CONF_25_SYSTEM_DISPLAY

HW_CONF_25_SYSTEM_DISPLAY

HW_CONF_26_MED_ENT_IND

HW_CONF_26_MED_ENT_IND

HW_CONF_27_ENV_DISP

HW_CONF_27_ENV_DISP

HW_CONF_28_DOC_PROC_MOD

HW_CONF_28_DOC_PROC_MOD

HW_CONF_29_COIN_TAMP_IND

HW_CONF_29_COIN_TAMP_IND

HW_CONF_30_DOC_TAMP_IND

HW_CONF_30_DOC_TAMP_IND

HW_CONF_31_RESERVED

HW_CONF_31_RESERVED

HW_CONF_32_DIG_AUDIO_SERV

HW_CONF_32_DIG_AUDIO_SERV

HW_CONF_33_RESERVED

HW_CONF_33_RESERVED

HW_CONF_34_RESERVED

HW_CONF_34_RESERVED

360

June 2015

Registry Cross Reference

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

June 2015

361

Registry Cross Reference


Table 66: Registry cross link [LYNXCI_PARAMETER]
USER AREA in"CUSTOM.PPF"
[LYNXCI_PARAMETER]
USER NAME
PARAMETER_00
PARAMETER_01
PARAMETER_02
PARAMETER_03
PARAMETER_04
PARAMETER_05
PARAMETER_06
PARAMETER_07
PARAMETER_08
PARAMETER_09
PARAMETER_10
PARAMETER_11
PARAMETER_12
PARAMETER_13
PARAMETER_14
PARAMETER_15
PARAMETER_100
PARAMETER_101
LUNO
CONFIG_ID

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\PARAMETER]
REGISTRY PARAMETER
PARAMETER_00
PARAMETER_01
PARAMETER_02
PARAMETER_03
PARAMETER_04
PARAMETER_05
PARAMETER_06
PARAMETER_07
PARAMETER_08
PARAMETER_09
PARAMETER_10
PARAMETER_11
PARAMETER_12
PARAMETER_13
PARAMETER_14
PARAMETER_15
PARAMETER_100
PARAMETER_101
LUNO
CONFIG_ID

Table 67: Registry cross link [LYNXCI_TIMER]


USER AREA in"CUSTOM.PPF"
[LYNXCI_TIMER]
USER NAME
TIMER_00
TIMER_01
TIMER_02
TIMER_03
TIMER_04
TIMER_05
TIMER_06
TIMER_07
TIMER_09
TIMER_10
TIMER_94
TIMER_95
TIMER_96
TIMER_99

362

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\TIMER]
REGISTRY PARAMETER
TIMER_00
TIMER_01
TIMER_02
TIMER_03
TIMER_04
TIMER_05
TIMER_06
TIMER_07
TIMER_09
TIMER_10
TIMER_94
TIMER_95
TIMER_96
TIMER_99

June 2015

Registry Cross Reference


Table 68: Registry cross link [LYNXCI_EMV]
USER AREA in"CUSTOM.PPF"
[LYNXCI_EMV]
USER NAME
COMPLETION_OBJECTS
CONTACT_THRESHOLD
LANGUAGE_SUPPORTED
PROTOCOL_SPEC

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\EMV]
REGISTRY PARAMETER
COMPLETION_OBJECTS
CONTACT_THRESHOLD
LANG_SUPPORTED
PROTOCOL_SPEC

Table 69: Registry cross link [EMV_TAGS]


USER AREA in"CUSTOM.PPF"
[EMV_TAGS]

USER NAME
ACQUIRER_IDENTIFIER_9F01
MERCHANT_CATEGORY_CODE_9F15
TERMINAL_COUNTRY_CODE_9F1A
TERMINAL_CAPABILITIES_9F33
TERMINAL_TYPE_9F35
ADDITIONAL_TERMINAL_
CAPABILITIES_9F40

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\EMVDEBITCREDITFW\
TERMINAL_PROPERTIES\TAGS]
REGISTRY PARAMETER
9F01
9F15
9F1A
9F33
9F35
9F40

Table 70: Registry cross link [CASH_DISPENSER]


USER AREA in"CUSTOM.PPF"
[CASH_DISPENSER]
USER NAME
NUM_LOG_CASS
CURRENCY_1
CURRENCY_2
CURRENCY_3
CURRENCY_4
CURRENCY_5
CURRENCY_6
CURRENCY_7
CURRENCY_8
VALUE_1
VALUE_2
VALUE_3
VALUE_4
VALUE_5
VALUE_6
VALUE_7
VALUE_8

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\CASH_DISPENSER]
REGISTRY PARAMETER
NUM_LOG_CASS
CURRENCY_1
CURRENCY_2
CURRENCY_3
CURRENCY_4
CURRENCY_5
CURRENCY_6
CURRENCY_7
CURRENCY_8
VALUE_1
VALUE_2
VALUE_3
VALUE_4
VALUE_5
VALUE_6
VALUE_7
VALUE_8

June 2015

363

Registry Cross Reference

DEFAULT_NUM_NOTES_1
DEFAULT_NUM_NOTES_2
DEFAULT_NUM_NOTES_3
DEFAULT_NUM_NOTES_4
DEFAULT_NUM_NOTES_5
DEFAULT_NUM_NOTES_6
DEFAULT_NUM_NOTES_7
DEFAULT_NUM_NOTES_8
AUTO_LOGON_CASSETTES
AUTO_LOGON_IN_SOP
AUTO_LOGON_NOTES
DENOMINATION_LOW_MSG
CLEAR_MISS_COUNTER
DISPENSE_ALGO
SEND_CASSETTE_LOW_ALWAYS
MAX_PRESENT_ERRORS
SEND_SOL_RETRACT
SOLICITED_IF_RETRACT_INHIBIT
CAS_WAIT_TIME
FATAL_CASS_AS_MISSING
DISPENSE_BELOW_ZERO
LOGICAL_MAPPING
DENOM_ID_UPPERCASE
CHECK_STATUS_AFTER_MONEY_TAKEN
PRESENT_FAILURE_SCREEN
NUM_PHYS_NAMES
PHYS_NAME_X
DISPENSE_RETRIES
PRESENT_TIMER
MAX_REJECT_NOTES
REJECT_FATAL_STATUS
MV_TESTDISPENSE
EQUAL_PHYS_CASS_COUNTERS
CHECK_FATAL_BEFORE_DISPENSE
MAX_DISPENSE_ERRORS
HWERR_DISPENSE_RETRIES
EXPONENT_CORRECTION
DISPLAY_PRESENT_SCREEN
PHYS_GOOD_NOTES
MAX_DISPENSE_TIME
DO_CIN_RETRACT

364

DEFAULT_NUM_NOTES_1
DEFAULT_NUM_NOTES_2
DEFAULT_NUM_NOTES_3
DEFAULT_NUM_NOTES_4
DEFAULT_NUM_NOTES_5
DEFAULT_NUM_NOTES_6
DEFAULT_NUM_NOTES_7
DEFAULT_NUM_NOTES_8
AUTO_LOGON_CASSETTES
AUTO_LOGON_IN_SOP
AUTO_LOGON_NOTES
DENOMINATION_LOW_MSG
CLEAR_MISS_COUNTER
DISPENSE_ALGO
SEND_CASSETTE_LOW_ALWAYS
MAX_PRESENT_ERRORS
SEND_SOL_RETRACT
SOL_RETRACT_INHIBIT
CAS_WAIT_TIME
FATAL_CASS_AS_MISSING
DISPENSE_BELOW_0
LOGICAL_MAPPING
DENOM_ID_UPPERCASE
CHECK_STATUS_AFTER_MONEY_TAKEN
PRESENT_FAILURE_SCREEN
NUM_PHYS_NAMES
PHYS_NAME_X
DISPENSE_RETRIES
PRESENT_TIMER
MAX_REJECT_NOTES
REJECT_FATAL_STATUS
MV_TESTDISPENSE
EQUAL_PHYS_CASS_COUNTERS
CHECK_FATAL_BEFORE_DISPENSE
MAX_DISPENSE_ERRORS
HWERR_DISPENSE_RETRIES
EXPONENT_CORRECTION
DISPLAY_PRESENT_SCREEN
PHYS_GOOD_NOTES
MAX_DISPENSE_TIME
DO_CIN_RETRACT

June 2015

Registry Cross Reference

ProTopas
USER AREA in"CUSTOM.PPF"
[CCCDMFW]
USER NAME
MAXRETRACT

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
CurrentVersion\CCOPEN\CCCdmFW]
REGISTRY PARAMETER
MaxRetract

June 2015

365

Registry Cross Reference


Table 71: Registry cross link [COIN_DISPENSER]
USER AREA in"CUSTOM.PPF"
[COIN_DISPENSER]

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\COIN_DISPENSER]
REGISTRY PARAMETER
NUM_LOG_HOPPERS
NUM_HOST_HOPPERS
DISPENSE_FLAGS
CURRENCY_1
CURRENCY_2
CURRENCY_3
CURRENCY_4
CURRENCY_5
CURRENCY_6
CURRENCY_7
CURRENCY_8
VALUE_1
VALUE_2
VALUE_3
VALUE_4
VALUE_5
VALUE_6
VALUE_7
VALUE_8

USER NAME
NUM_LOG_HOPPERS
NUM_HOST_HOPPERS
DISPENSE_FLAGS
CURRENCY_1
CURRENCY_2
CURRENCY_3
CURRENCY_4
CURRENCY_5
CURRENCY_6
CURRENCY_7
CURRENCY_8
VALUE_1
VALUE_2
VALUE_3
VALUE_4
VALUE_5
VALUE_6
VALUE_7
VALUE_8

Table 72: Registry cross link [BARCODE]


USER AREA in"CUSTOM.PPF"
[BARCODE]
USER NAME

ACCEPT_CODE_FORMAT

366

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\BARCODE]
REGISTRY PARAMETER
READ_CODE

June 2015

Registry Cross Reference


Table 73: Registry cross link [DEPOSIT]
USER AREA in"CUSTOM.PPF"
[DEPOSIT]
USER NAME
DISPENSE_SCREEN
DISPENSE_WAIT_SCREEN
DISPENSE_ENVELOPE
CANCEL_ACTIVE
CAS_WAIT_TIME
PRINT_ON_ENVELOPE
DEPOSIT_CHARTABLE_LOW
DEPOSIT_CHARTABLE_HIGH
DEPOSIT_USER_CHARSET
USER AREA in"CUSTOM.PPF"
[DEP]
USER NAME
CONTPOLLTIME
ENTRYSPLIT
PREPAREDISPENSE

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\DEPOSIT]
REGISTRY PARAMETER
DISPENSE_SCREEN
DISPENSE_WAIT_SCREEN
DISPENSE_ENVELOPE
CANCEL_ACTIVE
CAS_WAIT_TIME
PRINT_ON_ENVELOPE
CHARTABLE_LOW
CHARTABLE_HIGH
USER_CHARSET
REGISTRY LOCATION
[HKEY_CLASSES_ROOT\WOSA/XFS_ROOT\
PHYSICAL_SERVICES\DEVICES\DEP]
REGISTRY PARAMETER
ContPollTime
EntrySplit
PrepareDispense

Table 74: Registry cross link [CARD_READER]


USER AREA in"CUSTOM.PPF"
[CARD_READER]
USER NAME
DEFAULT_READ_TRACK1
DEFAULT_READ_TRACK2
DEFAULT_READ_TRACK3
DEFAULT_READ_CHIP
IDLE_REMOVE_SCREEN
EJECT_IN_OUT_TIMER
MANIP_THRESHOLD
JAM_THRESHOLD
DIP_EJECT_SCREEN
CONTACTLESS_HANDLING

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\CARD_READER]
REGISTRY PARAMETER
DEFAULT_READ_TRACK1
DEFAULT_READ_TRACK2
DEFAULT_READ_TRACK3
DEFAULT_READ_CHIP
IDLE_REMOVE_SCREEN
EJECT_IN_OUT_TIMER
MANIP_THRESHOLD
JAM_THRESHOLD
DIP_EJECT_SCREEN
CONTACTLESS_HANDLING

June 2015

367

Registry Cross Reference


Table 75: Registry cross link [ELECTRONIC_JOURNAL]
USER AREA in"CUSTOM.PPF"
[ELECTRONIC_JOURNAL]
USER NAME
TOP_MAX_FILES
CUST_MAX_FILES
SPOOLER_RESET
SPOOLER_PRINT_CACHE_TIMER
SPOOLER_PRINT_CACHE_THRESHOLD
SPOOLER_MAX_SPOOL_FILE
SPOOLER_MAX_SPOOL_AREA

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\JOURNAL]
REGISTRY PARAMETER
TOP_MAXFILES
CUST_MAXFILES
RESET
PRINT_CACHE_TIMER
PRINT_CACHE_THRESHOLD
MAX_SPOOL_FILE
MAX_SPOOL_AREA

Table 76: Registry cross link [JOURNALPRINTER]


USER AREA in"CUSTOM.PPF"
[JOURNALPRINTER]

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\PRINTER\JOURNAL]
USER NAME
REGISTRY PARAMETER
CPI
CPI
LPI
LPI
USER_CHARSET
USER_CHARSET
PAPER_JOURNAL
PAPER_JOURNAL
ELECTRONIC_JOURNAL
ELECTRONIC_JOURNAL
JRN_FONT_ENTRIES
FONT_ENTRIES
SPOOLER_KEEP_PRINTER_STATUS SPOOLER_KEEP_PRT_STATUS
SEND_SPOOLER_ERROR
SEND_SPOOLER_ERROR
FORCE_PAPER_OUT_SUPPLY
FORCE_PAPER_OUT_SUPPLY
CP_JOURNAL_FONT_TYPE_NNN
CP_FONT_TYPE_NNN
PRINT_JOURNAL_ALWAYS
PRINT_JOURNAL_ALWAYS
HDD_SPACE_LOW_LIMIT
HDD_SPACE_LOW_LIMIT
CHECK_FILE_JOURNAL
CHECK_FILE_JOURNAL
EJU_SAF_MAX_FILE_SIZE
EJU_SAF_MAX_FILE_SIZE
EJU_SAF_FILE_NAME
EJU_SAF_FILE_NAME
EJU_CONVERT_HOST_DATA
EJU_CONVERT_HOST_DATA
ALL_CHARS_IN_EJRN
ALL_CHARS_IN_EJRN
PRINT_UNICODE
PRINT_UNICODE

Table 77: Registry cross link [JOURNAL_FONT_XXX]


USER AREA in"CUSTOM.PPF"
[JOURNAL_FONT_XXX]

USER NAME
JOURNAL_CONDENSED
JOURNAL_FONT_TYPE
JOURNAL_DOUBLE_WIDTH

368

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
LYNXPAR\PRINTER\JOURNAL\FONT_XXX]
REGISTRY PARAMETER
CONDENSED
FONT_TYPE
DOUBLE_WIDTH

June 2015

Registry Cross Reference

JOURNAL_CHARTABLE_LOW
JOURNAL_CHARTABLE_HIGH
JOURNAL_USER_CHARSET
JOURNAL_MACRO
JOURNAL_PRINT_UNICODE

CHARTABLE_LOW
CHARTABLE_HIGH
USER_CHARSET
MACRO
PRINT_UNICODE

June 2015

369

Registry Cross Reference


Table 78: Registry cross link [RECEIPTPRINTER]
USER AREA in"CUSTOM.PPF"
[RECEIPTPRINTER]
USER NAME
CPI
LPI
USER_CHARSET
RECEIPT_FONT_ENTRIES
RECEIPT_PAGE_HEADER
CAS_WAIT_TIME
FORCE_PAPER_OUT_SUPPLY
CP_RECEIPT_FONT_TYPE_NNN
RECEIPT_PAGE_FOOTER
RECEIPT_FOOTER_LINE
REAR_BAL_OPTIONS
MERGE_R01
PRINT_UNICODE
USER AREA in"CUSTOM.PPF"
[RECEIPTPRINTER]
USER NAME
LEDTIMER

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\PRINTER\RECEIPT]
REGISTRY PARAMETER
CPI
LPI
USER_CHARSET
FONT_ENTRIES
PAGE_HEADER
CAS_WAIT_TIME
FORCE_PAPER_OUT_SUPPLY
CP_FONT_TYPE_NNN
PAGE_FOOTER
FOOTER_LINE
REAR_BAL_OPTIONS
MERGE_R01
PRINT_UNICODE
REGISTRY LOCATION
[HKEY_CLASSES_ROOT\WOSA/XFS_ROOT\
PHYSICAL_SERVICES\DEVICES\NDXXR]
REGISTRY PARAMETER
LedTimer

Table 79: Registry cross link [RECEIPT_FONT_XXX]


USER AREA in"CUSTOM.PPF"
[RECEIPT_FONT_XXX]

USER NAME
RECEIPT_CONDENSED
RECEIPT_FONT_TYPE
RECEIPT_DOUBLE_WIDTH
RECEIPT_CHARTABLE_LOW
RECEIPT_CHARTABLE_HIGH
RECEIPT_USER_CHARSET
RECEIPT_MACRO
RECEIPT_PRINT_UNICODE

370

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
LYNXPAR\PRINTER\RECEIPT\FONT_XXX]
REGISTRY PARAMETER
CONDENSED
FONT_TYPE
DOUBLE_WIDTH
CHARTABLE_LOW
CHARTABLE_HIGH
USER_CHARSET
MACRO
PRINT_UNICODE

June 2015

Registry Cross Reference


Table 80: Registry cross link [DOCUMENTPRINTER]
USER AREA in"CUSTOM.PPF"
[DOCUMENTPRINTER]
USER NAME
CPI
LPI
USER_CHARSET
NO_OF_DOC_BEFORE_EJECT
CANCEL_ACTIVE
FONT_ENTRIES
DOC_PAGE_HEADER
CAS_WAIT_TIME
DOC_PAGE_FOOTER
DOC_FOOTER_LINE
PRINT_UNICODE

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\PRINTER\DOCUMENT]
REGISTRY PARAMETER
CPI
LPI
USER_CHARSET
NO_OF_DOC_BEFORE_EJECT
CANCEL_ACTIVE
FONT_ENTRIES
PAGE_HEADER
CAS_WAIT_TIME
PAGE_FOOTER
FOOTER_LINE
PRINT_UNICODE

Table 81: Registry cross link [DOCUMENT_FONT_XXX]


USER AREA in"CUSTOM.PPF"
[DOCUMENT_FONT_XXX]

USER NAME
DOCUMENT_CONDENSED
DOCUMENT_FONT_TYPE
DOCUMENT_DOUBLE_WIDTH
DOCUMENT_CHARTABLE_LOW
DOCUMENT_CHARTABLE_HIGH
DOCUMENT_USER_CHARSET
DOCUMENT_MACRO
DOCUMENT_PRINT_UNICODE

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
LYNXPAR\PRINTER\DOCUMENT\FONT_XXX]
REGISTRY PARAMETER
CONDENSED
FONT_TYPE
DOUBLE_WIDTH
CHARTABLE_LOW
CHARTABLE_HIGH
USER_CHARSET
MACRO
PRINT_UNICODE

June 2015

371

Registry Cross Reference


Table 82: Registry cross link [VIEWER]
USER AREA in"CUSTOM.PPF"
[VIEWER]
USER NAME
MODE
BELL_TIME
CURSOR
USER AREA in"CUSTOM.PPF"
[VIEWER]
USER NAME
TABLE_ENTRIES
USER AREA in"CUSTOM.PPF"
[VIEWER]
USER NAME
NAME
SIZE
NDC_DOUBLE
NDC_FONT
HEIGHT
PROPORTIONAL

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\VIEWER]
REGISTRY PARAMETER
MODE
BELL_TIME
CURSOR
REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\VIEWER\FONT]
REGISTRY PARAMETER
TABLE_ENTRIES
REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\VIEWER\FONT\FONT_XXX]
REGISTRY PARAMETER
NAME
SIZE
NDC_DOUBLE
NDC_FONT
HEIGHT
PROPORTIONAL

Table 83: Registry cross link [SNA]


USER AREA in"CUSTOM.PPF"
[SNA]
USER NAME
OPENTIME

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCOPEN\COMMUNICATION\SNA]
REGISTRY PARAMETER
OPENTIME

Table 84: Registry cross link [SNA_PROJECT]


USER AREA in"CUSTOM.PPF"
[SNA_PROJECT]

USER NAME
ADDSNAINFO
NAUTYPE
PROJECT_RECEIVE_BUFFER_SIZE
LUNAME
STRIPFMH
SENDINITSELF
RSPTIMER

372

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
CCOPEN\COMMUNICATION\SNA\PROJECT]
REGISTRY PARAMETER
ADDSNAINFO
NAUTYPE
RECEIVE_BUFFER_SIZE
LUNAME
STRIPFMH
SENDINITSELF
RSPTIMER

June 2015

Registry Cross Reference


Table 85: Registry cross link [SNA_PROJECT_INITSELF]
USER AREA in"CUSTOM.PPF"
[SNA_PROJECT_INITSELF]

USER NAME
OPLIB
DLUNAME
OPPASS
OPMODE
OPUID

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
CCOPEN\COMMUNICATION\SNA\PROJECT\INITSELF]
REGISTRY PARAMETER
OPLIB
DLUNAME
OPPASS
OPMODE
OPUID

Table 86: Registry cross link [X25]


USER AREA in"CUSTOM.PPF"
[X25]

USER NAME
CALLDELAY
CORESYNC
CONTABSIZE
CALLRETRY
POLLTIME
CLOSETIME
SHMDELAY
NETTIME
OPENTIME

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
CCOPEN\COMMUNICATION\X25]
REGISTRY PARAMETER
CALLDELAY
CORESYNC
CONTABSIZE
CALLRETRY
POLLTIME
CLOSETIME
SHMDELAY
NETTIME
OPENTIME

June 2015

373

Registry Cross Reference


Table 87: Registry cross link [X25_PROJECT]
USER AREA in"CUSTOM.PPF"
[X25_PROJECT]

USER NAME
PROJECT_RECEIVE_BUFFER_SIZE
SHMCLRCAUSEDIAG
MAXSENDSIZE
SHM_PASSIVE
CUGSELECTION
D_BIT_PROC
REMRESCAUSEDIAG
OFFRESCAUSEDIAG
VCTYPE
PASSIVE_START
CALLUSERDATA_P
NOTRACE
MAXRECVSIZE
PVCNO
CALLUSERDATA_A
CUGOUTSELECT
INDEX
SEND_RECONNECT
REVERSECHRG_PAS
SHMDELAY_FLAG
REVERSECHRG_ACT
LOCALADR
REMOTEADR1
REMOTEADR2
REMOTEADR3
REMOTEADR4
REMOTEADR5

374

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
CCOPEN\COMMUNICATION\X25\PROJECT]
REGISTRY PARAMETER
RECEIVE_BUFFER_SIZE
SHMCLRCAUSEDIAG
MAXSENDSIZE
SHM_PASSIVE
CUGSELECTION
D_BIT_PROC
REMRESCAUSEDIAG
OFFRESCAUSEDIAG
VCTYPE
PASSIVE_START
CALLUSERDATA_P
NOTRACE
MAXRECVSIZE
PVCNO
CALLUSERDATA_A
CUGOUTSELECT
INDEX
SEND_RECONNECT
REVERSECHRG_PAS
SHMDELAY_FLAG
REVERSECHRG_ACT
LOCALADR
REMOTEADR1
REMOTEADR2
REMOTEADR3
REMOTEADR4
REMOTEADR5

June 2015

Registry Cross Reference


Table 88: Registry cross link [TCPIP_PROJECT]
USER AREA in"CUSTOM.PPF"
[TCPIP_PROJECT]

USER NAME
REMOTEPEER
REMOTEPEER_X
KEEPALIVES
TRANSPORTSIZE
CLOSETIMEOUT
CLIENTOPENRETRY
CODINGDLL
TYPE
PORTNUMBER
ADMINSIZE
OPENTIMEOUT
SENDTIMEOUT
LOCALPORT

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\
CCOPEN\COMMUNICATION\TCPIP\PROJECT]
REGISTRY PARAMETER
REMOTEPEER
REMOTEPEERX
KEEPALIVES
TRANSPORTSIZE
CLOSETIMEOUT
CLIENTOPENRETRY
CODINGDLL
TYPE
PORTNUMBER
ADMINSIZE
OPENTIMEOUT
SENDTIMEOUT
LOCALPORT

Table 89: Registry cross link [TOPMSG]


USER AREA in"CUSTOM.PPF"
[TOPMSG]
DESTXXXX
MSGXXXX

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCSYSMSG\TOPMSG]
DESTXXXX
MSGXXXX

Table 90: Registry cross link [CUSTMSG]


USER AREA in"CUSTOM.PPF"
[CUSTMSG]
DESTXXXX
MSGXXXX

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\CCSYSMSG\CUSTMSG]
DESTXXXX
MSGXXXX

June 2015

375

Registry Cross Reference


Table 91: Registry cross link [LYNXCI_SCREEN]
USER AREA in"CUSTOM.PPF"
[LYNXCI_SCREEN]
SCREEN_FOREGROUND_COLOR
SCREEN_BACKGROUND_COLOR
SCREEN_TRANSPARENT_MODE
PICTURE_GXX
PICTURE_LXX
PICTURE_XX
PICTURE_XXX
PICTURE_XXXX
PALETTE_XXX
PALETTE_DEFAULT
BLINK_RATE
CHARACTER_WIDTH
CHARACTER_HEIGHT
PICTURE_BACKGROUND
VERTICAL_OFFSET
HORIZONTAL_OFFSET
PICTURE_EXT_X
SCREEN_FULL_SCREEN_VIDEO
PIN_TOUCH_ENABLE
PIN_CONFIRM_KEY
AUDIOX_PATH
AUDIOXXX_PATH
STOP_VIDEO_AFTER_DELAY
SPECIFIC_SV_MODE_SCREEN
ESC_SUB
SUBST_CHAR_SCREEN
SCREEN_MIN_PIN_LEN

376

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN]
FOREGROUND_COLOR
BACKGROUND_COLOR
TRANSPARENT_MODE
PICTURE_GXX
PICTURE_LXX
PICTURE_XX
PICTURE_XXX
PICTURE_XXXX
PALETTE_XXX
PALETTE_DEFAULT
BLINK_RATE
CHARACTER_WIDTH
CHARACTER_HEIGHT
PICTURE_BACKGROUND
VERTICAL_OFFSET
HORIZONTAL_OFFSET
PICTURE_EXT_X (X = file extensions)
FULL_SCREEN_VIDEO
PIN_TOUCH_ENABLE
PIN_CONFIRM_KEY
AUDIOX_PATH
AUDIOXXX_PATH
STOP_VIDEO_AFTER_DELAY
SPECIFIC_SV_MODE_SCREEN
ESC_SUB
SUBSTITUTION_CHARACTER
MIN_PIN_LEN

June 2015

Registry Cross Reference


Table 92: Registry cross link [SCREEN_XXX]
USER AREA in"CUSTOM.PPF"
[SCREEN_XXX]
FOREGROUND_COLOR
BACKGROUND_COLOR
IDLE_NEXT_SCREEN
IDLE_TIME
CHARACTER_WIDTH
CHARACTER_HEIGHT
VERTICAL_OFFSET
HORIZONTAL_OFFSET
TRANSPARENT_MODE
PICTURE_BACKGROUND
DISPLAY_CONTENTS
INPUT_FIELD_LEFT
INPUT_FIELD_TOP
INPUT_FIELD_RIGHT
INPUT_FIELD_BOTTOM
INPUT_FIELD_ADJUST
SCREEN_CONTENTS

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXCI\SCREEN\XXX]
FOREGROUND_COLOR
BACKGROUND_COLOR
IDLE_NEXT_SCREEN
IDLE_TIME
CHARACTER_WIDTH
CHARACTER_HEIGHT
VERTICAL_OFFSET
HORIZONTAL_OFFSET
TRANSPARENT_MODE
PICTURE_BACKGROUND
DISPLAY_CONTENTS
INPUT_FIELD_LEFT
INPUT_FIELD_TOP
INPUT_FIELD_RIGHT
INPUT_FIELD_BOTTOM
INPUT_FIELD_ADJUST
CONTENTS

Table 93: Registry cross link [OPERATOR_SCREENS]


USER AREA in"CUSTOM.PPF"
[OPERATOR_SCREENS]
PRINTER_HEADER_RECEIPT
PRINTER_HEADER_JOURNAL
PRINTER_HEADER_DOCUMENT

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\OPERATOR_SCREENS]
PRINTER_HEADER_RECEIPT
PRINTER_HEADER_JOPURNAL
PRINTER_HEADER_DOCUMENT

June 2015

377

Registry Cross Reference


Table 94: Registry cross link [APPLICATION_XXX]
USER AREA in"CUSTOM.PPF"
[APPLICATION_XXX]
CLEAR_HWFITNESS
RESEND_POWER_UP
SUSPEND_TIMEOUT
SEND_POWER_UP
SEND_DOOR_CHANGE
Q_UNSOL_IN_TRAN_REQ
Q_OFFLINE_TRAN_READY
SVRMODE_WHEN_DOOR_OPEN
SWITCH_LOGO
DEFAULT_MISC_FEATURE_1[1]
DEFAULT_MISC_FEATURE_2[1]
DEFAULT_MISC_FEATURE_3[1]
DEFAULT_CARD_READ_THRESHOLD
DEFAULT_CARD_WRITE_THRESHOLD
DEFAULT_SUPPLY_READY_AMOUNT_
OPTIONS[2]
OOS_AFTER_ONLINE
REAR_BALANCE_TIMEOUT
OFFLINE_REBOOT_TIMER
LED_IN_SERVICE
LED_SERVICE
LED_CUSTOMER
LED_SVR_MODE
LED_CASH
LED_PAPER
DOUBLE_LENGTH_KEYS
ADJ_GEN_BUF_FROM_AMT
JOU_NAME_CASS
JOU_NAME_CASSN
JOU_NAME_REJECT
JOU_TXT_REJECTS
JOU_TXT_RETRACTS
ADRS_OPTIONS
ADRS_MAX_RETRIES
STORE_COM_KEY
CARD_RETAIN_DISPLAY
ALARM_SENSORS
PRINT_IMMEDIATE_OPTIONS
[1] [2] -

378

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\APPLICATION]
CLEAR_HWFITNESS
RESEND_POWER_UP
SUSPEND_TIMEOUT
SEND_POWER_UP
SEND_DOOR_CHANGE
Q_UNSOL_IN_TRAN_REQ
Q_OFFLINE_TRAN_READY
SVRMODE_WHEN_DOOR_OPEN
SWITCH_LOGO
DEFAULT_MISC_FEATURE_1
DEFAULT_MISC_FEATURE_2[1]
DEFAULT_MISC_FEATURE_3[1]
DEFAULT_CARD_READ_THRESHOLD
DEFAULT_CARD_WRITE_THRESHOLD
DEFAULT_MISC_FEATURE_1
OOS_AFTER_ONLINE
REAR_BALANCE_TIMEOUT
OFFLINE_REBOOT_TIMER
LED_IN_SERVICE
LED_SERVICE
LED_CUSTOMER
LED_SVR_MODE
LED_CASH
LED_PAPER
DOUBLE_LENGTH_KEYS
ADJ_GEN_BUF_FROM_AMT
JOU_NAME_CASS
JOU_NAME_CASSN
JOU_NAME_REJECT
JOU_TXT_REJECTS
JOU_TXT_RETRACTS
ADRS_OPTIONS
ADRS_MAX_RETRIES
STORE_COM_KEY
CARD_RETAIN_DISPLAY
ALARM_SENSORS
PRINT_IMMEDIATE_OPTIONS

APPLICATION_DDC only
APPLICATION_NDC only

June 2015

Registry Cross Reference


Table 95: Registry cross link [APPLICATION_XXX] part 2
USER AREA in"CUSTOM.PPF"
[APPLICATION_XXX]
USE_CLOSE_TIMER_ALWAYS
RECEIPT_DELIVERED
TRAN_DELAY_TIME
FID_Z_WAIT_TIME
PAN_HANDLING
MONITOR_BOOT_SWITCH
MONITOR_SAFE_DOOR
RECONNECT_DELAY
POWER_SAVE_DELAY
NDC_LTS_OPTIONS
HP_HANDLING
[1] [2] [3] -

REGISTRY LOCATION
[HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\APPLICATION]
USE_CLOSE_TIMER_ALWAYS
RECEIPT_DELIVERED
TRAN_DELAY_TIME
FID_Z_WAIT_TIME[1]
PAN_HANDLING
MONITOR_BOOT_SWITCH
MONITOR_SAFE_DOOR
RECONNECTDELAY
POWER_SAVE_DELAY
NDC_LTS_OPTIONS[2]
HP_HANDLING[3]

APPLICATION_DDC only
APPLICATION_NDC only
Defined in CUSTOM.RCC for the Rich Client Manager

June 2015

379

Registry Cross Reference

380

June 2015

Installation and Configuration ToolsProCash/NDC-DDC Configuration Manag

Installation and Configuration Tools


This section describes tools and utilities for the configuration of hardware device
settings or application specific parameter settings. Additionally you get information about trace and analyzing tools.

ProCash/NDC-DDC Configuration Manager


The ProCash/NDC-DDC Configuration Manager is a Windows frontend for
operators. Several utilities can be called via pull down menus in one main
window. All menu functions contain context sensitive help items where the
menu functions are described in detail. Help for each menu can be reached if
you open the pull down menu item. Then you have to press the F1 key. The
manager can be called in C:\PROTOPAS\TOOLS\CFGMANAG.EXE.
Short overview about Configuration Manager functions:

View CI configuration (States Previewer, Screens, Parameters, Timers, FIT table)


Trace and analyzing, trace file transfer to floppy
Bitmap Previewer for BMP, PCX, ICN, DDU,JPG graphic or AVI video files
Printer test programs
Error Map configuration
PCedit interface
Parameterisation
Integrated Windows Explorer and Regedit
Windows context sensitive Help for each Menu and Dialog Item (F1 key)

June 2015

381

Font and Graphic utilities

Installation and Configuration Tools

Font and Graphic utilities


FONTEDIT.EXE
FontEdit.exe is a Windows program which is used to read, enhance and modify
characters from Windows font files. Windows font files which are currently in
use are typically placed in the directory WINNT\FONTS. These fonts cannot be
modified by FONTEDIT. If you want to modify those fonts you have to move
them via the Control Panel to a separate directory where they do not have
access from Windows anymore.
Syntax:

FONTEDIT WINNTfontfile

The following graphic shows the main screen with one loaded NDC font
named "NDC-SA1.FON".

382

June 2015

Installation and Configuration Tools

Font and Graphic utilities

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
Width
Height

Character XX

- sets the font name which must match (case sensitive)


with parameter "NAME" of section [VIEWER_FONT_XXX]
- sets the character width
- sets the character Height.

- 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 [-SCREEN] [-PRINTER] ASCIIfile

Options:
-SCREEN Creates font files according ANSI standard
-PRINTER Creates font files according OEM ASCII standard

June 2015

383

Font and Graphic utilities

Installation and Configuration Tools

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
-B
-G
-W
-0
-1
-2
fontfile

Enables font installation with automatic detection


Enables copying Bitmaps or Icons in the selected or detected
resolution.
Registers all GDI printer fonts located in
C:\PROTOPAS\FONTS\GDI_PRT
Registers all kind of windows fonts located in
C:\PROTOPAS\FONTS\WEB
Sets resolution 640x480
Sets resolution 800x600
Sets resolution 1024x768
Registers a single font in the selected or detected resolution.

The call without parameter -0, -1 or -2 (CPYNTFNT -R) enables


automatic detect. The resolution of the current Windows display
setting is used.

This utility is called by the "Configuration Manager" where you can


use font registration via an user friendly dialog window. See main
menu "Update" and sub menu "Install Fonts and Bitmaps".

384

June 2015

Installation and Configuration Tools

Font and Graphic utilities

ASC2ICN.EXE
Description:
ASC2ICN is used to convert an ASCII icon file into a *.icn file.
Syntax:
ASC2ICN sourcefile [destfile]

If destfile is not specified, $tmp$.icn is used or ASC2ICN -I destfile with


stdin as the input

ICN2ASC.EXE
Description:
Icn2asc.exe can be used to extract ICN icon files to ASCII matrix files for modifiations.
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.

June 2015

385

Font and Graphic utilities

Installation and Configuration Tools

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]

If destfile is not specified, $tmp$.pcc is used or ASC2PCC -I [-V]


destfile with stdin as the input.

386

June 2015

Installation and Configuration Tools

Font and Graphic utilities

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.

June 2015

387

Analyzing utilities

Installation and Configuration Tools

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
-S
-L

analyzes ProCash/DDC messages (DIEBOLD)


extracts messages for simulation
extracts download messages only (3...) useful for ndc-sim.dll

Font tools for journal and receipt printers


PRT-DOF.EXE
Prt-Dof.exe can be used to load native control sequences, resp. user defined
character sets into receipt or/and journal printers. You have to create an ASCII
file usually with the extension *.dof , which has to contain the control characters
that should be loaded into the printer. The format of this ASCII file is described
on the next pages.

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]

388

June 2015

Installation and Configuration ToolsFont tools for journal and receipt printer
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.

The DEVICE ID must be the logical name of the printer used


by CSCW32. The names which are typically used are JOURNAL1
for the journal printer and BON1 for the receipt printer.

The CSCW32 environment must be installed !


Structure and description of a download file for needle printers ND71 and ND9x:

All escape sequences must be entered in hex format !!!!!


Creation of an user-defined character file:
The file must be in the following format:
First line: /h 1b26024141
Next lines: /h 0900001f80200044008000440020001f800000

You can use any text editor you wish.


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.

June 2015

389

Font tools for journal and receipt printersInstallation and Configuration Too
Next lines:
The next lines are the pixel control of each character. You can create 95 userdefined characters from hex position 20H to 7EH in any style you like.
ND71:
ND9x:

Use 9 columns for 10 and 12 cpi; 7 columns for 15 cpi.


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
Needle
Needle
Needle
Needle
Needle
Needle
Needle
Needle
Needle

1
2
3
4
5
6
7
8
9

Byte1
Byte1
Byte1
Byte1
Byte1
Byte1
Byte1
Byte1
Byte2

7
6
5
4
3
2
1
0
7

1 2 3 4 5 6 7 8 9
------------------------0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0

Example 1:
Creation of the character A with 9 columns:
Columns
Needle
Needle
Needle
Needle
Needle
Needle
Needle
Needle
Needle

1
2
3
4
5
6
7
8
9

Byte1
Byte1
Byte1
Byte1
Byte1
Byte1
Byte1
Byte1
Byte2

7
6
5
4
3
2
1
0
7

1 2 3 4 5 6 7 8 9
------------------------0 0 0 0 1 0 0 0 0
0 0 0 1 0 1 0 0 0
0 0 1 0 0 0 1 0 0
0 1 0 0 0 0 0 1 0
0 1 0 0 0 0 0 1 0
0 1 0 1 0 1 0 1 0
0 1 0 0 0 0 0 1 0
0 1 0 0 0 0 0 1 0
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.

390

June 2015

Installation and Configuration ToolsFont tools for journal and receipt printer

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

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
Needle
Needle
Needle
Needle
Needle
Needle
Needle
Needle
Needle

1
2
3
4
5
6
7
8
9

Byte1
Byte1
Byte1
Byte1
Byte1
Byte1
Byte1
Byte1
Byte2

7
6
5
4
3
2
1
0
7

1 2 3 4 5 6 7
------------------0 0 0 1 0 0 0
0 0 1 0 1 0 0
0 1 0 0 0 1 0
0 1 0 0 0 1 0
0 1 0 0 0 1 0
0 1 0 1 0 1 0
0 1 0 0 0 1 0
0 1 0 0 0 1 0
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

Userdefined character sets can be activated via macro #CCT#.


Standard character sets can be set via macro #NCT#.

June 2015

391

Font tools for journal and receipt printersInstallation and Configuration Too
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 394 for ND9C utilities.
Syntax:
ASC2DOF [-Z] ASCIIfile > DOFfile

Example:
ASC2DOF ND98_7 > ND98_7.DOF

392

June 2015

Installation and Configuration ToolsFont tools for journal and receipt printer
Example:
Creation of character 'A' in 7 and 5 columns:
Structure of the ASCII file with 7
columns characters:

Structure of the ASCII file with 5


columns characters:

Font 7 columns

Font 5 columns

Width 7

Width 5

Height 9

Height 9
Character 41
..X.X..
.X...X.
X.....X
X.....X
X.X.X.X
X.....X
X.....X
.......
.......

Character 41
.XXX.
X...X
X...X
X...X
XXXXX
X...X
X...X
.....
.....

After conversion with asc2dof.exe:


/h 41 3e00400088000000880040003e00/h 41 7e008800880088007e00

The number 41 is the hexadecimal position which is defined in the


ASCII file before. This is not needed for the downloading process. For
the character downloading process you need to add the ESC &
loading command and the number of columns as described in section
"Structure and description of the download file".

June 2015

393

Font and Logo tools for printers

Installation and Configuration Tools

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 394.

Font and Logo tools for printers


LDND9X.EXE
Ldnd9x.exe loads Fonts and user defined Logos into the receipt printers ND9x,
TP06, TP07 or journal printer TH30. Furthermore ldnd9x.exe can delete logos
and user defined fonts of ND99. The font and logo files are in a special binary
format. The printer ND99 needs files with the extension *.SWF for fonts and
*.LOG for logos, which can be extracted into matrix files for modifications with
utilities described later on. The new series printers ND9x or TH30 need files with
extension *.FNT for standard fonts, *.MOD for firmware and *.BMP for logo
bitmaps. TP07 and TP06 support *.BMP format only. To load font and logo files
into ND99, you need the configuration file LD_ND99.CFG and for the ND9x
printers you need the file LD_ND9X.CFG in the path
C:\PROBASE\CSCW32\FRM.
LD_ND99.CFG or LD_ND9X.CFG is divided into two sections named
[FONTS] and [LOGOS].
In these sections you have to specify the directory path where the Font and
Logo files are stored.

394

June 2015

Installation and Configuration Tools

Font and Logo tools for printers

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.

June 2015

395

Font and Logo tools for printers

Installation and Configuration Tools

Contents example of LD_ND99.CFG for printer ND99:


[FONTS]
C:\PROBASE\CSCW32\FRM\FONT10.SWF
C:\PROBASE\CSCW32\FRM\FONT12.SWF
C:\PROBASE\CSCW32\FRM\FONT15.SWF
C:\PROBASE\CSCW32\FRM\FONT17.SWF
[LOGOS]
C:\PROBASE\CSCW32\FRM\LOGO1.LOG
C:\PROBASE\CSCW32\FRM\LOGO2.LOG

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#.
Contents example of LD_ND9X.CFG for printers ND9C, ND9D, ND9E, TH30:
[FONTS]
C:\PROBASE\CSCW32\FRM\FIRMW.MOD
C:\PROBASE\CSCW32\FRM\FONT_437.FNT
[LOGOS]
C:\PROBASE\CSCW32\FRM\LOGO1.BMP
C:\PROBASE\CSCW32\FRM\LOGO2.BMP
For ND9X printers logos can be controlled via macro #LOGO1#
With ldnd9x.exe you are able to load 4 Fonts and 10 Logos.
ATTENTION: If you need to load new firmware please make 100%
sure that the firmware file (*.MOD) you have configured is the right
one for the printer type you have connected. Wrong FW destroys
the printer. For (*.FNT) files it is the same.

396

June 2015

Installation and Configuration Tools

Font and Logo tools for printers

Function description of LDND9X:


The loader can be started from any directory you like but it needs the CSCW32
environment. When you call the program it checks first if the file LD_ND99.CFG
(option -ND99) or LD_ND9X.CFG (option -ND9X) exist. Then it shows the
number of Fonts or Logos depending on which loading process is selected (See
parameter options for load and delete options). If option -ND99 is in use, the
next step deletes all existing fonts or Logos first before the load for the new fonts
or Logos will be started. If option -ND9X is used, the deleting process is skipped
and the loading process starts immediately. Each process will be displayed on
screen to show information whether the load is successfully finished or if parts
of the process fail.
Syntax call:
LDND9X

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.

June 2015

397

Font and Logo tools for printers

Installation and Configuration Tools

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

The ASCII file must have the following header parameter:


Logo Type:
Logo Width:
Logo Height:
Logo Name:

- specifies the logo number which is used by the macro


#LOGO1# - #LOGO9#.
- specifies the width of the Logo in bytes. 1 byte represents
eight pixels in one line.
- specifies the Logo height. The number of lines represents
the Logo height.
- the file name of the logo (8.3 format) must be entered
there. The name will be printed in the test printout of ND99.

The Width and Height parameter should be in the range of


70 (560 pixel) and 200 (lines). This depends on the available memory
of the ND99.

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

398

June 2015

Installation and Configuration Tools

Font and Logo tools for printers

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.

The header parameter must be changed to the format as described


by utility ND99LOGO.EXE. It is important that the value of parameter
Width is divided by eight if you need it for the logo conversion,
because of the 1 byte steps for the logo width (1 byte represents eight
pixels).
Syntax:
PCX2ASC [-D] [-E] [-W] sourcefile

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

June 2015

399

Font and Logo tools for printers

Installation and Configuration Tools

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.

Use utility PRT-DOF.EXE to load the hexa decimal contents of a DOF


file into the ND9C, TH30 and TH21 or TH22 printer.

400

June 2015

Installation and Configuration Tools

Font and Logo tools for printers

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 sure 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......
.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......
................
................
................
................

CPI macro reference:


Width
CPI macro
10
17
12
15
14
14
16
12
20
10

User defined character sets can be deleted via


ESC (1B 27) with sequence "/h 1b27" using
utility PRT-DOF.EXE.
(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.
June 2015

401

Font and Logo tools for printers

Installation and Configuration Tools

Logo print with ND9E


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.

How to print the logo:


The hexa decimal sequence to print the logo is 1b6f. This sequence can be
inserted in a DOF file as: /h 1b6f0d0a0c
To print the logo via the application you can define an own macro in section
"..\CCOPEN\CCPRTFW\RECEIPT_MACROS" like MYLOGO = \1b\6f that can
be configured via parameter RECEIPT_PAGE_HEADER = #MYLOGO# in
CUSTOM.PPF.

402

June 2015

Installation and Configuration Tools

Font and Logo tools for printers

Font utilities for RJ03 series printers


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

June 2015

403

Font and Logo tools for printers

Installation and Configuration Tools

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.

See examples on the following page ...

404

June 2015

Installation and Configuration Tools

Font and Logo tools for printers

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..
.......

June 2015

405

Miscellaneous tools

Installation and Configuration Tools

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" ""

The WRITE-ID.EXE tool cannot work if the ATM is in service mode


or/and a card insert job has been already started.
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 ATMs. 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

406

June 2015

Installation and Configuration Tools

Miscellaneous tools

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

-Ffilename

specifies the filename that contains the printer data.

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#

June 2015

407

Miscellaneous tools

Installation and Configuration Tools

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

-Pprinter

printer - specifies the printer type:


REC
- receipt printer
JRN
- journal printer
DOC
- document printer
JOU
- E-journal destination

-E

Calls ProTopas Eject() method if -PREC is set

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#

408

June 2015

Installation and Configuration Tools

Miscellaneous tools

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
Function Description for -D option:
When the utility is called following functions are performed:
1. It checks if PRJ, PRR, PRD, DEP is configured in Registry parameter CCBase.
2. It sets Parameter ACTIVE = N for the sections [SERVICES_PRJ], [SERVICES_PRR], [SERVICES_PRD],
[SERVICES_DEP] in CUSTOM.PPF and parallel the value is set in the registry if the belonging service is
not configured.
3. If the PRJ service is not configured it sets in addition to parameter ACTIVE parameter
PAPER_JOURNAL = 0 in section [JOURNALPRINTER] of CUSTOM.PPF and parallel it
sets the value in the registry.
Function Description for -T option:
1. Calls batch program Sop3Des.bat to set parameters for ProSop Triple DES key input. Refer also to
Abschnitt Enable Triple DES operation on page 320.
Function Description for -G option:
1. Includes the GDI Printer Overlay Framework (dcPrtGdi.DLL) in the repository configuration for the Receipt
or/and Document printer. Scans the CSC-W32 printer configuration. If a valid GDI printer configuration is
found in the CSC-W32 section, the repository configuration for the detected printer is modified.
In addition the Windows printer name is set for parameter PRINTER_NAME in section
GDI_XXX_PRINTER (xxx = REC or DOC) of "CUSTOM.PPF".

June 2015

409

Miscellaneous tools

Installation and Configuration Tools

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.

410

June 2015

Installation and Configuration Tools

Simulation utilities

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.

June 2015

411

Simulation utilities

Installation and Configuration Tools

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:

412

June 2015

Installation of communication SW

Installation of Eicon Wan Adapter

Installation of communication SW
This section describes how to install and configure the software of network
cards and communication add on products.

Installation of Eicon Wan Adapter


Wincor Nixdorf currently uses the EICON card for X.25 native and SNA connections. For SNA you have to install the add on product Microsoft SNA Server
(Workstation).

Types of EICON cards


Wincor Nixdorf has released model EC/PC, C21 and S51 card. In the first half
of 2000 the new C91 board will be released which will not be supported in the
DOS environment. The release V4R2 supports the EC/PC, C21 and S51 cards
under WindowsNT 4.0 with service pack 3 or higher. You have to use a driver
update if your PC has a Pentium II or III processor. This patch (ECNB.SYS
23.07.98 4.2 Build 88) is included in release V4R2S1.
The S51 card was released for the installation of OS/2.

Internet links
EICON TECHNOLOGY
http://www.eicon.com/

WINCOR NIXDORF INTRANET


BS P42 Software integration and Pilot support
http://seeus.pdb.sni.de/ftp-user3/index.htm

June 2015

413

Installation of Eicon Wan Adapter

Installation of communication SW

Installation
Select "SETTINGS" from the Windows "START" button. Open "CONTROL
PANEL" and double click "NETWORK". Go to folder "ADAPTERS" and click
"ADD".
Now click on HAVE DISK...

414

June 2015

Installation of communication SW

Installation of Eicon Wan Adapter

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.

June 2015

415

Installation of Eicon Wan Adapter

Installation of communication SW

Now you have to select "AUTOMATIC" or "MANUAL" installation. For PnP OS


systems you can use use the automatic installation procedure. The system
automatically detects the card and defines the hardware resources. "Manual"
will be used in systems without PnP capabilities or if the automatic detection
fails or if the card has to have special resources. In that case you will have to
select the card type and assign its resources manually.

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.

416

June 2015

Installation of communication SW

Installation of Eicon Wan Adapter

Now you will be asked for the destination directory and Installation Group:

After selecting OK the software will be installed on your hard disk.

June 2015

417

Installation of Eicon Wan Adapter

Installation of communication SW

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.

418

June 2015

Installation of communication SW

Installation of Eicon Wan Adapter

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.

June 2015

419

Installation of Eicon Wan Adapter


...window and packet size...

420

June 2015

Installation of communication SW

Installation of communication SW

Installation of Eicon Wan Adapter

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.

June 2015

421

Installation of Eicon Wan Adapter

Installation of communication SW

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.

422

June 2015

Tables

Tables
Table 1: External Products

. . . . . . . . . . . . . . . . . . . . . .

Table 2: Components on "ProBase/C CD"

. . . . . . . . . . . . . .

Table 3: Core products and AddOns on "J/Install CD"

34
34

. . . . . . . .

35

. . . . . . . . . . . . .

43

. . . . . . . . . . . . . . . . .

114

Table 6: Miscellaneous Features I (DDC) . . . . . . . . . . . . . . .

116

Table 7: Miscellaneous Features II (DDC) . . . . . . . . . . . . . . .

117

Table 8: Miscellaneous Features III (DDC)

118

Table 4: Structure of the Customizing Media


Table 5: Optional Parameters (NDC)

. . . . . . . . . . . . . .

Table 9: SUnsupported timers by ProCash/NDC-DDC

. . . . . . . .

125

Table 10: RGB values for 16 standard colors . . . . . . . . . . . . . .

126

Table 11: Screen parameters reference table

. . . . . . . . . . . . .

129

Table 12: Parameters supported in language banks (DDC only) . . . .

149

Table 13: Variables and formats for event and error messages

. . . .

151

Table 14: Hardware Configuration Parameters (NDC) . . . . . . . . .

153

Table 15: Hardware Configuration Parameters (DDC) . . . . . . . . .

155

Table 16: Default NDC font names . . . . . . . . . . . . . . . . . . .

271

Table 17: Default DDC font names . . . . . . . . . . . . . . . . . . .

271

Table 18: DDC resolution dependent values for "SIZE" and "HEIGHT"

273

Table 19: NDC resolution dependent values for "SIZE" and "HEIGHT"

274

Table 20: Standard NDC and DDC font identifiers

. . . . . . . . . . .

275

Table 21: Default settings for NDC and DDC fonts . . . . . . . . . . .

276

Table 22: List of files in sub folder \BAS

. . . . . . . . . . . . . . . .

295

Table 23: List of files in sub folder \BATCH . . . . . . . . . . . . . . .

296

Table 24: List of files in sub folder \CDM . . . . . . . . . . . . . . . .

296

June 2015

423

Tables
Table 25: List of files in sub folder \CCD . . . . . . . . . . . . . . . .

297

Table 26: List of files in sub folder \CHQ . . . . . . . . . . . . . . . .

297

Table 27: List of files in sub folder \CRS . . . . . . . . . . . . . . . .

298

Table 28: List of files in sub folder \EMV . . . . . . . . . . . . . . . .

298

Table 29: Error class files of folder \CCERRMAP

. . . . . . . . . . .

299

Table 30: List of files in sub folder \WEB\CONF . . . . . . . . . . . .

299

Table 31: List of files in sub folder \WN

. . . . . . . . . . . . . . . .

299

Table 32: List of files in sub folder \NCR\XFS30 . . . . . . . . . . . .

299

Table 33: List of files in sub folder \DIEBOLD\XFS30

. . . . . . . . .

299

. . . . . . . . . . . . . . . .

300

Table 35: List of files in sub folder \BAS . . . . . . . . . . . . . . . .

301

Table 36: List of files in sub folder \BATCH

. . . . . . . . . . . . . .

302

Table 37: List of files in sub folder \CDM . . . . . . . . . . . . . . . .

302

Table 38: List of files in sub folder \CCD . . . . . . . . . . . . . . . .

303

Table 39: List of files in sub folder \CHQ . . . . . . . . . . . . . . . .

303

Table 40: List of files in sub folder \CRS . . . . . . . . . . . . . . . .

303

Table 41: List of files in sub folder \EMV . . . . . . . . . . . . . . . .

303

Table 42: List of files in sub folder \WEB\CONF . . . . . . . . . . . .

303

Table 43: List of files in sub folder \WN

. . . . . . . . . . . . . . . .

304

Table 44: List of files in sub folder \NCR\XFS30 . . . . . . . . . . . .

304

Table 45: List of files in sub folder \DIEBOLD\XFS30

. . . . . . . . .

304

. . . . . . . . . . . . . . . .

305

Table 34: List of files in sub folder \FLX

Table 46: List of files in sub folder \FLX

Table 47: Error parameter block of CCERRMAP

. . . . . . . . . . .

306

Table 48: CSC-W32 and XFS class assign table

. . . . . . . . . . .

310

Table 49: XFS30 - CSC-W32 class assign table . . . . . . . . . . . .

311

Table 50: Card less transaction parameters . . . . . . . . . . . . . .

324

424

June 2015

Tables
Table 51: Card less parameter fields . . . . . . . . . . . . . . . . . .

325

Table 52: Parameter fields for IDLE_TIMEOUT

. . . . . . . . . . . .

326

. . . . . . . . . . . . .

349

Table 54: Cash Dispenser Framework Error Table . . . . . . . . . . .

352

Table 55: Cash Dispenser return code table

. . . . . . . . . . . . . .

353

. . . . . . . . . . . . .

354

Table 57: Registry cross link [STARTUP] . . . . . . . . . . . . . . . .

355

Table 58: Registry cross link [START_APPLICATION] . . . . . . . . .

356

Table 59: Registry cross link [DEFAULT] . . . . . . . . . . . . . . . .

356

Table 60: Registry cross link [CCProtFW1] . . . . . . . . . . . . . . .

356

Table 61: Registry cross link [MODEM] . . . . . . . . . . . . . . . . .

357

Table 62: Registry cross link [SERIAL] . . . . . . . . . . . . . . . . .

358

Table 63: Registry cross link [PROTOCOL\PROJECT] . . . . . . . . .

358

Table 64: Registry cross link [HARDWARE_CONFIGURATION] (DDC)

359

Table 65: Registry cross link [HARDWARE_CONFIGURATION] (NDC)

360

Table 66: Registry cross link [LYNXCI_PARAMETER] . . . . . . . . .

362

Table 67: Registry cross link [LYNXCI_TIMER] . . . . . . . . . . . . .

362

Table 68: Registry cross link [LYNXCI_EMV] . . . . . . . . . . . . . .

363

Table 69: Registry cross link [EMV_TAGS] . . . . . . . . . . . . . . .

363

Table 70: Registry cross link [CASH_DISPENSER]

. . . . . . . . . .

363

Table 71: Registry cross link [COIN_DISPENSER] . . . . . . . . . . .

366

Table 72: Registry cross link [BARCODE]

. . . . . . . . . . . . . . .

366

Table 73: Registry cross link [DEPOSIT] . . . . . . . . . . . . . . . .

367

Table 74: Registry cross link [CARD_READER]

367

Table 53: Transaction Framework Error Table

Table 56: Transaction Framework Error Table

. . . . . . . . . . . .

Table 75: Registry cross link [ELECTRONIC_JOURNAL]


Table 76: Registry cross link [JOURNALPRINTER]
June 2015

. . . . . . .

368

. . . . . . . . . .

368
425

Tables
Table 77: Registry cross link [JOURNAL_FONT_XXX]

. . . . . . . .

368

. . . . . . . . . .

370

Table 79: Registry cross link [RECEIPT_FONT_XXX] . . . . . . . . .

370

Table 80: Registry cross link [DOCUMENTPRINTER] . . . . . . . . .

371

Table 81: Registry cross link [DOCUMENT_FONT_XXX] . . . . . . .

371

Table 82: Registry cross link [VIEWER]

. . . . . . . . . . . . . . . .

372

. . . . . . . . . . . . . . . . . .

372

Table 78: Registry cross link [RECEIPTPRINTER]

Table 83: Registry cross link [SNA]

Table 84: Registry cross link [SNA_PROJECT]

. . . . . . . . . . . .

Table 85: Registry cross link [SNA_PROJECT_INITSELF]

372

. . . . . .

373

Table 86: Registry cross link [X25] . . . . . . . . . . . . . . . . . . .

373

Table 87: Registry cross link [X25_PROJECT]

. . . . . . . . . . . .

374

Table 88: Registry cross link [TCPIP_PROJECT] . . . . . . . . . . .

375

Table 89: Registry cross link [TOPMSG] . . . . . . . . . . . . . . . .

375

Table 90: Registry cross link [CUSTMSG] . . . . . . . . . . . . . . .

375

Table 91: Registry cross link [LYNXCI_SCREEN] . . . . . . . . . . .

376

Table 92: Registry cross link [SCREEN_XXX] . . . . . . . . . . . . .

377

Table 93: Registry cross link [OPERATOR_SCREENS] . . . . . . . .

377

Table 94: Registry cross link [APPLICATION_XXX] . . . . . . . . . .

378

Table 95: Registry cross link [APPLICATION_XXX] part 2 . . . . . . .

379

426

June 2015

Abbreviations
API

Application Program Interface

ARC

Application Return Code

ASCII

American Standard Code for Information Interchange

ATM

Automated Teller Machine

CDM

Cash Dispenser Module

CI

Customization Image

CRT

Cathode Ray Tube

CSC

Customer Service Center

DDC

DIEBOLD Direct Connect (equals 911/912 Protocols)

DES

Data Encryption Standard

EBCDIC

Extended Binary Coded Decimal Interchange Code

FDK

Function Display Key

FIT

Financial Institution Table

ID

IDentification

IDCU

ID Card Unit

MAC

Message Authentication Code

MDS

Modular Delivery System

NCR

National Cash Register

NDC

NCR Direct Connect

OAR

Open Account Relationship

June 2015

427

Abbreviations
PAN

Primary Account Number

PC

Personal Computer

PIN

Personal Identification Number

POS

Point of Sales (Cash Registers)

QLLC

Qualified Logical Link Control

SDLC

Synchronous Data Link Control

SNA

System Network Architecture

PU

Physical Unit

LU

Logical Unit

SSCP

System Server Control Point

PLU

Primary Logical Unit

TABS

Total Automatic Banking System

PPF

Parac Parameter File

CFGM

ProCash-NDC/DDC Configuration Manager

428

June 2015

Figures

Figures
Figure 1:

Product Overview . . . . . . . . . . . . . . . . . . . . .

33

Figure 2:

ProBase/C Installation Medias

. . . . . . . . . . . . . .

38

Figure 3:

J/Install Installation medias . . . . . . . . . . . . . . . .

41

Figure 4:

PARAC Start window . . . . . . . . . . . . . . . . . . .

291

Figure 5:

PARAC Update window . . . . . . . . . . . . . . . . . .

291

Figure 6:

PARAC Finish window with return code (0) . . . . . . . .

291

Figure 7:

PARAC Finish window with error return code . . . . . . .

292

Figure 8:

Workbench of PCEDT

293

. . . . . . . . . . . . . . . . . .

June 2015

429

Figures

430

June 2015

Related publications
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\

ProCash/DDC & ProCash/NDC


DESIGNATION

VERSION ORDER NUMBER

ProCash/DDC User Guide manual

3.0/21

(PDF file)

ProCash/NDC User Guide manual

3.0/21

(PDF file)

ProFlex/NDC-DDC Programming Guide

3.0/21

(PDF file)

Protopas Module Construction Kit


Programming Guide

(PDF file)

Protopas Framework Documentation


Programming Guide

(PDF file)

Protopas Host Protocol and


Communication Frameworks
Programming Guide

(PDF file)

ProTopas Module Konstruction Kit Programming Guide


Describes the Frameworks of the ProTopas Manager and gives detailed API
descriptions for the programmer. With this manual a programmer is able to build
up Protopas applications.

June 2015

431

Related publications
ProTopas Framework Documentation Programming Guide
Gives a global overview about the ProTopas Framework architecture and
describes the interaction between the different frameworks.
ProTopas Host Protocol and Communication Frameworks
ProGramming Guide
Describes the APIs of the Communication Frameworks from ProTopas
Manager and gives detailed descriptions for the programmer.
ProCash/DDC User Guide manual
Provides detailed function description about ProCash/DDC operation and DDC
Host to terminal and Terminal to Host messages (Write Commands, Function
Commands, Operational Commands, Status messages, etc.).
ProCash/NDC User Guide manual
Provides detailed function description about ProCash/NDC operation and NDC
Host to terminal and Terminal to Host messages (Download Commands, Transaction Request and Reply messages, Terminal Commands, Status messages,
etc.).
ProFlex/NDC-DDC Programming Guide
Describes function details of the Addon product ProFlex/NDC-DDC.
It gives detailed programming descriptions for developers how to set up the
transaction flow and how to install and configure the product for a host
connection.

432

June 2015

Você também pode gostar