APTRATM Advance NDC
Multi-Vendor Support
Reference Manual
B006-6344-H000
Issue 1
January 2013
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
The products described in this document are copyrighted works of NCR Corporation.
NCR, APTRA and PersonaS are trademarks of NCR Corporation.
Diebold, Opteva and Agilis are registered trademarks of Diebold International in the United States and/or other countries.
Wincor and Wincor Nixdorf are registered trademarks of Wincor Nixdorf International in the United States and/or other
countries.
Microsoft, Windows, and ActiveX are registered trademarks of Microsoft Corporation in the United States and/or other
countries.
Adobe, Acrobat and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United
States and/or other countries.
All other trademarks are the property of their respective owners.
It is the policy of NCR Corporation (NCR) to improve products as new technology, components, software, and firmware
become available. NCR therefore reserves the right to change specifications without prior notice.
All features, functions and operations described herein may not be marketed by NCR in all parts of the world. In some
instances, photographs are of equipment prototypes. Therefore, before using this document, consult with your NCR
representative or NCR office for information that is applicable and current.
To maintain the quality of our publications, we need your comments on the accuracy, clarity, organization, and value
of this book.
Address correspondence to:
NCR Financial Solutions Group Ltd
Information Solutions Feedback
Discovery Centre
3 Fulton Road
Dundee, Scotland
DD2 4SW
© 2000 - 2013
By NCR Corporation
Duluth, Georgia U.S.A.
All Rights Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Federal Communications Commission (FCC) Radio Frequency Interference Statement
Federal Communications
Commission (FCC) Radio Frequency
Interference Statement
Note: This equipment has been tested and found to comply with
the limits for a Class A digital device, pursuant to Part 15 of the
FCC Rules. These limits are designed to provide reasonable
protection against harmful interference when the equipment is
operated in a commercial environment. This equipment
generates, uses, and can radiate radio frequency energy and, if not
installed and used in accordance with the instruction manual,
may cause harmful interference to radio communications.
Operation of this equipment in a residential area is likely to cause
harmful interference in which case the user will be required to
correct the interference at his own expense.
This digital apparatus does not exceed the Class A limits for radio
noise emissions from digital apparatus set out in the Radio
Interference Regulations of the Canadian Department of
Communications.
Canadian Class A Device
Declaration
Le présent appareil numérique n’émet pas de bruits
radioélectriques dépassant les limites applicables aux appareils
numériques de la classe A prescrites dans le Réglement sur le
brouillage radioélectrique édicté par le ministère des
Communications du Canada.
This equipment must be installed and used in strict accordance with
the manufacturer’s instructions. However, there is no guarantee
that interference to radio communications will not occur in a
particular commercial installation. If this equipment does cause
interference, which can be determined by turning the equipment off
and on, the user is encouraged to consult an NCR service
representative immediately.
Information to User
Caution
NCR Corporation is not responsible for any radio or television
interference caused by unauthorised modifications of this
equipment or the substitution or attachment of connecting cables
and equipment other than those specified by NCR. Such
unauthorised modifications, substitutions, or attachments may void
the user’s authority to operate the equipment. The correction of
interference caused by such unauthorised modifications,
substitutions, or attachments will be the responsibility of the user.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
iii
Federal Communications Commission (FCC) Radio Frequency Interference Statement
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
iv
APTRA Advance NDC Multi-Vendor Support Reference
Revision Record
Revision Record
Date
Page
Jan 2013
Description of Change
New revision for APTRA Advance NDC
4.02
2-2
Removed device status section as IFD is no
longer supported
2-3
Added that a device threshold might not be
reported until the following cash-in
transaction
2-20
Updated the differences for other vendors’
SSTs when using the Supervisor Configure
menu
3-3
Added the configuration information for
aligning the display of FDKs
3-12 to 3-15
Added reference to specific information for
the Update Note Types option of the
Extended Add Cash Supervisor menu and
updated the cassette mapping examples
6-6
Added configuration for the treatment of
notes with an unknown present status after
a power failure
6-9
Added the configuration required to run
OP05/OP06 operator panels as TTU
emulators
6-9
Added that the Wincor CCDM is supported
without further configuration
6-11
Reinstated information for the Update Note
Types option of the Extended Add Cash
Supervisor menu
6-12
Added that certificates are supported for
remote key loading
6-17
Amended the contact details for
information on using APTRA Security
July 2011
New revision for APTRA Advance NDC
4.01
2-3
Added that direct deposit cannot be
supported on other vendors’ SSTs
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
v
Revision Record
Date
Page
Description of Change
2-17, 3-11
Replaced the NCR-specific term, GBRU,
with the generic term, cash recycler
3-15
Updated the cassette mapping used by the
TEST CASH Supervisor option
AppendixB
Removed M-Status information
Oct 2010
New revision for APTRA Advance NDC 4.0
xxv
Added that multi-vendor support was
introduced in version 3.0 of Advance NDC
Updated the information on the audience
for this publication
1-3
Added recommendation that TCP/IP is
used as the communications protocol
1-4
Added that the 24-volt reset is now
supported on all SSTs
2-2
Added that IFD alarm monitoring will have
no effect on other vendors’ SSTs
2-2
Added cross reference to configuration
information for other vendors’ EPPs
2-2
Added information on configuring FDK
mapping when operator panel
configuration does not match the Advance
NDC default
2-5
Added information on access to
Diagnostics and use of reserved screen P97
2-8
Removed information on the top of receipt
flag and black mark settings as the
information is no longer applicable
2-9
Updated path used for receipt and journal
printers as forms are now used and
qualified the paper width settings as for
vendor-specific control codes only
2-10
Updated path used for statement printers
as forms are now used
Removed information on setting up K
screens and converting printer code pages,
as these apply to raw data, not the now
used forms printing
3-2
Added that a configuration component is
now provided with Advance NDC
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
vi
APTRA Advance NDC Multi-Vendor Support Reference
Revision Record
Date
Page
Description of Change
3-3
Updated section on changing screen
resolution using reserved files to make the
information more general
3-3
Added section on re-scaling screens to
correct FDK alignment
3-8
Updated the information on configuring
registry settings for SSTs
3-11
Updated the information on the location of
settings for cassette type to logical cash unit
configuration
3-11
Clarified that the EXTENDED ADD CASH
option is used with Wincor SSTs only and
moved information to Wincor section of
new Chapter 6
5-2
Added information on the configuration
component
Chapter 6
Added a new chapter for the use of
Advance NDC on specific vendors’
hardware
B-5 to B-11
Updated the currency dispenser status
mapping information
Glossary
Removed any entries not used in this IP
Glossary-1
Added definition for Agilis XFS
Glossary-3
Added definition for Diebold
Glossary-3
Added definitions for IX and Opteva
Glossary-4
Added definition for ProDevice
Glossary-5
Added definition for Wincor Nixdorf
June 2009
New revision for APTRA Advance NDC
3.04
1-4
Added that express recovery is only
supported on NCR SSTs
2-20
Added reporting of faults for bunch cheque
acceptors with more than three bins
3-3
Updated the path used for resrvd.def and
resrvd.4012
B-1
Added devices for which status mapping
are included
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
vii
Revision Record
Date
Page
Description of Change
B-2
Added device service mapping to the status
mapping table
B-12
Status mapping added for the coin
dispenser
B-25
Status mapping added for the barcode
reader
B-26
Status mapping added for the CPM
B-31
Status mapping added for the bunch
cheque acceptor
C-3
Updated the path used for RPrint.log
Oct 2008
New revision for APTRA Advance NDC
3.03
2-6
Added information on showing/hiding the
‘SERVICE ASSIST’ text diagnostics
shortcut
2-18
Moved information relating to ADD CASH
function from Replenish Menu to Chapter 4
of the APTRA Advance NDC, Supervisor’s
Guide, where it is now the EXTENDED
ADD CASH option on the Configure Menu.
2-19
Updated reference in table describing NO
DISP.
3-12, 3-17
Added reference to APTRA Advance NDC,
Supervisor’s Guide for information on the
EXTENDED ADD CASH option.
B-42 to
B-47
Added status mapping for passbook
printers
July 2007
New revision for APTRA Advance NDC
3.02
All
Replaced the APTRA Advance NDC, General
Description with the APTRA Advance NDC,
Overview;
Replaced the APTRA Advance ADE, User’s
Guide with the APTRA Author User’s Guide;
Updated Advance ADE to APTRA Author
2-2
Updated encryptors information
2-5
Added reference to MV diagnostics menu
section
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
viii
APTRA Advance NDC Multi-Vendor Support Reference
Revision Record
Date
Page
Description of Change
2-13
Add exception to supported Device Status
Information
2-16 to 2-18
Added optional MV diagnostics menu
3-2
3-3
Added information on 40x12 screen
resolution
3-8
Added information on additional
diagnostics menus
3-8
Changed online documentation title from
Self Service to APTRA XFS;
Added information on service provider file
locations for forms and media
3-12
Added extended cassette types to the
cassette registry settings
3-16
Updated maximum number of notes
information
Appendix
A
Updated available documentation
appendix
C-3 to C-6
Updated printer registry information
Apr 2006
New revision for APTRA Advance NDC
3.01
page -xxvii
Added navigation information for this
publication
2-10
Added default for statement length
C-3
Added maximum statement length setting
September
2005
June 2005
New issue for APTRA Advance NDC
3.00.01
2-2
Updated cross reference to release bulletin
2-22
Updated cash configuration and calibration
for non-NCR SSTs
C-3
Updated statement length information
All
New publication for Advance NDC 3.0 to
support multi-vendor environments
complying with CEN-XFS 3.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
ix
Revision Record
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
x
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Contents
Preface
About This Publication ........................................................................xxv
Audience .........................................................................................xxv
Knowledge and Experience..........................................................xxv
Contents of the Publication .........................................................xxvi
How to Use the Publication....................................................... xxvii
Abbreviations Used in the Publication ................................... xxviii
Chapter 1
Introducing Multi-Vendor Support in Advance NDC
Overview ................................................................................................1-1
What is Multi-Vendor Support?..........................................................1-2
Application Compatibility and Functionality ...................................1-3
Communications .............................................................................1-3
Incoming Messages.........................................................................1-3
Outgoing Messages ........................................................................1-3
Device Status Messages..................................................................1-3
Chapter 2
Support for Advance NDC Features
Overview ................................................................................................2-1
Device Support ......................................................................................2-2
Encryptors........................................................................................2-2
Cash Acceptors................................................................................2-3
Supplies Data Sources ....................................................................2-4
Fitness Data Sources .......................................................................2-4
Device Access.........................................................................................2-5
Vendor Dependent Mode ..............................................................2-5
Screen Data .............................................................................................2-7
Reserved Screen Layout for the Operator Panel ........................2-7
Printer Data ............................................................................................2-8
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
xi
Table of Contents
Print Processing...............................................................................2-8
Printer Registry Settings ................................................................2-9
Graphics Limitations ....................................................................2-10
Supervisor Messages...........................................................................2-11
Screen Size Limitations ................................................................2-11
Correct Display Layout ................................................................2-11
Print Data Layout..........................................................................2-11
Terminal to Central Messages ...........................................................2-12
Solicited Status Messages.............................................................2-12
Unsolicited Status Messages .......................................................2-12
Central to Terminal Messages ...........................................................2-14
Terminal Commands....................................................................2-14
Enhanced Configuration Parameters Load...............................2-14
Dispenser Currency Cassettes Mapping Table.........................2-14
Transaction Reply Command .....................................................2-14
Supervisor Mode .................................................................................2-16
Diagnostic Menu ...........................................................................2-16
MV Diagnostics Menu..................................................................2-16
Misc Funcs Menu ..........................................................................2-18
Replenish Menu ............................................................................2-18
Configure Menu ............................................................................2-20
Error and Exception Reporting and Recovery..........................2-20
Chapter 3
Configuring the Multi-Vendor Environment
Overview ................................................................................................3-1
Terminal Application ............................................................................3-2
Reserved Screen Layouts ...............................................................3-2
Screen Resolution............................................................................3-3
FDK Alignment ...............................................................................3-3
Displaying Diagnostics Menus .....................................................3-8
Communications .............................................................................3-8
Registry Configuration...................................................................3-8
Suspend Timeouts...........................................................................3-9
Central Application .............................................................................3-10
Printer Data....................................................................................3-10
Status Handling.............................................................................3-10
Product Class .................................................................................3-10
Cash Handler Configuration .............................................................3-11
Cassette Type to Logical Cash Unit Mapping ..........................3-11
Currency Cassettes Mapping Table ...........................................3-12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xii
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Currency Cassette Types Registry Settings...............................3-12
Event Log Error Strings................................................................3-13
Cassette Mapping Limitations ....................................................3-14
Physical Cassettes Mapping Table .............................................3-15
Maximum Notes ...........................................................................3-16
Notes Threshold............................................................................3-16
Cash Counters ...............................................................................3-17
Additional Customisation ...........................................................3-17
Chapter 4
Delivering an Advance NDC Application to an SST
Overview ................................................................................................4-1
Modifying the Advance NDC Aggregate for Installation...............4-2
Modifying Files and Components................................................4-2
Building a Multi-Vendor Application ................................................4-3
Testing Your Application ..............................................................4-3
Unattended Initial Installation ............................................................4-4
Chapter 5
Setting up the Terminal
Overview ................................................................................................5-1
Initial Configuration .............................................................................5-2
Configuration Differences on an SST...........................................5-2
Setting up the SST in a Multi-Vendor Environment..................5-2
Starting the Advance NDC Application ............................................5-5
Chapter 6
Advance NDC on Specific Vendors’ SSTs
Overview ................................................................................................6-1
Default Platform Installation.........................................................6-1
Getting Support...............................................................................6-1
Diebold Hardware.................................................................................6-3
Installing and Verifying the Platform ..........................................6-3
Configuring Cassettes ....................................................................6-3
Configuring Printers.......................................................................6-4
Configuring Encryptors .................................................................6-4
Configuring the Operator Panel ...................................................6-4
Starting the Platform and Advance NDC ...................................6-5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
xiii
Table of Contents
Using Vendor Dependent Mode...................................................6-5
Decoding Status Messages.............................................................6-6
Unknown Status of Notes After a Power Failure.......................6-6
Common Issues ...............................................................................6-7
Collecting Diebold Logs.................................................................6-7
Wincor-Nixdorf Hardware ..................................................................6-9
Installing and Verifying the Platform ..........................................6-9
Cash/Cheque Deposit Module ......................................................6-9
Configuring Card Readers...........................................................6-10
Configuring Cassettes ..................................................................6-10
Configuring Printers.....................................................................6-12
Configuring Encryptors ...............................................................6-12
Configuring Media Entry Indicators..........................................6-13
Configuring Supervisor Entry and Exit.....................................6-13
Configuring the Operator Panel .................................................6-13
Starting the Platform and Advance NDC..................................6-14
Using Vendor Dependent Mode.................................................6-15
Decoding Status Messages...........................................................6-15
Common Issues .............................................................................6-15
Collecting Wincor Logs................................................................6-16
Extending APTRA Security Settings ..........................................6-17
Appendix A
Related Documentation
Overview ...............................................................................................A-1
Advance NDC Documentation ..........................................................A-2
APTRA Author Documentation.........................................................A-3
NDC+ Documentation .........................................................................A-5
Other NCR Documentation ................................................................A-6
CEN-XFS Documentation....................................................................A-7
Appendix B
Status Mapping
Overview ............................................................................................... B-1
Table Conventions ......................................................................... B-2
Currency Dispenser.............................................................................. B-3
Coin Dispenser.................................................................................... B-12
Card Reader......................................................................................... B-16
PIN Pad ................................................................................................ B-21
Barcode Reader ................................................................................... B-25
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xiv
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Cheque Processing Module .............................................................. B-26
Bunch Cheque Acceptor .................................................................... B-31
Receipt and Journal Printers ............................................................. B-32
Statement Printer ................................................................................ B-37
Passbook Printer ................................................................................. B-42
Text Terminal Unit ............................................................................. B-48
Sensors and Indicators Unit .............................................................. B-49
Envelope Dispenser and Depository ............................................... B-50
Night Safe ............................................................................................ B-55
Appendix C
Printer Data — Control Codes and Registry Settings
Overview ............................................................................................... C-1
Printer Control Sequences................................................................... C-2
Glossary
Glossary .................................................................................... Glossary-1
Index
Index................................................................................................Index-1
User Feedback Form
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
xv
Table of Contents
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xvi
APTRA Advance NDC Multi-Vendor Support Reference
List of Figures
List of Figures
Chapter 2
Support for Advance NDC Features
Figure 2-1
MV Diagnostics screen ................................................2-16
Chapter 3
Configuring the Multi-Vendor Environment
Figure 3-1
Figure 3-2
Screen without Font Adjustment .................................3-5
Screen with Font Adjustment.......................................3-6
Chapter 6
Advance NDC on Specific Vendors’ SSTs
Figure 6-1
Example Dispenser Shutter Jam Message ..................6-6
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
xvii
List of Figures
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xviii
APTRA Advance NDC Multi-Vendor Support Reference
List of Tables
List of Tables
Chapter 2
Support for Advance NDC Features
Table 2-1
Table 2-2
Table 2-3
Table 2-4
Table 2-5
Table 2-6
Table 2-7
Table 2-8
Default FDK Mapping...................................................2-2
Updated FDK Mapping from Registry .......................2-3
Supplies Data on Other Vendors’ SSTs.......................2-4
VDM Registry Key .........................................................2-5
Device Status Information Exception........................2-13
Function Identifiers......................................................2-15
MV Diagnostics Options .............................................2-17
Device Clearing ............................................................2-17
Chapter 3
Configuring the Multi-Vendor Environment
Table 3-1
Table 3-2
Table 3-3
Table 3-4
Table 3-5
Table 3-6
Rescaling Activation Properties ...................................3-8
NDC Cassette Type Mapping to XFS Cash Unit .....3-13
Invalid Currency ID and Value..................................3-14
Invalid Voucher Types ................................................3-15
Physical Cassettes Registry Entries ...........................3-15
DCCMT and Registry Currency Cassettes Mapping
Table.............................................................................3-17
Chapter 5
Setting up the Terminal
Table 5-1
Table 5-2
Table 5-3
Table 5-4
Registry Keys ..................................................................5-3
Registry Key Set-up .......................................................5-3
Service Provider Configuration ...................................5-4
Miscellaneous Configuration .......................................5-4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
xix
List of Tables
Chapter 6
Advance NDC on Specific Vendors’ SSTs
Table 6-1
Table 6-2
Table 6-3
FDK Mapping .................................................................6-5
Treatment of Notes After a Power Failure .................6-7
Wincor Graphical Operator Panel Lights .................6-14
Appendix A
Related Documentation
Table A-1
Table A-2
Table A-3
Table A-4
Table A-5
Table A-6
Advance NDC Documentation ...................................A-2
Provided Authoring Environment Documentation.A-3
Additional Authoring Environment
Documentation ............................................................A-4
Additional NDC+ Documentation..............................A-5
Other NCR Documentation .........................................A-6
CEN-XFS Documentation ............................................A-7
Appendix B
Status Mapping
Table B-1
Table B-2
Table B-3
Table B-4
Table B-5
Table B-6
Table B-7
Table B-8
Table B-9
Table B-10
Table B-11
Table B-12
Table B-13
Table B-14
Status Mapping Tables ................................................. B-2
XFS Command: CDM, all except PRESENT.............. B-3
XFS Command: CDM_DISPENSE.............................. B-3
XFS Command: CDM_PRESENT ............................... B-5
XFS Command: CDM_RETRACT............................... B-6
XFS Command: CDM_REJECT ................................... B-7
XFS Commands:
START_EXCHANGE/END_EXCHANGE .............. B-7
Currency Dispenser Event Mapping.......................... B-7
Currency Dispenser Severity Mapping...................... B-8
Currency Dispenser Replenishment Information
Mapping ....................................................................... B-9
Currency Dispenser Cash Tamper Indication
Mapping ..................................................................... B-10
Currency Dispenser Cash Counters ......................... B-10
Currency Dispenser Counter Updates..................... B-11
XFS Command: CDM_DISPENSE............................ B-12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xx
APTRA Advance NDC Multi-Vendor Support Reference
List of Tables
Table B-15
Table B-16
Table B-17
Table B-18
Table B-19
Table B-20
Table B-21
Table B-22
Table B-23
Table B-24
Table B-25
Table B-26
Table B-27
Table B-28
Table B-29
Table B-30
Table B-31
Table B-32
Table B-33
Table B-34
Table B-35
Table B-36
Table B-37
Table B-38
Table B-39
Table B-40
Table B-41
Table B-42
Table B-43
Table B-44
Table B-45
Table B-46
Table B-47
Table B-48
Table B-49
Table B-50
Table B-51
Table B-52
Table B-53
Coin Dispenser Event Mapping................................ B-13
Coin Dispenser Severity Mapping............................ B-13
Coin Dispenser Replenishment Information
Mapping ..................................................................... B-14
Coin Dispenser Cash Tamper Indication Mapping B-14
Coin Dispenser Counters ........................................... B-15
Coin Dispenser Counter Updates ............................. B-15
XFS Command: IDC_READ_RAW_DATA............. B-16
XFS Command: IDC_WRITE_RAW_DATA ........... B-17
XFS Command: IDC_CHIP_IO ................................. B-17
XFS Command: IDC_RESET_COUNT..................... B-18
XFS Command: IDC_EJECT_CARD ........................ B-18
XFS Command: IDC_RETAIN_CARD .................... B-18
Card Reader Event Mapping..................................... B-19
Card Reader Severity Mapping ................................ B-19
Card Reader Replenishment Information Mapping
(State of the LFCC Bin)............................................. B-20
XFS Command: PIN Pad, all...................................... B-21
XFS Command: PIN_CRYPT..................................... B-21
XFS Command: PIN_IMPORT_KEY........................ B-21
XFS Command: PIN_GET_PIN................................. B-22
XFS Command: PIN_LOCAL_DES .......................... B-22
XFS Command: PIN_LOCAL_VISA ........................ B-22
XFS Command: PIN_GET_PINBLOCK................... B-23
XFS Command: PIN_GET_DATA ............................ B-23
PIN Pad Event Mapping ............................................ B-23
PIN Pad Severity Mapping ........................................ B-23
XFS Command: PTR_READ_FORM ........................ B-25
Barcode Reader Severity Mapping ........................... B-25
XFS Command: All, PTR_RETRACT_MEDIA
(CPM).......................................................................... B-26
XFS Command: PTR_CONTROL_MEDIA ............. B-26
XFS Command: PTR_READ_IMAGE ...................... B-27
XFS Command: PTR_PRINT_FORM (CPM)........... B-27
XFS Command: PTR_RESET ..................................... B-28
CPM Severity Mapping: WFS_PTR_STATUS......... B-28
CPM Replenishment Information Mapping:
WFS_PTR_STATUS .................................................. B-29
XFS Command: PTR, all ............................................. B-32
XFS Command: PTR_RAW_DATA.......................... B-32
XFS Command: PTR_CONTROL_MEDIA ............. B-32
XFS Command: PTR_PRINT_FORM ....................... B-33
Receipt and Journal Printer Event Mapping........... B-34
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
xxi
List of Tables
Table B-54
Table B-55
Table B-56
Table B-57
Table B-58
Table B-59
Table B-60
Table B-61
Table B-62
Table B-63
Table B-64
Table B-65
Table B-66
Table B-67
Table B-68
Table B-69
Table B-70
Table B-71
Table B-72
Table B-73
Table B-74
Table B-75
Table B-76
Table B-77
Table B-78
Table B-79
Table B-80
Table B-81
Table B-82
Table B-83
Table B-84
Table B-85
Table B-86
Receipt and Journal Printer Severity Mapping....... B-34
Receipt and Journal Printer Replenishment
Information Mapping ............................................... B-35
XFS Command: PTR (Statement, all)........................ B-37
XFS Command: PTR_RAW_DATA (Statement) .... B-37
XFS Command: PTR_CONTROL_MEDIA
(Statement) ................................................................. B-37
XFS Command: PTR_RETRACT_MEDIA
(Statement) ................................................................. B-38
XFS Command: PTR_PRINT_FORM (Statement) .. B-38
XFS Command: PTR_RESET (Statement)................ B-39
Statement Printer Event Mapping ............................ B-39
Statement Printer Severity Mapping ........................ B-40
Statement Printer Replenishment Information
Mapping ..................................................................... B-41
XFS Command: PTR
(Passbook printer, all)............................................... B-42
XFS Command: PTR_RAW_DATA (Passbook)...... B-42
XFS Command: PTR_CONTROL_MEDIA
(Passbook) .................................................................. B-43
XFS Command: PTR_PRINT_FORM (Passbook) ... B-43
XFS Command: PTR_RETRACT_MEDIA
(Passbook) .................................................................. B-44
XFS Command: PTR_READ_FORM (Passbook) .... B-45
Passbook Printer Event Mapping ............................. B-45
Passbook Printer Severity Mapping ......................... B-46
Passbook Printer Replenishment Information
Mapping ..................................................................... B-47
XFS Command: DEP, all............................................. B-50
XFS Command: DEP_ENTRY ................................... B-50
XFS Command: DEP_RESET..................................... B-51
XFS Command: DEP_DISPENSE.............................. B-51
XFS Command: DEP_RETRACT .............................. B-51
Depository Event Mapping ....................................... B-52
Depository Severity Mapping ................................... B-52
Depository Replenishment Information Mapping. B-54
XFS Command: DEP, all............................................. B-55
XFS Command: DEP_ENTRY ................................... B-55
Night Safe Event Mapping ........................................ B-55
Nigh Safe Severity Mapping...................................... B-56
Night Safe Replenishment Information Mapping.. B-56
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxii
APTRA Advance NDC Multi-Vendor Support Reference
List of Tables
Appendix C
Printer Data — Control Codes and Registry Settings
Table C-1
Table C-2
Table C-3
Table Headings.............................................................. C-2
Printer Registry Settings............................................... C-3
Printer Control Sequences Registry Settings............. C-4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
xxiii
List of Tables
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxiv
APTRA Advance NDC Multi-Vendor Support Reference
Preface
About This Publication
About This Publication
This publication describes how to use APTRA Advance NDC
(Advance NDC) in a multi-vendor environment, that is, a network
comprised of either of the following:


NCR SSTs and SSTs manufactured by other vendors
SSTs manufactured by other vendors only.
The publication focuses on the differences in installation,
configuration and operation of Advance NDC on other vendors’
SSTs compared to Advance NDC on NCR SSTs. It is intended as a
supplement to the following manuals, which provide information
about Advance NDC running on NCR SSTs:





Audience
APTRA Advance NDC, Overview, B006-6597
APTRA Advance NDC, Developer’s Guide, B006-6046
APTRA Advance NDC, Supervisor’s Guide, B006-6062
APTRA Advance NDC, Reference Manual, B006-6180
APTRA Advance NDC, Extending the Product, B006-6926
This publication is intended for users of Advance NDC in a
multi-vendor environment. In particular, the publication is
intended for the following:



