Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Multi-Vendor Support
Reference Manual
B006-6344-H000
Issue 1
January 2013
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.
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.
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
Canadian Class A Device noise emissions from digital apparatus set out in the Radio
Declaration Interference Regulations of the Canadian Department of
Communications.
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.
Revision Record
Contents
Preface
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
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
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
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
Appendix C
Printer Data — Control Codes and Registry Settings
Glossary
Glossary .................................................................................... Glossary-1
Index
Index................................................................................................Index-1
List of Figures
Chapter 2
Support for Advance NDC Features
Chapter 3
Configuring the Multi-Vendor Environment
Chapter 6
Advance NDC on Specific Vendors’ SSTs
List of Tables
Chapter 2
Support for Advance NDC Features
Chapter 3
Configuring the Multi-Vendor Environment
Chapter 5
Setting up the Terminal
Chapter 6
Advance NDC on Specific Vendors’ SSTs
Appendix A
Related Documentation
Appendix B
Status Mapping
Appendix C
Printer Data — Control Codes and Registry Settings
You should be familiar with Advance NDC and the Advance NDC
Knowledge and publications listed above. If you intend to modify or customize
Experience Advance NDC, you will need to be familiar with the CEN-XFS
interface specification and be experienced in programming to the
XFS interface.
If you are new to Advance NDC, NCR recommends that first you
How to Use the read the APTRA Advance NDC, Overview, B006-6597, for an
Publication 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.
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.
Table of Contents List the first two heading levels in page order with
page references.
Table of Contents Lists the first three heading levels in page order
for chapter or with page references.
appendix
Element Description
HKEY_LOCAL_MACHINE HKLM
Chapter 1
Introducing Multi-Vendor Support
in Advance NDC
Overview 1-1
Overview
Overview 1
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”.
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”.
Chapter 2
Support for Advance NDC Features
Overview 2-1
Overview
Overview 2
Device Support 2
C F2
E F3
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
D F2
F F3
A F5
C F6
E F7
On NCR GBXX and single note acceptor (SNA) devices, notes can be
Cash Acceptors 2
Except for items in the following table, data sources for printer
Supplies Data Sources 2
Table 2-3
Supplies Data on Other Vendors’ SSTs
Device ID Device Name Supplies Data Data source on Other Vendors SSTs
Fitness data sources are the same on other vendors’ SSTs as on NCR
Fitness Data Sources 2
SSTs.
Device Access 2
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
Screen Data 2
Reserved screen layouts, which are unique for the size of the
Reserved Screen Layout operator panel, are defined in an ASCII file. This file must conform
for the Operator Panel 2
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.
Printer Data 2
Receipt Printer 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
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
Envelope Printing 2
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.
Statement Printer 2
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.
Supervisor Messages 2
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
Device Fault 2
Card Variants 2
Function Identifier
Printer Data Field.
Function Identifier 2
Supervisor Mode 2
0 CLEAR ALL
26 FAULT DISPLAY 91 SHUTDOWN
SELECT FUNCTION-
Table 2-7
MV Diagnostics Options
Select... To...
0 Clear all devices that are installed and configured on the SST
26 Display the Fault Display screen. For further information on Fault Display,
refer to 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
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.
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
Note: This does not clear the encryption keys. For details of the encryption keys
refer to the APTRA Advance NDC, Developer’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
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
PRINT CNTRS 2
CLR CARDS 2
GBXX CONFIG 2
Chapter 3
Configuring the Multi-Vendor
Environment
Overview 3-1
Overview
Overview 3
Terminal Application 3
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
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
The following illustration shows how a screen could look when the
fonts need to be reduced:
Figure 3-1
Screen without Font Adjustment
The following illustration shows how the same screen could look
with the font reduced:
Figure 3-2
Screen with Font Adjustment
the font with a designator of "1" will be reduced in size for all
screens.
The original font definition in the DisplayManagerConfig.xml file is as
follows:
<font id="1" 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" />
<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
Table 3-1
Rescaling Activation Properties
Property Description
HKLM\SOFTWARE\NCR\Advance
NDC\Supervisor\Diagnostics\MVDiagnostics
For details of the menus, see “MV Diagnostics Menu” on page 2-16.
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
HKLM\SOFTWARE\NCR\Advance NDC\
supervisor\ModeSwitchRegStatus
— 0 for Run
— 1 for Supervisor.
For devices that are in a suspend state, Advance NDC will attempt
Suspend Timeouts 3
Central Application 3
The print data is passed through a conversion DLL before being sent
Printer Data 3
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.
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.
The cassettes mapping table maps the XFS currency ID, media type,
Currency Cassettes value and cassette unit identifier to NDC cassette types.
Mapping Table 3
The currency ID, media type, value and cassette unit identifier can
be mapped to NDC cassette types through the following methods:
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
Currency Cassette Types types must be set as follows:
Registry Settings 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
Table 3-2
NDC Cassette Type Mapping to XFS Cash
Unit
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.
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.
Table 3-3
Invalid Currency ID and Value
Table 3-4
Invalid Voucher Types
HKLM\SOFTWARE\NCR\Advance NDC\PhysicalCassettes
Note: The mapping table includes an entry for the reject bin. This
setting is used by device status handling.
Test Cash 3
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
If cash counters are not set, then a request from the host to dispense
Cash Counters 3
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.
Chapter 4
Delivering an Advance NDC
Application to an SST
Overview 4-1
Overview
Overview 4
Any files that you have to modify for your SST environment, such
Modifying Files and as additional script or command files, must be included in the
Components 4
Advance NDC aggregate. For information about where to place
modified files for an aggregate, refer to the APTRA Advance NDC,
Developer’s Guide.
This section describes the differences that apply when building and
testing a multi-vendor application on your development PC.
Chapter 5
Setting up the Terminal
Overview 5-1
Overview
Overview 5
Initial Configuration 5
Registry Keys 5
The following table lists the registry keys provided for Advance
NDC under
HKLM/SOFTWARE/NCR/Advance NDC
Service Providers 5
Miscellaneous Configuration 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
HKLM\SOFTWARE\NCR\Advance NDC\SPStartPause
Chapter 6
Advance NDC on Specific Vendors’
SSTs
Overview 6-1
Default Platform Installation 6-1
Getting Support 6-1
Logs 6-2
Vendor Logs 6-2
Overview
Overview 6
If you contact NCR for help with troubleshooting, you must provide
Getting Support 6
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.
Logs 6
Note: You must provide Problem Determination trace files for any
.NET components.
Vendor Logs 6
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.
Diebold Hardware 6
Before using Diebold cash cassettes, ensure that they are correctly
Configuring Cassettes 6
You must use the ACU to remove unused or duplicate logical cash
units as Advance NDC does not support duplicate logical cash
units.
Key Mapping 6
C F2
E F3
G F4
B F5
D F6
F F7
H F8
You can start the platform and then start Advance NDC by running
Starting the Platform and the ncr.aptra.Apploader.exe file from the C:\Program Files\NCR
Advance NDC 6
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.
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
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
<key>=<value><null>
7000=6
7003=5
9830537=259
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
Table 6-2
Treatment of Notes After a Power Failure
Value Description
The counts can be checked using the Display Cash option on the
Supervisor Replenish menu.
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.
HKLM\SOFTWARE\NCR\Advance NDC\CashHandler\
RejectAfterBadStack
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.
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.
Wincor-Nixdorf Hardware 6
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.
You can configure the card reader at the platform level to allow
Configuring Card Readers 6
The casettes can be configured using the Extended Add Cash option
Configuring Cassettes 6
Note 1: The currency cassettes mapping table does not map the
physical cassettes to the logical cash units.
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.
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 6
following situations:
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.
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.
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.
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:
A – C33F
B – 3597
C – 18EC
D – AF0B
E – 6678.
On Wincor SSTs, you must update the SizeX and SizeY settings of
Configuring the Operator the following registry entry as shown below:
Panel 6
HKLM\SOFTWARE\NCR\Advance NDC\
NoTTUOperatorResolution\
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\
Screen Resolution 6
You can start the platform and then start Advance NDC by running
Starting the Platform and the the ncr.aptra.Apploader.exe file from the C:\Program Files\NCR
Advance NDC 6
APTRA\Advance NDC folder.
You can shut down the SST and then restart in the vendor
diagnostic mode.
common issues.
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
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.
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.
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.
Appendix A
Related Documentation
Overview A-1
Overview
Overview A
Table A-1
Advance NDC Documentation
APTRA Advance NDC, Developer’s Guide PDF/Paper Describes how to migrate to Advance NDC. It
B006-6046 also identifies the functionality offered by
Advance NDC, and describes how to enhance it.
APTRA Advance NDC, Reference Manual PDF/Paper Provides application programmers with reference
B006-6180 information for Advance NDC, including States,
Screens, and the message formats between
Central and the terminal.
APTRA Advance NDC, Multi-Vendor PDF/Paper Provides users with information about running
Support Reference Manual the Advance NDC application on other vendors’
B006-6344 SSTs, describing the differences between Advance
NDC on NCR SSTs and other vendors’ SSTs.
APTRA Advance NDC, Supervisor’s Guide PDF/Paper Describes the Supervisor interface, how to set up
B006-6062 the terminal’s local configuration parameters, and
how to replenish the terminal.
APTRA Advance NDC, Extending the PDF/Paper Describes how to modify Advance NDC
Product
B006-6926
Table A-2
Provided Authoring Environment
Documentation
APTRA Author, User’s PDF/Paper Describes how to install and use the Author and
Guide Runtime Components to design, develop and maintain
B006-6038 a self-service application.
APTRA Author Help Windows Context-sensitive help for the Author user interface
Help and authoring errors.
Runtime Core Help Windows Context-sensitive help for the Runtime Core Authoring
Help components and runtime errors, which are part of Core
Self-Service.
Advance NDC Help Windows Context-sensitive help for the Advance NDC
Help Authoring components (excluding Application Core
components).
Self-Service Core Help Windows Context-sensitive help for the Self-Service Core
Help Authoring components, which are part of Core
Self-Service.
Basic Self-Service Help Windows Context-sensitive help for the Authoring components
Help and runtime errors provided with Basic Self-Service.
Special Self-Service Help Windows Context-sensitive help for the Authoring components
Help and runtime errors provided with Special Self-Service.
Statement Printer Help Windows Context-sensitive help for the Authoring components
Help 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.
Table A-3
Additional Authoring Environment
Documentation
APTRA Advance ADE, Programmer’s PDF/Paper Describes how application programmers should create
Guide their own C++ Worker Classes. It also contains
B006-6042 information on using C routines to manipulate data.
APTRA Advance ADE, C++ Class PDF/Paper Provides application programmers with definitions for
Reference a number of C++ Runtime and Utility Worker Classes
B006-6043 provided by NCR.
APTRA Advance ADE, Local PDF/Paper Describes how to customise the APTRA Advance ADE
Language Customisation Guide product into a local language.
B006-6037
NDC+ Documentation A
Table A-4
Additional NDC+ Documentation
NDC, Using NDC Exits PDF/ Introduces NDC Exits to experienced NDC
B006-5102 Paper programmers intending to develop
customised terminal applications.
NDC+, Programmer’s Reference Manual PDF/ Aimed at programmers who write host or
B006-2486 Paper switch applications to support NDC+
terminals, or who create the terminal
configuration that customises NDC+.
NDC, Message Formats For Host Application PDF/ Designed for Central control application
Developers Paper developers working with NDC RMX,
B006-4201 NDCxa or NDC+. Intended to help in
creating a control program that handles all
the NDC variants.
NDC+, Supervisor’s Reference Manual PDF/ Designed for those people who are
B006-2487 Paper responsible for setting up the terminal’s
local configuration parameters, or for
routine replenishment of the terminal.
Table A-5
Other NCR Documentation
APTRA XFS Self-Service Support PDF/Paper Describes the functions that are used to perform
System Application configuration and maintenance on an SST.
User Guide
B006-6167
APTRA Documentation HTML Help On-line help for the Communications Connection
CCM TCPIP (CHM) Manager TCP/IP module.
EMV/CAM2 EMV Integrated Circuit PDF/Paper Provides reference information for any APTRA
Exits for Card (ICC) Reference Advance NDC developer who wishes to add
APTRA Manual EMV Integrated Circuit Card (ICC) Card
Advance NDC B006-6297 Authentication Method (CAM) functionality to
their Advance NDC application.
APTRA Simulator HTML Help Context-sensitive help for the APTRA Simulator.
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
Extensions for Financial Services (XFS) interface PDF or Provides reference information for
specification zipped CEN-XFS specifications, release 3.0x (3.10
(CWA 14050) PDF for IPM).
Appendix B
Status Mapping
Overview B-1
Table Conventions B-2
Overview
Overview B
command, its return value, and the Advance NDC status data, the
mapping is based on context and may be an approximation:
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
Table B-3
XFS Command: CDM_DISPENSE
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.
Table B-4
XFS Command: CDM_PRESENT
WFS_SUCCESS 05 Good
Currency has been presented to the cardholder. All purged bill
counts are accurate.
Table B-5
XFS Command: CDM_RETRACT
other 01 UNSUCCESSFUL
(covers all device failures that are The items have been retracted but there is a fault. The count of
nonspecific) items transferred to the purge bin is inaccurate.
Table B-6
XFS Command: CDM_REJECT
Table B-7
XFS Commands:
START_EXCHANGE/END_EXCHANGE
Table B-8
Currency Dispenser Event Mapping
COUNTS_CHANGED —
Table B-9
Currency Dispenser Severity Mapping
fwDevice DEVHWERROR
with one of
Table B-10
Currency Dispenser Replenishment
Information Mapping
XFS Device Status XFS Device Element XFS Value R-Data Value
Table B-11
Currency Dispenser Cash Tamper
Indication Mapping
XFS Device Status XFS Device Element XFS Value T-Data Value
Table B-12
Currency Dispenser Cash Counters
Combined Separated
Counter Origin Counters CDI Counters CDI
Array Arrays
Notes to Dispense Taken from the input parameter of the DISPENSE 5014 N/A
command
Standard Note Counts Taken from the input parameter of the DISPENSE 5027 CDM1: 5028
command for a STANDARD CASH operation CDM2: 5029
Table B-13
Currency Dispenser Counter Updates
Reject
Coin Dispenser B
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
Table B-15
Coin Dispenser Event Mapping
Table B-16
Coin Dispenser Severity Mapping
fwDevice DEVONLINE,
with one of DEVBUSY
fwDevice DEVHWERROR
with one of
Table B-17
Coin Dispenser Replenishment Information
Mapping
XFS Device Status XFS Device Element XFS Value R-Data Value - Hopper
WFSCDMCUINFO
Table B-18
Coin Dispenser Cash Tamper Indication
Mapping
XFS Device Status XFS Device Element XFS Value T-Data Value - Hopper
WFSCDMCUINFO
XFS Device Status XFS Device Element XFS Value T-Data Value - Hopper
Table B-19
Coin Dispenser Counters
Coins Adjustment Not applicable as the XFS SP interface does not 00541... 00544...
implement coins adjustment and therefore it
remains zero
Table B-20
Coin Dispenser Counter Updates
Dispense
Card Reader B
Table B-21
XFS Command: IDC_READ_RAW_DATA
Table B-22
XFS Command: IDC_WRITE_RAW_DATA
WFS_SUCCESS 00 Good
MEDIAJAM 04 The card is jammed or there are too many write errors
SHUTTERFAIL 03 Inoperative
Other 03 Inoperative
Table B-23
XFS Command: IDC_CHIP_IO
WFS_SUCCESS 00 Good
MEDIAJAM 08 Error
NOMEDIA 08 Error
Other 03 Inoperative
Table B-24
XFS Command: IDC_RESET_COUNT
WFS_SUCCESS 00 Good
Other 00 Good
Table B-25
XFS Command: IDC_EJECT_CARD
WFS_SUCCESS 00 Good
MEDIAJAM 03 Inoperative
SHUTTERFAIL 03 Inoperative
ERR_UNSUPP_COMMAND 00 Good
(The device does not have the capability of ejecting the card)
Other 03 Inoperative
Table B-26
XFS Command: IDC_RETAIN_CARD
MEDIAJAM MEDIAUNKNOWN,
MEDIAPRESENT, 03 Inoperative
MEDIAENTERING
Table B-27
Card Reader Event Mapping
XFS Event Prefix XFS Event XFS Parameter XFS Value Unsolicited Event T-Code
Table B-28
Card Reader Severity Mapping
XFS Device Status XFS Device Element XFS Element Value S-Data
fwDevice DEVONLINE,
with DEVBUSY
XFS Device Status XFS Device Element XFS Element Value S-Data
fwDevice DEVHWERROR
with one of
Table B-29
Card Reader Replenishment Information
Mapping (State of the LFCC Bin)
INF_IDC_STATUS
RETAINBINFULL Empty/overfill
RETAINBINHIGH High/low
RETAINBINNOTSUPP Good
PIN Pad B
Table B-30
XFS Command: PIN Pad, all
WFS_SUCCESS 00 Good
KEYNOTFOUND 01 Error
KEYNOVALUE 01 Error
Other 01 Error
Table B-31
XFS Command: PIN_CRYPT
MODENOTSUPPORTED 01 Error
INVALIDKEYLENGTH 01 Error
NOCHIPTRANSACTIVE 01 Error
ALGORITHMNOTSUPP 01 Error
Table B-32
XFS Command: PIN_IMPORT_KEY
INVALIDID 01 Error
DUPLICATEKEY 01 Error
INVALIDKEYLENGTH 01 Error
NOKEYRAM 01 Error
Table B-33
XFS Command: PIN_GET_PIN
KEYINVALID 01 Error
KEYNOTSUPPORTED 01 Error
NOACTIVEKEYS 01 Error
NOTERMINATEKEYS 01 Error
MINIMUMLENGTH 01 Error
Table B-34
XFS Command: PIN_LOCAL_DES
NOPIN 01 Error
INVALIDKEYLENGTH 01 Error
Table B-35
XFS Command: PIN_LOCAL_VISA
NOPIN 1 Error
INVALIDKEYLENGTH 01 Error
Table B-36
XFS Command: PIN_GET_PINBLOCK
FORMATNOTSUPP 1 Error
Table B-37
XFS Command: PIN_GET_DATA
KEYINVALID 1 Error
KEYNOTSUPPORTED 1 Error
NOACTIVEKEYS 1 Error
Table B-38
PIN Pad Event Mapping
Table B-39
PIN Pad Severity Mapping
XFS Device Status XFS Device Element XFS Element Value S-Data
fwDevice DEVONLINE,
with one of DEVBUSY
XFS Device Status XFS Device Element XFS Element Value S-Data
fwDevice DEVHWERROR
with one of
Barcode Reader B
Table B-40
XFS Command: PTR_READ_FORM
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
Table B-42
XFS Command: All,
PTR_RETRACT_MEDIA (CPM)
WFS_SUCCESS 0 Good
NOMEDIAPRESENT 8 No document
MEDIAJAMMED 5 Jam
Table B-43
XFS Command: PTR_CONTROL_MEDIA
NOMEDIAPRESENT 8 No document
Table B-44
XFS Command: PTR_READ_IMAGE
MEDIASIZE 12 Misread
Table B-45
XFS Command: PTR_PRINT_FORM
(CPM)
Table B-46
XFS Command: PTR_RESET
Table B-47
CPM Severity Mapping:
WFS_PTR_STATUS
Endorser Stamper
XFS Device Element XFS Value S-Data Overall Bin 1 Bin 2 Bin 3
Ribbon Ink
fwRetractBin1 RETRACTBINHIGH
fwRetractBin2 RETRACTBINHIGH
fwRetractBin3 RETRACTBINHIGH
Endorser Stamper
XFS Device Element XFS Value S-Data Overall Bin 1 Bin 2 Bin 3
Ribbon Ink
fwDevice DEVHWERROR
with one of
fwRetractBin1 RETRACTBINHIGH
fwRetractBin2 RETRACTBINHIGH
fwRetractBin3 RETRACTBINHIGH
Other Fatal
Table B-48
CPM Replenishment Information Mapping:
WFS_PTR_STATUS
R-Data
R-Data R-Data R-Data R-Data
XFS Device Element XFS Value Endorser
Stamper Ink Bin 1 Bin 2 Bin 3
Ribbon
fwMedia WFS_MEDIAPRESENT
WFS_MEDIANOTPRESENT
WFS_PTR_MEDIAENTERING
WFS_PTR_MEDIARETRACTED
fwMedia WFS_MEDIAUNKNOWN
fwMedia WFS_MEDIANOSUP
R-Data
R-Data R-Data R-Data R-Data
XFS Device Element XFS Value Endorser
Stamper Ink Bin 1 Bin 2 Bin 3
Ribbon
fwInk INKUNKNOWN
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
WFS_SUCCESS 00 Good
Table B-50
XFS Command: PTR_RAW_DATA
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
Table B-51
XFS Command: PTR_CONTROL_MEDIA
NOMEDIAPRESENT 01 Error
FLUSHFAIL 01 Error
RETRACTBINFULL 01 Error
STACKERFULL 01 Error
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
Table B-52
XFS Command: PTR_PRINT_FORM
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
STACKERFULL 01 Error
PAGETURNFAIL 01 Error
SHUTTERFAIL 01 Error
MEDIAJAMMED 03 Error
PAPERJAMMED 03 Error
PAPEROUT 01 Error
INKOUT 01 Error
TONEROUT 01 Error
CHARSETDATA 01 Error
Other 01 Error
Table B-53
Receipt and Journal Printer Event Mapping
Table B-54
Receipt and Journal Printer Severity
Mapping
XFS Device Status XFS Device Element XFS Element Value S-Data
fwDevice No error
fwDevice DEVONLINE,
with one of: DEVBUSY
XFS Device Status XFS Device Element XFS Element Value S-Data
fwDevice DEVHWERROR
with one of:
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
XFS Device Element XFS Value R-Data
Status
WFS_PTR_
Paper Ribbon
STATUS
XFS Device
XFS Device Element XFS Value R-Data
Status
Statement Printer B
Table B-56
XFS Command: PTR (Statement, all)
WFS_SUCCESS 00 Good
Table B-57
XFS Command: PTR_RAW_DATA
(Statement)
SHUTTERFAIL 01 Error
MEDIAJAMMED 01 Error
PAPERJAMMED 03 Error
PAPEROUT 01 Error
INKOUT 01 Error
TONEROUT 01 Error
Table B-58
XFS Command: PTR_CONTROL_MEDIA
(Statement)
NOMEDIAPRESENT 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
SEQUENCEINVALID 01 Error
Table B-59
XFS Command: PTR_RETRACT_MEDIA
(Statement)
NOMEDIAPRESENT 01 Error
RETRACTBINFULL 01 Error
MEDIAJAMMED 03 Error
PAPERJAMMED 03 Error
USERERROR 03 Error
Table B-60
XFS Command: PTR_PRINT_FORM
(Statement)
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
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
Table B-61
XFS Command: PTR_RESET (Statement)
SHUTTERFAIL 01 Error
RETRACTBINFULL 01 Error
MEDIAJAMMED 03 Error
PAPERJAMMED 03 Error
Table B-62
Statement Printer Event Mapping
MEDIADETECTED N/A — —
Table B-63
Statement Printer Severity Mapping
XFS Device Status XFS Device Element XFS Element Value S-Data
fwDevice DEVHWERROR
with one of:
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
XFS Device Element XFS Value R-Data
Status
WFS_PTR_
Paper Ribbon
STATUS
WFS_PTR_
Paper Ribbon
STATUS
Passbook Printer B
Table B-65
XFS Command: PTR
(Passbook printer, all)
WFS_SUCCESS 00 Good
Table B-66
XFS Command: PTR_RAW_DATA
(Passbook)
SHUTTERFAIL 03 Error
INKOUT 01 Error
TONEROUT 01 Error
Table B-67
XFS Command: PTR_CONTROL_MEDIA
(Passbook)
NOMEDIAPRESENT 05 Error
FLUSHFAIL 04 Error
RETRACTBINFULL 03 Error
STACKERFULL 03 Error
SHUTTERFAIL 01 Error
PAPEROUT 05 Error
INKOUT 01 Error
TONEROUT 01 Error
SEQUENCEINVALID 01 Error
Table B-68
XFS Command: PTR_PRINT_FORM
(Passbook)
FORMNOTFOUND 01 Error
FORMINVALID 01 Error
MEDIANOTFOUND 01 Error
MEDIAINVALID 01 Error
FIELDSPECFAILURE 01 Error
FIELDERROR 01 Error
FLUSHFAIL 04 Error
RETRACTBINFULL 03 Error
STACKERFULL 03 Error
SHUTTERFAIL 01 Error
PAPEROUT 05 Error
INKOUT 01 Error
TONEROUT 01 Error
Table B-69
XFS Command: PTR_RETRACT_MEDIA
(Passbook)
NOMEDIAPRESENT 05 Error
RETRACTBINFULL 03 Error
MEDIAJAMMED 04 Error
PAPERJAMMED 04 Error
Table B-70
XFS Command: PTR_READ_FORM
(Passbook)
READNOTSUPPORTED 02 Error
FORMNOTFOUND 01 Error
FORMINVALID 01 Error
MEDIANOTFOUND 01 Error
MEDIAINVALID 01 Error
MEDIASKEWED 01 Error
FIELDSPECFAILURE 01 Error
FIELDERROR 01 Error
NOMEDIAPRESENT 05 Error
FLUSHFAIL 01 Error
RETRACTBINFULL 01 Error
SHUTTERFAIL 01 Error
LAMPINOP 01
SEQUENCEINVALID 01
MEDIASIZE 01 Error
Table B-71
Passbook Printer Event Mapping
MEDIAINSERTED N/A — —
FIELDERROR N/A — —
FIELDWARNING N/A — —
Table B-72
Passbook Printer Severity Mapping
XFS Device Status XFS Device Element XFS Element Value S-Data
fwDevice DEVHWERROR
with one of:
XFS Device Status XFS Device Element XFS Element Value S-Data
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
XFS Device Element XFS Value R-Data
Status
fwMedia MEDIAPRESENT,
MEDIANOTPRESENT
fwMedia MEDIAUNKNOWN
fwMedia MEDIANOTSUPP
fwPaper PAPERFULL
fwPaper PAPERLOW
fwPaper PAPEROUT
fwPaper PAPERNOTSUPP
WFS_PTR_
Paper Ribbon
STATUS
fwPaper PAPERUNKNOWN
Note 7: The status of paper and knife is always 0 for the passbook
printer.
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.
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.
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
WFS_SUCCESS 00 The command has been successful and the depository is ready for
use
Table B-75
XFS Command: DEP_ENTRY
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
Other 01 Error
Table B-76
XFS Command: DEP_RESET
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
Table B-77
XFS Command: DEP_DISPENSE
ENVJAMMED 01 Error
SHTNOTOPEN 01 Error
Other 01 Error
Table B-78
XFS Command: DEP_RETRACT
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
TONEROUT 00 Good
Other 01 Error
Table B-79
Depository Event Mapping
CONTINSERTED N/A —
CONTREMOVED N/A —
ENVINSERTED N/A —
MEDIADETECTED N/A —
TONERTHRESHOLD N/A —
ENVTHRESHOLD N/A —
Table B-80
Depository Severity Mapping
XFS Device
XFS Device Element XFS Element Value S-Data
Status
fwDevice DEVONLINE,
with one of: DEVBUSY
XFS Device
XFS Device Element XFS Element Value S-Data
Status
fwDevice DEVHWERROR
with one of:
Depository Dispenser
(006) (028)
Table B-81
Depository Replenishment Information
Mapping
INF_DEP_STATUS
DEPFULL Overfill
DEPHIGH Low/High
DEPNOTSUPP Good
ENVLOW Low
ENVEMPTY Empty
ENVNOTSUPP Good
TONLOW N/A
TONEMPTY Empty
TONNOTSUPP Good
Night Safe B
Table B-82
XFS Command: DEP, all
WFS_SUCCESS 00 The command has been successful and the night safe is ready for
use
Table B-83
XFS Command: DEP_ENTRY
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-84
Night Safe Event Mapping
CONTREMOVED N/A —
Table B-85
Nigh Safe Severity Mapping
XFS Device
XFS Device Element XFS Element Value S-Data
Status
NSD_DEP_
fwDevice DEVONLINE,
with one of DEVBUSY
fwDevice DEVHWERROR
with one of:
Table B-86
Night Safe Replenishment Information
Mapping
INF_NSD_STATUS
DEPHIGH Good
DEPFULL Overfill
DEPNOTSUPP Good
Appendix C
Printer Data — Control Codes and
Registry Settings
Overview C-1
Overview
Overview C
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
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.
The following tables give details of the registry settings for printing.
Not all printer types have all the settings.
DPI Dots per inch. For printers that do not use columns for
margin setting, must match printer settings.
Table C-3
Printer Control Sequences Registry
Settings
Hex Value
Control Registry Name ASCII Value Var Description
(NDC Code)
Line-feed LINE_FEED 0A — —
character
Form-feed FORM_FEED 0C — —
character
Carriage return CR 0D — —
character
Horizontal tab HT 09 — —
character
Select OS2 code OS2_CODE_PAGE 1B 25 var ESC % var Code page number
page
Hex Value
Control Registry Name ASCII Value Var Description
(NDC Code)
Print barcode BARCODE 1B 6B var 1B 5C, ESC k 3xh var ESC \ Barcode type and
barcode data
Print graphics GRAPHICS 1B 47 var 1B 5C ESC G var ESC \ Path and name of
file graphics file
Define character DEF_BIT_IMAGE 1B 2A var 1B ESC * var ESC \ Bit image ID and the
set 5C path/filename
containing the
definition
Hex Value
Control Registry Name ASCII Value Var Description
(NDC Code)
Cut CUT 11 — —
(and feed on
some printers)
Set first line FIRST_LINE_POS 1B 5B var 75 ESC [ var u First line position
position
Table Note 2: If the barcode does not fit on the line, a partial
barcode is printed
Glossary 0
D4x Diebold SST model used in the Indian and South American
D 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.
LFCC Latch fast card capture. The latch fast card capture bin is an
L 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.
XFS Cash Unit The logical cassette representation used by XFS; for
example, XFS logical type 1.
See also: Cassette type and NDC Cassette Type.
Index 0
Barcode reader
B command completion mapping B-25
status mapping B-25
Bunch cheque acceptor
status mapping B-31
Card reader
C 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
Encryptor configuration
E Diebold 6-4
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
Journal printer
J registry settings 2-9
K Screens 2-10
K Knowledge and experience required xxv
Logs
L collecting Diebold 6-7
collecting Wincor 6-16
general 6-2
other vendors 6-2
Mapping tables
M 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
Screen data
S 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
TCP/IP 1-3
T 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
XFS command
X 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
NCR welcomes your feedback on this publication. Your comments can be of great value in helping us improve
our information products.
Cut
You may send your comments to us electronically. See over for details.
Circle the numbers below that best represent your opinion of this publication.
Cut
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