Programmers who create the terminal configuration that
customises the Advance NDC software
Anyone who is responsible for installing and configuring
software on the SSTs
Anyone who is responsible for maintaining and supporting the
software on the SSTs.
This publication builds on the information provided in the
publications listed above, particularly the Developer’s Guide and
Reference Manual. Reference to the other Advance NDC publications
is provided for each area of functionality as appropriate.
If you want to use Advance NDC only on NCR SSTs, you do not
need to refer to this manual.
Knowledge and
Experience
You should be familiar with Advance NDC and the Advance NDC
publications listed above. If you intend to modify or customize
Advance NDC, you will need to be familiar with the CEN-XFS
interface specification and be experienced in programming to the
XFS interface.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
xxv
Preface
About This Publication
You will also need to be familiar with the requirements of other
vendors’ hardware in order to run Advance NDC in a multi-vendor
environment.
Contents of the Publication
This publication contains the following information:
Chapter 1, “Introducing Multi-Vendor Support in Advance
NDC”, provides an introduction to using Advance NDC in a
multi-vendor environment.
Chapter 2, “Support for Advance NDC Features”, provides
information about any functional differences to consider when
customising Advance NDC for a multi-vendor environment. The
headings correspond to the equivalent chapters in the APTRA
Advance NDC, Reference Manual and the APTRA Advance NDC,
Supervisor’s Guide.
Chapter 3, “Configuring the Multi-Vendor Environment”
provides information about how to configure an Advance NDC
application and the Central application for use in a multi-vendor
environment.
Chapter 4, “Delivering an Advance NDC Application to an SST”,
provides information about how to deliver your Advance NDC
application to the SST when using Advance NDC in a multi-vendor
environment, and corresponds to the equivalent chapter in the
APTRA Advance NDC, Developer’s Guide.
Chapter 5, “Setting up the Terminal”, provides information about
how to configure the SST after installing your Advance NDC
application in a multi-vendor environment, and corresponds to the
equivalent chapter in the APTRA Advance NDC, Supervisor’s Guide.
Chapter 6, “Advance NDC on Specific Vendors’ SSTs”, provides
information on installing, configuring and troubleshooting Advance
NDC on specific vendors’ SSTs.
Appendix A, “Related Documentation”, refers you to the
documentation related to using Advance NDC.
Appendix B, “Status Mapping”, provides information about the
mapping between XFS status codes and Advance NDC T-Codes and
M-Status codes.
Appendix C, “Printer Data — Control Codes and Registry
Settings” gives details of the support provided in a multi-vendor
environment for each of the NDC printer controls described in the
APTRA Advance NDC, Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxvi
APTRA Advance NDC Multi-Vendor Support Reference
Preface
About This Publication
How to Use the
Publication
If you are new to Advance NDC, NCR recommends that first you
read the APTRA Advance NDC, Overview, B006-6597, for an
overview of the Advance NDC system. Then, use this publication
together with the Advance NDC publications listed earlier to
establish what you will have to do to ensure your application will
run in a multi-vendor environment.
If you have an existing single-vendor Advance NDC application
that you want to migrate to a multi-vendor environment, read
Chapter 2, “Support for Advance NDC Features”, before making
any application changes. If you have used the Author to customise
your application, refer to the APTRA Author, User’s Guide for details
of new, changed and unsupported workers.
Finding Information in the Publication
0
The manual has, at the front, a master table of contents, which lists
in page sequence the highest two levels of heading for the whole
book. Each chapter and appendix has its own table of contents,
which contains entries down to heading level three. In addition, the
index at the back of the book presents topics in alphabetical order,
with page references, and in greater detail.
If you are viewing the publication electronically, all the entries for
tables of contents and index are hyperlinked.
Using this Publication
This publication can be printed, or viewed electronically.
The electronic publication provides:


Hyperlinked page references
A hyperlinked content tree in the Bookmarks pane.
The following navigation and commenting elements are used in this
publication.
Table Pref-1
Navigation Elements
Element
Description
Revision Record
Lists updates for supported releases in page order
with page references. The most recent release is
listed first.
Table of Contents
List the first two heading levels in page order with
page references.
Table of Contents
for chapter or
appendix
Lists the first three heading levels in page order
with page references.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
xxvii
Preface
About This Publication
Abbreviations Used in the
Publication
Element
Description
Glossary
Provides an alphabetical list of terms, acronyms,
and abbreviations with their meaning.
Index
Provides an alphabetical list of topics, keywords,
concepts, and data references with page references.
Feedback
Allows you to comment on the publication by:
— Printing the form
— Selecting the Email link
— Selecting the Web link.
The following short forms and abbreviations are used throughout
the manual. For a complete list of abbreviations and short forms, see
the Glossary.
Full Form
Short Form
APTRATM Advance NDC
Advance NDC
APTRATM Author
Author
CEN-XFS 3.xx
CEN-XFS 3
HKEY_LOCAL_MACHINE
HKLM
Wincor Nixdorf International
Wincor
Diebold Incorporated
Diebold
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxviii
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Introducing Multi-Vendor Support in Advance NDC
Chapter 1
Introducing Multi-Vendor Support
in Advance NDC
Overview
1-1
What is Multi-Vendor Support?
1-2
Application Compatibility and Functionality
Communications
Incoming Messages
Outgoing Messages
Device Status Messages
1-3
1-3
1-3
1-3
1-3
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Introducing Multi-Vendor Support in Advance NDC
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Introducing Multi-Vendor Support in Advance NDC
Overview
A
Overview
1
This chapter provides an introduction to using Advance NDC in a
multi-vendor environment. It discusses the differences in
functionality and configuration of Advance NDC on NCR SSTs and
other vendors’ SSTs.
The APTRA Advance NDC, Developer’s Guide describes new and
changed functionality that is common to all SSTs in a multi-vendor
environment.
For details of building a multi-vendor Advance NDC application, or
migrating your existing Advance NDC application to run on other
vendors’ SSTs, use both the APTRA Advance NDC, Developer’s Guide
and this publication, APTRA Advance NDC, Multi-Vendor Support
Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
1-1
Introducing Multi-Vendor Support in Advance NDC
What is Multi-Vendor Support?
What is Multi-Vendor Support?
Multi-vendor support allows an Advance NDC application to be
used on a network containing either of the following:
NCR SSTs and SSTs manufactured by other vendors.

SSTs manufactured by other vendors only
For a multi-vendor environment, NCR has migrated the Advance
NDC product from a proprietary implementation based on ADI2 to
a vendor-independent implementation that is compliant with
CEN-XFS 3.

Advance NDC runs on both NCR SSTs and other vendors’ SSTs. On
NCR SSTs, the functionality is built upon APTRA XFS, NCR’s
implementation of the CEN-XFS interface; other vendors have their
own implementation of CEN-XFS running on their hardware. As
there can be differences between vendors in their interpretation and
implementation of the CEN-XFS specifications, this publication
focuses on issues affecting other vendors’ SSTs.
Where Advance NDC replaces the native application for the
hardware, the following work in the same manner as Advance NDC
on an NCR SST:




Replenishment operations
Supervisor operations
NDC download
Transactions.
For more information about the structure of an Advance NDC
application, refer to the APTRA Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-2
APTRA Advance NDC Multi-Vendor Support Reference
1
Introducing Multi-Vendor Support in Advance NDC
Application Compatibility and Functionality
Application Compatibility and
Functionality
1
Wherever possible, the Advance NDC application provides the
same functionality on other vendors’ SSTs as on NCR SSTs. This
section indicates any differences.
Communications
1
On NCR SSTs, Advance NDC supports all communications
protocols as previously, through APTRA Communications
Connection Manager (CCM). On other vendors’ SSTs, TCP/IP is
supported without a proxy application; other protocols can be used
with a proxy.
NCR recommends that you use TCP/IP as the communications
protocol.
Incoming Messages
Outgoing Messages
Device Status Messages
1
1
1
For incoming messages, the Advance NDC application maintains
the existing Advance NDC message structure and content. For more
information, see Chapter 2, “Support for Advance NDC Features”
under the heading, “Central to Terminal Messages”.
For outgoing messages, the Advance NDC application maintains
the existing Advance NDC message structure. Where possible, the
content of the Advance NDC message is also maintained with the
exception of device status messages, described in the next topic.
Migrating device access from ADI2 to the XFS interface means it is
not always possible to provide the full range of values offered for all
fields in a message. In this case, an attempt is made to generate the
closest compatible message by deriving the message content from
the XFS data.
An example of this is the device status information field in
Solicited/Unsolicited Device Status messages. The device status
information is maintained where possible, but may be different for
other vendors’ hardware.
For more information, see the section headed “Terminal to Central
Messages” in Chapter 2, “Support for Advance NDC Features”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
1-3
Introducing Multi-Vendor Support in Advance NDC
Application Compatibility and Functionality
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-4
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Support for Advance NDC Features
Chapter 2
Support for Advance NDC Features
Overview
2-1
Device Support
Encryptors
Mapping FDK Key Entry
Cash Acceptors
Supplies Data Sources
Fitness Data Sources
2-2
2-2
2-2
2-3
2-4
2-4
Device Access
Vendor Dependent Mode
Show/Hide Diagnostics Shortcut
2-5
2-5
2-6
Screen Data
Reserved Screen Layout for the Operator Panel
2-7
2-7
Printer Data
Print Processing
Receipt Printer
Printer Registry Settings
Receipt Printer Settings
Journal Printer Settings
Paper Width
Envelope Printing
Statement Printer
Graphics Limitations
2-8
2-8
2-8
2-9
2-9
2-9
2-9
2-9
2-10
2-10
Supervisor Messages
Screen Size Limitations
Correct Display Layout
Print Data Layout
2-11
2-11
2-11
2-11
Terminal to Central Messages
2-12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Support for Advance NDC Features
Solicited Status Messages
Device Fault
Card Variants
Unsolicited Status Messages
Device Status Information
2-12
2-12
2-12
2-12
2-13
Central to Terminal Messages
Terminal Commands
Enhanced Configuration Parameters Load
Dispenser Currency Cassettes Mapping Table
Transaction Reply Command
Function Identifier
Printer Data Field
2-14
2-14
2-14
2-14
2-14
2-15
2-15
Supervisor Mode
Diagnostic Menu
MV Diagnostics Menu
Misc Funcs Menu
Replenish Menu
DISP CASH
CLR CASH
DISP CNTRS
PRINT CNTRS
CLR CARDS
Configure Menu
GBXX CONFIG
BNA CASS CFG
Error and Exception Reporting and Recovery
Device Fault Reporting
2-16
2-16
2-16
2-18
2-18
2-19
2-19
2-19
2-20
2-20
2-20
2-20
2-20
2-20
2-20
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Support for Advance NDC Features
Overview
B
Overview
2
This chapter describes the differences in the features and
functionality of Advance NDC on other vendors’ SSTs.
Some of these differences may require you to modify your Advance
NDC application; others may require modifications to the Central
application.
NCR recommends that you familiarise yourself with the
information in this chapter before making any application changes.
The first two headings discuss Advance NDC support for devices
and device access on other vendors’ SSTs.
The following headings in the first part of this chapter correspond to
the equivalent chapters in the APTRA Advance NDC, Reference
Manual:







Device Support
Device Access
Screen Data
Printer Data
Supervisor Messages
Terminal to Central Messages
Central to Terminal Messages
The “Supervisor Mode” heading in the second part of this chapter
has subheadings corresponding to the equivalent chapters in the
APTRA Advance NDC, Supervisor’s Guide, as follows:



Replenish Menu
Configure Menu
Error and Exception Reporting and Recovery
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-1
Support for Advance NDC Features
Device Support
Device Support
2
This section provides information about device support on other
vendors’ SSTs under the following headings:
Encryptors
Cash Acceptors
Supplies Data Sources
Fitness Data Sources




For more information about data sources used in the Advance NDC
application, refer to the APTRA Advance NDC, Developer’s Guide and
the APTRA Advance NDC, Reference Manual. For more information
about messages, see “Solicited Status Messages” on page 2-12.
Encryptors
2
On NCR SSTs, the encryption keys can be restored after re-installing
Advance NDC. On other vendors’ SSTs, the encryption keys always
have to be entered following a re-installation of Advance NDC. For
further information on the Encryptor Mode key settings, refer to the
APTRA Advance NDC, Developer’s Guide.
On other vendors’ SSTs, the availability of double-length,
restricted-mode key entry does not imply the Encrypting PINPad
(EPP) used is compliant with the Payment Card Industry (PCI)
standard.
To check whether the EPP is PCI compliant, refer to the following
PCI web page:
https://www.pcisecuritystandards.org/security_standards/ped/
index.shtml
For details of configuration required for other vendors’ EPPs, see
“Configuring Encryptors” on page 6-12.
Mapping FDK Key Entry
2
For encryption key entry, the default mapping of function display
keys (FDKs) is as described in the following table:
Table 2-1
Default FDK Mapping
FDK
Maps to....
A
F1
C
F2
E
F3
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-2
APTRA Advance NDC Multi-Vendor Support Reference
Support for Advance NDC Features
Device Support
FDK
Maps to....
B
F5
D
F6
F
F7
If the FDK layout on the operator panel is different from that on the
front panel, the entered key will have a different Key Verification
Value (KVV). The following registry entry can be used to configure
FDK mapping to ensure the same KVV is returned from both the
front and operator panels:
HKLM\SOFTWARE\NCR\Advance NDC\supervisor\OperatorFDKMap
The value for this registry entry is a string of letters separated by
semi-colons. Each letter specifies an FDK, and each position
corresponds to a function key starting with F1. If no mapping needs
to be defined for a specific function key, use the space character in
that position.
The following table shows the remapping of FDKs to function keys
on the operator panel:
B;D;F; ;A;C;E
Table 2-2
Updated FDK Mapping from Registry
Cash Acceptors
2
FDK
Mapped to....
B
F1
D
F2
F
F3
A
F5
C
F6
E
F7
On NCR GBXX and single note acceptor (SNA) devices, notes can be
deposited to the cassettes without first being stored in the escrow
(direct deposit).
Advance NDC does not support direct deposit on other vendors’
SSTs.
On some Cash-In Module (CIM) devices, a device threshold might
only be reported on the next cash-in transaction.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-3
Support for Advance NDC Features
Device Support
Supplies Data Sources
2
Except for items in the following table, data sources for printer
supplies on other vendors’ SSTs are the same as on NCR SSTs:
Table 2-3
Supplies Data on Other Vendors’ SSTs
Device ID
Device Name
Supplies Data
Data source on Other Vendors SSTs
G
Receipt Printer
Receipt printer print-head
01 (good state) always returned
Receipt printer knife
01 (good state) always returned
Journal printer print-head
01 (good state) always returned
H
Journal Printer
Fitness Data Sources
2
Fitness data sources are the same on other vendors’ SSTs as on NCR
SSTs.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-4
APTRA Advance NDC Multi-Vendor Support Reference
Support for Advance NDC Features
Device Access
Device Access
2
For information relating to the XFS service provider interfaces used
for device access on NCR SSTs, refer to the APTRA Advance NDC,
Developer’s Guide. For details of the device identifiers in Advance
NDC, refer to the APTRA Advance NDC, Reference Manual.
Vendor Dependent Mode
2
Vendor Dependent Mode (VDM) allows direct access to devices
without using the XFS SPs and is used for diagnostics and
maintenance. Some vendors, however, do not support VDM
because of the way they manage their diagnostics; for example,
diagnostics may have to be accessed by booting from a diskette.
If VDM is unsupported or not provided, configure the VDM
registry setting as follows:
HKLM\SOFTWARE\NCR\Advance NDC
VDMSupported = 0
The default value is 1 (VDM supported). If the key is missing, the
default is assumed. The following table gives details of this key:
Table 2-4
VDM Registry Key
VDM Registry
Key Value
Description
0
Advance NDC does not register with the VDM SP.
When Diagnostics is selected from the Supervisor menu,
a screen offers the operator the option to press Enter to
shut down the SST or Cancel to return to the Main Menu.
Do not set this value for NCR SSTs.
1
The Advance NDC application registers with the VDM
service provider and requests entry to VDM when the
Diagnostics option is selected on the Supervisor menu.
The vendor-dependent application (VDA), if provided
by the vendor, starts the Diagnostics application
automatically when VDM mode is entered. When
exiting from the Diagnostics application, the VDA will
cause VDM to exit automatically and return to
Supervisor mode with device access once again through
XFS
You cannot enter Diagnostics if the SST mode switch is set to
Normal. If this is attempted, a message (P97) is displayed asking
that the mode switch is set to Supervisor to continue. You can
update this message with appropriate information for a specific SST
model. For details of the message, refer to Appendix A, “Reserved
Screens” in the APTRA Advance NDC, Reference Manual. For
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-5
Support for Advance NDC Features
Device Access
information on editing reserved screens, refer to Chapter 3, “Screen
Data” in the APTRA Advance NDC, Reference Manual.
For more information about Exits and VDM, refer to the APTRA
Advance NDC, Extending the Product publication.
To use the MV Diagnostic menu from Supervisor, see “MV
Diagnostics Menu” on page 2-16.
Show/Hide Diagnostics Shortcut
If VDM is not supported, or you do not want to display the
“SERVICE ASSIST” text link to access the VDM, you must ensure
that the show/hide diagnostics shortcut is disabled. For more
information, refer to Chapter 5 of the APTRA Advance NDC,
Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-6
APTRA Advance NDC Multi-Vendor Support Reference
2
Support for Advance NDC Features
Screen Data
Screen Data
2
For reserved screens, the Advance NDC screen display is sized
according to the operator panel sizes. For other vendors’ SSTs, you
may need to modify the operator panel screen layout.
Reserved Screen Layout
for the Operator Panel
2
Reserved screen layouts, which are unique for the size of the
operator panel, are defined in an ASCII file. This file must conform
to the format of the Advance NDC resrvd.def file, as described in the
APTRA Advance NDC, Reference Manual.
The default settings (32 rows by 16 columns) for an NCR operator
panel are contained in the file resrvd.def. For details of this file, see
“Screen Resolution” on page 3-3. Advance NDC also provides
screen definitions for some other vendors’ displays.
For all other displays, you are responsible for updating the screen
layouts to accommodate different resolutions.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-7
Support for Advance NDC Features
Printer Data
Printer Data
2
The default configuration settings apply to NCR SSTs. On other
vendors’ SSTs, printer settings must be configured. This section
gives details of the registry keys associated with printing, and other
printing differences.
Printer configuration files for other vendors’ SSTs can be obtained
from NCR.
For more information about printer data, refer to the APTRA
Advance NDC, Reference Manual.
Print Processing
2
On both NCR and other vendors’ hardware, when a message is
received containing print data for a receipt, journal, document or
statement printer, it is processed as follows:
1
Advance NDC adds preprint information if required. For receipt
printers, this is defined in reserved screens R00 and R01. K
screens can be added and file references resolved. For details of
K screens, refer to the APTRA Advance NDC, Reference Manual.
2
Advance NDC passes the complete NDC print data string to a
parser.
3
The parser produces an XFS form suitable for multi-vendor
printing.
An alternative method is available using vendor-specific control
codes. For details of the printer control sequences that are stored in
the registry, see Appendix C, “Printer Data — Control Codes and
Registry Settings”.
Receipt Printer
2
For consistency across all vendors’ hardware, Advance NDC
controls the cutting and ejecting of receipts. By default, the NCR
receipt printer service provider is configured for all NCR SSTs as
follows:
HKEY_CLASSES_ROOT\WOSA/XFS_ROOT\SERVICE_PROVIDERS\RPTR\
GENERAL_CONFIGS\VariableLengthReceipts = TRUE
For other hardware, refer to the vendor’s documentation for
configuration of service providers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-8
APTRA Advance NDC Multi-Vendor Support Reference
Support for Advance NDC Features
Printer Data
Printer Registry Settings
2
For each of the printer types supported in Advance NDC,
printer-specific information is stored in the registry.
For details of the control sequences and other registry settings for
printers, see Appendix C, “Printer Data — Control Codes and
Registry Settings”; and refer to the APTRA Advance NDC, Reference
Manual.
Receipt Printer Settings
2
For the receipt printer, forms are used and all registry settings,
including printer control sequences are held under:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Receipt Forms
Journal Printer Settings
2
The settings for the receipt printer also apply to the journal printer,
with the following differences:

The registry key for journal printer settings is
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Journal Forms

The LENGTH setting has no effect for the journal printer.
Paper Width
2
For printers that require vendor-specific control codes, to ensure
printing remains on the paper, the conversion process limits the
width of the print area to a predefined value, which overrides the
default width and margin options. The paper width needs to be set
correctly for the particular vendor’s hardware. The width can be set
using any of the following:



Enhanced configuration parameter
described in the APTRA Advance NDC, Reference Manual
Supervisor Configure menu function
described in the APTRA Advance NDC, Supervisor’s Guide
Registry keys
Messages that contain print data sent from the host, such as
Transaction Replies, must have the print data formatted to the
configured width.
Envelope Printing
2
The vendor-specific settings for Envelope Depository printing are
held in the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Deposit
The settings are similar to the receipt printer. The default values for
all fields are blank as this is the default for NCR. Other vendors may
support different printing features.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-9
Support for Advance NDC Features
Printer Data
Statement Printer
2
The vendor-specific settings for Statement printing are held in the
following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\
Statement Forms
The settings are similar to the receipt printer. The default values for
all except the length field are blank as this is the default for NCR.
The default for the length field, which sets the maximum page
length, is 12. Other vendors may support different printing features.
Graphics Limitations
2
Graphics printing is supported using forms. Refer to the APTRA
Advance NDC, Developer’s Guide for information on configuring
forms-based printing.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-10
APTRA Advance NDC Multi-Vendor Support Reference
Support for Advance NDC Features
Supervisor Messages
Supervisor Messages
2
When Supervisor messages are sent to the cardholder display, they
are displayed at the same resolution as configured for the rear
operator display. On NCR’s SSTs, there is no change in operation.
On other vendors' SSTs, Supervisor messages are prepared for
display or printing as follows:


The messages are sized according to the operator panel sizes.
The output to the operator display, receipt printer or journal
printer is adjusted to the vendor’s hardware format.
For further information on Supervisor messages, refer to the APTRA
Advance NDC, Reference Manual.
Screen Size Limitations
Correct Display Layout
2
2
On other vendors’ hardware, if screens need to be adjusted, for
example, to accommodate a row or column limitation, this is
configured in the resrvd.def file. For general information, see “Screen
Data” earlier in this chapter. For configuration through the registry,
see “Reserved Screen Layouts” on page 3-2.
On other vendors’ hardware, the resrvd.def file is used to define the
correct display layout. The display definitions are identical for both
the cardholder display and the operator display. For both NCR and
other vendors’ SSTs, if a rear operator panel is not 32x16, the front
screen size can also be updated to reflect the actual size using the
following registry keys:
HKLM\SOFTWARE\NCR\Advance NDC\
NoTTUOperatorResolution\SizeX
HKLM\SOFTWARE\NCR\Advance NDC\
NoTTUOperatorResolution\SizeX
This allows the updated resrvd.def screens to be correctly rendered
to fit the cardholder display.
For general information about screen data, see “Screen Data” on
page 2-7. For configuration details, see “Reserved Screen Layouts”
on page 3-2.
Print Data Layout
2
On other vendors’ hardware, the print data is adjusted, if required,
through configuration of the registry and resrvd.def file. For more
information, see “Printer Data” on page 2-8.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-11
Support for Advance NDC Features
Terminal to Central Messages
Terminal to Central Messages
2
On other vendors’ SSTs, Advance NDC sends messages with the
same format as on NCR SSTs, and where possible, with the same
content. The following sections describe any differences in
functionality.
For more information about Terminal to Central messages, refer to
the APTRA Advance NDC, Reference Manual.
For more information about the command completion returned by
XFS commands, refer to the Extensions for Financial Services (XFS)
interface specification (CWA 14050).
Solicited Status Messages
2
Solicited status messages with the following status descriptors are
sent exactly as on NCR SSTs:




‘9’ - Ready
‘A’ - Command Reject
‘B’ - Ready
‘F’ - Terminal State
The rest of this section describes the differences in functionality for
the other solicited status messages.
Device Fault
2
When the status descriptor is ‘8’ - Device Fault, messages are
the same as on NCR SSTs with the exception of the content of the
Diagnostic Status field. For details, see “Device Status Information”
on page 2-13.
Card Variants
Where the card variant is returned in response to a Terminal
Command message, for example Enhanced Configuration and
Hardware Configuration, only some variants are supported in the
multi-vendor environment. For unsupported variants, a default
value of 0x03 is returned.
For details of hardware configuration data, supplies data and fitness
data, refer to the APTRA Advance NDC, Reference Manual.
Unsolicited Status
Messages
2
In a multi-vendor application, the format of unsolicited status
messages is unchanged, but the content will vary as described in
“Solicited Status Messages”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-12
APTRA Advance NDC Multi-Vendor Support Reference
2
Support for Advance NDC Features
Terminal to Central Messages
An unsolicited status message is sent if one of the following
conditions is met:



Device status is non-zero
Derived error severity is 2 (warning) or greater
Derived supplies status is 2, 3 or 4.
Device Status Information
Device status information is provided as follows:



Table 2-5
Device Status Information Exception
2
On NCR hardware, the content is the same as in previous
releases of Advance NDC
No M-Data is provided for a successful Card Retain on NCR
hardware, but a Card Captured message is displayed. However,
this message is not displayed on other vendors’ hardware.
On other vendors’ hardware, the following exception applies:
Field
Description
Other vendors’ hardware
g4/
e4
Diagnostic Status
(M-Status+M-Data)
The M-Status field value is derived from
the XFS status information mapped to the
most likely M-Status.
The M-Data field is either empty or
contains vendor-specific extended
information if the device status is a
hardware error and the SP provides
extended information.
For more information about device status information refer to the
following:



APTRA Advance NDC, Developer’s Guide
APTRA Advance NDC, Reference Manual
Extensions for Financial Services (XFS) interface specification (CWA
14050)
For details of the status mapping between XFS and M-Data, see
Appendix B, “Status Mapping”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-13
Support for Advance NDC Features
Central to Terminal Messages
Central to Terminal Messages
On other vendors’ SSTs, the Advance NDC application accepts all
Central to Terminal messages that are accepted on NCR SSTs.
This section gives details of any variations in the actions taken on
receipt of a Central to Terminal message.
For further information about Central to Terminal messages, refer to
the APTRA Advance NDC, Reference Manual.
Terminal Commands
Enhanced Configuration
Parameters Load
Dispenser Currency
Cassettes Mapping Table
2
2
2
Terminal command messages are handled as on NCR SSTs.
Exceptions are described earlier in this chapter under the heading
“Solicited Status Messages”.
Enhanced Configuration Parameters Load messages are handled as
on NCR SSTs, with the exception of MCRW Enhanced Card Drive
(ECD) Security Jitter. On other vendors’ hardware, this parameter is
ignored.
This downloadable mapping table is used when the Amount Check
state is contained in a state table download. The dispenser currency
cassettes mapping table (DCCMT) is supported in Advance NDC.
If you use the DCCMT, its currency configuration, as defined by the
host, must match the configuration of the currency cassettes
mapping table held in the registry of the SST, The mapping table
held in the registry is used to map the XFS logical cassette units to
Advance NDC cassette types. For details of the registry settings in
the currency cassettes mapping table, see “Currency Cassette Types
Registry Settings” on page 3-12.
If the Amount Check state cannot establish that the requested
amount is dispensable, an attempt to dispense cash will fail. For
more information about the currency cassettes mapping table see
“Currency Cassettes Mapping Table” on page 3-12. For more
information about the DCCMT, see “Additional Customisation” on
page 3-17.
Transaction Reply
Command
Transaction reply commands on other vendors’ SSTs are handled as
on NCR SSTs, with the following exceptions:
2


Function Identifier
Printer Data Field.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-14
APTRA Advance NDC Multi-Vendor Support Reference
2
Support for Advance NDC Features
Central to Terminal Messages
Function Identifier
2
If the Function Identifier (field I) is set to the following value, the
message is rejected.
Table 2-6
Function Identifiers
Function ID
Function Performed
‘S’
Process document with cash
Printer Data Field
2
As the printer data (field r/t/v/v2) sent to other vendors’ hardware
must conform to any limitations imposed by that hardware, this is
achieved through the parser DLL. For details, see “Printer Data” on
page 2-8. For more information about the printer data field, refer to
the APTRA Advance NDC, Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-15
Support for Advance NDC Features
Supervisor Mode
Supervisor Mode
2
This section focuses on the differences in Supervisor mode
functionality on other vendors’ SSTs. Menus and functions that are
not discussed here are the same as on NCR SSTs.
The layout of Supervisor screens may be different on other vendors’
hardware, and is dependent on the physical display properties of
the hardware. For details, see “Screen Data” on page 2-7.
The DIAGNOSTIC menu offers the following:
Diagnostic Menu
2


MV Diagnostics Menu
2
For SSTs that support VDM mode, the vendor-specific
diagnostic application is invoked.
For SSTs that do not support VDM mode, the option to shut
down the SST is offered, allowing a diagnostics diskette to be
used for error investigation.
This option is designed for use where there is no VDA diagnostic
support and is only displayed if additional diagnostics screens are
configured. For information on configuring additional diagnostic
screens, refer to the APTRA Advance NDC, Developer’s Guide.
Details of up to six installed and configured devices can be
displayed on each screen. An example of the screen is shown in
Figure 2-1. The screen is repeated for further devices. The screen is
built from the results of fitness queries to each device.
MV DIAGNOSTICS
Figure 2-1
MV Diagnostics screen
1
2
3
4
DEVICE
CASH DISPENSER
CARD READER
JOURNAL PRINTER
RECEIPT PRINTER
0 CLEAR ALL
26 FAULT DISPLAY
FITNESS
GOOD
GOOD
FATAL
GOOD
91 SHUTDOWN
SELECT FUNCTION-
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-16
APTRA Advance NDC Multi-Vendor Support Reference
Support for Advance NDC Features
Supervisor Mode
The options from this screen are described in Table 2-7.
Table 2-7
MV Diagnostics Options
Select...
To...
0
Clear all devices that are installed and configured on the SST
The number representing the
device that you want to clear
Clear that device
8
Move backward through the MV Diagnostic screens. This is only displayed if
there are previous MV Diagnostic screens
9
Move forward through the MV Diagnostic screens. This is only displayed if
there are further MV Diagnostic screens
26
Display the Fault Display screen. For further information on Fault Display,
refer to the APTRA Advance NDC, Supervisor’s Guide
91
Be given the option to shut down the SST
Note: If necessary, multiple screens display up to six devices each. You can
only select from the devices on the currently displayed screen.
During self tests, prompts may be displayed requiring action. For
example, during a card reader self test, an Enter Card prompt is
displayed.
Once the specified device or devices are cleared, the MV Diagnostics
screen is redisplayed.
The devices that can be cleared are described in Table 2-8. For
details of any referenced Supervisor options, refer to ‘Chapter 3,
Replenish Menu’ in the APTRA Advance NDC, Supervisor’s Guide.
Table 2-8
Device Clearing
Device
Description
Cash handler 1
This is cleared as described in the TEST CASH option, but the test cash result
screen is not displayed
Note: When a cash recycler is used for cash-out transactions, the display can list
‘Cash recycler’ instead of ‘Cash handler 1’
Cash handler 2
This is the same as for cash handler 1, but the test is run only on cash handler 2
Coin dispenser
This is cleared as described in the CLR COINS option
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-17
Support for Advance NDC Features
Supervisor Mode
Device
Description
Card reader
The card reader is reset, and any cards present are captured. A card must be
entered to complete the self test. The card is immediately ejected, and can either
be taken, or left until it is captured
Note: NCR recommends that this is done at the cardholder interface as you must
enter a card to complete the self test.
Note acceptor
This is cleared as described in the CLR BNA option
Envelope depository
This is cleared as described in the INIT DEPOS option, and allows the operator to
deposit an envelope as part of the self test
Cheque processing module
Allows the operator to enter a cheque, which is immediately ejected and the
codeline is displayed
If the cheque is not taken it is captured to bin 1
Where hardware is capable, the cheque is printed and stamped before being
captured
Journal printer
This is only listed where a physical journal is installed and configured
The journal printer is initialised, and a test print using screen t64 is produced
Note: For details of the test screen, t64, refer to the APTRA Advance NDC,
Reference Manual. If you use the default font and character set defined by screens
K02, K08, and K10 the test print is as shown. Otherwise, some characters may be
rendered differently, depending on your margin and character set settings
Receipt printer
This is cleared as described in the INIT RECPT option
Statement printer
This is cleared as described in the INIT STMNT option
Envelope dispenser
This is cleared as described in the FILL ENV option
Pin Pad/Encryptor
Initialises the PIN pad
Note: This does not clear the encryption keys. For details of the encryption keys
refer to the APTRA Advance NDC, Developer’s Guide.
Night safe
Initialises the night safe
Barcode reader
Initialises the barcode reader
Misc Funcs Menu
Replenish Menu
2
2
On the MISC FUNCS menu, Option 0, PRNT CMPNT VERS,
performs the same function as on NCR SSTs. Option 1, PRNT SCRW
VERS, prints the default message, VERSION NOT INSTALLED, as the
version details cannot be retrieved on other vendors’ SSTs.
On the REPLENISH menu, most menu functions operate as on NCR
SSTs. In cash handling, however, there are several differences in the
operation of cash-related menu options to accommodate differences
in implementation of the CEN-XFS interface on different vendors’
SSTs while providing the same functionality as on NCR SSTs.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-18
APTRA Advance NDC Multi-Vendor Support Reference
Support for Advance NDC Features
Supervisor Mode
For further information on the Replenish menu functions, refer to
the APTRA Advance NDC, Supervisor’s Guide.
DISP CASH
2
On other vendors’ SSTs, pressing Enter after the Cash counts are
displayed displays the currency cassette settings for each Advance
NDC cassette type as follows:




Currency ID
Media type
Media value
DISP (OK or NO DISP)
Values for the last setting (DISP) mean the following:
Value
Meaning
OK
The currency/denomination is present in the service provider.
This does not indicate the fitness of the device, that is, whether
notes can be dispensed.
NO DISP
The currency/denomination is not present in the service
provider (SP). The SP must be reconfigured to match Advance
NDC or the operator uses the UPDATE NOTE TYPE option in
the REPLENISH menu (ADD CASH) to change the cassette
type to a currency/denomination offered by the SP.
Note: The currency denomination for each NDC cassette must also
match that of Central for the correct amount to be dispensed.
Pressing the Cancel key returns the display to the Replenish menu.
These settings are used to identify the physical cassette to use for
dispensing currency. For more information about configuring
cassettes, see “Cash Handler Configuration” on page 3-11.
DISP CASH may show incorrect amounts when first installed as the
SP counts may not be zero. In this case, they must be cleared using
the CLR CASH menu option. This will synchronise Advance NDC
note counts with the SP note counts.
CLR CASH
2
This resets the counters maintained by Advance NDC and the CDM
service provider. For details of the counters maintained by Advance
NDC, refer to the APTRA Advance NDC, Developer’s Guide.
DISP CNTRS
2
The information displayed for card reader devices is obtained by
querying the IDC service provider.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
2-19
Support for Advance NDC Features
Supervisor Mode
PRINT CNTRS
2
On other vendors’ SSTs, this option prints the same cassette
configuration as Display Cash.
CLR CARDS
2
This option resets the counters maintained by the IDC service
provider.
Configure Menu
2
On the Configure menu, most menu functions operate as on NCR
SSTs. For cash acceptors, however, there are some differences.
GBXX CONFIG
2
This option configures cassettes on NCR devices only.
BNA CASS CFG
2
This option configures the following settings for cassettes on all
vendors’ cash acceptors:



The types of items that the cassettes can accept
The three-character ISO-format currency identifier
The maximum threshold to trigger a device status of high.
For further information on this .NET Supervisor task and the
screens displayed for this option, refer to the .NET CIM
Configuration Tasks On-Line Documentation.
For further information on the Configure menu functions, refer to
the APTRA Advance NDC, Supervisor’s Guide.
Error and Exception
Reporting and Recovery
This section describes any differences in the error and exception
reporting functionality of Advance NDC on other vendors’ SSTs.
2
Device Fault Reporting
The fault display is responsible for displaying fault information on
the rear operator interface when the SST is not in Supervisor mode.
The fault display cycles through fault information for each device
requiring attention.
With a multi-vendor application, an error report is displayed for
each hardware error event generated by XFS, indicating which
device has failed and, depending on the device, the nature of the
failure.
If a bunch cheque acceptor with more than three bins is supported,
any faults reported for the additional bins are all listed as bin three.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-20
APTRA Advance NDC Multi-Vendor Support Reference
2
Table of Contents
Configuring the Multi-Vendor Environment
Chapter 3
Configuring the Multi-Vendor
Environment
Overview
3-1
Terminal Application
Reserved Screen Layouts
Screen Resolution
FDK Alignment
Preventing Overlapping Text
Defining When Rescaling is Applied
Displaying Diagnostics Menus
Communications
Registry Configuration
Supervisor Mode Switch
Suspend Timeouts
3-2
3-2
3-3
3-3
3-4
3-7
3-8
3-8
3-8
3-9
3-9
Central Application
Printer Data
Status Handling
Product Class
3-10
3-10
3-10
3-10
Cash Handler Configuration
Cassette Type to Logical Cash Unit Mapping
NCR SSTs
Other Vendors’ SSTs
Currency Cassettes Mapping Table
Other Vendors’ SSTs
Currency Cassette Types Registry Settings
Event Log Error Strings
Cassette Mapping Limitations
Currency ID and Value
Different Voucher Types
Physical Cassettes Mapping Table
Physical Cassettes Registry Settings
Test Cash
Device Status Handling
3-11
3-11
3-11
3-11
3-12
3-12
3-12
3-13
3-14
3-14
3-14
3-15
3-15
3-16
3-16
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Configuring the Multi-Vendor Environment
Maximum Notes
Notes Threshold
Cash Counters
Additional Customisation
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-16
3-16
3-17
3-17
Configuring the Multi-Vendor Environment
Overview
C
Overview
3
This chapter contains information about the configuration of your
Advance NDC application and the corresponding Central
application for other vendors’ SSTs. It discusses the following:



Terminal application
Central application
Cash handler configuration
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-1
Configuring the Multi-Vendor Environment
Terminal Application
Terminal Application
3
To configure your Advance NDC terminal application on other
vendors’ SSTs, you need to consider the following:









Reserved screen layouts
Screen resolution
FDK alignment
Display of additional diagnostic menus
Communications
Registry configuration
Service providers (SPs)
Suspend time-out for the MCRW, the cash handler and the
envelope depository devices
Cash handler configuration, which is described in detail later in
this chapter
For more information about building and testing your application,
refer to the following:



Chapter 4, “Delivering an Advance NDC Application to an SST”
APTRA Advance NDC, Developer’s Guide
APTRA Advance NDC Release Bulletin, on the Advance NDC
Package CD-ROM
The Self Service Terminal Configuration component (SST
configuration component) is supplied with Advance NDC for
specific vendors’ platforms. For further details of the SST
configuration component, refer to Chapter 5, “Configuring Advance
NDC and Associated Components” in the APTRA Advance NDC,
Developer’s Guide.
Reserved Screen Layouts
3
Reserved screen layouts for NCR operator panels are defined in
resrvd.def. The display resolution is 32 columns by 16 rows.
For other display resolutions, you may have to configure the TTU
SP for the correct default resolution. You must also either edit
resrvd.def to match the rear display resolution or load an additional
reserved screen file containing updated screens during startup. For
details of loading an additional reserved screen file, see “Screen
Resolution” on page 3-3.
The functionality of the Supervisor menus is unchanged for the
different layouts. Only the menu prompts and their placement on
the operator panel vary according to the resolution.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-2
APTRA Advance NDC Multi-Vendor Support Reference
Configuring the Multi-Vendor Environment
Terminal Application
When the operator interface is set to the front display, the font size
of the front display text is adjusted to the resolution of the current
rear display, so that both interfaces have the same appearance and
only one resrvd.def is required.
When the SST has no rear panel and all operator interaction takes
place on the front display, the following registry keys define the
resolution to use:
HKLM\SOFTWARE\NCR\Advance NDC\
NoTTUOperatorResolution
SizeX = <x> (minimum of 20, default is 32)
SizeY = <y> (minimum of 12, default is 16)
To keep the same operator interface look and feel on SSTs of a
particular vendor, the key values must match the screen layouts in
the installed resrvd.def file, otherwise the screens are displayed
incorrectly. If these keys are not defined, the NCR resolution (32
columns by 16 rows) is applied as the default. The edited resrvd.def
file must be added to the Advance NDC aggregate, as described in
the APTRA Advance NDC, Developer’s Guide.
Screen Resolution
3
The default file, resrvd.def, is provided for a display resolution of 32
columns by 16 rows.
You can update any screen or add screens by loading an additional
reserved screen file containing the changes and additions. If
creating your own file, it must have the same format as resrvd.def
and be installed to C:\Program Files\NCR APTRA\Advance
NDC\Config on the SST.
To load an additional reserved screen file, you must update the
following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\supervisor\
UserAdditionalReservedScreenFile
Valid values are blank for no additional reserved screen loading or
the name of the file, for example resrvd.4012.
Note: Running the vendor-specific configuration tools provided
with Advance NDC may automatically update this key with the
required file name.
FDK Alignment
3
The SST configuration component calculates the following to adjust
the display of FDK labels:


The amount that the screen is to be scaled (screen scale factor)
The amount in pixels that the text is to be moved up or down the
screen (vertical offset).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-3
Configuring the Multi-Vendor Environment
Terminal Application
The SST configuration component updates the AdvanceNDC.accfg
file with these calculated values as shown in the following example:
<Class ID="ScreenRescaler"
Name="NCR.APTRA.NDC.ScreenAdjuster.FDKScreenAdjuster"
Assembly="NCR.APTRA.NDC.ScreenAdjuster.dll">
<Constructor>
<Argument Name="executionContext" Value="NDC
Configuration"/>
</Constructor>
<Interface>
<Property Name="FDKsSpan" Value="0.83" />
<Property Name="VerticalOffset" Value="1" />
</Interface>
</Class>
If an XML file with a name matching the FDKsSpan value multiplied
by 100 is located in the C:\Program Files\NCR APTRA\Advance
NDC\Config\DMConfigs folder, the SST configuration component
copies it to DisplayManagerConfig.xml, overwriting the existing file.
For the entry in the above example, the DMConfigs folder would be
checked for an XML file named 83.xml.
For the VerticalOffset value in the above example, the text would
be moved one pixel up the screen.
Note: Some Wincor SSTs use an FDKsSpan value of 0.83 as shown in
the above example. Diebold SSTs normally use an FDKsSpan value
of 0.91.
For further information on the SST configuration component, refer
to Chapter 5, “Configuring Advance NDC and Associated
Components” in the APTRA Advance NDC, Developer’s Guide.
You must validate the screen layout and further configuration may
be necessary, as described in the following section and “Defining
When Rescaling is Applied” on page 3-7.
Preventing Overlapping Text
The following approaches can be used to prevent overlapping text
on rescaled screens:



Set a transparent background for all screens. For details, refer to
Chapter 3, “Screen Data” in the APTRA Advance NDC, Reference
Manual
Reduce the font size for all screens. This approach maintains the
same layout for all screens whether or not they include active
FDKs
Reduce the font size for rescaled screens only.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-4
APTRA Advance NDC Multi-Vendor Support Reference
3
Configuring the Multi-Vendor Environment
Terminal Application
To specify a reduced font size, complete the following steps:
1
Calculate the size of the reduced font. To do this, multiply the
default font size by the FDKsSpan value in the AdvanceNDC.accfg
file
2
Add or amend a height attribute in the
DisplayManagerConfig.xml file for each font definition used by
the SST as shown in the following examples. In both of these
examples, the default font size is 125 and the FDKsScan value is
0.83, so the font is to be reduced to 103 (125*0.83).
The following illustration shows how a screen could look when the
fonts need to be reduced:
Figure 3-1
Screen without Font Adjustment
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-5
Configuring the Multi-Vendor Environment
Terminal Application
The following illustration shows how the same screen could look
with the font reduced:
Figure 3-2
Screen with Font Adjustment
Example of Reducing the Font for All Screens In this example,
the font with a designator of "1" will be reduced in size for all
screens.
3
The original font definition in the DisplayManagerConfig.xml file is as
follows:
<font id="1" face="NDCAlphanumeric1" />
The font definition must be amended as follows:
<font id="1" face="NDCAlphanumeric1" height="103" />
Example of Reducing the Font for Rescaled Screens In this
example the font with a designator of "1" will be replaced by the
font with a designator of "6" on rescaled screens only.
The original font definitions in the DisplayManagerConfig.xml file are
as follows:
<font id="1" face="NDCAlphanumeric1" />
<font id="6" face="NDCAlphanumeric1" />
The font definition for the font with a designator of "6" must be
amended as follows:
<font id="6" face="NDCAlphanumeric1" height="103" />
The FontMapping property must be added to point to the array
giving the mapping information, as follows:
<Class ID="ScreenRescaler"
Name="NCR.APTRA.NDC.ScreenAdjuster.FDKScreenAdjuster"
Assembly="NCR.APTRA.NDC.ScreenAdjuster.dll">
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-6
APTRA Advance NDC Multi-Vendor Support Reference
3
Configuring the Multi-Vendor Environment
Terminal Application
<Constructor>
<Argument Name="executionContext" Value="NDC
Configuration" />
</Constructor>
<Interface>
<Property Name="FDKsSpan" Value="0.83" />
<Property Name="VerticalOffset" Value="" />
<Property Name="FontMapping"
Value="ScreenAdjusterFontMap" />
</Interface>
</Class
The ScreenAdjusterFontMap array must be updated with the font
mapping information as follows:
<Array ID="ScreenAdjusterFontMap">
<Element Value="1,6" />
</Array>
Defining When Rescaling is Applied
3
The screens to rescale can be defined using the following properties
under the ScreenRescaler class:

StateTypeActivationList defines the states for which all
screens are to be rescaled

ScreenNumberActivationList explicitly lists screens to be
rescaled.
By default, all FDK selection states are defined using the
StateTypeActivationList property.
The following extract from the DisplayManagerConfig.xml file shows
the properties that can be used to define the states and/or screens for
which rescaling is applied. The properties are described in
Table 3-1, “Rescaling Activation Properties” on page 3-8.
<Class ID="ScreenRescaler"
Name="NCR.APTRA.NDC.ScreenAdjuster.FDKScreenAdjuster"
Assembly="NCR.APTRA.NDC.ScreenAdjuster.dll">
<Constructor>
<Argument Name="executionContext" Value="NDC
Configuration" />
</Constructor>
<Interface>
<Property Name="FDKsSpan" Value="0.83" />
<Property Name="VerticalOffset" Value="" />
<Property Name="FontMapping"
Value="ScreenAdjusterFontMap" />
<Property Name"ActiveAlways" Value="false" />
<Property Name"ScreenNumberActivationList" Value="" />
<Property Name"StateTypeActivationList"
Value="B,E,F,H,M,X,Y,b,T,I,>,z001,z002,z003,z004" />
</Interface>
</Class>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-7
Configuring the Multi-Vendor Environment
Terminal Application
Table 3-1
Rescaling Activation Properties
Property
Description
ActiveAlways
Defines whether re-scaling is applied to each displayed screen
independently of the settings of other activation properties.
Valid values are as follows:

"true" - Rescale screens only if the FDKsSpan value is not set to "1" or
the VerticalOffset value is not set to " "

"false" - Default. Rescale screens according to the settings of the other
activation properties
ScreenNumberActivationList
Lists the screen identifiers separated by a comma (,) to be rescaled even if
the corresponding state is not listed in the StateTypeActivationList
property
The screen identifiers can be obtained from the screens downloaded from
the host
By default, the list is empty
StateTypeActivationList
Lists the states during which screens will be rescaled
By default, states B, E, F, H, M, X, Y, b, T, I, >, z001, z002, z003 and z004 are
listed
Displaying Diagnostics
Menus
3
On other vendors’ SSTs with no access to VDM and VDA diagnostic
support, you can choose to display additional diagnostics menus
within Supervisor.
To display these menus, set the following registry key to 1:
HKLM\SOFTWARE\NCR\Advance
NDC\Supervisor\Diagnostics\MVDiagnostics
For details of the menus, see “MV Diagnostics Menu” on page 2-16.
Communications
3
Registry Configuration
3
On other vendors’ SSTs, only TCP/IP is supported without a proxy
application. Other protocols require use of a proxy. It is your
responsibility to ensure that communications on other vendors’
hardware is configured before being used by the Advance NDC
application.
Advance NDC provides settings at start up with the SST
configuration component. A basic configuration is provided and
can be updated with the settings required for your SST
environment. The SST configuration component is run at start up if
the ANDCConfig.NDC file is not found. For further information on
the SST configuration tool, refer to Chapter 5, “Configuring
Advance NDC and Associated Components” in the APTRA Advance
NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-8
APTRA Advance NDC Multi-Vendor Support Reference
Configuring the Multi-Vendor Environment
Terminal Application
Supervisor Mode Switch
3
The following registry key can be used to define the trigger used to
switch the application to Supervisor mode:
HKLM\SOFTWARE\NCR\Advance NDC\
supervisor\ModeSwitchTrigger
Valid values are as follows:




0 to use the mode switch
1 to use the cabinet
2 to use the safe door
3 to use the registry entry defined in the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\
supervisor\ModeSwitchRegStatus
Valid values are as follows:
— 0 for Run
— 1 for Supervisor.
If a value of 3 is used, the following are also true:
— If a TTU is also present, key 9 on the TTU acts as a mode
switch when not in Supervisor mode.
— When key 9 is selected from the Select menu in Supervisor,
Advance NDC automatically exits Supervisor
— Auto Exit Function is not supported.
Suspend Timeouts
3
For devices that are in a suspend state, Advance NDC will attempt
to clear them on exit from the Suspend state. On other vendors’
SSTs, further operator intervention may be required to return the
device to a good state.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-9
Configuring the Multi-Vendor Environment
Central Application
Central Application
To configure the Central application, you need to consider the
following:




Printer Data
Status Handling
3
3
Printer data
Status handling
Product class
Cash handler configuration, which is described in detail in
“Cash Handler Configuration” on page 3-11.
The print data is passed through a conversion DLL before being sent
to the printer, and some control characters might not be supported
by the vendor’s printer. It is possible to configure how the print data
is handled for other vendors’ printers. For details, see “Printer
Data” on page 2-8.
The status information from XFS is mapped to the existing Advance
NDC status. For details of the status mapping tables, see
Appendix B, “Status Mapping”.
For details of device interface support, refer to the APTRA Advance
NDC, Developer’s Guide, Chapter 4, “Upgrading From Earlier
Releases of Advance NDC, under the “Device Access” topic.
Product Class
3
On other vendors' hardware, the product class is reported as
Personas86 (‘1F’). For details of product class values, refer to the
APTRA Advance NDC, Reference Manual, Chapter 9, “Terminal to
Central Messages”.
The product class is stored in the registry entry
HKLM\SOFTWARE\NCR\Advance NDC\ProductClass, which is a string
type.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-10
APTRA Advance NDC Multi-Vendor Support Reference
3
Configuring the Multi-Vendor Environment
Cash Handler Configuration
Cash Handler Configuration
3
In a multi-vendor environment, a means of mapping NDC cassette
types (for example NDC type 1) to the correct XFS cash unit is
required. Central sends messages to dispense cash, documents or
vouchers from NDC cassette types, but Advance NDC has to
dispense using XFS cash units. Registry keys are used to provide the
mapping between them. For some cassette mapping scenarios, refer
to Chapter 3, “Configure Menu” of the APTRA Advance NDC,
Supervisor’s Guide.
This section discusses the differences in cash management on other
vendors’ SSTs, compared with NCR SSTs, as follows:


Cassette Type to Logical
Cash Unit Mapping
3
The role of the cassette mapping table in the mapping of the XFS
cash units to NDC cassette types for cash dispensing. This table
is defined in the registry of the SST under
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable.
What reconfiguration is required as a result of replenishing the
cassettes.
The cassettes must be preconfigured according to the particular
vendor’s procedures for cassette configuration. The default values
used in Advance NDC are stored in AdvanceNDC.reg in the DLL
directory; these can be set at start-up by the SST configuration
component.
NCR SSTs
3
On NCR SSTs, the cassette types are matched to the APTRA XFS SP
default settings. No additional operator configuration is needed
after the initial installation of Advance NDC on NCR SSTs unless
you are using a recycling unit (GBRU) in any capacity, nor is any
reconfiguration after replenishment necessary. As the default values
are always used, the menu option “Update Note Types” (see
“Update Note Types” on page 6-11) is not required on NCR SSTs.
If, however, the default settings are changed for the SP, the currency
cassettes mapping table must be configured through the registry so
the values match. Similarly, if the registry values in the currency
cassettes mapping table are changed, the XFS SP for the CDM must
be configured to match.
Other Vendors’ SSTs
3
On other vendors’ SSTs, the logical cash units may change
dynamically when cassettes are added, removed and so on.
Additional menu options are provided in Supervisor to maintain
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-11
Configuring the Multi-Vendor Environment
Cash Handler Configuration
the mapping between XFS cash units and NDC cassette types. For
details of the EXTENDED ADD CASH menu options in Supervisor,
refer to Chapter 4, “Configure Menu” in the APTRA Advance NDC,
Supervisor’s Guide. The Update Note Types option of the
EXTENDED ADD CASH menu is used only by Wincor SSTs. For
details, see “Configuring Cassettes” on page 6-10.
Currency Cassettes
Mapping Table
The cassettes mapping table maps the XFS currency ID, media type,
value and cassette unit identifier to NDC cassette types.
3
Other Vendors’ SSTs
3
The currency ID, media type, value and cassette unit identifier can
be mapped to NDC cassette types through the following methods:


Currency Cassette Types
Registry Settings
Registry settings supplied by the customer for preconfiguration
For Wincor SSTs, the extended add cash options on the
Configure menu in Supervisor. For further details, see
“Extended Add Cash” on page 6-10.
For Advance NDC to dispense cash, values for the NDC cassette
types must be set as follows:
3







HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCType1
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCType2
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCType3
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCType4
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCType5
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCType6
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCType7
The key names NDCType1 to NDCType7 correspond to the NDC
cassette types used in the Advance NDC message interface. The
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-12
APTRA Advance NDC Multi-Vendor Support Reference
Configuring the Multi-Vendor Environment
Cash Handler Configuration
mapping to the XFS cash units is defined by the following settings
under each registry key:
Table 3-2
NDC Cassette Type Mapping to XFS Cash
Unit
Name
Type
Data Description
Matching
CurrencyID
string
Currency used, for example, “GBP” for
sterling or “USD” for American dollars. The
currency ID must be a valid ISO currency
code.
WFSCDMCUINFO.cCurrencyID
MediaType
string
A number corresponding to the three types of
media that can be dispensed. The values are
taken from the enumerated type used in XFS:
— ‘3’ for notes
— ‘7’ for vouchers/coupons
— ‘8’ for documents
WFSCDMCUINFO.usType
Value
string
Value of the note denomination
WFSCDMCUINFO.ulValues
UnitID
string
A unique identifier for each cassette.
cUnitID
This is only required if configuring the
same denomination for multiple NDC
cassette types. If used, it must be defined
for every cassette.
All the values must be provided for each cassette type, otherwise a
stack error will occur. The values must also conform to the
limitations described later under the heading “Cassette Mapping
Limitations”.
The CurrencyID is important for some vendors’ cassettes. This
information cannot be changed using the SP, so it is important to
match the values under these registry keys with the values returned
by the SP.
Event Log Error Strings
3
The following error strings can be written to the Windows
Application event log if there is a configuration error related to the
Cassette Mapping table:




CASHHANDLER CONFIGURATION ERROR: Error accessing the
NDCTypeX key from under the CurrencyTable key in registry
CASHHANDLER CONFIGURATION ERROR: Error accessing Currency
Value from NDCTypeX key in registry
CASHHANDLER CONFIGURATION ERROR: Error accessing
CurrencyID from NDCTypeX key in registry
CASHHANDLER CONFIGURATION ERROR: Error accessing Currency
MediaType from NDCTypeX key in registry
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-13
Configuring the Multi-Vendor Environment
Cash Handler Configuration


CASHHANDLER CONFIGURATION ERROR: The same Currency type
(CurrencyID = %s, Value = %d, MediaType = %d, UnitID = %s)
is mapped to more than one XFS Logical Type. Each XFS
Logical Type must be assigned to a unique combination of
CurrencyID, Value and MediaType values
CASHHANDLER CONFIGURATION ERROR: A request to dispense
from NDC Cassette Type X failed because it has no mapping
to an XFS Logical Cassette Type
If these errors occur, check the registry entries used to configure the
cassettes for Advance NDC as described in Chapter 5, “Configuring
Advance NDC and Associated Components” of the APTRA Advance
NDC, Developer’s Guide. For CurrencyID and Value settings, you
also need to check that they match the information in the Display
Configuration option of the Supervisor Configure menu.
Cassette Mapping
Limitations
3
The functionality of cassettes in a multi-vendor environment is
constrained by what can be configured. If the cassette configuration
is invalid, an entry is placed in the Application event log. For
details, see “Event Log Error Strings”.
Currency ID and Value
3
The following table shows an invalid mapping for cassette types 1
and 2 if the unit identifier is not used:
Table 3-3
Invalid Currency ID and Value
Cassette Contents
Cassette Type
Currency ID
Value
Media Type (XFS Cash Unit
Content Type)
$10 Bills
1
“USD”
10
WFS_CDM_TYPEBILLCASSETTE
$10 Bills
2
“USD”
10
WFS_CDM_TYPEBILLCASSETTE
$10 Travellers
Cheques
3
“USD”
10
WFS_CDM_TYPEDOCUMENT
Money-off Vouchers
4
“
0
WFS_CDM_TYPECOUPON
”
Different Voucher Types
The application cannot distinguish between two different types of
voucher (also called coupons). For example, it cannot distinguish
between a money-off voucher and a “buy one, get one free”
voucher, because they are not separately identifiable through XFS.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-14
APTRA Advance NDC Multi-Vendor Support Reference
3
Configuring the Multi-Vendor Environment
Cash Handler Configuration
The following table shows an invalid mapping for NDC cassette
types 3 and 4:
Table 3-4
Invalid Voucher Types
Cassette Content
NDC Cassette Type
Currency ID
Value
Media Type
$10 Bills
1
“USD”
10
WFS_CDM_TYPEBILLCASSETTE
$20 Bills
2
“USD”
20
WFS_CDM_TYPEBILLCASSETTE
Money-off Voucher
3
“
”
0
WFS_CDM_TYPECOUPON
“Buy One Get One
Free” Voucher
4
“
”
0
WFS_CDM_TYPECOUPON
Physical Cassettes
Mapping Table
3
The TEST CASH option on the Supervisor Replenish menu uses a
separate mapping table, defined in the registry of the SST, to
identify the physical location of cassettes. Physical cassette location
is reported in XFS by a string value, which may be specific to the
vendor. The physical cassettes mapping table maps XFS physical
cassette names to the names Advance NDC uses for cassette
positions.
Physical Cassettes Registry Settings
3
The mapping table is defined in the registry under the following
key:
HKLM\SOFTWARE\NCR\Advance NDC\PhysicalCassettes
The mapping consists of the following name/value pairs. The name
is the NDC name used by the Test Cash function in Supervisor for
the physical location of each cassette. The corresponding XFS value
is vendor-specific. The table shows NCR SP values; the XFS value
will be different for other vendors.
Note: The mapping table includes an entry for the reject bin. This
setting is used by device status handling.
Table 3-5
Physical Cassettes Registry Entries
NDC Name
Type
APTRA XFS SP Value
Top
string
Unit 1 (top)
Second
string
Unit 2 (next to top)
Third
string
Unit 3 (next to bottom)
Fourth
string
Unit 4 (bottom)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-15
Configuring the Multi-Vendor Environment
Cash Handler Configuration
NDC Name
Type
APTRA XFS SP Value
Fifth
string
This value is blank by default.
If a fifth cassette is used, this value must
be populated with the XFS value used by
the vendor
Reject
string
Reject bin
Test Cash
3
The TEST CASH function in Supervisor uses and displays the
information in the mapping table for physical cassettes. The
mapping is used by Advance NDC to dispense cash from each
physical cassette and report errors in the NDC message format. It
ensures all physical cassettes are usable after replenishment to
maximise in-service time.
Device Status Handling
Device status handling makes use of the settings in the physical
cassettes mapping table, and also the setting for the reject bin. For
more information about status handling, see “Status Handling” on
page 3-10.
Maximum Notes
3
The maximum number of notes that can be dispensed is taken from
the service provider capability information. If Enhanced
Configuration option 76 (cash handlers) is set to 001, the maximum
number of notes that can be dispensed is also reported in the
Hardware Configuration message.
On other vendors’ hardware, if the Central application attempts to
dispense more notes than the hardware can dispense, the following
will occur:


The transaction fails
A device status message is returned with an M-Status indicating
the cash dispenser cannot dispense the amount.
In this case, the Central application must be configured to handle a
lower number of notes.
For details of the dispensers supported in a multi-vendor
environment, refer to the APTRA Advance NDC, Developer’s Guide.
Notes Threshold
3
The CEN-XFS standard requires a threshold value to be set on the
reject and retract bins, and all cash-in cassettes. This threshold value
(ulMaximum) is passed to the CDM SP using the
WFS_CMD_CDM_SET_CASH_UNIT_INFO command. Advance NDC has
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-16
APTRA Advance NDC Multi-Vendor Support Reference
3
Configuring the Multi-Vendor Environment
Cash Handler Configuration
the following string registry value to allow configuration of the
notes threshold:
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\RejectBin
"MaxBillsThreshold" = "<notes threshold>"
This value is passed to the CDM SP as part of the Clear Cash
supervisor operation for the Reject cassette and also the Retract
cassette if present. If this registry value is not defined, the CDM SP
default values apply.
Cash Counters
3
If cash counters are not set, then a request from the host to dispense
cash will fail with the transaction status indicating stack failure and
no notes dispensed.
For details of the additional options for managing cash counters on
other vendors’ SSTs, see the EXTENDED ADD CASH configuration
option in the APTRA Advance NDC, Supervisor’s Guide.
Additional Customisation
3
If you need additional cash-handling customisation, you can
download customisation data for the currency cassettes with the
Dispenser Currency Cassette Mapping Table (DCCMT) command.
Customisation data sent from Central with this command is used
separately from the CDM SP configuration and the Currency
Cassettes Mapping Table defined in the registry of the SST.
Downloading this table is optional. It is required only if the Amount
Check state is contained in a state table download. The purpose of
the DCCMT is to define the currency type and denomination values
for each NDC cassette type, allowing the Amount Check state to
offer its functionality.
The downloaded table data must correspond with both the CDM SP
configuration and the currency cassettes mapping table described in
“Cash Handler Configuration” on page 3-11. The equivalent terms
are listed in the following table:
Table 3-6
DCCMT and Registry Currency Cassettes
Mapping Table
DCCMT Term
Registry Currency Cassettes Mapping Table
Cassette Type
Media Type
Denomination for Cassette
Value
Currency Type
Currency ID
Although the contents of the Currency Type and Currency ID are
not equivalent as one is numeric and the other is ASCII, a mapping
must be adopted to ensure consistent usage, such as 01 equals
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
3-17
Configuring the Multi-Vendor Environment
Cash Handler Configuration
“USD”. This will enable the Amount Check State to function
correctly.
For further details of the DCCMT and the Amount Check State,
refer to the following topics in the APTRA Advance NDC, Reference
Manual:


DCCMT: “Dispenser Currency Cassette Mapping Table” in
Chapter 10, “Central to Terminal Messages”
Amount Check State: “G - Amount Check State” in Chapter 2,
“State Tables”.
If the Currency Cassettes Mapping table in the registry is updated
locally, the updates must be synchronised with the DCCMT data
download. The table can also be updated remotely.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-18
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Delivering an Advance NDC Application to an SST
Chapter 4
Delivering an Advance NDC
Application to an SST
Overview
4-1
Modifying the Advance NDC Aggregate for Installation
Modifying Files and Components
4-2
4-2
Building a Multi-Vendor Application
Testing Your Application
Using the NCR XFS Simulator
4-3
4-3
4-3
Unattended Initial Installation
4-4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Delivering an Advance NDC Application to an SST
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Delivering an Advance NDC Application to an SST
Overview
D
Overview
4
This chapter contains the following topics on installing a
multi-vendor application on SSTs in a multi-vendor environment:



Modifying the Advance NDC aggregate as supplied by NCR on
the Advance NDC CD-ROM
Building and testing a customised multi-vendor application
Initial unattended installation.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
4-1
Delivering an Advance NDC Application to an SST
Modifying the Advance NDC Aggregate for Installation
Modifying the Advance NDC
Aggregate for Installation
The Advance NDC aggregate as supplied on the CD-ROM will
require modification for your particular environment. Once the
aggregate is ready, it can be installed after the particular vendor’s
XFS service providers, the equivalent of APTRA XFS. For the
installation procedure, refer to the APTRA Advance NDC, Developer’s
Guide.
For details of starting the Advance NDC application, see “Starting
the Advance NDC Application” on page 5-5.
For information about customising aggregates using the Aggregate
Builder Tool (ABT), refer to Chapter 11, “Delivering an Advance
NDC Application to the SST” in the APTRA Advance NDC,
Developer’s Guide.
Modifying Files and
Components
4
Any files that you have to modify for your SST environment, such
as additional script or command files, must be included in the
Advance NDC aggregate. For information about where to place
modified files for an aggregate, refer to the APTRA Advance NDC,
Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-2
APTRA Advance NDC Multi-Vendor Support Reference
4
Delivering an Advance NDC Application to an SST
Building a Multi-Vendor Application
Building a Multi-Vendor Application
4
This section describes the differences that apply when building and
testing a multi-vendor application on your development PC.
Testing Your Application
4
There are restrictions on how you can test your multi-vendor
application. For details, refer to the Configuring and Troubleshooting
SST Software on non-NCR Hardware course, which gives access to the
NCR wiki pages for registered users.
Using the NCR XFS Simulator
4
If you have the NCR XFS Simulator installed on the development
PC, you can use it to test your multi-vendor application but there
are limitations, including the following:


Simulation may not be available for all devices
Variations in SP implementation between vendors mean the
application must be tested on each particular vendor’s
hardware.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
4-3
Delivering an Advance NDC Application to an SST
Unattended Initial Installation
Unattended Initial Installation
For information about an initial unattended installation on an SST,
refer to the APTRA Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-4
APTRA Advance NDC Multi-Vendor Support Reference
4
Table of Contents
Setting up the Terminal
Chapter 5
Setting up the Terminal
Overview
5-1
Initial Configuration
Configuration Differences on an SST
Setting up the SST in a Multi-Vendor Environment
Registry Keys
Service Providers
Miscellaneous Configuration
5-2
5-2
5-2
5-2
5-4
5-4
Starting the Advance NDC Application
5-5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Setting up the Terminal
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Setting up the Terminal
Overview
E
Overview
5
This chapter discusses the following:


Setting local configuration and terminal access parameters when
Advance NDC is first installed on another vendor’s SST
Starting the Advance NDC application.
For information about configuration and application startup that is
common to all SSTs, refer to the following:


APTRA Advance NDC, Developer’s Guide
APTRA Advance NDC, Supervisor’s Guide, Chapter 6, “Setting up
the Terminal”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
5-1
Setting up the Terminal
Initial Configuration
Initial Configuration
5
Differences in the initial configuration of other vendors’ SST for
Advance NDC are described here.
Configuration Differences
on an SST
The following configuration will be required:

5

Vendor-specific SP configuration
Customisation for the areas described or referred to in this
publication, for example, currency settings and printers.
The level of customisation is dependent on the hardware
configuration and SP software present and is summarised in the
next topic.
Updates to many of the configuration settings are made using the
SST configuration component. For the latest details of configuring
Advance NDC on an SST in a multi-vendor environment, refer to
the Configuring and Troubleshooting SST Software on non-NCR
Hardware course, which gives access to the NCR wiki pages for
registered users. For details of the SST configuration component,
refer to Chapter 5, “Configuring Advance NDC and Associated
Components” in the APTRA Advance NDC, Developer’s Guide.
Setting up the SST in a
Multi-Vendor
Environment
This summarises the areas that may require configuration or
customisation on the SST, with a quick reference to the headings
giving further information.
5
Registry Keys
The following table lists the registry keys provided for Advance
NDC under
HKLM/SOFTWARE/NCR/Advance NDC
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-2
APTRA Advance NDC Multi-Vendor Support Reference
5
Setting up the Terminal
Initial Configuration
Table 5-1
Registry Keys
Registry Key
Configuration
Aliases
Alternatives names for devices. They must match
the names used by the service providers (SPs). By
default, APTRA XFS names are provided for
NCR SSTs. You will need to change them for
other vendors’ SSTs.
CurrencyTable
Currency ID, media type and value of media for
up to four cassettes, plus reject bin settings.
Default values are provided.
PhysicalCassettes
Physical location of four cassettes, plus reject bin.
The default values are for the NCR SP and must
match the names used by the installed SP.
PRINTING
Contains printer control codes for Deposit,
Journal, Receipt and Statement printers. The
default values are for an NCR thermal printer
and must be configured for the printer attached
to the SST.
supervisor
ISO IDs of the currencies for use in the additional
multi-vendor cash menus provided for other
vendors’ SSTs; and setting to allow the
alternatives to be used as the Supervisor mode
switch for SSTs that do not have a physical mode
switch.
VPIComms
Off-line timer and TCP/IP communications
service.
The following table summarises additional information available in
this publication about other registry key settings in a multi-vendor
environment.
Table 5-2
Registry Key Set-up
Registry Key Area
Heading Reference
Page Reference
VDM
“Vendor Dependent Mode”
On page 2-5
Printer set-up
“Printer Registry Settings”
On page 2-9
“Envelope Printing”
On page 2-9
Currency settings
“Currency Cassette Types
Registry Settings”
On page 3-12
Physical cassette
settings
“Physical Cassettes Mapping
Table”
On page 3-15
Bills threshold
“Notes Threshold”
On page 3-16
Supervisor mode
switch
“Supervisor Mode Switch”
On page 3-9
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
5-3
Setting up the Terminal
Initial Configuration
Service Providers
5
To use service provider (SP) functionality, the SPs must be
configured as defined in the relevant publication from the SST
vendor. The following table summarises additional service provider
configuration that may be required for other vendors’ SSTs.
Table 5-3
Service Provider Configuration
Service Provider
Heading Reference
Page Reference
PTR
“Receipt Printer”
On page 2-8
TTU (if you
supply your own
display resolution
file)
“Reserved Screen Layouts”
On page 3-2
Miscellaneous Configuration
5
The following table summarises other configuration that may be
required for other vendors’ SSTs.
Table 5-4
Miscellaneous Configuration
Item
Heading Reference
Page Reference
RESRVD.DEF
“Reserved Screen Layouts”
On page 3-2
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-4
APTRA Advance NDC Multi-Vendor Support Reference
Setting up the Terminal
Starting the Advance NDC Application
Starting the Advance NDC
Application
5
The script, startapps.vbs, is executed for all SSTs, but it will need to
be edited to start up the required SPs on other vendors’ SSTs. The
script does the following:
1
Runs the command defined in:
HKLM\SOFTWARE\NCR\Advance NDC\SPStartCommand
and waits for the command to complete. If the service providers
are self-starting, set this to null (“”).
2
Pauses for a time defined by the following registry setting:
HKLM\SOFTWARE\NCR\Advance NDC\SPStartPause
The default is 30 seconds.
3
Runs Advance NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
5-5
Setting up the Terminal
Starting the Advance NDC Application
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-6
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Advance NDC on Specific Vendors’ SSTs
Chapter 6
Advance NDC on Specific Vendors’
SSTs
Overview
Default Platform Installation
Getting Support
Logs
Vendor Logs
6-1
6-1
6-1
6-2
6-2
Diebold Hardware
Installing and Verifying the Platform
Configuring Cassettes
Configuring Printers
Configuring Encryptors
Remote Key Loading
Configuring the Operator Panel
Key Mapping
Starting the Platform and Advance NDC
Using Vendor Dependent Mode
Decoding Status Messages
Unknown Status of Notes After a Power Failure
Common Issues
Note Counts
Clearing the Transport
Collecting Diebold Logs
6-3
6-3
6-3
6-4
6-4
6-4
6-4
6-5
6-5
6-5
6-6
6-6
6-7
6-7
6-7
6-7
Wincor-Nixdorf Hardware
Installing and Verifying the Platform
Cash/Cheque Deposit Module
Configuring Card Readers
Configuring Cassettes
Extended Add Cash
Configuring Printers
Configuring Encryptors
Remote Key Loading
Restricted Key Entry Mode
Configuring Media Entry Indicators
Configuring Supervisor Entry and Exit
6-9
6-9
6-9
6-10
6-10
6-10
6-12
6-12
6-12
6-13
6-13
6-13
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Advance NDC on Specific Vendors’ SSTs
Configuring the Operator Panel
Configuring a Graphical Operator Panel
Configuring a Graphical Operator Panel (USB)
Screen Resolution
Starting the Platform and Advance NDC
Using Vendor Dependent Mode
Decoding Status Messages
Common Issues
Multiport Card Issues
Non-Responsive Device
FDK Issues
Powering Down the SST
Collecting Wincor Logs
Wincor Test Tools
Extending APTRA Security Settings
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-13
6-14
6-14
6-14
6-14
6-15
6-15
6-15
6-15
6-16
6-16
6-16
6-16
6-16
6-17
Advance NDC on Specific Vendors’ SSTs
Overview
F
Overview
6
This chapter provides information on areas that may require further
configuration on specific vendors’ hardware.
Specific configuration information is available through the
Configuring and Troubleshooting SST Software on non-NCR Hardware
course, which gives access to the NCR wiki pages. For a full list of
available courses, see http://www.ncru.ncr.com if you are a registered
user.
For further information on the registry entries, configuration
settings and configuration component, refer to Chapter 5,
“Configuring Advance NDC and Associated Components” in the
APTRA Advance NDC, Developer’s Guide.
Default Platform
Installation
You must start with a default installation of a vendor platform as
the SST configuration component assumes a default installation.
6
Advance NDC cannot be supported if the production build of the
previous vendor installation is removed as NCR does not know
what configuration has been carried out.
If you are unsure whether you have a default platform installation,
use the HKLM registry key export and compare the results with a
known default installation.
Getting Support
6
If you contact NCR for help with troubleshooting, you must provide
logs to help identify and solve the issue. This section describes the
logs you can collect and the tools you can use to obtain
troubleshooting information.
The best approach to getting help with troubleshooting is to collect
as much information as possible to help resolve the issues. If you
can recreate the problem, use test tools to help eliminate the
platform as a potential source of the issue.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-1
Advance NDC on Specific Vendors’ SSTs
Overview
Logs
6
You must always collect the following logs:

Those provided by the Advance NDC tools. For further
information on the tools and logs, refer to Chapter 12,
“Installing and Configuring Troubleshooting Tools” in the
APTRA Advance NDC, Developer’s Guide
Note: You must provide Problem Determination trace files for any
.NET components.


The Windows application event log
The system HKLM from the registry.
If you are having issues with printing, ensure that you also supply
the XFS form files produced by Advance NDC and the Transaction
Reply data.
Vendor Logs
Other vendors also supply their own tools for collecting logs. These
tools are introduced in this chapter. For full details of the tools, refer
to the vendor’s documentation.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-2
APTRA Advance NDC Multi-Vendor Support Reference
6
Advance NDC on Specific Vendors’ SSTs
Diebold Hardware
Diebold Hardware
6
The following Diebold SSTs have an XFS platform that is suitable
for Advance NDC:



Installing and Verifying
the Platform
IX series
Opteva
D4x.
Diebold supply media for the installation of their platform.
6
On some IX SSTs, the BIOS must be updated to accept an
installation of the platform and some extra manual procedures must
be carried out to set up some serial connections. Details are
provided with the installation media.
To install the platform, follow the instructions and prompts
provided by the vendor. The platform starts automatically
following the installation.
To verify the installation, open the Diebold XFS Service Client after
the devices have initialised.
Once the platform is successfully installed, you can install Advance
NDC. However, you must not start Advance NDC until you have
finished configuring it.
The SST configuration component is provided to update the registry
settings for the default Advance NDC installation. The tool is run at
start-up if the ANDCConfig.NDC file is not found in C:\Program
Files\NCR APTRA\Advance NDC\Config.
Configuring Cassettes
6
Before using Diebold cash cassettes, ensure that they are correctly
configured by checking the buttons on the back. The buttons
indicate the currency and denominations to be used. The cassette
type must match one of the types defined in the Agilis configuration
utility (ACU). For further details of the ACU, refer to the vendor’s
documentation.
The platform reports the currency and value of the cassette to
Advance NDC and Advance NDC maps these to the values used by
the host using the CurrencyType registry entry.
Note: You cannot use the configuration option of the Extended
Add Cash menu on the Configure menu in Supervisor to configure
Diebold cassettes. The option can only be used to check the
configuration. The Update Note Types option can be used to adjust
the NDC types so that they match the cassette configuration.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-3
Advance NDC on Specific Vendors’ SSTs
Diebold Hardware
You must use the ACU to remove unused or duplicate logical cash
units as Advance NDC does not support duplicate logical cash
units.
Configuring Printers
Configuring Encryptors
6
6
Advance NDC uses forms to print to receipt and journal printers.
The use of raw data is not recommended.
If the application is compliant with the PA-DSS (Payment
Application Data Security Standard), you must use the restricted
double-length key entry mode. For details of EPP modes, refer to
the APTRA Advance NDC, Supervisor’s Guide.
Remote Key Loading
Advance NDC supports Diebold remote key loading with
certificates.
For information on the message formats for encryptors, refer to the
APTRA Advance NDC, Reference Manual.
For information on certificates, refer to your Diebold
documentation.
Configuring the Operator
Panel
6
The Diebold operator panel (rear display) uses a full QUERTY
keyboard and screen. The screen is controlled by a dual monitor
system, and this might require configuration when the platform is
installed. On this rear display, an application acts as the operator
panel screen. For further details, refer to the vendor’s
documentation.
The Advance NDC Supervisor menus and fault display appear on
the operator panel.
By default, the operator panel is defined as the primary display and
the front screen is defined as the secondary display. As Advance
NDC always appears on the primary display, the front screen must
be the primary display. The Terminal Text Unit window (TTU) and
diagnostics must appear on the secondary display.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-4
APTRA Advance NDC Multi-Vendor Support Reference
6
Advance NDC on Specific Vendors’ SSTs
Diebold Hardware
Key Mapping
6
If encryption key entry is used, the FDKs are mapped to the
function keys on the operator panel QWERTY keyboard as
described in the following table:
Table 6-1
FDK Mapping
FDK
Mapped to....
A
F1
C
F2
E
F3
G
F4
B
F5
D
F6
F
F7
H
F8
The Esc key on the QWERTY keyboard is mapped to the Cancel
button.
Starting the Platform and
Advance NDC
6
You can start the platform and then start Advance NDC by running
the ncr.aptra.Apploader.exe file from the C:\Program Files\NCR
APTRA\Advance NDC folder.
All other Advance NDC configuration can continue as for NCR
SSTs. This includes, for example, setting encryption keys, adding
the cash counts, setting the message mode and configuring
communications.
The host must send an NDC download to any SST running Advance
NDC. If the host is set up to send the Diebold 91x download to the
SST, this must be changed as transactions will not be recognised.
Using Vendor Dependent
Mode
When Diagnostics is selected from the Select menu in Supervisor,
the vendor-dependent application (VDA) runs.
6
All XFS sessions are closed to allow the VDA to run. The VDA will
not run if any XFS sessions remain open. The following registry
entry ensures that the CDM session is closed:
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\
Diagnotics\CDMCloseDuringVDM
Dialogs always appear on the configured display and Advance
NDC has no influence on which display is used. Using the Transfer
Interface option in Supervisor will not transfer the display.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-5
Advance NDC on Specific Vendors’ SSTs
Diebold Hardware
Decoding Status Messages
6
Advance NDC sends maintenance data provided by the XFS
platform.
The following example shows a message sent by Advance NDC
followed by an example of how to interpret the information.
Figure 6-1
Example Dispenser Shutter Jam Message
12<fs>000<fs><fs>E001000000<fs>40000<fs>
13373030303D3600373030333D3500393833303532373D3235390000<fs>12000
In this example, the mStatus is 13 and the mData is
373030303D3600373030333D3500393833303532373D3235390000.
Translating the mData from hex into ASCII format gives a set of
key/value pairs in the following format:
<key>=<value><null>
The last record is followed by 2x <NULL>
In the above example, the vendor’s data is translated as follows:
7000=6
7003=5
9830537=259
Use the vendor’s documentation to decode this data.
Unknown Status of Notes
After a Power Failure
6
Caution:
If the status of notes is unknown following a power failure during a
transaction, the notes are treated as presented by default. This
situation can occur, for example, if a power failure occurs during
note stacking.
The following solution is not CEN-XFS compliant. Changing this
registry entry from the default setting may open the SST to fraud
because notes dispensed when a power failure occurs are not
debited from the cardholder’s account. If any notes are moved to the
reject bin during recovery from a power failure, all notes are
regarded as rejected although notes may have been removed from
the transport during device recovery.
Update the following registry entry, which can be used if you need
to treat notes with an unknown status as not presented, only if the
default setting is causing issues at the SST:
HKLM\SOFTWARE\NCR\Advance NDC\CashHandler\
UnknownAsRejectedAfterPowerfail
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-6
APTRA Advance NDC Multi-Vendor Support Reference
Advance NDC on Specific Vendors’ SSTs
Diebold Hardware
Valid values are described in the following table:
Table 6-2
Treatment of Notes After a Power Failure
Value
Description
0
Treat notes as presented (default)
Notes are treated as presented and the presented count is updated
Note counts are journaled; both the notes presented count and the notes remaining count are updated
The counts in field ‘r’ (Last Transaction Status) of the next Transaction Request are reported
1
Treat notes as not presented
Notes are treated as rejected and the reject count is updated
Note counts are journaled; the notes presented count is unchanged, but the notes remaining count is
updated
Reserved screen j0026 (LAST DISPENSED COUNTS ARE UNKNOWN) is journaled
The note count of notes with an unknown status is logged to the object oriented XFS (OOXFS) log file
The counts in field ‘r’ (Last Transaction Status) of the next Transaction Request are set to zero
The counts can be checked using the Display Cash option on the
Supervisor Replenish menu.
Common Issues
6
The following sections provide suggestions as to possible causes for
common issues.
Note Counts
6
On Diebold SSTs, clearing the reject bin counts also clears the purge
counts for all cassettes. This causes incomplete counts.
Clearing the Transport
6
Diebold dispensers do not automatically clear the transport
following a short stack of notes. To ensure that Advance NDC clears
the transport, set the following registry entry to 1:
HKLM\SOFTWARE\NCR\Advance NDC\CashHandler\
RejectAfterBadStack
Collecting Diebold Logs
6
Diebold provides a log viewer, called LogViewer.exe, which allows
you to view the XFS activity. This tool can be used to view the
current daily log or to capture real-time logs. Details of the location
of this tool and its logs are available through the Configuring and
Troubleshooting SST Software on non-NCR Hardware course, which
gives access to the NCR wiki pages if you are a registered user. Logs
are created every day and retained for a set period. For further
information on the log files, refer to the vendor’s documentation.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-7
Advance NDC on Specific Vendors’ SSTs
Diebold Hardware
Note: If sending the log to NCR for support purposes, produce a
capture of a specific test or configure the logs to limit the size if
possible as the daily log files can get very large.
You can use the ACU to set the level of detail to include in the logs.
The Request ID in the daily log file can be used to map the trace to
the commands in the OOXFS debug log trace.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-8
APTRA Advance NDC Multi-Vendor Support Reference
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
Wincor-Nixdorf Hardware
6
Wincor-Nixdorf (Wincor) SSTs have an XFS platform that is suitable
for Advance NDC.
Installing and Verifying
the Platform
To install the Wincor platform, follow the instructions provided by
the vendor.
6
Note: If you want to install the test tools, select a custom
installation.
The SST configuration component starts the following if not already
started:



The vendor’s platform (CSC). The start-up screen will list the
services as they start
The Wincor XFS layer (ProDevice/SSP)
The service providers
If an OP05/OP06 operator panel is fitted, the ProBase platform must
be installed with the following value set in the ProBase.cus file to
configure the operator panel as a TTU emulator:
"cscw32.CSC-W.OPL_OP05_EMU=WIN"
If this is not set, the operator panel is a VGA monitor only and
Advance NDC will not display Supervisor menus on the rear
display. For further information, see “Configuring the Operator
Panel” on page 6-13.
If APTRA Security is installed, you can find more information on
using the security installation batch file in the APTRA online
documentation under Security.
When the service providers are stated, icons are displayed next to
the clock on the Windows Start bar. Hovering over an icon identifies
the service.
Once the platform is successfully installed, you can install Advance
NDC. However, you must not start Advance NDC until you have
completed the configuration.
The SST configuration component is provided to update the registry
settings for the default Advance NDC installation. The tool is run at
start up if the ANDCConfig.NDC file is not found.
Cash/Cheque Deposit
Module
The Cash/Cheque Deposit Module (CCDM) is supported. No
configuration is required.
6
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-9
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
Configuring Card Readers
6
You can configure the card reader at the platform level to allow
protection against card skimming.
You can also configure Advance NDC to accept only magnetic
cards.
Configuring Cassettes
6
The casettes can be configured using the Extended Add Cash option
on the Configure menu in Supervisor.
You must also configure the points at which the cassettes are
deemed to be low or out-of-cash.
If the cassettes do not have low sensors, all the Advance NDC note
thresholds must be set. For details of setting note thresholds, refer to
Chapter 5, “Configuring Advance NDC and Associated
Components” in the APTRA Advance NDC, Developer’s Guide.
Extended Add Cash
Selecting EXTENDED ADD CASH on the CONFIGURE menu
displays an additional Supervisor submenu that includes an option
“Update Note Types”. The option allows the currency cassettes
mapping table to be updated with new values for currency ID,
media type, value and cassette unit identifier if necessary. This
enables the Advance NDC model to accommodate differences in
CEN-XFS implementation on other vendors’ SSTs.
Note 1: The currency cassettes mapping table does not map the
physical cassettes to the logical cash units.
Note 2: To update the SP configuration using Advance NDC, the
operator must use the Configure Cassettes option on the extended
add cash menu.
The menus must be used in sequence when setting up a new SST, as
follows:
1
Open the safe door and replenish the cassettes.
2
Close the safe door and select 0 EXCHANGE CASH UNITS to
replenish the cassettes.
3
Press Enter to return to the EXTENDED ADD CASH menu.
4
Select 1 CONFIGURE CASH UNITS to update the service provider
settings for each position in the device.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-10
APTRA Advance NDC Multi-Vendor Support Reference
6
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
Check that the NDC cassette types match the dispenser cassette
types. Each NDC cassette type must be unique. You can,
however, configure multiple cassettes to dispense the same
currency and denomination.
5
If you have reconfigured the cassette, select 2 CLEAR CASH to
clear counts.
6
Select 3 ADD CASH to carry out replenishment activities.
7
If you have reconfigured the cassette, select 4 CALIBRATE CASH
UNITS to calibrate physical cassettes based on position.
8
Select 5 TEST CASH to check that the SST can successfully pick
the cash.
If no configuration of the cassettes is required, you can use the
standard ADD CASH, CLEAR CASH and STD CASH Supervisor options
after you have completed this initial setup. For details of these
options, refer to Chapter 3, “Replenish Menu” in the APTRA
Advance NDC, Supervisor’s Guide.
Update Note Types This menu option is for use in either of the
following situations:


6
When new denominations are introduced into an SST
After initial installation if the SST has not been preconfigured
using a registry setup file.
When the option is selected, the operator is prompted for the NDC
cassette type requiring update. Then a sequence of screens is
displayed allowing the operator to view and update the current
settings for the currency ID, media type, value and cassette unit
identifier. If the current settings do not map to XFS cash units with
equivalent values, NO DISP is displayed. For further details of the
screens, refer to Chapter 4, “Configure Menu” in the APTRA
Advance NDC, Supervisor’s Guide.
Note: A request to dispense from an NDC cassette type that is not
configured will result in a bad stack response to the host.
Reconfiguration after Replenishment For each cassette type for
which the cassette has been changed, the operator must enter valid
values for the currency ID, media type and media value. Entering
duplicate data, that is, values matching those entered for another
cassette type will result in an error. To allow the physical cassette to
be supplied later, no error is generated if the values do not identify a
logical cash unit. If the values are accepted, the currency table is
updated.
6
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-11
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
Caution
Configuring Printers
6
If the cassette/SP configuration is incorrect, or the currency table is
incorrectly mapped (due to either incorrect preconfiguration or
incorrect manual configuration) errors will occur or incorrect notes
will be consistently dispensed. This will be obvious during testing
or from the errors generated.
Advance NDC uses dynamic forms to print on Wincor receipt and
journal printers. If you are using vendor-specific control codes and
alternative fonts, Wincor must provide the native font file.
Receipt printers must be configured to run in Graphics Device
Interface (GDI) mode. This can be checked by looking in the Printers
section of the Windows Control Panel.
If ProDevice is not installed to the default forms directory used by
Advance NDC, you must ensure that the forms path defined in the
Print Data registry entry matches that used by the service
provider.
If you are using pre-printed paper, you can change the top-of-form
setting to control the position at which printing starts. This is
controlled using screen K01. For details of setting the first line
position, refer to Chapter 3, “Screen Data”, in the APTRA Advance
NDC, Reference Manual.
Configuring Encryptors
6
If the application is compliant with the PA-DSS (Payment
Application Data Security Standard), you must use the restricted
double-length key entry mode. For details of EPP modes, refer to
the APTRA Advance NDC, Supervisor’s Guide.
Note: If a password is required on secure key entry, restricted
double-length key entry mode will fail as Advance NDC does not
support password entry.
You can turn off the sound notifying you that an invalid key has
been pressed. Information on controlling the sound is available
through the Configuring and Troubleshooting SST Software on
non-NCR Hardware course, which gives access to the NCR wiki
pages if you are a registered user.
Remote Key Loading
Advance NDC supports Wincor remote key loading with
signatures.
Extra firmware is required to load the vendor key and HSM public
key into the EPP.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-12
APTRA Advance NDC Multi-Vendor Support Reference
6
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
Restricted Key Entry Mode
6
The usual layout for a secure keyboard is as follows:
1 (A)
2 (B)
3 (C)
CANCEL
4 (D)
5 (E)
6 (F)
DELETE
7
8
9
SHIFT
0
ENTER
On Wincor hardware, you cannot configure the layout, but you may
need to verify the position of the SHIFT key. The following show the
Key Verification Values that can be used to verify the position of the
SHIFT key, for example if you enter 32xA, the result in checksum is
C33F:





Configuring Media Entry
Indicators
Configuring Supervisor
Entry and Exit
Configuring the Operator
Panel
6
6
A – C33F
B – 3597
C – 18EC
D – AF0B
E – 6678.
The Media Entry Indicators (MEIs) can be controlled using either
the CSC or XFS layer on Wincor SSTs. The default is to use the CSC
layer, but as Advance NDC also controls the MEI the CSC activation
must be turned off.
Wincor SSTs do not always have a mode switch. If a mode switch is
not present, you can define the trigger used to switch the
application to Supervisor mode. For details, see “Supervisor Mode
Switch” on page 3-9.
On Wincor SSTs, you must update the SizeX and SizeY settings of
the following registry entry as shown below:
6
HKLM\SOFTWARE\NCR\Advance NDC\
NoTTUOperatorResolution\


With an operator panel fitted:
— SizeX must be set to dword:00000028
— SizeY must be set to dword:0000000c
With no operator panel fitted:
— SizeX must be set to dword:00000020
— SizeY must be set to dword:00000010
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-13
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
By default, an FDK activates a Wincor diagnostics application. This
application can only be closed by restarting the SST. To avoid this,
you can disable the application.
There are two types of operator panel typically found on Wincor
systems, as follows:


A serial operator panel, known as the Graphical Operator Panel
(GOP)
A USB operator panel, known as the Graphical Operator Panel
(USB) (GOP USB).
Configuring a Graphical Operator Panel
6
The lights on a GOP must be configured for use by Advance NDC,
the default lights are described in Table 6-3.
Table 6-3
Wincor Graphical Operator Panel Lights
Label (translation)
Colour of Light
XFS Index
Betreib (operate)
green
wLEDs[0]
Kunde (customer)
orange
wLEDs[1]
Geld (money)
orange
wLEDs[2]
Papier (paper)
red
wLEDs[3]
Service
red
wLEDs[4]
Use the following registry entry to map the rear In-Service indicator
light to the Betreib light by setting the RearInServiceIndex value
to hex:00 and the Supervisor indicator light to the service light by
setting the SupervisorIndex value to hex:04:
HKLM\SOFTWARE\NCR\Advance NDC\LEDS\
Advance NDC does not use the remaining lights.
Configuring a Graphical Operator Panel (USB)
6
The GOP USB must be configured to avoid extra lines appearing.
Screen Resolution
You can update any screen or add screens by loading an additional
reserved screen file containing the changes and additions. For
details of loading an additional reserved screen file, see “Screen
Resolution” on page 3-3.
Starting the Platform and
Advance NDC
6
You can start the platform and then start Advance NDC by running
the the ncr.aptra.Apploader.exe file from the C:\Program Files\NCR
APTRA\Advance NDC folder.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-14
APTRA Advance NDC Multi-Vendor Support Reference
6
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
Wincor do not provide a VDA, so selecting Diagnostics from the
Select menu simply returns to the Select menu.
Using Vendor Dependent
Mode
6
You can shut down the SST and then restart in the vendor
diagnostic mode.
Decoding Status Messages
6
Advance NDC includes maintenance data provided by the Wincor
XFS platform in status messages. The data is formatted as an ASCII
representation of the characters in the field.
The diagnostic status on a Wincor system has the following format:


mStatus – 2 bytes
MData – Variable, as follows:
— Class – 8 bytes
— Error Code – 8 bytes
— Warning – 8 bytes
— Description – Variable. This is the remainder to the <fs> and
if this is 00 there is no description.
The mStatus is mapped from the XFS information and based on the
responses given by Advance NDC running on NCR hardware.
For example, when the following data arrives as bytes from WNI
XFS in HEX:
33 00 00 00 0D 81 00 28 00 00 00 00 00
The diagnostic status is read backwards and can be translated using
the system messages documentation provided by Wincor, as
follows:




There is no description (00)
There is no warning (00 00 00 00)
The error code (28 00 81 0D) identifies a journal paper tear
The class (00 00 00 33) identifies the journal printer.
The information is sent in field ‘g4’ of the status message with each
byte converted to clear text.
Common Issues
6
The following sections provide suggestions as to possible causes for
common issues.
Multiport Card Issues
6
If you encounter problems with the multiport card, the most
common reason is that the FITWIN driver has not been installed.
On older machines, the driver for the rocket port may be missing or
incorrect if Windows XP has installed the default driver.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-15
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
In either of these situations, you must obtain the correct driver and
manually install it. You do not need to reinstall the platform.
The drivers are available on the installation media for the multiport
card.
Non-Responsive Device
6
If a device is not responding, you must first eliminate the possibility
of a hardware error.
If the cause is not a hardware error, check the event log and check
the entries against the vendor’s documentation.
The most likely causes for the non-responsiveness of a device are as
follows:


The CSC-W32 registry settings are incorrect. Ensure that the
entries match the physical port
The XFS registry settings are incorrect. If the CSC-W32 registry
entries are correct, use the relevant Wincor XFS documentation
to check the XFS entries.
FDK Issues
6
If the FDKs are not recognised, or FDKs are reported when a touch
screen is used, check the configuration of the platform and service
provider.
Powering Down the SST
6
There is a button, known as a bootswitch, on the Wincor Special
Electronics Unit that can be used to close down the system once the
current transaction is complete. This is not supported by Advance
NDC.
An alternative method is to enter Supervisor mode, enter the
Advance NDC multi-vendor diagnostics menu and select the power
down option. For details, refer to the APTRA Advance NDC,
Supervisor’s Guide.
Collecting Wincor Logs
6
Significant warnings and errors are logged to the Windows event
log.
The TV.EXE file, found in C:\CSCW32\BIN, can be used to trace the
system activity. However, you must know the bitmap setting in the
tool to be able to collect the traces. The bitmaps to use are
documented in the Wincor XFS specifications.
Wincor Test Tools
Where installed, the XFS tools are found in C:\Program
Files\ProDeviceSSP\TEST and can be accessed from the Windows
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-16
APTRA Advance NDC Multi-Vendor Support Reference
6
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
Start menu. You must ensure that you use the CEN-XFS version 3
tools, for example CDM300.EXE.
These tools from Wincor can be used on all vendors’ SSTs with a
CEN XFS platform. They use the aliases defined for the service
providers. The tools can be used to verify the hardware and CSC
and XFS layers before installing Advance NDC as well as for
troubleshooting.
Extending APTRA
Security Settings
6
If APTRA Security is installed, you can extend it for the Wincor
platform using policy files. If you need to use APTRA Security,
please contact the Advance NDC Solution Manager
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
6-17
Advance NDC on Specific Vendors’ SSTs
Wincor-Nixdorf Hardware
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-18
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Related Documentation
Appendix A
Related Documentation
Overview
A-1
Advance NDC Documentation
A-2
APTRA Author Documentation
A-3
NDC+ Documentation
A-5
Other NCR Documentation
A-6
CEN-XFS Documentation
A-7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Related Documentation
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Related Documentation
Overview
A
Overview
A
This appendix lists the following documentation:



Documentation provided with the Advance NDC CD-ROM
Documentation that is historically linked to Advance NDC, but
not provided on the Advance NDC CD-ROM
Documentation from other sources, such as standards bodies
and optional components. This documentation is not provided
on the Advance NDC CD-ROM.
To read the Adobe Acrobat Portable Document Format (PDF)
documentation, you need Adobe Reader version 5.0 or later. The
latest version is available free from www.adobe.com.
On a development system, the documentation can be installed alone
or installed with the Advance NDC software. The documentation is
not installed on a runtime system.
All APTRA product documentation is available under Start |
Programs | NCR APTRA | APTRA (TM) Documentation after the
relevant product has been installed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
A-1
Related Documentation
Advance NDC Documentation
Advance NDC Documentation
The following publications are provided on the Advance NDC
CD-ROM. Printed versions can be ordered from the NCR
Publications web site.
Note: The Advance NDC Windows help files listed in this
Appendix are provided as part of the APTRA Author.
Table A-1
Advance NDC Documentation
Title
Format
Description
APTRA Advance NDC, Overview
B006-6597
PDF/Paper
Provides an introduction to Advance NDC,
including overviews of the components contained
in the Advance NDC product and provided as
part of the ANDC Package on CD-ROM.
APTRA Advance NDC, Developer’s Guide
B006-6046
PDF/Paper
Describes how to migrate to Advance NDC. It
also identifies the functionality offered by
Advance NDC, and describes how to enhance it.
APTRA Advance NDC, Reference Manual
B006-6180
PDF/Paper
Provides application programmers with reference
information for Advance NDC, including States,
Screens, and the message formats between
Central and the terminal.
APTRA Advance NDC, Multi-Vendor
Support Reference Manual
B006-6344
PDF/Paper
Provides users with information about running
the Advance NDC application on other vendors’
SSTs, describing the differences between Advance
NDC on NCR SSTs and other vendors’ SSTs.
APTRA Advance NDC, Supervisor’s Guide
B006-6062
PDF/Paper
Describes the Supervisor interface, how to set up
the terminal’s local configuration parameters, and
how to replenish the terminal.
APTRA Advance NDC, Extending the
Product
B006-6926
PDF/Paper
Describes how to modify Advance NDC
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-2
APTRA Advance NDC Multi-Vendor Support Reference
A
Related Documentation
APTRA Author Documentation
APTRA Author Documentation
A
The following titles are provided on the Advance NDC CD-ROM to
support the use of the authoring environment. A printed version of
the PDF file can be ordered from the NCR Publications web site.
The APTRA Author is used in Advance NDC development and can
be used to modify Advance NDC.
Table A-2
Provided Authoring Environment
Documentation
Title
Format
Description
APTRA Author, User’s
Guide
B006-6038
PDF/Paper
Describes how to install and use the Author and
Runtime Components to design, develop and maintain
a self-service application.
APTRA Author Help
Windows
Help
Context-sensitive help for the Author user interface
and authoring errors.
Runtime Core Help
Windows
Help
Context-sensitive help for the Runtime Core Authoring
components and runtime errors, which are part of Core
Self-Service.
GUI Help
Windows
Help
Context-sensitive help for the GUI Authoring
components, which are part of Core Self-Service.
Advance NDC Help
Windows
Help
Context-sensitive help for the Advance NDC
Authoring components (excluding Application Core
components).
Advance NDC
Application Core Help
Windows
Help
Context-sensitive help for the Application
Core/Supervisor Authoring components.
Self-Service Core Help
Windows
Help
Context-sensitive help for the Self-Service Core
Authoring components, which are part of Core
Self-Service.
ActiveX™ Help
Windows
Help
Context-sensitive help for the ActiveX™ Authoring
components and runtime errors, which are part of Core
Self-Service.
Basic Self-Service Help
Windows
Help
Context-sensitive help for the Authoring components
and runtime errors provided with Basic Self-Service.
ATM Help
Windows
Help
Context-sensitive help for the Authoring components
and runtime errors provided with ATM.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
A-3
Related Documentation
APTRA Author Documentation
Title
Format
Description
Special Self-Service Help
Windows
Help
Context-sensitive help for the Authoring components
and runtime errors provided with Special Self-Service.
Statement Printer Help
Windows
Help
Context-sensitive help for the Authoring components
and runtime errors provided with Statement Printer.
The PDF publications in Table A-3 below are not provided on the
Advance NDC CD-ROM. These publications have not been
updated, but may be useful if you are using the authoring
environment to extend Advance NDC. Printed versions can be
ordered from the NCR Publications web site.
Note: NCR recommends the use of C Exits to extend Advance
NDC.
Table A-3
Additional Authoring Environment
Documentation
Title
Format
Description
APTRA Advance ADE, Programmer’s
Guide
B006-6042
PDF/Paper
Describes how application programmers should create
their own C++ Worker Classes. It also contains
information on using C routines to manipulate data.
APTRA Advance ADE, C++ Class
Reference
B006-6043
PDF/Paper
Provides application programmers with definitions for
a number of C++ Runtime and Utility Worker Classes
provided by NCR.
APTRA Advance ADE, Local
Language Customisation Guide
B006-6037
PDF/Paper
Describes how to customise the APTRA Advance ADE
product into a local language.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-4
APTRA Advance NDC Multi-Vendor Support Reference
Related Documentation
NDC+ Documentation
NDC+ Documentation
A
The publications in the following table are not provided on the
Advance NDC CD-ROM. Printed versions are available from NCR
on request.
Table A-4
Additional NDC+ Documentation
Title
Format
Description
NDC, Using NDC Exits
B006-5102
PDF/
Paper
Introduces NDC Exits to experienced NDC
programmers intending to develop
customised terminal applications.
NDC, Programmer’s Overview
B006-2485
PDF/
Paper
Provides an introduction to, and overview
of, the NDC software.
NDC+, Programmer’s Reference Manual
B006-2486
PDF/
Paper
Aimed at programmers who write host or
switch applications to support NDC+
terminals, or who create the terminal
configuration that customises NDC+.
NDC, Message Formats For Host Application
Developers
B006-4201
PDF/
Paper
Designed for Central control application
developers working with NDC RMX,
NDCxa or NDC+. Intended to help in
creating a control program that handles all
the NDC variants.
NDC+, Supervisor’s Reference Manual
B006-2487
PDF/
Paper
Designed for those people who are
responsible for setting up the terminal’s
local configuration parameters, or for
routine replenishment of the terminal.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
A-5
Related Documentation
Other NCR Documentation
Other NCR Documentation
The publications in the following table are provided with the
software component to which they refer. Printed versions of the first
two titles can be ordered from the NCR Publications web site.
Table A-5
Other NCR Documentation
Product
Title
Format
Description
APTRA XFS
Self-Service Support
System Application
User Guide
B006-6167
PDF/Paper
Describes the functions that are used to perform
configuration and maintenance on an SST.
APTRA Documentation
CCM TCPIP
HTML Help
(CHM)
On-line help for the Communications Connection
Manager TCP/IP module.
APTRA Documentation
CCM PCCM
HTML Help
(CHM)
On-line help for Communications Connection
Manager PCCM module.
APTRA Communications
PDF/Paper
Describes how to use the Communications
Feature software, which provides the files and
registry settings required to run any PC
Communications Module (PCCM)
communications protocol on APTRA XFS.
EMV Integrated Circuit
Card (ICC) Reference
Manual
B006-6297
PDF/Paper
Provides reference information for any APTRA
Advance NDC developer who wishes to add
EMV Integrated Circuit Card (ICC) Card
Authentication Method (CAM) functionality to
their Advance NDC application.
APTRA Simulator
HTML Help
Context-sensitive help for the APTRA Simulator.
Feature, User’s Guide
B006-0012
EMV/CAM2
Exits for
APTRA
Advance NDC
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-6
APTRA Advance NDC Multi-Vendor Support Reference
A
Related Documentation
CEN-XFS Documentation
CEN-XFS Documentation
A
For device access, Advance NDC supports release 3.0x (3.10 for the
IPM service provider) of the CEN-XFS specification.
The following documents are available from the CEN site,
http://www.cen.eu/cen/Sectors/Sectors/ISSS/CEN Workshop
Agreements/Pages.
Table A-6
CEN-XFS Documentation
Title
Format
Description
Extensions for Financial Services (XFS) interface
specification
(CWA 14050)
PDF or
zipped
PDF
Provides reference information for
CEN-XFS specifications, release 3.0x (3.10
for IPM).
ActiveXFS Interface Specification
(CWA 13849)
PDF or
zipped
PDF
Provides reference information for the
ActiveXFS specifications.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
A-7
Related Documentation
CEN-XFS Documentation
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-8
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Status Mapping
Appendix B
Status Mapping
Overview
Table Conventions
B-1
B-2
Currency Dispenser
B-3
Coin Dispenser
B-12
Card Reader
B-16
PIN Pad
B-21
Barcode Reader
B-25
Cheque Processing Module
B-26
Bunch Cheque Acceptor
B-31
Receipt and Journal Printers
B-32
Statement Printer
B-37
Passbook Printer
B-42
Text Terminal Unit
B-48
Sensors and Indicators Unit
B-49
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Status Mapping
Envelope Dispenser and Depository
B-50
Night Safe
B-55
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Overview
B
Overview
B
This appendix gives details of the status mapping provided by NCR
to enable an Advance NDC application to function in a
multi-vendor environment based on XFS. These mapping tables are
already implemented in the product. You do not need to read this
appendix unless changes to values reported by the SST are required.
The status mapping takes information from XFS (command
completions, events and query results) and maps it to the Advance
NDC format required to generate status messages within the
Advance NDC application.
Status mapping information is provided for the following devices:











Currency dispenser
Coin dispenser
Card reader
PIN pad
Barcode reader
Cheque Processing Module
Receipt and journal printers
Statement printer
Passbook printer
Envelope dispenser and depository
Night safe
There is no status mapping for the following devices:



Text Terminal Unit (TTU)
Sensors and Indicators Unit (SIU)
Bunch cheque acceptor
The following table summarises the types of information that are
mapped. As there is not an exact correspondence between each XFS
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-1
Status Mapping
Overview
command, its return value, and the Advance NDC status data, the
mapping is based on context and may be an approximation:
Table B-1
Status Mapping Tables
Mapping Table
Description
Command Completion
Mapping
All possible XFS HRESULTs for each
supported XFS command. The result of this
mapping is an Advance NDC T-Code.
Event Mapping
All XFS events. Shows whether and how
they are mapped to unsolicited Advance
NDC events. If a solicited event is returned,
this is explicitly stated in the tables.
Severity Mapping
How device severity is obtained. The set of
Advance NDC severity values is restricted
to:
good
warning
suspend
fatal.
Replenishment
Information Mapping
How device replenishment information is
obtained.
Note: For other vendors’ SSTs, the returned XFS command
HRESULT is mapped to the most likely status, this means that, as
there is no exact mapping for the XFS HRESULT, the best match in
context is returned.
Table Conventions
In the tables, the following apply:
B



For ease of reading, the prefix WFS_CMD_ is not shown for
commands.
The prefix WFS_CMD_ERR is not shown for the EXCHANGE_ACTIVE
commands.
Where there are mappings for two devices, such as the envelope
depository (006) and dispenser (028), the lines are processed
until a value is found for both devices.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-2
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Currency Dispenser
Currency Dispenser
B
The Cash Dispenser Module Service Provider (CDM SP) covers both
the Currency Dispenser device (ID = 005) and the Currency
Dispenser Tamper Indicator (ID = 094). Where appropriate, the
tables indicate which device is affected.
The first command completion table gives mapping details for all
successful commands except the PRESENT command.The
subsequent command completion tables give the mapping details
for each XFS command.
Table B-2
XFS Command: CDM, all except
PRESENT
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
SUCCESSFUL OPERATION
All bills requested have been stacked. The count of bills
transferred to the purge bin in the RC_DATA fields is accurate.
XFS Cmd HRESULT
T-Code
T-Code Explanation
CASHUNITERROR
01
UNSUCCESSFUL
A fault has occurred and the requested amount has not been
properly stacked. An attempt has been made to clear the currency
in the transport to the purge bin. The count of bills transferred to
the purge bin is accurate. The device severity S_DATA (0) indicates
the state of the device for future operation.
If FATAL, the device must not be used before operator
intervention.
EXCHANGE_ACTIVE
(mapping is not implemented
as Advance NDC does not
support in-service
replenishment)
01
UNSUCCESSFUL OPERATION
INVALIDCURRENCY
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested in
the C_DATA. All counts are accurate.
Table B-3
XFS Command: CDM_DISPENSE
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-3
Status Mapping
Currency Dispenser
XFS Cmd HRESULT
T-Code
T-Code Explanation
INVALIDDENOMINATION
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested.
All counts are accurate.
INVALIDMIXNUMBER
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested.
All counts are accurate.
UNSUPPOSITION
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested.
All counts are accurate.
INVALIDTELLERID
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested.
All counts are accurate.
NOCURRENCYMIX
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested.
All counts are accurate.
PRERRORNOITEMS
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested.
All counts are accurate.
PRERRORITEMS
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested.
All counts are accurate.
PRERRORUNKNOWN
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested.
All counts are accurate.
NOTDISPENSABLE
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills were requested.
All counts are accurate.
SAFEDOOROPEN
01
UNSUCCESSFUL OPERATION
A fault has occurred and the requested amount has not been
properly stacked. An attempt has been made to clear the currency
in the transport to the purge bin. The count of bills transferred to
the purge bin is accurate. The device severity S_DATA (0) indicates
the state of the device for future operation.
If FATAL, the device must not be used before an operator
intervention.
TOOMANYITEMS
01
UNSUCCESSFUL OPERATION
A fault has occurred and the requested amount has not been
properly stacked. An attempt has been made to clear the currency
in the transport to the purge bin. The count of the items transferred
to the purge bin is accurate. The device severity S_DATA (0)
indicates the state of the device for future operation.
If FATAL, the device must not be used before an operator
intervention.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-4
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Currency Dispenser
XFS Cmd HRESULT
T-Code
T-Code Explanation
DEV_NOT_READY
01
UNSUCCESSFUL OPERATION
A fault has occurred and the requested amount has not been
dispensed
SHUTTERNOTOPEN
02
UNSUCCESSFUL OPERATION
SHUTTEROPEN
02
UNSUCCESSFUL OPERATION
AMOUNTNOTINMIXTABLE
09
UNSUCCESSFUL OPERATION
NOCASHBOXPRESENT
09
UNSUCCESSFUL OPERATION
ITEMSNOTTAKEN
01
UNSUCCESSFUL OPERATION
ITEMSLEFT
01
UNSUCCESSFUL OPERATION
other
(covers all device failures that are
nonspecific)
01
UNSUCCESSFUL OPERATION
A fault has occurred and the requested amount has not been
properly stacked. An attempt has been made to clear the currency
in the transport to the purge bin. The count of bills transferred to
the purge bin is accurate. The device severity S_DATA (0) indicates
the state of the device for future operation.
If FATAL, the device must not be used before an operator
intervention.
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
05
Good
Currency has been presented to the cardholder. All purged bill
counts are accurate.
EXCHANGE_ ACTIVE
(mapping is not implemented
as Advance NDC does not
support in-service
replenishment)
09
UNSUCCESSFUL OPERATION
No bills have been presented. A CLEAR has been attempted to
move the bills to the purge bin. All purged bill counts are accurate.
NOITEMS
09
UNSUCCESSFUL OPERATION
The command has been rejected because no bills are stacked.
SHUTTERNOTOPEN
02
UNSUCCESSFUL OPERATION
SHUTTEROPEN
02
UNSUCCESSFUL OPERATION
PRERRORNOITEMS
02
UNSUCCESSFUL OPERATION
Table B-4
XFS Command: CDM_PRESENT
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-5
Status Mapping
Currency Dispenser
XFS Cmd HRESULT
T-Code
T-Code Explanation
PRERRORITEMS
03
UNSUCCESSFUL OPERATION
An unknown number of bills has been presented to the cardholder.
The number of bills involved in the operation is indicating the
RC_DATA unknown destination counts.
The purged bills counts may be inaccurate. This error occurs only
under extreme conditions.
PRERRORUNKNOWN
03
UNSUCCESSFUL OPERATION
An unknown number of bills has been presented to the cardholder.
The number of bills involved in the operation is indicating the
RC_DATA unknown destination counts.
The purged bills count may be inaccurate. This error occurs only
under extreme conditions.
other
(covers all device failures that are
nonspecific)
02
UNSUCCESSFUL OPERATION
XFS Cmd HRESULT
T-Code
T-Code Explanation
ITEMSTAKEN
03
Bills have been taken by the cardholder during a RETRACT
operation. An unsolicited response will have been issued when the
bills were taken.
EXCHANGE_ACTIVE
(mapping is not implemented as
Advance NDC does not support
in-service replenishment)
02
UNSUCCESSFUL OPERATION
The items have not been retracted because of a fault. The count of
items transferred to the purge bin is inaccurate. M-Status describes
the fault in detail. If S_DATA(0) is FATAL, the device must not be
used again before operator intervention.
SHUTTERNOTCLOSED
02
UNSUCCESSFUL OPERATION
INVALIDRETRACT POSITION
01
UNSUCCESSFUL OPERATION
The bills were not retracted because of an invalid command.
NOTRETRACT AREA
1
UNSUCCESSFUL OPERATION
The bills were not
retracted because of an invalid command
CASHUNIT ERROR
1
UNSUCCESSFUL OPERATION
NOITEMS
09
UNSUCCESSFUL OPERATION
The command has been rejected because no items have been
presented. All counts are accurate.
other
(covers all device failures that are
nonspecific)
01
UNSUCCESSFUL
The items have been retracted but there is a fault. The count of
items transferred to the purge bin is inaccurate.
Table B-5
XFS Command: CDM_RETRACT
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-6
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Currency Dispenser
Table B-6
XFS Command: CDM_REJECT
XFS Cmd HRESULT
T-Code
T-Code Explanation
EXCHANGE_ACTIVE
(mapping is not implemented as
Advance NDC does not support
in-service replenishment)
01
UNSUCCESSFUL OPERATION
NOITEMS
00
UNSUCCESSFUL OPERATION
other
(covers all device failures that are
nonspecific)
01
UNSUCCESSFUL OPERATION
XFS Cmd HRESULT
T-Code
T-Code Explanation
CASHUNITERROR
01
UNSUCCESSFUL OPERATION
Table B-7
XFS Commands:
START_EXCHANGE/END_EXCHANGE
Table B-8
Currency Dispenser Event Mapping
XFS Event Prefix
XFS Event
Unsolicited Event
T-Code
EXEE_CDM_
DELAYEDDISPENSE
N/A (Dispenser)
—
STARTDISPENSE
N/A (Dispenser)
—
PARTIALDISPENSE
N/A (Dispenser)
—
SUBDISPENSEOK
N/A (Dispenser)
—
INCOMPLETEDISPENSE
N/A (Dispenser)
—
NOTEERROR
N/A (Dispenser)
—
MEDIADETECTED
N/A (Dispenser)
—
CASHUNITERROR
See Note 1:
N/A (Dispenser)
—
ITEMSTAKEN
Cash taken
(Dispenser)
00
ITEMSPRESENTED
Cash Presented
(Dispenser)
—
SRVE_CDM_
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-7
Status Mapping
Currency Dispenser
XFS Event Prefix
XFS Event
Unsolicited Event
T-Code
SAFEDOOROPEN
N/A (Tamper
indicator)
03
T-Data gives replenishment
information about the cassettes
by their physical location in the
presenter.
SAFEDOORCLOSED
N/A (Tamper
indicator)
—
COUNTS_CHANGED
SRVE_CDM_
USRE_CDM_
—
CASHUNITINFOCHANGED
N/A (Tamper
indicator)
—
TELLERINFOCHANGED
Cassette has been
removed or inserted
(Tamper indicator)
—
CASHUNITTHRESHOLD
N/A (Dispenser)
—
Note 1: This event is used to trigger a status query to get more
details of the error.
Table B-9
Currency Dispenser Severity Mapping
XFS Device Status
XFS Device Element
XFS Value
WFSCDMSTATUS
Overall device severity
fwDevice
DEVONLINE,
DEVBUSY
No error
fwDispenser
DISP_OK
No error
fwDevice
DEVUSERERROR
Suspend
fwDevice
DEVNODEVICE,
DEVOFFLINE,
DEVPOWEROFF
Fatal
fwDevice
with one of
DEVHWERROR
fwSafeDoor
DOORUNKNOWN
Fatal
fwDispenser
DISPCUSTOP,
DISPUUNKNOWN
Fatal
FwIntermediateStacker
ISUNKNOWN
Fatal
fwShutter
SHTJAMMED,
SHTUNKNOWN
Fatal
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-8
S-Data
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Currency Dispenser
XFS Device Status
XFS Device Element
XFS Value
S-Data
fwOutputPosition
CTUNKNOWN
Fatal
fwTransport
TPINOP,
TPIUNKNOWN
Fatal
all other cases
Warning
WFSCDMCUINFO
Cassette severity
usStatus
STATCUOK,
HIGH,
LOW
No error
usStatus
STATCUEMPTY,
STATCUFULL,
STATCUINOP,
STATCUMANIP
any others
Fatal
Table B-10
Currency Dispenser Replenishment
Information Mapping
XFS Device Status
XFS Device Element
XFS Value
WFSCDMCUINFO
R-Data Value
Reject/Purge Bin
Cassette
usStatus
STATCUOK
Good
Good
usStatus
STATCUFULL
Overfill
Overfill
usStatus
STATCUHIGH
High/low
High/low
usStatus
STATCULOW
High/low
High/low
usStatus
STATCUEMPTY
Empty
Empty
usStatus
STATCUINOP
No new state
No new state
usStatus
STATCUMANIP
No new state
No new state
usStatus
STATCUMISSING,
STATCUNOVAL,
STATCUNOREF
No new state
No new state
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-9
Status Mapping
Currency Dispenser
Table B-11
Currency Dispenser Cash Tamper
Indication Mapping
XFS Device Status
XFS Device Element
XFS Value
WFSCDMCUINFO
T-Data Value
Purge Bin
Cassette
Not available
None
No change
No change
usStatus
STATCUMISSING
Removed
Removed
usStatus
all others
Inserted
Inserted
Table B-12
Currency Dispenser Cash Counters
Combined
Counters CDI
Array
Separated
Counters CDI
Arrays
CASHUNITINFO.CASHUNIT.ulCount is taken
from XFS
5010
CDM1: 5019
CDM2: 5022
Notes Dispensed
Stored according to command completion
information from XFS
5012
CDM1: 5018
CDM2: 5021
Notes to Dispense
Taken from the input parameter of the DISPENSE
command
5014
N/A
Last Notes Dispensed
Stored according to command completion
information from XFS
5015
N/A
Notes Rejected
Stored according to command completion
information from XFS
5016
CDM1: 5020
CDM2: 5023
Notes Loaded
CASHUNITINFO.CASHUNIT.ulInitialCount is
taken from XFS
5026
CDM1: 5024
CDM2: 5025
Standard Note Counts
Taken from the input parameter of the DISPENSE
command for a STANDARD CASH operation
5027
CDM1: 5028
CDM2: 5029
Counter
Origin
Notes Remaining
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-10
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Currency Dispenser
Table B-13
Currency Dispenser Counter Updates
Operation
State
Value Derived From...
Notes dispensed
The output parameter of the DISPENSE command
(DENOMINATION.lpulValues array)
Notes presented
Presented + dispensed
Notes rejected
Rejected + remaining before dispense - remaining
after dispense - dispensed
Notes remaining
Updated XFS counters
Notes loaded
Updated XFS counters
Notes rejected
Rejected + remaining before dispense - remaining
after dispense
Notes remaining
Updated XFS counters
Notes loaded
Updated XFS counters
Last Notes Dispensed
Total Notes Dispensed
Reject
Retract
As RETRACT counters are not kept, there is no
value.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-11
Status Mapping
Coin Dispenser
Coin Dispenser
The CDM SP covers both the Coin Dispenser device (ID = 025) and
Coin Dispenser Tamper Indicator (ID = 030). Where appropriate, the
tables indicate which device is affected.
The following mapping tables are provided for coin dispensers:






Command completion
Event mapping
Severity mapping
Replenishment information mapping
Tamper indication
Coin dispenser counters
Table B-14
XFS Command: CDM_DISPENSE
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
SUCCESSFUL OPERATION
All coins requested have been successfully dispensed to the
customer
CASHUNITERROR
09
HOPPER JAM
Coins are jammed in the hopper.
EXCHANGEACTIVE
(mapping is not implemented as
Advance NDC does not support
in-service replenishment)
03
UNSUCCESSFUL OPERATION
No coins have been presented
INVALIDCURRENCY
03
UNSUCCESSFUL OPERATION
INVALIDDENOMINATION
03
UNSUCCESSFUL OPERATION
INVALIDMIXNUMBER
03
UNSUCCESSFUL OPERATION
NOCURRENCYMIX
03
UNSUCCESSFUL OPERATION
NOTDISPENSABLE
03
UNSUCCESSFUL OPERATION
SAFEDOOROPEN
03
UNSUCCESSFUL OPERATION
TOOMANYITEMS
03
UNSUCCESSFUL OPERATION
DEV_NOT_READY
03
UNSUCCESSFUL OPERATION
HARDWARE ERROR
12
UNSUCCESSFUL OPERATION
other
12
UNSUCCESSFUL OPERATION
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-12
APTRA Advance NDC Multi-Vendor Support Reference
B
Status Mapping
Coin Dispenser
Table B-15
Coin Dispenser Event Mapping
XFS Event Prefix
XFS Event
Unsolicited Event
T-Code
EXEE_CDM_
CASHUNITERROR
N/A
—
SRVE_CDM_
SAFEDOOROPEN
N/A (Tamper
indicator)
—
SAFEDOORCLOSED
N/A (Tamper
indicator)
—
CASHUNITINFOCHANGED
Hopper removed or
inserted (Tamper
indicator)
03
CASHUNITTHRESHOLD
N/A (Dispenser)
—
USRE_CDM_
Table B-16
Coin Dispenser Severity Mapping
XFS Device Status
XFS Device Element
XFS Value
WFSCDMSTATUS
S-Data
Overall device severity
fwDevice
with one of
DEVONLINE,
DEVBUSY
fwSafeDoor
DOOROPEN,
DOORCLOSED,
DOORUNKNOWN
all other cases
No error
No error
fwDispenser
DISP_OK
No error
fwDevice
DEVUSERERROR
Suspend
fwDevice
DEVNODEVICE,
DEVOFFLINE,
DEVPOWEROFF
Fatal
fwDevice
with one of
DEVHWERROR
fwSafeDoor
DOORUNKNOWN,
DOOROPEN
Fatal
fwSafeDoor
DOORCLOSED
No error
fwDispenser
DISPCUSTOP,
DISPUUNKNOWN
Fatal
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-13
Status Mapping
Coin Dispenser
XFS Device Status
XFS Device Element
XFS Value
S-Data
fwTransport
TPINOP,
TPIUNKNOWN
Fatal
all other cases
Warning
WFSCDMCUINFO
Hopper severity
usStatus
STATCUOK,
STATCULOW
No error
usStatus
STATCUEMPTY,
STATCUINOP,
STATCUMANIP,
STATCUMISSING,
STATCUNOVAL
Fatal
Table B-17
Coin Dispenser Replenishment Information
Mapping
XFS Device Status
XFS Device Element
XFS Value
R-Data Value - Hopper
usStatus
STATCUOK
Good
usStatus
STATCULOW
Low
usStatus
STATCUEMPTY
Empty
usStatus
STATCUINOP
No new state
usStatus
STATCUMISSING
(dispense request)
Empty
usStatus
STATCUMISSING,
(no dispense request),
STATCUNOVAL,
No new state
XFS Value
T-Data Value - Hopper
WFSCDMCUINFO
Table B-18
Coin Dispenser Cash Tamper Indication
Mapping
XFS Device Status
XFS Device Element
WFSCDMCUINFO
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-14
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Coin Dispenser
XFS Device Status
XFS Device Element
XFS Value
T-Data Value - Hopper
Not available
None
No change
usStatus
STATCUMISSING
Removed
usStatus
all others
Inserted
Table B-19
Coin Dispenser Counters
Counter
Origin
mPersistInt Names
Coins Remaining
CASHUNITINFO.CASHUNIT.ulCount are taken
from XFS. These counters are accessible using the
Integer Array Element worker
000_000,000_001,000_002,000_
003,000_004,000_005,000_006,
000_007
Coins Dispensed
Stored according to command completion
information from XFS
005_000,005_001,005_002,005_
003,005_004,005_005,005_006,
005_007
Coins Loaded
CASHUNITINFO.CASHUNIT.ulInitialCount
are taken from XFS.
007_000,007_001,007_002,007_
003,007_004,007_005,007_006,
007_007
Coins Adjustment
Not applicable as the XFS SP interface does not
implement coins adjustment and therefore it
remains zero
00541... 00544...
Coins Dispensed
Stored according to command completion
information from XFS
00551... 00554...
Coins Loaded
CASHUNITINFO.CASHUNIT.ulInitialCount
are taken from XFS
00561...00564...
Table B-20
Coin Dispenser Counter Updates
Operation
State
Value Derived From...
Coins dispensed
The output parameter of the DISPENSE command
(DENOMINATION.lpulValues array)
Dispense
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-15
Status Mapping
Card Reader
Card Reader
B
The following mapping tables are provided for card readers:




Command completion, which gives mapping information for
the following:
— IDCCARDDATA.wstatus
— IDCRETAINCARD.fwPosition
Event mapping
Severity mapping
Replenishment information mapping, which gives information
about the state of the latch fast card capture (LFCC) bin.
Table B-21
XFS Command: IDC_READ_RAW_DATA
XFS Cmd HRESULT
Element Value
T-Code
T-Code Explanation
WFS_SUCCESS
DATA_OK
00
Good
DATAMISSING
05
Blank track
DATAINVALID
01
Read error
DATATOOLONG
01
Read error
DATATOOSHORT
01
Read error
DATASRCNOTSUPP
02
The track is not supported
DATASRCMISSING
01
Read error
MEDIAJAM
04
The card is jammed
SHUTTERFAIL
03
The device is inoperative
NOMEDIA
06
There is no card present
INVALID MEDIA
05
There is an invalid card in the
reader
CARDTOOSHORT
3
The card cannot be read due to
invalid size
CARDTOOLONG
3
The card cannot be read due to
invalid size
Other
03
The device is inoperative
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-16
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Card Reader
In the following tables, there are no mapping values applicable to
the following device elements:

IDCCARDDATA.wstatus

IDCRETAINCARD.fwPosition
Table B-22
XFS Command: IDC_WRITE_RAW_DATA
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
Good
MEDIAJAM
04
The card is jammed or there are too many write errors
SHUTTERFAIL
03
Inoperative
NOMEDIA
06
No card present
INVALID MEDIA
01
Write error
ERR_UNSUPP_COMMAND
02
Writing to track 3 is unsupported
ERR_INVALID_DATA
05
Invalid data length or format
ERR_IDC_WRITE_METHOD
03
Specified write method is not supported
CARDTOOSHORT
30
The card size is invalid
CARDTOOLONG
03
The card size is invalid
Other
03
Inoperative
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
Good
MEDIAJAM
08
Error
NOMEDIA
08
Error
INVALID MEDIA
08
Error
INVALIDDATA
09
Invalid data
PROTOCOLNOTSUPP
09
Protocol not supported
Other
03
Inoperative
Table B-23
XFS Command: IDC_CHIP_IO
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-17
Status Mapping
Card Reader
Table B-24
XFS Command: IDC_RESET_COUNT
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
Good
Other
00
Good
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
Good
MEDIAJAM
03
Inoperative
SHUTTERFAIL
03
Inoperative
NOMEDIA
06
No card present
MEDIARETAINED
02
The card jammed and has been captured
ERR_UNSUPP_COMMAND
00
Good
(The device does not have the capability of ejecting the card)
Other
03
Inoperative
Table B-25
XFS Command: IDC_EJECT_CARD
Table B-26
XFS Command: IDC_RETAIN_CARD
XFS Cmd HRESULT
Element Value
T-Code
T-Code Explanation
WFS_SUCCESS
N/A
00
Good
MEDIAJAM
MEDIAUNKNOWN,
MEDIAPRESENT,
MEDIAENTERING
03
Inoperative
NOMEDIA
MEDIAUNKNOWN
01
The transport is clear and there is
no card to capture
RETAINBILLFULL
MEDIAPRESENT
03
Inoperative
ERR_UNSUPP_COMMAND
N/A
00
Good
Other
N/A
03
Inoperative
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-18
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Card Reader
Table B-27
Card Reader Event Mapping
XFS Event Prefix
XFS Event
XFS Parameter
XFS Value
Unsolicited Event
T-Code
EXEE_IDC_
INVALID
TRACK
DATA
fwStatus
DATA
MISSING
READ solicited
05
INVALID
TRACK
DATA
fwStatus
Any except
DATA
MISSING
READ solicited
02
MEDIA
INSERTED
N/A
Card detected
01
INVALID
MEDIA
N/A
There is an invalid
card in the reader;
ejecting
05
MEDIA
REMOVED
N/A
The card has been
removed
00
CARD
ACTION
wAction
IDC_CARD
READ
POSITION
N/A
—
wAction
IDC_CARD
RETAINED
N/A
—
wAction
IDC_CARD
EJECTED
N/A
—
lpfwRetainBin
RETAIN
BIN
FULL
The device is
inoperative
03
SRVE_IDC_
USRE_IDC_
RETAIN
BIN
THRESHOLD
Table B-28
Card Reader Severity Mapping
XFS Device Status
XFS Device Element
XFS Element Value
INF_IDC_STATUS
S-Data
Overall device severity
fwDevice
with
DEVONLINE,
DEVBUSY
fwRetainBin
RETAINBINOK,
RETAINBINFULL,
RETAINBINHIGH,
RETAINNOTSUPP
No error
fwDevice
DEVUSERERROR
Suspend
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-19
Status Mapping
Card Reader
XFS Device Status
XFS Device Element
XFS Element Value
S-Data
fwDevice
DEVNODEVICE,
DEVOFFLINE,
DEVPOWEROFF
Fatal
fwDevice
with one of
DEVHWERROR
fwMedia
MEDIAJAMMED,
MEDIAUNKNOWN
Fatal
fwRetainBin
RETAINBINFULL
RETAINBINHIGH
Fatal
FwSecurity
SECNOTREADY
Fatal
all other cases
Warning
Table B-29
Card Reader Replenishment Information
Mapping (State of the LFCC Bin)
XFS Device Status
XFS Device Element
XFS Value
R-Data
fwRetainBin
RETAINBINOK
Good
RETAINBINFULL
Empty/overfill
RETAINBINHIGH
High/low
RETAINBINNOTSUPP
Good
INF_IDC_STATUS
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-20
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
PIN Pad
PIN Pad
B
The following mapping tables are provided for PIN pads:

Command completion
Event mapping
Severity mapping
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
Good
KEYNOTFOUND
01
Error
KEYNOVALUE
01
Error
USEVIOLATION
06
Security module has been reset
ACCESSDENIED
06
Security module has been reset
Other
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
MODENOTSUPPORTED
01
Error
INVALIDKEYLENGTH
01
Error
NOCHIPTRANSACTIVE
01
Error
ALGORITHMNOTSUPP
01
Error


Table B-30
XFS Command: PIN Pad, all
Table B-31
XFS Command: PIN_CRYPT
Table B-32
XFS Command: PIN_IMPORT_KEY
XFS Cmd HRESULT
T-Code
T-Code Explanation
INVALIDID
01
Error
DUPLICATEKEY
01
Error
INVALIDKEYLENGTH
01
Error
NOKEYRAM
01
Error
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-21
Status Mapping
PIN Pad
Table B-33
XFS Command: PIN_GET_PIN
XFS Cmd HRESULT
T-Code
T-Code Explanation
KEYINVALID
01
Error
KEYNOTSUPPORTED
01
Error
NOACTIVEKEYS
01
Error
NOTERMINATEKEYS
01
Error
MINIMUMLENGTH
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESSpResult = FALSE
03
PIN verification failed
NOPIN
01
Error
INVALIDKEYLENGTH
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESSpResult = FALSE
03
PIN verification failed
NOPIN
1
Error
INVALIDKEYLENGTH
01
Error
Table B-34
XFS Command: PIN_LOCAL_DES
Table B-35
XFS Command: PIN_LOCAL_VISA
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-22
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
PIN Pad
Table B-36
XFS Command: PIN_GET_PINBLOCK
XFS Cmd HRESULT
T-Code
T-Code Explanation
MODENOT SUPPORTED
1
Error
NOPIN
3
PIN verification failed
FORMATNOTSUPP
1
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
KEYINVALID
1
Error
KEYNOTSUPPORTED
1
Error
NOACTIVEKEYS
1
Error
Table B-37
XFS Command: PIN_GET_DATA
Table B-38
PIN Pad Event Mapping
XFS Event Prefix
XFS Event
Unsolicited Event
T-Code
S-Data
EXEE_PIN_
KEY
T-Data = keycode
00
N/A
SRVE_PIN_
INITIALIZED
N/A
—
N/A
ILLEGAL_KEY_ACCESS
N/A
—
N/A
PIN_OPT_REQUIRED
N/A
—
N/A
Table B-39
PIN Pad Severity Mapping
XFS Device Status
XFS Device Element
XFS Element Value
WFS_PIN_STATUS
S-Data
Overall device severity
fwDevice
with one of
DEVONLINE,
DEVBUSY
fwEncStat
ENCNOTINITIALIZED
ENCUNDEFINED
ENCNOTREADY
Warning
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-23
Status Mapping
PIN Pad
XFS Device Status
XFS Device Element
XFS Element Value
any other
S-Data
No error
fwDevice
DEVUSERERROR
Suspend
fwDevice
DEVNODEVICE,
DEVOFFLINE,
DEVPOWEROFF
Fatal
fwDevice
with one of
DEVHWERROR
fwEncStat
ENCUNDEFINED
ENCNOTINITIALIZED
ENCNOTREADY
ENCBUSY
other
Fatal
fwRetainBin
RETAINBINFULL
Fatal
FwSecurity
SECNOTREADY
Fatal
any other
Warning
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-24
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Barcode Reader
Barcode Reader
B
The following mapping tables are provided for barcode readers:


Command completion
Severity mapping
There is no mapping for the EXEE_PTR_FIELDERROR event.
Table B-40
XFS Command: PTR_READ_FORM
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
0
GOOD
FORMNOTFOUND
6
Error
FORMINVALID
6
Error
FIELDNOTFOUND
6
Error
FIELDERROR
6
Error
FIELDSPECFAILURE
6
Error
WFS_ERR_TIMEOUT
5
Error
WFS_ERR_HARDWARE_ERROR
3
Error
Other
1
Error
Table B-41
Barcode Reader Severity Mapping
XFS Device Status
XFS Device Element
XFS Value
WFS_PTR_STATUS
S-Data
Overall device severity
fwDevice
DEVNODEVICE,
DEVOFFLINE,
DEVPOWEROFF
Fatal
fwDevice
DEVHWERROR
Fatal
fwDevice
DEVUSERERROR
Suspend
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-25
Status Mapping
Cheque Processing Module
Cheque Processing Module
The following mapping tables are provided for cheque processing
modules (CPMs):



Command completion
Severity mapping
Replenishment information mapping
There is no mapping for CEN-XFS events.
Table B-42
XFS Command: All,
PTR_RETRACT_MEDIA (CPM)
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
0
Good
NOMEDIAPRESENT
8
No document
RETRACTBINFULL
with PTR_RETRACTBINFULL=
4
Bad - command not completed
PTR.STATUS.RetractBins[0].wRetractBin
PTR.STATUS.RetractBins[1].wRetractBin
PTR.STATUS.RetractBins[3].wRetractBin
4
4
4
Bad - command not completed
Bad - command not completed
Bad - command not completed
MEDIAJAMMED
5
Jam
MEDIAJAMMED
5
Jam while entering the transport
HARDWARE_ERROR
2
Bad - command not completed
XFS Cmd HRESULT
T-Code
T-Code Explanation
NOMEDIAPRESENT
8
No document
MEDIAJAMMED
5
Bad - command not completed
SHUTTERFAIL
6
Bad - command not completed
HARDWARE_ERROR
2
Bad - command not completed
INKOUT
9
Bad - command not completed
TONEROUT
10
Bad - command not completed
Table B-43
XFS Command: PTR_CONTROL_MEDIA
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-26
APTRA Advance NDC Multi-Vendor Support Reference
B
Status Mapping
Cheque Processing Module
Table B-44
XFS Command: PTR_READ_IMAGE
XFS Cmd HRESULT
T-Code
T-Code Explanation
MEDIAJAMMED
5
Bad - command not completed
SHUTTERFAIL
6
Bad - command not completed
FILE_IO_ERROR
11
Bad - command not completed
MEDIASIZE
12
Misread
HARDWARE_ERROR
2
Bad - command not completed
Table B-45
XFS Command: PTR_PRINT_FORM
(CPM)
XFS Cmd HRESULT
T-Code
T-Code Explanation
UNSUPP_COMMAND
13
Command reject
MEDIAJAMMED
5
A document jam has occurred
SHUTTERFAIL
6
Bad - command not completed
INKOUT
9
Bad - command not completed
TONEROUT
10
Bad - command not completed
HARDWARE_ERROR
2
Bad - command not completed
FIELDERROR
14
Bad - command not completed
FORMNOTFOUND
15
Bad - command not completed
FIELDSPECFAILURE
16
Parameter error
FORMINVALID
17
Parameter error
MEDIAOVERFLOW
18
Bad - command not completed
RETRACTBINFULL
with PTR_RETRACTBINFULL=
4
Bad - command not completed
PTR.STATUS.RetractBins[0].wRetractBin
PTR.STATUS.RetractBins[1].wRetractBin
PTR.STATUS.RetractBins[3].wRetractBin
4
4
4
Bad - command not completed
Bad - command not completed
Bad - command not completed
MEDIAJAMMED
5
Bad - command not completed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-27
Status Mapping
Cheque Processing Module
Table B-46
XFS Command: PTR_RESET
XFS Cmd HRESULT
T-Code
T-Code Explanation
MEDIAJAMMED
5
A document jam has occurred
SHUTTERFAIL
6
Bad - command not completed
HARDWARE_ERROR
2
Bad - command not completed
Table B-47
CPM Severity Mapping:
WFS_PTR_STATUS
S-Data Overall
Endorser
Ribbon
Stamper
Ink
XFS Device Element
XFS Value
fwDevice
DEVONLINE, DEVBUSY
fwMedia
MEDIAJAMMED
fwToner
TONERLOW
Low
fwToner
TONEROUT
Fatal
fwInk
INKLOW
Low
fwInk
INKOUT
Fatal
fwRetractBin1
RETRACTBINFULL
Fatal
fwRetractBin2
RETRACTBINFULL
Fatal
fwRetractBin3
RETRACTBINFULL
Fatal
fwRetractBin1
RETRACTBINHIGH
fwRetractBin2
RETRACTBINHIGH
fwRetractBin3
RETRACTBINHIGH
fwRetractBin1
RETRACTBINMISSING
Fatal
fwRetractBin2
RETRACTBINMISSING
Fatal
fwRetractBin3
RETRACTBINMISSING
Fatal
fwDevice
DEVUSERERROR
Suspend
fwDevice
DEVNODEVICE,
DEVOFFLINE,
DEVPOWEROFF
Fatal
Bin 2
Bin 3
Fatal
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-28
Bin 1
APTRA Advance NDC Multi-Vendor Support Reference
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Status Mapping
Cheque Processing Module
XFS Device Element
XFS Value
S-Data Overall
fwDevice
with one of
DEVHWERROR
fwMedia
MEDIAJAMMED
fwToner
TONEROUT
fwInk
INKOUT
fwRetractBin1
RETRACTBINFULL
Fatal
fwRetractBin2
RETRACTBINFULL
Fatal
fwRetractBin3
RETRACTBINFULL
Fatal
fwToner
TONERLOW
fwInk
INKLOW
fwRetractBin1
RETRACTBINHIGH
fwRetractBin2
RETRACTBINHIGH
fwRetractBin3
RETRACTBINHIGH
fwRetractBin1
RETRACTBINMISSING
Fatal
fwRetractBin2
RETRACTBINMISSING
Fatal
fwRetractBin3
RETRACTBINMISSING
Fatal
Endorser
Ribbon
Stamper
Ink
Bin 1
Bin 2
Bin 3
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Low
Low
Other
Fatal
Fatal
Fatal
Fatal
Table B-48
CPM Replenishment Information Mapping:
WFS_PTR_STATUS
R-Data
Endorser
Ribbon
XFS Device Element
XFS Value
fwMedia
WFS_MEDIAPRESENT
WFS_MEDIANOTPRESENT
WFS_PTR_MEDIAENTERING
WFS_PTR_MEDIARETRACTED
fwMedia
WFS_MEDIAUNKNOWN
fwMedia
WFS_MEDIANOSUP
fwToner
TONERFULL
TONERNOTSUPP
R-Data
Stamper Ink
R-Data
Bin 1
R-Data
Bin 2
R-Data
Bin 3
Good
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-29
Status Mapping
Cheque Processing Module
XFS Device Element
XFS Value
R-Data
Endorser
Ribbon
fwToner
TONERLOW
Low
fwToner
TONEROUT
Out
fwInk
INKFULL
INKNOTSUPP
Good
fwInk
INKLOW
Low
fwInk
INKOUT
Out
fwInk
INKUNKNOWN
fwRetractBin1
RETRACTBINFULL
fwRetractBin2
RETRACTBINFULL
fwRetractBin3
RETRACTBINFULL
fwRetractBin1
RETRACTBINHIGH
fwRetractBin2
RETRACTBINHIGH
fwRetractBin3
RETRACTBINHIGH
R-Data
Stamper Ink
R-Data
Bin 1
APTRA Advance NDC Multi-Vendor Support Reference
R-Data
Bin 3
Overfill
Overfill
Overfill
Nearly
Overfill
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-30
R-Data
Bin 2
Nearly
Overfill
Nearly
Overfill
Status Mapping
Bunch Cheque Acceptor
Bunch Cheque Acceptor
B
The bunch cheque acceptor status handling maps the following:


Command completion
Event mapping.
Note: T-Code information is not visible for bunch cheque acceptor
devices.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-31
Status Mapping
Receipt and Journal Printers
Receipt and Journal Printers
The following mapping tables are provided for receipt and journal
printers:




Command completion
Event mapping
Severity mapping
Replenishment information mapping
Table B-49
XFS Command: PTR, all
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
Good
XFS Cmd HRESULT
T-Code
T-Code Explanation
SHUTTERFAIL
01
Error
MEDIAJAMMED
01
Error
PAPERJAMMED
03
Error
PAPEROUT
01
Error
INKOUT
01
Error
TONEROUT
01
Error
Others
01
Error
If the severity is not fatal, the device can accept any command
XFS Cmd HRESULT
T-Code
T-Code Explanation
NOMEDIAPRESENT
01
Error
FLUSHFAIL
01
Error
RETRACTBINFULL
01
Error
STACKERFULL
01
Error
Table B-50
XFS Command: PTR_RAW_DATA
Table B-51
XFS Command: PTR_CONTROL_MEDIA
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-32
APTRA Advance NDC Multi-Vendor Support Reference
B
Status Mapping
Receipt and Journal Printers
XFS Cmd HRESULT
T-Code
T-Code Explanation
PAGETURNFAIL
01
Error
MEDIATURNFAIL
01
Error
SHUTTERFAIL
01
Error
MEDIAJAMMED
01
Error
PAPERJAMMED
01
Error
PAPEROUT
01
Error
INKOUT
01
Error
TONEROUT
01
Error
SEQUENCEINVALID
01
Error
Other
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
FORMNOTFOUND
01
Error
FORMINVALID
01
Error
MEDIANOTFOUND
01
Error
MEDIAINVALID
01
Error
MEDIASKEWED
01
Error
MEDIAOVERFLOW
01
Error
FIELDSPECFAILURE
01
Error
FIELDERROR
01
Error
FLUSHFAIL
01
Error
RETRACTBIN FULL
01
Error
STACKERFULL
01
Error
PAGETURNFAIL
01
Error
MEDIATURN FAIL
01
Error
SHUTTERFAIL
01
Error
MEDIAJAMMED
03
Error
PAPERJAMMED
03
Error
Table B-52
XFS Command: PTR_PRINT_FORM
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-33
Status Mapping
Receipt and Journal Printers
XFS Cmd HRESULT
T-Code
T-Code Explanation
PAPEROUT
01
Error
INKOUT
01
Error
TONEROUT
01
Error
CHARSETDATA
01
Error
SEQUENCE INVALID
01
Error
Other
01
Error
Table B-53
Receipt and Journal Printer Event Mapping
XFS Event Prefix
XFS Event
Unsolicited Event
S-Data
R-Data
EXEE_PTR_
NOMEDIA
N/A
4
Empty
SRVE_PTR_
MEDIATAKEN
N/A
—
—
LAMPTHRESHOLD
N/A
—
N/A
MEDIADETECTED
N/A
—
N/A
PAPERTHRESHOLD
N/A
N/A
Paper low
INKTHRESHOLD
N/A
N/A
Ribbon low
TONERTHRESHOLD
N/A
N/A
Ribbon low
RETRACTBINTHRESHOLD
N/A
—
N/A
USRE_PTR_
Table B-54
Receipt and Journal Printer Severity
Mapping
XFS Device Status
XFS Device Element
XFS Element Value
WFS_PTR_STATUS
S-Data
Overall device severity
fwDevice
No error
fwDevice
with one of:
DEVONLINE,
DEVBUSY
fwMedia
MEDIAJAMMED
Fatal
fwPaper
PAPERLOW
No error
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-34
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Receipt and Journal Printers
XFS Device Status
XFS Device Element
XFS Element Value
S-Data
fwPaper
PAPEROUT
Fatal
fwToner
TONERLOW
No error
fwToner
TONEROUT
Fatal
fwInk
INKLOW
No error
fwInk
INKOUT
Fatal
fwDevice
DEVUSERERROR
Suspend
See Note 2:
fwDevice
DEVNODEVICE,
DEVOFFLINE,
DEVPOWEROFF
Fatal
fwDevice
with one of:
DEVHWERROR
fwMedia
MEDIANOTPRESENT
Fatal
fwMedia
MEDIAJAMMED
Fatal
fwPaper
PAPEROUT
Fatal
fwToner
TONEROUT
Fatal
fwInk
INKOUT
Fatal
fwLamp
LAMPINOP
Fatal
fwRetractBin
RETRACTBINFULL
Fatal
all other cases
Fatal
Note 2: This value applies only to other vendors’ SSTs and is never
returned on NCR SSTs.
Table B-55
Receipt and Journal Printer Replenishment
Information Mapping
XFS Device
Status
XFS Device Element
XFS Value
WFS_PTR_
STATUS
R-Data
Paper
fwMedia
MEDIAPRESENT,
MEDIANOTPRESENT
See Note 3:
Good
fwMedia
MEDIANOTSUPP
Good
Ribbon
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-35
Status Mapping
Receipt and Journal Printers
XFS Device
Status
XFS Device Element
XFS Value
R-Data
fwPaper
PAPERFULL,
PAPERNOTSUPP
Good
fwPaper
PAPERLOW
Low
fwPaper
PAPEROUT
Empty
fwToner
TONERFULL,
TONERNOTSUPP
Good
fwToner
TONERLOW
Low
fwToner
TONEROUT
Empty
fwInk
INKFULL, INKNOTSUPP
Good
fwInk
INKLOW
Low
fwInk
INKOUT
Empty
Note 3: Other vendors’ implementation of the SP interface may use
MEDIANOTPRESENT to indicate an absence of paper in the
transport; therefore paper supplies are good.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-36
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Statement Printer
Statement Printer
B
The following mapping tables are provided for statement printers:




Command completion
Event mapping
Severity mapping
Replenishment information mapping
Table B-56
XFS Command: PTR (Statement, all)
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
Good
XFS Cmd HRESULT
T-Code
T-Code Explanation
SHUTTERFAIL
01
Error
MEDIAJAMMED
01
Error
PAPERJAMMED
03
Error
PAPEROUT
01
Error
INKOUT
01
Error
TONEROUT
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
NOMEDIAPRESENT
01
Error
FLUSHFAIL
01
Error
RETRACTBINFULL
01
Error
STACKERFULL
01
Error
Table B-57
XFS Command: PTR_RAW_DATA
(Statement)
Table B-58
XFS Command: PTR_CONTROL_MEDIA
(Statement)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-37
Status Mapping
Statement Printer
XFS Cmd HRESULT
T-Code
T-Code Explanation
PAGETURNFAIL
01
Error
MEDIATURNFAIL
01
Error
SHUTTERFAIL
01
Error
MEDIAJAMMED
03
Error
PAPERJAMMED
03
Error
PAPEROUT
01
Error
INKOUT
01
Error
TONEROUT
01
Error
SEQUENCEINVALID
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
NOMEDIAPRESENT
01
Error
RETRACTBINFULL
01
Error
MEDIAJAMMED
03
Error
PAPERJAMMED
03
Error
USERERROR
03
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
FORMNOTFOUND
01
Error
FORMINVALID
01
Error
MEDIANOTFOUND
01
Error
MEDIAINVALID
01
Error
MEDIASKEWED
01
Error
MEDIAOVERFLOW
01
Error
FIELDSPECFAILURE
01
Error
Table B-59
XFS Command: PTR_RETRACT_MEDIA
(Statement)
Table B-60
XFS Command: PTR_PRINT_FORM
(Statement)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-38
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Statement Printer
XFS Cmd HRESULT
T-Code
T-Code Explanation
FIELDERROR
01
Error
FLUSHFAIL
01
Error
RETRACTBINFULL
01
Error
STACKERFULL
01
Error
PAGETURNFAIL
01
Error
MEDIATURNFAIL
01
Error
SHUTTERFAIL
01
Error
MEDIAJAMMED
03
Error
PAPERJAMMED
03
Error
PAPEROUT
01
Error
INKOUT
01
Error
TONEROUT
01
Error
CHARSETDATA
01
Error
SEQUENCE INVALID
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
SHUTTERFAIL
01
Error
RETRACTBINFULL
01
Error
MEDIAJAMMED
03
Error
PAPERJAMMED
03
Error
Table B-61
XFS Command: PTR_RESET (Statement)
Table B-62
Statement Printer Event Mapping
XFS Event Prefix
XFS Event
Unsolicited Event
S-Data
R-Data
EXEE_PTR_
NOMEDIA
N/A
4
Empty
SRVE_PTR_
MEDIATAKEN
N/A
—
—
USRE_PTR_
PAPERTHRESHOLD
N/A
N/A
Paper low
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-39
Status Mapping
Statement Printer
XFS Event Prefix
XFS Event
Unsolicited Event
S-Data
R-Data
TONERTHRESHOLD
N/A
N/A
Toner low
INKTHRESHOLD
N/A
N/A
Ink low
RETRACTBINTHRESHOLD
N/A
—
N/A
LAMPTHRESHOLD
N/A
N/A
—
MEDIADETECTED
N/A
—
—
Table B-63
Statement Printer Severity Mapping
XFS Device Status
XFS Device Element
XFS Element Value
WFS_PTR_STATUS
S-Data
Overall device severity
fwDevice
DEVONLINE,
DEVBUSY
No error
fwDevice
DEVUSERERROR
Suspend
See Note 4:
fwDevice
DEVNODEVICE,
DEVOFFLINE,
DEVPOWEROFF
Fatal
fwDevice
with one of:
DEVHWERROR
fwMedia
MEDIANOTPRESENT
Fatal
fwMedia
MEDIAJAMMED
Fatal
fwPaper
PAPEROUT
Fatal
fwToner
TONEROUT
Fatal
fwInk
INKOUT
Fatal
fwLamp
LAMPINOP
Fatal
fwRetractBin
RETRACTBINFULL
Fatal
fwPaper
PAPERLOW
Fatal
fwToner
TONERLOW
Fatal
fwInk
INKLOW
Fatal
all other cases
Fatal
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-40
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Statement Printer
Note 4: This value applies only to other vendors’ SSTs and is never
returned on NCR SSTs.
Table B-64
Statement Printer Replenishment
Information Mapping
XFS Device
Status
XFS Device Element
XFS Value
WFS_PTR_
STATUS
R-Data
Paper
Ribbon
fwMedia
MEDIAPRESENT,
MEDIANOTPRESENT
See Note 5:
Good
fwMedia
MEDIANOTSUPP
Good
fwPaper
PAPERFULL,
PAPERNOTSUPP
Good
fwPaper
PAPERLOW
Low
fwPaper
PAPEROUT
Empty
fwToner
TONERFULL,
TONERNOTSUPP
Good
fwToner
TONERLOW
Low
fwToner
TONEROUT
Empty
fwInk
INKFULL,
INKNOTSUPP
Good
WFS_PTR_
STATUS
Paper
Ribbon
fwInk
INKLOW
Low
fwInk
INKOUT
Empty
wRetractBins
RETRACTBINFULL
Overfill
Note 5: Other vendors’ implementation of the SP interface may use
MEDIANOTPRESENT to indicate an absence of paper in the
transport; therefore paper supplies are good.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-41
Status Mapping
Passbook Printer
Passbook Printer
The following mapping tables are provided for passbook printers:




Command completion
Event mapping
Severity mapping
Replenishment information mapping
Table B-65
XFS Command: PTR
(Passbook printer, all)
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
Good
XFS Cmd HRESULT
T-Code
T-Code Explanation
SHUTTERFAIL
03
Error
MEDIAJAMMED
04
Passbook jammed
PAPERJAMMED
04
Passbook jammed
INKOUT
01
Error
TONEROUT
01
Error
all other cases
03
Error
Table B-66
XFS Command: PTR_RAW_DATA
(Passbook)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-42
APTRA Advance NDC Multi-Vendor Support Reference
B
Status Mapping
Passbook Printer
Table B-67
XFS Command: PTR_CONTROL_MEDIA
(Passbook)
XFS Cmd HRESULT
T-Code
T-Code Explanation
NOMEDIAPRESENT
05
Error
FLUSHFAIL
04
Error
RETRACTBINFULL
03
Error
STACKERFULL
03
Error
PAGETURNFAIL
01
Page turn error
MEDIATURNFAIL
01
Page turn error
SHUTTERFAIL
01
Error
MEDIAJAMMED (with CTRLFLUSH)
04
The book is jammed in the device
MEDIAJAMMED (with CTRLRETRACT)
04
The book is jammed in the device
MEDIAJAMMED (with CTRLEJECT)
04
The book is jammed in the device
PAPERJAMMED
04
The book is jammed in the device
PAPEROUT
05
Error
INKOUT
01
Error
TONEROUT
01
Error
SEQUENCEINVALID
01
Error
all other cases
01
error
Table B-68
XFS Command: PTR_PRINT_FORM
(Passbook)
XFS Cmd HRESULT
T-Code
T-Code Explanation
FORMNOTFOUND
01
Error
FORMINVALID
01
Error
MEDIANOTFOUND
01
Error
MEDIAINVALID
01
Error
MEDIASKEWED
01
Write error
MEDIAOVERFLOW
01
Format error
FIELDSPECFAILURE
01
Error
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-43
Status Mapping
Passbook Printer
XFS Cmd HRESULT
T-Code
T-Code Explanation
FIELDERROR
01
Error
FLUSHFAIL
04
Error
RETRACTBINFULL
03
Error
STACKERFULL
03
Error
PAGETURNFAIL
01
Page turn error
MEDIATURNFAIL
01
Page turn error
SHUTTERFAIL
01
Error
MEDIAJAMMED
04
The book is jammed in the device
PAPERJAMMED
04
The book is jammed in the device
PAPEROUT
05
Error
INKOUT
01
Error
TONEROUT
01
Error
all other cases
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
NOMEDIAPRESENT
05
Error
RETRACTBINFULL
03
Error
MEDIAJAMMED
04
Error
PAPERJAMMED
04
Error
all other cases
03
Error
Table B-69
XFS Command: PTR_RETRACT_MEDIA
(Passbook)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-44
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Passbook Printer
Table B-70
XFS Command: PTR_READ_FORM
(Passbook)
XFS Cmd HRESULT
T-Code
T-Code Explanation
READNOTSUPPORTED
02
Error
FORMNOTFOUND
01
Error
FORMINVALID
01
Error
MEDIANOTFOUND
01
Error
MEDIAINVALID
01
Error
MEDIASKEWED
01
Error
MEDIAOVERFLOW
01
Format error
FIELDSPECFAILURE
01
Error
FIELDERROR
01
Error
NOMEDIAPRESENT
05
Error
FLUSHFAIL
01
Error
RETRACTBINFULL
01
Error
SHUTTERFAIL
01
Error
MEDIAJAMMED
04
The book is jammed in the device
INKOUT
01
Ribbon out
LAMPINOP
01
SEQUENCEINVALID
01
MEDIASIZE
01
Error
all other cases
01
Error
Table B-71
Passbook Printer Event Mapping
XFS Event Prefix
XFS Event
Unsolicited Event
S-Data
R-Data
EXEE_PTR_
NOMEDIA
No book present;
T-code = 05
4
Empty
MEDIAINSERTED
N/A
—
—
FIELDERROR
N/A
—
—
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-45
Status Mapping
Passbook Printer
XFS Event Prefix
XFS Event
Unsolicited Event
S-Data
R-Data
FIELDWARNING
N/A
—
—
SRVE_PTR_
MEDIATAKEN
N/A
—
—
USRE_PTR_
PAPERTHRESHOLD
N/A
N/A
N/A
TONERTHRESHOLD
N/A
N/A
Ribbon low
RETRACTBINTHRESHOLD
N/A
—
Bin full
Table B-72
Passbook Printer Severity Mapping
XFS Device Status
XFS Device Element
XFS Element Value
WFS_INF_PTR_STATUS
S-Data
Overall device severity
fwDevice
with one of:
DEVONLINE,
DEVBUSY
No error
fwMedia
MEDIAJAMMED
Fatal
fwToner
TONERLOW
No error
fwToner
TONEROUT
See Note 6:
No error
fwInk
INKLOW
No error
fwInk
INKOUT
No error
all other cases
No error
fwDevice
DEVUSERERROR
Suspend
fwDevice
DEVNODEVICE,
DEVOFFLINE,
DEVPOWEROFF
Fatal
fwDevice
with one of:
DEVHWERROR
fwMedia
MEDIAJAMMED
Fatal
fwPaper
PAPEROUT
Fatal
fwToner
TONEROUT
Fatal
fwInk
INKOUT
Fatal
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-46
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Passbook Printer
XFS Device Status
XFS Device Element
XFS Element Value
S-Data
fwLamp
LAMPINOP
Fatal
fwRetractBin
RETRACTBINFULL
Fatal
all other cases
Fatal
Note 6: The value for TONEROUT is not set to fatal to ensure the
printer remains operable as it can perform other operations such as
reading the magnetic stripe or page number of the passbook.
Table B-73
Passbook Printer Replenishment
Information Mapping
XFS Device
Status
XFS Device Element
XFS Value
WFS_PTR_
STATUS
fwMedia
MEDIAPRESENT,
MEDIANOTPRESENT
fwMedia
MEDIAUNKNOWN
fwMedia
MEDIANOTSUPP
fwPaper
PAPERFULL
fwPaper
PAPERLOW
fwPaper
PAPEROUT
fwPaper
PAPERNOTSUPP
WFS_PTR_
STATUS
fwPaper
PAPERUNKNOWN
fwToner
TONERFULL,
TONERNOTSUPP
R-Data
Paper/Knife
See Note 7:
Ribbon
Paper
Ribbon
Printhead
See Note 8:
Capture bin
Good
Note 7: The status of paper and knife is always 0 for the passbook
printer.
Note 8: Printhead status is always reported as good; but on NCR
SSTs, the value is obtained from the Device Status Monitor (DSM).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-47
Status Mapping
Text Terminal Unit
Text Terminal Unit
The Text Terminal Unit Service Provider (TTU SP) interface is used
to display operator screens and get operator input from the operator
keyboard. The functioning of these devices is not reported to the
NDC host in the form of status messages. As the TTU SP interface is
not remotely monitored in an NDC application, no status mapping
is needed for the TTU device.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-48
APTRA Advance NDC Multi-Vendor Support Reference
B
Status Mapping
Sensors and Indicators Unit
Sensors and Indicators Unit
B
The Sensors and Indicators Unit (SIU) service, which covers various
SST sensors, is not part of the status handling unit. Advance NDC
monitors these sensors, but uses sensor workers in the Application
Core authored flow to manage status handling; therefore no status
mapping is needed for the SIU service.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-49
Status Mapping
Envelope Dispenser and Depository
Envelope Dispenser and Depository
The Depository Service Provider (DEP SP) interface covers both the
envelope dispenser (ID = 028) and the envelope depository
(ID = 006).
The following mapping tables are provided for the envelope
dispenser and depository:



Command completion
Event mapping
Severity mapping
Table B-74
XFS Command: DEP, all
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
The command has been successful and the depository is ready for
use
XFS Cmd HRESULT
T-Code
T-Code Explanation
ENVJAMMED
01
Error - the Depository is not operational
DEPFULL
01
Error
CONTMISSING
01
Error
ENVSIZE
01
Error
PTRFAIL
01
Error
SHTNOTCLOSED
01
Error
SHTNOTOPENED
01
Error
DEPUNKNOWN
01
Error
ERR_CANCELED
03
Good
ERR_TIMEOUT
00
Good
TONEROUT
00
Good
CHARSETNOT SUPP
01
Error
Other
01
Error
Table B-75
XFS Command: DEP_ENTRY
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-50
APTRA Advance NDC Multi-Vendor Support Reference
B
Status Mapping
Envelope Dispenser and Depository
Table B-76
XFS Command: DEP_RESET
XFS Cmd HRESULT
T-Code
T-Code Explanation
DEPFULL
01
Error
The Depository is not operational
DEPJAMMED
01
Error
CONTMISSING
01
Error
ENVJAMMED
01
Error
SHTNOTCLOSED
01
Error
SHTNOTOPENED
01
Error
Other
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
ENVEMPTY
01
Error - envelope not presented
ENVJAMMED
01
Error
SHTNOTOPEN
01
Error
Other
01
Error
XFS Cmd HRESULT
T-Code
T-Code Explanation
DEPFULL
01
Error
The envelope has not been retracted
DEPJAMMED
01
Error
CONTMISSING
01
Error
ENVJAMMED
01
Error
NOENV
02
Taken
The cardholder has taken the envelope
SHTNOTCLOSED
01
Error
Table B-77
XFS Command: DEP_DISPENSE
Table B-78
XFS Command: DEP_RETRACT
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-51
Status Mapping
Envelope Dispenser and Depository
XFS Cmd HRESULT
T-Code
T-Code Explanation
TONEROUT
00
Good
CHARSETNOT SUPP
01
Print FAILURE due to ANSI/UNICODE mismatch
Other
01
Error
Table B-79
Depository Event Mapping
XFS Event Prefix
XFS Event
Unsolicited Event
T-Code
EXEE_DEP_
ENVDEPOSITED
Deposit done
00
DEPOSITERROR
Deposit with access
04
ENVTAKEN
Deposit not done (depository)
Envelope taken (dispenser)
03
02
CONTINSERTED
N/A
—
CONTREMOVED
N/A
—
ENVINSERTED
N/A
—
MEDIADETECTED
N/A
—
DEPTHRESHOLD
N/A
—
TONERTHRESHOLD
N/A
—
ENVTHRESHOLD
N/A
—
SRVE_DEP_
USRE_DEP_
Table B-80
Depository Severity Mapping
XFS Device
Status
XFS Device Element
XFS Element Value
INF_DEP_
STATUS
S-Data
Depository
(006)
Dispenser
(028)
fwDevice
with one of:
DEVONLINE,
DEVBUSY
fwDepContainer
DEPFULL
DEPHIGH
No error
No error
fwToner
TONLOW
TONEMPTY
No error
No error
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-52
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Envelope Dispenser and Depository
XFS Device
Status
XFS Device Element
XFS Element Value
S-Data
fwEnvSupply
ENVLOW
ENVEMPTY
No error
No error
No error
No error
other cases
fwDevice
DEVUSERERROR
Suspend
Suspend
fwDevice
DEVPOWEROFF,
DEVOFFLINE,
DEVNODEVICE
Fatal
Fatal
fwDevice
with one of:
DEVHWERROR
fwDepContainer
DEPHIGH
DEPOK
No error
N/A
fwDepContainer
DEPINOP
DEPMISSING
DEPFULL
Fatal
N/A
fwDepTransport
DEPINOP
DEPUNKNOWN
Fatal
N/A
Depository
(006)
Dispenser
(028)
fwShutter
SHTOPEN,
SHTJAMMED,
SHTUNKNOWN
Fatal
N/A
fwEnvSupply
ENVOK
ENVLOW
N/A
No error
fwEnvSupply
ENVEMPTY
ENVINOP
ENVMISSING
N/A
Fatal
fwDispenser
ENVUNKNOWN
N/A
Fatal
fwEnvDispenser
ENVNOTSUPP
N/A
Fatal
fwPrinter
PTRINOP
PTRUNKNOWN
N/A
N/A
fwToner
TONLOW
TONEMPTY
No error
N/A
Warning
Warning
all other cases
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-53
Status Mapping
Envelope Dispenser and Depository
Table B-81
Depository Replenishment Information
Mapping
XFS Device Status
XFS Device Element
XFS Value
R-Data
fwDepContainer
DEPOK
Good
DEPFULL
Overfill
DEPHIGH
Low/High
DEPNOTSUPP
Good
ENVOK
Good
ENVLOW
Low
ENVEMPTY
Empty
ENVNOTSUPP
Good
all other cases
Good
TONOK
N/A
TONLOW
N/A
TONEMPTY
Empty
TONNOTSUPP
Good
all other cases
Good
INF_DEP_STATUS
Deposit
Dispenser
Printer toner
fwEnvSupply
fwToner
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-54
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Night Safe
Night Safe
B
The following mapping tables are provided for night safes:




Command completion
Event mapping
Severity mapping
Replenishment information mapping
Table B-82
XFS Command: DEP, all
XFS Cmd HRESULT
T-Code
T-Code Explanation
WFS_SUCCESS
00
The command has been successful and the night safe is ready for
use
XFS Cmd HRESULT
T-Code
T-Code Explanation
DEPFULL
01
Error
CONTMISSING
01
Error
SHTNOTCLOSED
01
Error
SHTNOTOPENED
01
Error
DEPUNKNOWN
01
Error
ERR_CANCELED
03
Good
ERR_TIMEOUT
01
Error
Other
01
Error
Table B-83
XFS Command: DEP_ENTRY
Table B-84
Night Safe Event Mapping
XFS Event Prefix
XFS Event
Unsolicited Event
T-Code
EXEE_DEP_
ENVDEPOSITED
N/A
—
DEPOSITERROR
006: Deposit with access
01
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-55
Status Mapping
Night Safe
XFS Event Prefix
XFS Event
Unsolicited Event
T-Code
SRVE_DEP_
CONTINSERTED
N/A
—
CONTREMOVED
N/A
—
DEPTHRESHOLD
N/A
—
USRE_DEP_
Table B-85
Nigh Safe Severity Mapping
XFS Device
Status
XFS Device Element
XFS Element Value
S-Data
fwDevice
with one of
DEVONLINE,
DEVBUSY
fwDepContainer
DEPHIGH
Warning
fwDepContainer
DEPINOP
DEPMISSING
Fatal
fwDepContainer
ENVLOW
ENVEMPTY
No error
fwDevice
DEVPOWEROFF,
DEVOFFLINE,
DEVNODEVICE
Fatal
fwDevice
with one of:
DEVHWERROR
fwDepContainer
DEPHIGH
DEPFULL
Warning
fwDepContainer
DEPINOP
DEPMISSING
Fatal
all other cases
Warning
XFS Device Element
XFS Value
R-Data
fwDepContainer
DEPOK
Good
DEPHIGH
Good
NSD_DEP_
Table B-86
Night Safe Replenishment Information
Mapping
XFS Device Status
INF_NSD_STATUS
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-56
APTRA Advance NDC Multi-Vendor Support Reference
Status Mapping
Night Safe
XFS Device Status
XFS Device Element
XFS Value
R-Data
DEPFULL
Overfill
DEPNOTSUPP
Good
all other cases
Good
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
B-57
Status Mapping
Night Safe
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-58
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Printer Data — Control Codes and Registry Settings
Appendix C
Printer Data — Control Codes and
Registry Settings
Overview
C-1
Printer Control Sequences
C-2
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Table of Contents
Printer Data — Control Codes and Registry Settings
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Printer Data — Control Codes and Registry Settings
Overview
C
Overview
C
This appendix gives details of the support provided for the
Advance NDC printer controls described in the APTRA Advance
NDC, Reference Manual.
Each printer control that has an entry in the registry will be
converted as it is received in the print data stream from the host.
Additional registry settings are provided to help with
vendor-specific configuration requirements.
For more information about configuring printers on other vendors’
SSTs, see “Printer Data” on page 2-8.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
C-1
Printer Data — Control Codes and Registry Settings
Printer Control Sequences
Printer Control Sequences
The control codes for all receipt and journal printers are stored in
subkeys under the following registry keys:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\DEPOSIT
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\JOURNAL
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\RECEIPT
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\STATEMENT
Table C-3, “Printer Control Sequences Registry Settings”, gives
details of the printer control sequences. The table uses the following
headings:
Table C-1
Table Headings
Heading
Description
Control
Name of the control sequence
Registry name
Registry key name for the sequence
Hex value
The NCR value for an NDC printer
ASCII value
The ASCII equivalent. If this is shown as a long
dash (—), it cannot be represented
Var description
Description of the 'var' part of the registry string
value. If this is shown as a long dash (—), it does
not apply to the registry entry.
The control sequences take the format of hexadecimal digits
separated by spaces. The term ‘var’ is used to denote a variable
retrieved from the original Advance NDC sequence. For example,
for the Advance NDC sequence LEFT_MARGIN = ESC [ 10 p, the
conversion process to set the left margin is as follows:
1
The host sends print data containing the Advance NDC control
sequence 1B 5B var 70, in which the value of var is the part
that is transferred to the new sequence.
2
The conversion DLL takes the setting for the left margin from
the registry LEFT_MARGIN key, which is defined as 1B 6B var
for a particular vendor’s hardware.
3
The conversion DLL sends ESC k 10 to the print device.
If a sequence is not defined or the definition is empty, the sequence
will be removed from the output data sent to the print device. The
sequences are defined in the registry for each printer type.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
C-2
APTRA Advance NDC Multi-Vendor Support Reference
C
Printer Data — Control Codes and Registry Settings
Printer Control Sequences
The following tables give details of the registry settings for printing.
Not all printer types have all the settings.
Table C-2
Printer Registry Settings
Setting
Description
AddCR
Set to TRUE for printers that require a CR to clear the
buffer. The default setting is TRUE.
WIDTH
All prints are wrapped at the column (right margin)
specified by this registry setting. See “Paper Width”
on page 2-9. The default setting is 40.
LENGTH
The printable length of the paper standard characters.
For receipts, this should normally be set to over 50 to
accommodate NDC normal (24 line) and double (49
lines) receipts. It is provided for printers that can only
accommodate less than these limits. The default
setting is 50
For statements, the default LENGTH value is 12. If you
have a statement printer, check the configuration of
the media and statement printer data and update this
value accordingly. Using the default performs a form
feed and cut every 12 lines, potentially leading to
multi-part statements. The maximum setting for this
value is 92.
debug
When set to 1, a trace of the conversion process
appears in C:\Program Files\NCR APTRA\Advance
NDC\Rprint.log. This is for debugging the conversion
process only and is not intended for live installations.
The default setting is 0.
BUFFER_SIZE
The upper limit of any print data intended to be
printed at one time. This value should not exceed the
buffer capacity of the printer SP. If this setting is not
defined, the default is 3000 characters.
CPI
Characters per inch. For printers that do use columns
for margin setting, must match printer settings
DPI
Dots per inch. For printers that do not use columns for
margin setting, must match printer settings.
dllname
The conversion DLL to The default is
MVNDCprinters.dll
ProcessK
screens
Determines whether to passes printer data straight to
the service provider for processing without going
through the conversion routine.Set to 0 if K screens
contain vendor-specific codes. The default setting is 1.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
C-3
Printer Data — Control Codes and Registry Settings
Printer Control Sequences
Table C-3
Printer Control Sequences Registry
Settings
Hex Value
(NDC Code)
Control
Registry Name
Header
HEADER
Sequence added
before any print
data.
The sequence is not
processed by
Advance NDC, and
must therefore use
the printer’s native
escape sequences
Footer
FOOTER
Sequence added
after any print data.
The sequence is not
processed by
Advance NDC, and
must therefore use
the printer’s native
escape sequences
Line-feed
character
LINE_FEED
0A
—
—
Form-feed
character
FORM_FEED
0C
—
—
Carriage return
character
CR
0D
—
—
Horizontal tab
character
HT
09
—
—
Set left margin
LEFT_MARGIN
1B 5B var 70
ESC [ var p
Column position of
the left margin in
standard characters,
typically between 1
and 39
Set right margin
RIGHT_MARGIN
1B 5B var 71
ESC [ var q
Column position of
the right margin in
standard characters,
typically between 1
and 39
Select OS2 code
page
OS2_CODE_PAGE
1B 25 var
ESC % var
Code page number
ASCII Value
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
C-4
APTRA Advance NDC Multi-Vendor Support Reference
Var Description
Printer Data — Control Codes and Registry Settings
Printer Control Sequences
Control
Registry Name
Hex Value
(NDC Code)
ASCII Value
Var Description
Select
international
character set
INTR_CHAR_SET
1B 32
ESC 2
—
Select Arabic
character set
ARAB_CHAR_SET
1B 33
ESC 3
—
Print
downloaded bit
image
BIT_IMAGE
1B 2F var
ESC / var
Bit image identifier /
bit image size
Print barcode
BARCODE
1B 6B var 1B 5C,
ESC k 3xh var ESC \
Barcode type and
barcode data
Print graphics
file
GRAPHICS
1B 47 var 1B 5C
ESC G var ESC \
Path and name of
graphics file
Select primary
character set G0
SHIFT_IN
0E
—
—
Select secondary
character set G1
SHIFT_OUT
0F
—
—
Select character
set as active set
G0
CHAR_SET1
1B 28 var
ESC ( var
Character set
number
Select character
set as active set
G1
CHAR_SET2
1B 29 var
ESC ) var
Character set
number
Define character
set
DEF_CHAR_SET
1B 26 var 1B 5C
ESC & var ESC \
Path/filename
containing the
character set
definition
Define character
set
DEF_BIT_IMAGE
1B 2A var 1B
5C
ESC * var ESC \
Bit image ID and the
path/filename
containing the
definition
Position of
human-readable
characters
(for barcode)
POS_HRI_CHAR
1B 65 var
ESC e var
Position of characters
HZ_HGHT_BARCODE
1B 68 var
ESC h var
Height in dots
See Table Note 1:
and Table Note
2:
Height of
barcode
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
C-5
Printer Data — Control Codes and Registry Settings
Printer Control Sequences
Control
Registry Name
Hex Value
(NDC Code)
ASCII Value
Var Description
Width of
barcode
WIDTH_BARCODE
1B 77 var
ESC w var
Width in dots
Form length
SET_FORM_LEN
1B 5B var 73
ESC [ var s
Length of form in
rows
Cut
(and feed on
some printers)
CUT
11
—
—
Sideways mode
on
SW_ON
1D
—
—
Sideways mode
off
SW_OFF
1E
—
—
Vertical tab
VERT_TAB
0B var
—
Number of lines to
advance
Set extra dot
rows
EXTRA_DOT_ROW
1B 5B var 72
ESC [ var r
Number of extra
rows
Set line spacing
LINE_SPACE
1B 5B var 74
ESC [ var t
Line spacing
Set first line
position
FIRST_LINE_POS
1B 5B var 75
ESC [ var u
First line position
Table Note 1: The default setting is empty so it is not processed
Table Note 2: If the barcode does not fit on the line, a partial
barcode is printed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
C-6
APTRA Advance NDC Multi-Vendor Support Reference
Glossary
Glossary
A
0
ActiveXTM ActiveX from Microsoft is a set of technologies built on
two Microsoft architectures: object linking and embedding (OLE),
and the Component Object Model (COM). It enables the sharing of
information among different software applications in a networked
environment.
ACU Agilis configuration utility.
ADE Application Development Environment.
Advance ADE An application development environment from NCR.
Advance ADE is no longer available as a separate product, but the
APTRA Author is used in Advance NDC development.
ADI2 Application Device Interface 2. A proprietary interface from
NCR. Superseded by XFS.
Application An application is a collection of Workers that can be
built to create an executable.
Application Core The part of Advance NDC that performs the SST
mode handling and message processing. For details of the
Application Core worker classes, refer to the on-line help.
APTRA Author A tool that allows you to design and develop a
self-service application.
Authoring Component The smallest manageable unit in the Author.
Examples are Workers, Applications and Catalogs.
B
C
BNA Bunch Note Acceptor.
Cardholder The SST customer.
Cassette type A logical representation of one or more cassettes (also
known as cash units) containing the same type of media; for
example, NDC cassette type 1.
See also: NDC Cassette Type and XFS Cash Unit.
Cassette Unit Identifier A unique identifier for the cassette. Also
known as CUID or cassette unit ID.
Catalog A component in the APTRA Author for organising all the
other Authoring components into manageable groups.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Glossary-1
Glossary
CCM Communications Connection Manager. An APTRA
component providing a layer of software to separate an application
from the underlying communications protocol.
CDI Common Data Interface.
CDI Store In Advance NDC, a data element that is shared by the
Customisation Layer, Application Core and Supervisor
applications. CDI stores are created and initialised by the Advance
NDC runtime program.
CDM Cash Dispenser Module. CEN-XFS class name for the Cash
Dispenser service.
CEN Comité Européen de Normalisation (European Committee for
Standardization) Responsible for the XFS interface specification.
Central Application An application that resides on a host computer or
switch and interacts with Advance NDC on the SST to manage
self-service transactions and maintain the SST in operation.
CIM Cash-In Module. A device that allows a consumer to deposit
banknotes.
COM Microsoft Component Object Model. An open architecture for
cross-platform development of client/server applications based on
object-oriented technology. Clients have access to an object through
interfaces implemented on the object (access to Methods, Properties
and Events).
CPM Cheque Processing Module. An NCR device.
Currency Medium of exchange in a country, for example American
dollars (USD) or British pounds (GBP).
D
D4x Diebold SST model used in the Indian and South American
markets.
DCCMT Dispenser Currency Cassette Mapping Table.
Customisation data sent in a message from Central and distinct
from the currency table held in the registry of the SST.
Denomination The values of the monetary units in a series as defined
by the combination of value, currency and media type.
DEP Depository. CEN-XFS class name for the Depository service.
DES Data Encryption Standard. An information processing
standard for computer security, issued by the National Bureau of
Standards, United States.
DES encryption, Triple See Triple DES Encryption.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Glossary-2
APTRA Advance NDC Multi-Vendor Support Reference
Glossary
Diebold A company offering self-service banking solutions and
SSTs.
DLL A Dynamic-Link Library. A library that can be linked at
execution time.
DSM Device Status Monitor. Part of the NCR Self-Service platform.
E
EMV Europay, Mastercard and VISA. Specifications for payment
systems to ensure interoperability between smart credit/debit cards
and interoperability between the terminals that support them,
jointly created and published by Europay International, MasterCard
and Visa International in 1996.
EOP Enhanced Operator Panel. An NCR device.
EPP Encrypting PIN Pad. A combined encryptor and PIN pad,
supporting triple DES encryption.
Exits A general programming term covering user-defined states,
supervisor features, virtual controllers and special synchronisation
routines.
F
Fault Display This gives information to allow you to anticipate and
prevent media shortages and device failures.
FDK Function Display Key. These keys are located on each side of
the facia screen and enable various options to be chosen. Some
screens have touch screen areas which emulate FDK functions.
G
H
I
GOP Graphical Operator Panel.
HKLM HKEY_LOCAL_MACHINE. Predefined key in the registry.
ID Identifier.
IDC Identification Card unit. CEN-XFS class name for the
Identification Card Units service.
IX An SST model from Diebold.
K
L
KVV Key Verification Value. A value that can be recomputed using
a key to validate that the key has not been changed.
LFCC Latch fast card capture. The latch fast card capture bin is an
optional closed metal container mounted behind the MCRW. It has
a sealable access door and a mechanically operated lockout lever
that prevents any unauthorised removal of captured cards when the
LFCC is free of its mounting.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Glossary-3
Glossary
M
M-Data Maintenance Data.
Media Type The CEN-XFS identifier for classes of cassette such as
deposit cassettes or recycling cassettes.
M-Status Maintenance Status.
MCRW Magnetic Card Reader/Writer. It reads data from a standard
magnetic stripe card and, depending on the MCRW variant, writes
data to one or more of the tracks on the card’s magnetic stripe.
MEI Media Entry/Exit Indicator.
Multi-Vendor Application An Advance NDC application capable of
running on SSTs that comply with the CEN-XFS specifications.
N
NDC NCR Direct Connect. An NCR application that works in
conjunction with a host- or switch-based Central application to
perform self-service transactions.
NDC Cassette Type The logical cassette representation used by
Advance NDC; for example, NDC cassette type 1.
See also: Cassette type and XFS Cash Unit.
O
OEM Original Equipment Manufacturer.
OLE Object Linking and Embedding. An architecture for enabling
one application to insert and access objects created in another
application.
OOXFS Object oriented eXtended Financial Systems.
Opteva An SST model from Diebold.
P
PCI Payment Card Industry.
PIN Personal Identification Number. A secret identification number
that is issued to each cardholder.
PED PIN Entry Device. A device used for secure PIN entry and
processing.
PPD Programmable Printing Depository. A type of printer
supported by Advance NDC. Also called Envelope Depository.
ProDevice The interpretation of the CEN-XFS standard
implemented by Wincor-Nixdorf.
PTR CEN-XFS class name for the Printers service.
R
R-Data Replenishment Data.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Glossary-4
APTRA Advance NDC Multi-Vendor Support Reference
Glossary
RESRVD.DEF ASCII text file containing definitions for reserved
screens and keyboards, provided as part of APTRA Advance NDC.
For details, refer to the APTRA Advance NDC, Reference Manual.
RPTR CEN-XFS class name for the Receipt Printers service.
S
S-Data Severity Data.
Service Provider A software layer responsible for hardware
abstraction and providing applications with transparent access to
services.
SIU Sensors and Indicators Unit.
SST Self-Service Terminal.
SP See Service Provider.
Supervisor The Supervisor application in Advance NDC performs
the SST supervisor functions. Refer to the on-line help for details of
the Supervisor worker classes.
T
T-Code Transaction Code.
TCP/IP Transmission Control Protocol/Internet Protocol. The open
communications standard for the Internet.
TI Tamper Indication.
Triple DES Encryption DES encryption performed three times in
succession for greater security.
See also: DES Encryption
TTU Text Terminal Unit.
V
Value In the definition of currency, the worth of the media.
VDA Vendor-Dependent Application.
VDM Vendor-Dependent Mode.
W
Wincor-Nixdorf A company offering self-service banking solutions
and SSTs.
Work Flow In APTRA Author, a work flow allows workers to
communicate across work groups by associating two work groups.
It specifies the flow of control from one work group to another.
X
XFS EXtensions for Financial Services. Application and service
provider interface specifications from CEN.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Glossary-5
Glossary
XFS Cash Unit The logical cassette representation used by XFS; for
example, XFS logical type 1.
See also: Cassette type and NDC Cassette Type.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Glossary-6
APTRA Advance NDC Multi-Vendor Support Reference
Index
Index
A
B
C
0
Abbreviations in the publication xxviii
Accessing wiki pages 6-1
Advance NDC
configuring printer data 3-10
configuring screen data 3-2
configuring status handling 3-10
multi-vendor support 1-2
product class 3-10
starting the application on an SST 5-5
Advance NDC features in a multi-vendor environment, overview 2-1
Application compatibility 1-3
Applications
Central 3-10
Terminal 3-2
APTRA Security
Wincor 6-17
Audience xxv
Author
documentation A-3
Barcode reader
command completion mapping B-25
status mapping B-25
Bunch cheque acceptor
status mapping B-31
Card reader
command completion mapping B-16
event mapping B-19
replenishment information mapping B-20
severity mapping B-19
Wincor configuration 6-10
Card variants 2-12
Cash dispenser
See Currency dispenser
Cash handler, configuring 3-11
Cassette configuration
Diebold 6-3
Wincor 6-10
CDM SP and currency cassettes mapping table 3-12
CDM_DISPENSE B-3, B-25
coin B-12
CDM_PRESENT B-5
CDM_REJECT B-7
CDM_RETRACT B-6
Central application 3-10
Central to Terminal messages
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Index-1
Index
enhanced configuration parameters load 2-14
Terminal commands 2-14
transaction reply command 2-14
Certificates for RKM 6-4
CLR CARDS menu option 2-20
CLR CASH menu option 2-19
Coin dispenser
cash TI mapping B-14
command completion B-12
counters B-15
event mapping B-13
replenishment information mapping B-14
severity mapping B-13
status mapping B-12
Coin dispenser, counter updates B-15
Command completion mapping
barcode reader B-25
card reader B-16
coin dispenser B-12
CPM B-26
envelope dispenser and depository B-50
PIN pad B-21, B-55
printers B-37, B-42
Receipt and journal printers B-32
Common issues
Diebold 6-7
Wincor 6-15
Communications
configuring 3-8
protocols 1-3
Compatibility of applications 1-3
Configuration
cash handler 3-11
Central application 3-10
currency cassettes 3-12
Diebold cassettes 6-3
Diebold operator panel 6-4
Diebold printers 6-4
first time on an SST 5-2
paper width 2-9
printer data 2-8, 3-10
product class 3-10
receipt printer 2-8
service providers 5-4
Supervisor entry/exit on Wincor 6-13
Terminal application 3-2
Wincor card readers 6-10
Wincor cassettes 6-10
Wincor MEI 6-13
Wincor operator panel 6-13
Wincor printers 6-12
Configure menu 2-20
Configuring the multi-vendor environment, overview 3-1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-2
APTRA Advance NDC Multi-Vendor Support Reference
Index
Contents, publication xxvi
CPM
command completion mapping B-26
replenishment information mapping B-29
severity mapping B-28
status mapping B-26
CRT/EOP layout 2-11
Currency cassettes
dispenser mapping table downloaded from Central 2-14
mapping table in registry 3-12
physical cassettes mapping table in registry 3-15
registry keys 3-12
Currency dispenser
cash counters B-10
cash tamper indication mapping B-10
counter updates B-11
event mapping B-7
replenishment information mapping B-9
severity mapping B-8
status mapping B-3
Customising cash handling 3-17
D
E
Default platform installation 6-1
DEP_CLEAR_TRANSPORT B-51
DEP_DISPENSE B-51
DEP_ENTRY B-50
DEP_RETRACT B-51
Depository
envelope printing 2-9
event mapping B-52
replenishment information mapping B-54
severity mapping B-52
Device access 2-5
Device status messages 1-3
Devices, fault reporting 2-20
Diebold
91x download 6-5
cassette configuration 6-3
collecting logs 6-7
common issues 6-7
decoding status messages 6-6
platform installation 6-3
printer configuration 6-4
starting platform 6-5
Vendor Dependent Mode 6-5
DISP CASH menu option 2-19
DISP CNTRS menu option 2-19
Dispenser currency cassettes mapping table, downloadable 2-14
Document contents xxvi
Encryptor configuration
Diebold 6-4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Index-3
Index
Wincor 6-12
Enhanced configuration
parameter for printers 2-9
parameters load 2-14
Envelope depository
printing 2-9
Envelope dispenser and depository
command completion mapping B-50
event mapping B-52
replenishment information mapping B-54
severity mapping B-52
EOP/CRT layout 2-11
Error reporting 2-20
Event mapping
card reader B-19
coin dispenser B-13
currency dispenser B-7
depository B-52
PIN pad B-23
printers B-39
Receipt and journal printer B-34
Exception reporting 2-20
F
G
I
FDK alignment 3-3
Files
RESRVD.DEF 2-7
RESRVD.DEF, screen size limitation 2-11
Functionality of applications 1-3
Graphics, limitations for printing 2-10
IDC_CHIP_IO B-17
IDC_EJECT_CARD B-18
IDC_RETAIN_CARD B-18
IDC_WRITE_RAW_DATA B-17
Incoming messages 1-3
Initial configuration on an SST 5-2
Installing
default platform 6-1
Diebold platform 6-3
Wincor platform 6-9
Introduction to Advance NDC multi-vendor support 1-1
J
Journal printer
registry settings 2-9
K
K Screens 2-10
Knowledge and experience required xxv
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-4
APTRA Advance NDC Multi-Vendor Support Reference
Index
L
M
N
O
Logs
collecting Diebold 6-7
collecting Wincor 6-16
general 6-2
other vendors 6-2
Mapping tables
currency cassettes in registry 3-12
downloadable dispenser currency cassettes 2-14
physical cassettes in registry 3-15
MCRW, Security jitter 2-14
Media Entry Indicator configuration
Wincor 6-13
Menus
Configure 2-20
Fault Display 2-16
Misc Funcs 2-18
Replenish 2-18
Messages
device fault 2-12
device status 1-3
enhanced configuration parameters load 2-14
incoming 1-3
outgoing 1-3
solicited status 2-12
Supervisor 2-11
unsolicited 2-12
Misc Funcs menu 2-18
Multi-vendor configuration, overview 3-1
Multi-vendor support 1-2
MV diagnostics menu 2-16
NCR documentation, other A-6
Night safe mappings B-55
Operator panel configuration
Diebold 6-4
Operator panel screen layout 2-7
Other vendors
default platform installation 6-1
Diebold 6-3
logs 6-2
troubleshooting 6-1
Wincor 6-9
Outgoing messages 1-3
Overviews
Advance NDC features in a multi-vendor environment 2-1
configuring the multi-vendor environment 3-1
installation on an SST 4-1
printer control codes C-1
SST initial configuration 5-1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Index-5
Index
status mapping B-1
P
R
Paper width, configuration 2-9
Physical cassettes mapping table 3-15
PIN pad
command completion mapping B-21, B-55
event mapping B-23
severity mapping B-23
PIN_CRYPT B-21
PIN_GET_PIN B-22
PIN_IMPORT_KEY B-21
PIN_LOCAL_VISA B-22
Platform
starting Diebold 6-5
starting Wincor 6-14
Print data on other vendors’ hardware 2-11
Printer code pages 2-11
Printer configuration
Diebold 6-4
Wincor 6-12
Printer control codes, overview C-1
Printer data
configuring 2-8, 3-10
K screens 2-10
receipt and journal printers 2-8
Statement printer 2-10
Printers
command completion mapping B-37, B-42
event mapping B-39
graphics limitations 2-10
registry settings 2-9
replenishment information mapping B-41, B-47
severity mapping B-40, B-46
PRNT SCRW VERS 2-18
Product class 3-10
Programmable printing depository (PPD) 2-9
Protocols, communications 1-3, 3-8
PTR_CONTROL_MEDIA B-26, B-32, B-37, B-43
PTR_PRINT_FORM B-33, B-38, B-43, B-45
PTR_RAW_DATA B-32, B-37, B-42
Publication
Abbreviations xxviii
Contents xxvi
Using xxvii
Receipt and journal printers
Command completion mapping B-32
command completion mapping B-37
Event mapping B-34
event mapping B-39
Replenishment information mapping B-35
replenishment information mapping B-41, B-47
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-6
APTRA Advance NDC Multi-Vendor Support Reference
Index
Severity mapping B-34
severity mapping B-40, B-46
Receipt printer
configuration 2-8
registry settings 2-9
Registry keys
currency cassettes mapping table 3-12
initial configuration on the SST 5-2
physical cassettes mapping table 3-15
Registry settings
currency cassettes 3-12
printers 2-9
Related documentation
overview A-1
Replenish menu 2-18
CLR CARDS 2-20
CLR CASH 2-19
DISP CASH 2-19
DISP CNTRS 2-19
Replenishment information mapping
CPM B-29
depository B-54
printers B-41, B-47
Receipt and journal printers B-35
Reports
errors and exceptions 2-20
Reserved screen layouts 3-2
RESRVD.DEF
screen layouts 2-7
screen size limitations 2-11
S
Screen data
configuring 2-7, 3-2
operator panel screen layout 2-7
Screen resolution 6-14
Security jitter 2-14
Select menu
MV DIAG 2-16
Sensors and indicators unit B-49
Service providers
initial configuration on the SST 5-4
Severity mapping
card reader B-19
coin dispenser B-13
CPM B-28
currency dispenser B-8
depository B-52
PIN pad B-23
receipt and journal printers B-34
statement printer B-40, B-46
Solicited status messages 2-12
card variants 2-12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Index-7
Index
device fault 2-12
SST set-up 5-2
Statement printer
mappings B-37
Status mapping 3-10
barcode reader B-25
bunch cheque acceptor B-31
coin dispenser B-12
CPM B-26
currency dispenser B-3
envelope dispenser and depository B-50
PIN pad B-21
printers B-37
Status messages
decoding Diebold 6-6
decoding Wincor 6-15
Status messages, unsolicited 2-12
Supervisor entry/exit configuration
Wincor 6-13
Supervisor messages 2-11
CRT/EOP layout 2-11
printer layout 2-11
screen size limitations 2-11
T
U
V
TCP/IP 1-3
Terminal application 3-2
Terminal commands 2-14
Terminal to Central messages
device status information 2-13
solicited status messages 2-12
Text terminal unit (TTU) B-48
Transaction reply command 2-14
Troubleshooting 6-1
common Diebold issues 6-7
common Wincor issues 6-15
logs 6-2
vendor 6-2
Unsolicited status messages 2-12
Using the publication xxvii
Vendor Dependent Mode
Diebold 6-5
Wincor 6-15
Vendor-independent Advance NDC
configuring currency cassettes 3-12
Verifying
Diebold platform 6-3
Wincor platform 6-9
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-8
APTRA Advance NDC Multi-Vendor Support Reference
Index
W
X
Wiki pages, accessing 6-1
Wincor
APTRA Security 6-17
card reader configuration 6-10
cassette configuration 6-10
collecting logs 6-16
common issues 6-15
MEI configuration 6-13
operator panel configuration 6-13
platform installation 6-9
printer configuration 6-12
starting platform 6-14
Supervisor entry/exit configuration 6-13
Vendor Dependent Mode 6-15
XFS command
CDM_DISPENSE B-3, B-25
CDM_DISPENSE, coin B-12
CDM_PRESENT B-5
CDM_REJECT B-7
CDM_RETRACT B-6
currency dispenser, all except PRESENT B-3
DEP_CLEAR_TRANSPORT B-51
DEP_DISPENSE B-51
DEP_ENTRY B-50
DEP_RETRACT B-51
depository, all B-50, B-55
IDC_CHIP_IO B-17
IDC_EJECT_CARD B-18
IDC_RETAIN_CARD B-18
IDC_WRITE_RAW_DATA B-17
night safe B-55
PIN pad, all B-21
PIN_CRYPT B-21
PIN_GET_PIN B-22
PIN_IMPORT_KEY B-21
PIN_LOCAL_VISA B-22
PTR_CONTROL_MEDIA B-26, B-32, B-37, B-43
PTR_PRINT_FORM B-33, B-38, B-43, B-45
PTR_RAW_DATA B-32, B-37, B-42
receipt and journal printers B-32
statement printer B-37, B-42
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC Multi-Vendor Support Reference
Index-9
Index
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-10
APTRA Advance NDC Multi-Vendor Support Reference
Cut
User Feedback Form
Title:
Multi-Vendor Support Reference Manual
Number:
B006-6344-H000
Release: Issue 1
Date: January 2013
NCR welcomes your feedback on this publication. Your comments can be of great value in helping us improve
our information products.
You may send your comments to us electronically. See over for details.
Circle the numbers below that best represent your opinion of this publication.
Ease of use
5
4
3
2
1
0
Accuracy
5
4
3
2
1
0
Clarity
5
4
3
2
1
0
Completeness
5
4
3
2
1
0
Organisation
5
4
3
2
1
0
Appearance
5
4
3
2
1
0
Examples
5
4
3
2
1
0
Illustrations
5
4
3
2
1
0
Job performance
5
4
3
2
1
0
Question resolution
5
4
3
2
1
0
Overall satisfaction
5
4
3
2
1
0
5 = Excellent
4 = Good
3 = Adequate
2 = Fair
1 = Poor
0 = Not applicable
Indicate the ways you feel we could improve this publication.




Improve the table of contents
Improve the overview/introduction
Improve the organisation
Improve the index
 Make it less technical
 Make it more concise/brief




Add more/better quick reference aids
Add more examples
Add more illustrations
Add more step-by-step procedures
 Add more troubleshooting information
 Add more detail
Write any additional comments you may have below and on additional sheets, if necessary. Include page
numbers where applicable.
Use the following addresses to send your comments to us electronically:
E-mail - sf230067@ncr.com
Cut
Web (within firewall) - http://www.dundee.ncr.com/infoprod/rcomment/newform/webform99.htm
Fold
If we may contact you concerning your comments, please fill in the information below:
Name:
Organisation:
Company:
Address:
Phone:
Fax:
Thank you for your evaluation of this publication. Fold the form where indicated, tape (please do not staple),
and drop in the mail.
F 8763-0695
Fold
Affix
Postage
Stamp
Here
NCR Financial Solutions Group Ltd.
Information Solutions Feedback
Discovery Centre
3 Fulton Road
Dundee, Scotland
DD2 4SW