APTRA™Advance NDC
Developer’s Guide
B006-6046-P000
Issue 1
January 2013
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
The product described in this book is a licensed product of NCR Corporation.
NCR, APTRA, and personaS are trademarks of NCR Corporation.
Microsoft, Windows, Visual Studio, ActiveX, DirectShow and Visual Basic Script are registered trademarks or trademarks
of Microsoft Corporation in the United States and/or other countries.
Parascript is a registered trademark of Parascript LLC in the United States and/or other countries.
IBM and OS/2 are trademarks of International Business Machines Corporation.
Diebold is a trademark of Diebold, Incorporated.
Sound Blaster is a trademark of Creative Technology Ltd.
Adobe, Acrobat and Adobe Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in
the United States and/or other countries.
Autodesk and FLIC are a trademarks of Autodesk, Inc.
RealSpeak Solo is a trademark of Nuance Communications Inc.
Disclaimer:
It is the policy of NCR Corporation to improve products as 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, organisation 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.
Canadian Class A Device
Declaration
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.
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, Developer’s Guide
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, Developer’s Guide
Revision Record
Revision Record
Date
Page
Jan
2013
Description of Change
New revision for Advance NDC 4.02
lxi
Added section on navigation in online
documentation for cross-references
lxii
Added section on terms used for cash
acceptors
1-12, 1-19
Added note mix selection state, which allows
consumers to select the note mix in a cash
dispense
1-16
Added improvements to reset functionality
1-16
Added that displaying a PIN Entry screen in
the PIN Entry Initiation State is optional
1-16, 1-63
Added that track data can now be reported
following a card retract operation
1-17
Added that .NET classes are now supported
by the security camera
1-18
Added that multiple cassette types can be
mapped to the same denomination
1-18
Added that the level of error reported
following consecutive pick failures can be
configured
1-19
Added that each cash handler can be cleared
separately on dual cash handlers
1-19
Added the triggers for automatic error
recovery
1-20
Added information about support for foreign
currency transactions
1-20
Added information about the Local Cash
Dispense state
1-22
Added information on endorsing cheques
returned by the host
1-22
Added information about local configuration
of cheque image display
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
v
Revision Record
Date
Page
Description of Change
1-23
Added that the display of bunched cheque
amounts can be aligned to the left of the
screen as well as to the right
1-25, 5-158
Added information to indicate that EJ
initialisation can be delayed while a
transaction is in progress
1-25
Added section to describe the PIN-acquired
flow point
1-26
Added information about long receipt
handling
1-26
Added information about the configuration
of media definition for receipts in
forms-based printing
1-26
Added information about graphics scaling in
forms-based printing
1-27
Added that table entry 7 is now used in Web
Exit states to hide web pages
1-27, 5-21
Added information to describe when local
customisation files are loaded
1-29
Added information about the use of MCNs to
validate ITRs and ECP option 34 to define
handling of incorrect TREPs and ITRs
1-29
Added information describing the Supervisor
option to enable and disable cardless
transactions and set or change the next state
number
1-30
Added SNMP Traps to Feature Support
1-30
Added information about NDC Monitor
1-31, 5-61
Added that archived PD Investigations are
automatically deleted
1-31
Added that character encoding can be
specified in the voice guidance XML
configuration file
Added that the association of voice and
language is only required if multiple
languages are used and is now done using
the AdvanceNDC.accfg file
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
vi
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
1-31
Added that if only a single language is
available no language needs to be selected
and if multiple languages are available the
language needs to be selected only once in a
voice-guided transaction
1-32
The intelligent fraud device is no longer
supported
1-32
Added section for a new Supervisor option to
configure top of margin for receipts
1-32
Registry configuration can be used to control
reporting of the receipt capture bin
1-33
Added the limitation in replacing MPEG
animations prior to the introduction of
display management in Advance NDC 4.00
1-33
Added that customisations can define screens
to display on the Fault Display
1-33, 1-68
Registry configuration can be used to control
reporting of cardholder display in fitness
status messages
1-33
Added that table entry 9 in the Information
Entry state can be overridden using an XML
file
1-33
Added information about a new state, Data
Copy and Compare
1-34
Automatic onfiguration for Wincor CCDM
1-34
Added that APTRA Promote is now enabled
by default
1-34
IPv6 supported as well as IPv4
1-35
Added information about Always On tracing
and Silent Debug start-up in a new section,
“Troubleshooting Assistance”
1-35
Added a new section for cash acceptors to
bring together all the information about the
development of support for them in Advance
NDC
1-36
Added that the allowed number of attempts
made to insert notes can be configured
1-36
Added that the number of bunches that can
be inserted during a single transaction can be
limited
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
vii
Revision Record
Date
Page
Description of Change
1-36
Added that the destination of retracted notes
can be configured
1-36
Added that the receipt printing can be
triggered by a CDI store
1-36 1-37
Added information on option 82 BNA CASS
CFG on the Supervisor Configure menu
1-38
Added information on the improvements
made to the reconciliation lists
1-39
Added section for new state for off-line
handling of cash deposits
1-39
Added that the mapping of NDC cassette
type to XFS logical units can be fixed for
cash-in cassettes
1-40
Added that the Transaction Request can be
configured to include notes identified as
counterfeit or suspect under the ECB 6
regulations
1-40
Added that signatures retrieved for
counterfeit or suspect note are always logged
to the ECB 6 database
1-41
Added that cash acceptor exceptions can be
reported in a log file
1-42
Added information about journaling the
escrow status and the differences in
behaviour from ANDC 3.04
1-42
Added that the journaling of cash counts can
be disabled
1-42
Added information about changes in how
counts are journaled if notes are in the escrow
when a power failure occurs and AER is
enabled
1-43
Added information about a new Supervisor
option to print BNA totals
1-44
Product class SelfServ 14 is supported in
hardware configuration messages
1-44
Replaced Device Access section with new
section called Support for CEN-XFS
1-45
Added that the number of screens referenced
from state tables has increased, as has the
number of multiple-language screens
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
viii
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
1-45
Added that the display of FDK labels has
been improved for other vendors’ SSTs
1-46, 6-9
Clarified information describing handling of
invalid xml files
1-47
Added that from Advance NDC 04.01.01,
RKM for other vendors’ SSTs that use
certificates is supported
1-48
Added that group separators in journaled
messages are represented as asterisks
1-49
Added that print points have been defined to
allow print data to be defined locally
1-50
Added information about a Supervisor
option to update software or configuration
files
1-52
Added directories information for
customisation
1-52
Added that MEI can be enabled and
configured for spray dispensers
1-71
Clarified that .pcx file format is no longer
supported although the name can still be
used in the screen definitions
4-20
Added that group separators in journaled
messages are represented as asterisks
5-13
Added a cross-reference to Chapter 12,
“Installing and Configuring Troubleshooting
Tools”
5-19
Added registry entry to include or exclude
cardholder display status in fitness messages
5-19
Added registry entry to include or exclude
receipt capture bin supplies and fitness in
status messages
5-29
Added cash-in security camera flowpoints
5-41
Added information about support for IPv6
5-42
Added information about configuring
multiple network connections
5-52
Added new section to describe how to
configure range of CEN-XFS versions
supported
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
ix
Revision Record
Date
Page
Description of Change
5-56
Added note to clarify that Advance NDC
generates mode change traps when an
application is negotiating for resources but
mode does not change
5-67
Added new section to describe archiving
registry keys using .NET Archive Manager
5-73
Added information on enabling and
configuring NDC Monitor
5-78
Updated the information on configuring the
resetting of USB devices
5-89
Updated information about developing a
new .NET Supervisor Task and added a new
section ‘Integrating New or Existing .NET
Supervisor Tasks’
5-91
Added a section on the .NET Software
Update Tasks functions available in
Supervisor
5-95
Updated configuration information for
created signatures
5-96
Added configuration for extracted signatures
5-112
Added that the screen download must be
present if using AppendBuffer.xml with
Display Manager
5-112
Added the note mix selection state to the list
of states that use whole amount entry
5-113
Updated the information on the execution
when invalid data is identified when
validating buffer data
5-115
Updated the cardless transaction
configuration to clarify that a reboot is not
required if updating using Enhanced
Configuration option 77
5-116
Updated cardless transactions to include
details of supervisor configuration option
5-135, 5-143,
5-146
Added details of resizing cheque images for
screen display
5-151
Added details on enabling extended screen
base and group sizes
5-163
Added information on disabling the
journaling of cash counts
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
x
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
5-164
Added configuration details for long receipt
retract
5-165
Added the configuration details for reporting
the receipt capture bin as fatal when full on
NCR SSTs
5-170
Added scaling registry entry for form-based
printing
5-170
Updated the media definition registry
description for form-based printing
5-175
Removed Receipt Retract details and added a
cross-reference to Receipt Handling
5-187
Added the cassette unit identifier registry
entry
5-189
Added configuration detail for disabling
retract following suspend
5-190
Added the registry entry for configuring the
level of error reporting for consecutive pick
failures
5-192
Added section describing how to enable and
configure MEI for spray dispensers
5-196
Added details of configuring the way
counters are cleared on dual cash handlers
5-201
Added configuration for limiting the number
of bunches of notes that can be inserted in a
single transaction
5-202
Added configuration for the allowable
number of note insertion retries
5-202
Added configuration for reporting
cumulative counts in Transaction Request
messages
5-203, 5-223,
5-234
Added information on configuring note
retract to escrow when refunded notes are left
by the consumer
5-206
Added configuration to suppress status
messages for off-line cash deposits
5-208
Added information about retrieving and
printing the serial numbers of category 4
notes on a BNA with an HBV installed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xi
Revision Record
Date
Page
Description of Change
5-209
Added configuration details for a new
Supervisor option to print BNA totals
5-211
Amended the description of the length of
time that ECB 6 information will be stored
5-221
Added configuration for MStatus mapping
on cash acceptors
5-226
Added that signatures retrieved for
counterfeit or suspect notes are logged to the
ECB 6 database even if ECB 6 is not enabled
5-227
Added that if ECB 6 support enabled, Option
45 must be set to allow more than 90 notes
5-230
Added details of the configuration for cash
acceptor exception reporting
5-233
Amended format of element value
5-234
Added details of configuring the journal
entries for the retract area and recovery
destination
5-234
Added details of configuring the journal
entry for a consumer time-out
5-238
Added details of configuring the delay
between the GBXX shutter opening and the
prompts for note insertion
5-241
Added information on configuring cash
acceptor cassettes on any vendors’ SSTs
5-247
Added that GBRU configuration will not fail
if the cassette type on the SST is not defined
in the XML configuration file
5-254
Added section on configuring fixed cassette
mapping for GBXX
5-257
Added section about remote access to cheque
data.
5-262
Added section on configuring the bunch
cheque acceptor to accept single cheques
6-2
Updated the introduction to voice-guided
sessions
6-5
Added configuration information for
selecting the language only once during
voice-guided transactions
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xii
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
6-6
Added information on automatic language
selection when only a single language is
supported
6-6
Updated the registry entry used to enable
voice guidance without updating the host
6-6
Updated information on configuring
text-to-speech software
6-7
Added information on specifying the
character encoding to use
6-12
Updated example voice guidance schema
6-22
Added that no language selection is required
if useLang is omitted or set to false
6-30
Updated the Key element description to
clarify restrictions
6-32
Updated the ParamSourceID element in the
voice guidance XML configuration file
6-33
Added the note mix selection state to the list
of states that can echo key selection
6-37
Added information on legacy configuration
for the Spanish language
6-38
Added information about encoding formats
for voice guidance
8-25
Added that the host emulator tool supports
IPv6 as well as IPv4
11-4
Added that Advance NDC and
customisations must be executed from the
same directory
11-14
Added a cross-reference to the MV Support
Reference Manual for details on other
vendors’ encryptors
12-2, 12-11,
12-12
Added new sections for Always On tracing
and Silent Debug registry settings; updated
related text
B-15
Updated the description of the Resource
Initialiser worker as it now identifies the type
of reset required
B-17
Removed the IFD Alarm worker as the
intelligent fraud device is no longer used
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xiii
Revision Record
Date
Page
Description of Change
C-10
Added that the Cash-In Notes Present CDI is
read-only
C-11
Added information on the use of buffers in
cash dispense operations
C-13
Added information for local cash dispense
transactions
C-30
Added the cash dispenser type
denominations stores to the note counters
catalog
C-31
Added the CDI used to store the last cleared
date for cash handler 2 in dual cash handlers
C-32
Added the CDI used to store the setting of
Enhanced Configuration option 41
C-44
Added the CDI used to store the next state
number in Cardless Transactions (option 93)
C-48
Updated the CDI store description as APTRA
Promote is now enabled by default
C-55
Added the host timeout flag to the
miscellaneous CDI stores
Added the CDI store used to store reserved
screen numbers for use by customisations
E-8
Removed the Set Password option from the
Access menu list as it does not use secure
authentication
G-2, G-3 and
G-5
Added information on hiding the web page
in a Web Exit state
Glossary
Added definitions for 24-volt reset and
express recovery
Added definitions for screen base and screen
group
Added definition for SNA (single note
acceptor)
Added definition for TTS
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xiv
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Jul 11
Description of Change
New revision for Advance NDC 4.01
1-12
Clarified details of cardholder data entry
processing
1-18
Added that support for the ECB 6 regulations
has been re-introduced and listed the
differences in implementation
Added updates made in the support of cash
acceptors for 4.1
1-20
Added that retract counts can be maintained
for dispense and deposit operations for
recycling
1-17
Added information about cameras taking
pictures during cash presented and cash
taken operations
1-18
Added that a fifth physical cassette is
supported in fault display and TEST CASH
1-22
Added details of PAN data handling for
CRM in cardless transactions without FIT
search
1-24
Added information about the standard TTU
form
1-24
Added that users can print Promote coupons
only when a receipt is printed is supported
Added that new Promote flow points have
been added for cash and cheque deposit
1-27
Added information on PC beep configuration
1-27
Added information about the touch-screen
keyboard for alphanumeric data entry by the
consumer
1-28
Added information about reserved screen
m03 replacing M03
1-28
Added information on the extra field in
Supervisor entry and exit message
1-28
Added that a message to set the mode switch
to normal is displayed on front interface and
rear interface
1-28
Added that machine numbers fewer than six
characters or digits are accepted
1-29
Added that ECB 6 database file can be
archived
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xv
Revision Record
Date
Page
Description of Change
1-29
Added that ITR supports display of screen
data and playing of audio guidance
1-31
Added that the taskbar is controlled through
the registry
1-32
Added information about NDC CRM service
1-46
Added information on changes to TCP/IP
Supervisor options
1-47
Added information about configuring the
storage location for note signatures
4-6
Historical information about file location
changes required by Security for APTRA
moved here from chapter 11
5-2
Clarified the context of the SST configuration
component
5-19
Expanded the note to clarify that the Display
Manager is for HTML screens
5-19
Added information on how to send power-up
message to the host when communications
are restored.
5-18
Added information on how to suspend
unsolicited status messages for cash handlers
when Enhanced Present Sequence 2
(EPS2)/Dispenser Security Enhancement
hardware is present
5-23
Added information on the reason for
changing the next state number
5-23
Added information on how cameras can be
configured for a particular position
5-27
Added cash presented and cash taken flow
points
5-27
Added an example of adding Flow Points
5-35
Updated the information on using the .NET
Class Configurator files
5-37
Moved the information on the .NET
Assemblies for Advance NDC component
configuration to the Class Configurator file
section
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xvi
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
5-39, 5-40
Added information on the adding, deleting
and editing of SSL certificate details through
the Supervisor Configure menu
5-45
Added that VDM mode will not be entered
during a transaction
5-55
Updated the group names of the archiving
files
5-57
Added information about archiving EJ data
files in EJ data log
5-59
Added section ‘Archiving ECB 6 Database
File’
5-68
Added information on how to configure
.NET NDC CRM service
5-82
Added that Advance NDC can be configured
to show or hide fixed drives
5-82
Added details of configuring the default
fixed drive path for the storage of note
signatures
5-85, 5-111
Added information about touch-screen
keyboards for consumer data entry
5-89
Moved the “Cash Accept State Screens”
section to Chapter 5, “Configuring Advance
NDC and associated Components” in the
APTRA Advance NDC, Developer’s Guide as it
is configuration information and renamed it
“Confirmation Screens During Cash Deposit”
Updated the configuration of screens used
during a cash deposit when applying the ECB
6 regulations
Updated the confirmation screen
configuration information
5-102
Added information on PC beep configuration
5-102 to
5-104
Added details of PAN data handling for
CRM in cardless transactions without FIT
search
5-109
Added reference to CEN XFS online
document
5-114
Added information on how Taskbar is
hidden
5-114
Clarified that Display manager for HTML
screens is separate from NDC screens
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xvii
Revision Record
Date
Page
Description of Change
5-121
Added the file location of Display Manager
5-152
Added information on printing promote
coupons during transaction reply functions
5-171
Added that a fifth cassette will need to be
configured if present
5-174
Updated the registy entries for physical
cassette
5-183
Reorganised the Cash Acceptor section and
renamed sections for a more generic
approach to devices
5-185
Added information on parameters defined
for cash acceptors using the .NET Class
Configurator
5-186
Added the configuration required to enable
direct deposit to the cassettes
5-189
Added the configuration required to enable
the reading of serial numbers
5-200
Added how to localise the journal entry for
tamper indication on cash acceptors
5-202
Added the reasons that can be used to journal
the failure of the note configuration on a cash
acceptor
5-203
Added the reasons that can be used to journal
the failure of note validation on a cash
acceptor
5-203
Added information on configuring how to
handle a suspend state on a cash acceptor
5-205
Updated the values available for note
recovery destinations
5-205
Added the reasons that can be used to journal
the failure to recover the cash acceptor
5-206
Updated the configuration required to
support the ECB 6 regulations
5-207
Added details of configuration for the
logging of counterfeit and suspect notes to
the ECB 6 database
5-210
Corrected registry entry for BNA using ECB 6
Mode 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xviii
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
5-216
Added details of configuring supplies and
severity journaling for cash acceptors
5-217
Added the reserved screen used to journal
that counts may be inaccurate
5-218
Added the reserved screens used to journal
note signatures
5-219
Added the reserved screen used to journal
that notes have been detected at the exit
during AER
5-219
Updated the configuration for dynamic note
sorting
5-221, 5-225
and 5-230
Updated the configuration for the GBXX
configuration Supervisor menu
5-234
Updated the table entries describing the
values for cash recyclers
5-235
Added the registry entry for reporting retract
counts for dispense operations in a recycling
environment
7-41
Added configuration required for cash
acceptors in the XFS Simulator
Chapter 11
Miscellaneous updates for file names and
locations, and SIU
11-4
Clarified files saved in the C:\Program
Files\NCR APTRA\Advance NDC\PD
directory
11-6
Updated the steps for including the
runtime-only component in your aggregate
11-4
Added that the PersistedData folder needs to
be deleted for a fresh start
11-8
Added the command to run install.bat
11-10
Updated the steps for creating a
super-aggregate
11-10
Removed the Update STARTAPPS.VBS
section as this is no longer necessary
11-12
Updated the introduction to the Secure IUI
information
11-12
Moved the note on installing a newer version
of Security for APTRA from Creating
Aggregate Subsets and Supersets
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xix
Revision Record
Date
Page
Description of Change
11-23
Updated the example commands for silent
installation
12-16
Added that interaction between Advance
NDC and CEN-XFS can also be traced using a
registry entry.
13-2
Added that the APTRA Author can be used
to create C Exits, but this is not recommended
by NCR
13-5
Added that STCONT can be used if writing a
new State as an external C function.
C-30, C-55
Added CDIs for retract note counts during
dispense operations on recycling units
C-46
Added that the Product Class CDI Store
Worker is not used in Advance NDC
C-49
Added Timer 63 CDI
Added recycle cassette note count CDI
Appendix E
Updated for PCI DSS 2.0 and PA-DSS 2.0;
removed references to EFS as it is no longer
used by Advance NDC
Glossary
Updated terms used for cash acceptors and
recycling units.
Added definition for HBV.
Oct 10
New revision for Advance NDC 4.00
lxxxi
Updated information on NCR University
courses
lxxxi
Added that Problem Determination traces
must be provided if seeking support for .NET
components
1-7
Added reference to Activate .NET Supervisor
Tasks
1-15
Moved the section previously called
“Differences Between Advance NDC 3.x and
Earlier Versions” here and renamed it
“Advance NDC Development”
1-17
Added Cash-In component updates for this
release and stated that the ECB 6 regulations
are not supported in this release
Added section on changes made to the
journaling of counts for cash acceptors
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xx
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
1-19
Added information on cash dispenser
statuses
1-20
Added information on configuring a bunch
cheque acceptor in single cheque mode for
Advance NDC 3.02.x and 3.03.x
1-19
Added that Advance NDC can be configured
to update the actual replenishment status of
all cassettes
1-21
Added information about returning of
invalid cheques
1-21
Added information about MICR reading
configuration
1-25
Added information about configuring the
length of amount entries
1-32
Added that Problem Determination can now
be fully controlled from Supervisor mode
1-27
Added that Advance NDC can be configured
to generate a beep on selection of an
emulated FDK
1-27
Added that the type of alert given on card
eject or cash present is configurable
1-27
Added changes to alphanumeric entry in this
release
1-29
Added description of voice-guided sessions
without host update
1-30
Added description of the intelligent fraud
device
1-30
Added information about reporting the
status of the receipt capture bin.
1-32
Added information on full support for RSIs
1-32
Added information about a new worker
class, NDC CRM Interface, and additional
flow points
1-41
Added information on product class support
1-42
Added information about the integrated
consumer display and support for
multi-media file formats
1-44
Added information about a new modifier for
remote key management
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xxi
Revision Record
Date
Page
Description of Change
1-44
Added information about printer interfaces
for C Exits
1-45
Added information on cardholders being
able to unmark cheques
1-46
Added information about .NET Supervisor
Tasks
1-46
Added information about Promote and
Relate interaction through the Supervisor
menus
1-47
Added information about the Self-Service
Terminal Configuration component
1-47
Added information on masking sensitive
data
1-48
Added information about Runtime-only
installer
1-51
Added difference between NDC+ and
Advance NDC in supplies reporting
following retract
1-59
Added RSI to the ignored configuration
parameters
1-64
Added information about Cardholder
Display Alarm reporting unsolicited
messages
1-64
Removed bullet item Option Digit 6, Part A
as it is now supported
1-20
Added “Bunch Cheque State” section and
content
1-71
Added section “Roll Width and Left Margin”.
1-71
Added the differences between NDC+ and
Advance NDC in using remote status
indicators
2-4
Added information about the runtime-only
installer
3-10
Moved the information from the “Migrating
Existing NDC+ Exits” section to the new
APTRA Advance NDC, Extending the Product
publication
4-12
Added that Advance NDC must no longer be
hosted as a child window
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxii
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
4-14
Updated tables “Supplies Data Source
Information”and “Fitness Data Source
Information”with further information on
receipt printers
4-21
Added that Promote campaigns must be
created using Promote 4.00
Chapter 5
Restructured Chapter 5 for readability.
Removed section on registry key for
language-specific code pages as it is not used.
5-2, 5-150,
5-153, 5-156,
5-158, 5-163,
5-171, 5-175
Added information on using the Self-Service
Terminal Configuration component and
updated information where this component
replaces the device configuration done with
NDC_SP.reg, AdvanceNDC.reg and specific
printer registry files
5-16
Added the information on configuring
CEN-XFS logical device names
5-17
Added the the Active XFS alias must be set
for the appropriate hardware variant
5-17
Added steps required to enable remote status
indicators. As Advance NDC controls RSI, no
configuration is needed.
5-17
Added that Advance NDC fully controls the
Remote Status Indicators.
5-18
Added details of configuration for
unsolicited status messages for external
system events
5-20
Added that associated keyboards can be
defined using local customisation data
5-23
Added information on how to change state
flows by changing state numbers locally
5-27
Added configuration details for masking
sensitive data in the ITR
5-29
Added section on support for DVDs on SSTs
5-38
Updated references to .NET CCM TCPIP
5-40
Added note about the restriction on the size
of APTRA CCM TCP/IP messages
5-37
Added details of configuring Activate .NET
Supervisor Tasks
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xxiii
Revision Record
Date
Page
Description of Change
5-50
Moved information on SNMP traps from
APTRA Advance NDC, Reference Manual
5-55 to 5-57
Added information on configuring the .NET
Archive Manager component
5-65
Added examples of updating the
AdvanceNDC.ccfg file for RETRIEVE
ARCHIVE option on the Configure menu in
Supervisor mode
5-69
Updated the “Express Recovery (24-Volt
Reset)” section
5-76
Added details about rear settlement
transactions
5-81
Added details of configuring Supervisor
Promote function
5-82
Added details of configuring Supervisor
Relate function
5-88
Added STCONT Entry for Cardholder
Verification State
5-79
Added configuration details for generating a
beep on emulated FDK selection
5-98
Added information in section “Configuring
Amount Entry Length”and updated table
“Amount Entry XML Schema”
5-99
Added information on states affected by
whole amount entry
5-101
Added configuration details for the type of
alert sounded on card ejection or cash
presentation
5-102
Added that enhanced configuration option 77
can be used to change the registry settings
5-114
Removed Show/Hide Mouse Pointer
configuration information; this is now done
using the AdvanceNDC.accfg file and details
are under Advance NDC display
configuration
5-115 - 5-138
Added configuration details for the Advance
NDC display
5-149
Added configuration details for EJ level
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxiv
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
5-150
Updated configuration of a dot- matrix
printer for coupon printing
5-151
Added details of additional control through
the Journal Page worker for journal printer
data
5-154
Updated configuration of a dot- matrix
printer for coupon printing
5-155
Added statement about creating fonts for use
on forms-based statement printers
5-156
Restructured the “Registry Entry for
Configuring Forms” table
5-160
Added that missing LPI indexes are ignored
5-165
Added Advance NDC registry entry for
accepting non-magnetic cards
5-178
Added information on configuring Advance
NDC to update the actual replenishment
status of all cassettes
5-199
Removed the information on enhanced
confirmation screens, this information is now
in the APTRA Advance NDC, Extending the
Product publication
5-199
Added configuration information for the text
journaled when a deposit is refused
5-148
Replaced the “w3 - Error “ status
messagewith “w4 - Device inoperative -...”
5-200
Added details of the note mapping XML file
5-204
Updated the configuration of cash-in
automatic error recovery
5-206, 5-209,
5-226
Added that the ECB 6 regulations are not
supported in this release
5-214
Updated BNA journal configuration
5-214
Updated the default registry entries for BNA
count journal formats
5-239
Added section on raw data printing of
resized cheque images
5-240
Added information on disabling MICR
reading through the registry
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xxv
Revision Record
Date
Page
Description of Change
5-240
Added information on configuring codeline
MICR fonts
5-241
Added informtion on support for the SCPM
when modifications are made to Advance
NDC
5-241
Added information about returning of
invalid cheques and methods to change the
default value
5-242
Added information on configuring cheque
amount recognition (courtesy and legal)
6-2, 6-6
Added information on configuring
third-party text-to-speech (TTS) software
6-2
Added an introduction to using voice-guided
sessions without host update
6-5
Described how to enable voice-guided
sessions without host update
6-11
Clarified the example voice guidance schema
is a sample and removed redundant elements
6-23
Added information on configuring the
opCodePos sub-element of the standard
voice guidance XML schema for voice-guided
sessions without host update
6-25
Added information on configuring the
OpCode and opCodeNoALT sub-elements of
the standard voice guidance XML schema for
voice-guided sessions without host update
6-26
Added information on configuring the
treqFieldID sub-element of the standard
voice guidance XML schema for voice-guided
sessions without host update
6-32, 6-41
Added information providing audio
feedback when the Clear key is pressed and
added XML example for the same.
6-35
Added lang element and clarified the File
element details under the Recording
element in the voice guidance schema
6-38
Updated XML elements in the example Voice
Guidance XML File.
6-43
Added information on the XML schema used
for voice-guided sessions without host
update
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxvi
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
Chapter 7
Changed NDC+ to Advance NDC where
required
7-7
Noted that the AP Synch NDC State
Processing - Session worker is no longer
required for APTRA Promote
synchronisation
7-8
Updated information regarding cardless
transactions
7-36
Added information about testing Advance
NDC projects in the Author environment
8-2
Added paragraph referencing changes to the
Journal Page worker as a Level 1
customisation
8-6
Updated information on the correct format of
user IDs in the APTRA Author
8-10
Added example of how to control the data
journaled to the journal printer and EJ
through the Journal Page worker
11-2
Added a note that Advance NDC supports
the English version of Windows XP.
11-3
Added information about the combined
installer and the runtime-only installer.
11-4
Updated the SST directory structure table to
specify the AdvanceNDC.reg file, as this is the
only .reg file still in use
11-4
Moved information on clearing persistent
memory from the APTRA Advance NDC,
Reference Manual to here
11-5
Removed note that the Presentation Client is
started if using Promote as this is no longer
the case
11-12
Added information on unavailability of
network drive options in Supervisor menus if
Security for APTRA is installed.
11-21
Clarified what can be done with an installable
aggregate created to extend the supplied
application
12-2
Added that Problem Determination must be
used to collect data for .NET components
12-9
Added information on state flow tracing
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xxvii
Revision Record
Date
Page
Description of Change
12-19
Updated Problem Determination with
information on Supervisor tasks
12-21
Added information on warnings logged for
the Advance NDC Self-Service Terminal
Configuration component
12-25
Added caution that you cannot re-use a
filename when saving trace streams using
DebugLog
12-26
Added information regarding invalid screen
definition, and the application’s response to
it.
13-4
Moved conceptual information on Exits from
APTRA Advance NDC, Reference Manual
13-6
Moved the information from the
Implementation Options section to the new
APTRA Advance NDC, Extending the Product
publication
Chapters 14,
15 and 16
Removed these chapters from this IP and
moved the content to the new APTRA
Advance NDC, Extending the Product
publication
B-6
Updated information in NDC Export
Encryptor Data worker.
B-16
Added description of the Supervisor Task
Executor worker class
B-17
Added description of the IFD Alarm worker
C-4 to C-10
Updated the CDI information for BNAs
C-45
Added information about Card Holder
Display Alarm
C-46
Removed "Journal"from the description as
"Left Print Column" applies to Receipt only.
C-48
Added PromoteEnabled and RelateEnabled
CDIs to Terminal Configuration catalog
C-52
Added the State Flow Sequence CDI store to
the Transaction Processing Flag catalog
C-53
Added DM ParamValues in the UCDI Store.
C-56
Added a note saying that the ECB 6
regulations are not supported in this release
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxviii
APTRA™Advance NDC, Developer’s Guide
Revision Record
Date
Page
Description of Change
D-2
Added statement about creating fonts for use
with specific languages on forms-based
printers
D-2
Removed printing from the font information
D-3, D-5
Added details of the Advance NDC display
configuration file.
D-3, D-7
Clarified the font names example
Appendix E
Moved the information on PCI DSS
compliance with customisations to the
APTRA Advance NDC, Extending the Product
publication
E-3, E-7
Added a note saying that the ECB 6
regulations are not supported in this release
Glossary-1
Added definition for AAC
Glossary-3
Added definition for CAR/LAR
Glossary-4
Added definition for Codec
Glossary-5
Updated the definition of CPM, which can
now also refer to other document processing
modules.
Glossary-4
Added definition for Combined Installer
Added definition for CRM
Glossary-6
Added definition for DIVX
Glossary-8
Added definition for GIF
Glossary-8
Added definition for JPEG
Glossary-9
Added definition for MP3
Glossary-10
Added definition for PCX and PNG
Glossary-11
Added definition for Runtime Only installer
Added definition for SDM
Glossary-14
Added definition for WMV
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™Advance NDC, Developer’s Guide
xxix
Revision Record
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxx
APTRA™Advance NDC, Developer’s Guide
Table of Contents
Contents
Preface
Conventions Used in This Publication ........................................lxii
What Is in This Publication?.........................................................lxiv
Who Should Read This Publication?............................................lxv
What Experience Should I Have? ................................................lxvi
Support Information......................................................................lxvi
Chapter 1
Introducing Advance NDC
Overview ................................................................................................1-1
Advance NDC Implementation ..........................................................1-2
Application Core ...................................................................................1-4
Managing SST Modes.....................................................................1-4
Message Handling ..........................................................................1-4
Activating the Customisation Layer and Supervisor ................1-5
Enhancing the Application Core ..................................................1-5
Supervisor...............................................................................................1-7
Customisation Layer .............................................................................1-8
State Type Modules ........................................................................1-8
Upgrading from an Earlier Release of Advance NDC ..............1-8
Migrating from NDC+ to Advance NDC ....................................1-8
Synchronisation Between Applications ...........................................1-10
Common Data Interface .....................................................................1-11
Common Data Interface...............................................................1-11
User-defined Common Data Interface.......................................1-13
Advance NDC Development.............................................................1-15
The Advance NDC Application..................................................1-15
Supported Operating Systems ....................................................1-15
Feature Support.............................................................................1-15
Internet Protocols..........................................................................1-34
Troubleshooting Assistance ........................................................1-35
Cash Acceptors..............................................................................1-35
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xxxi
Table of Contents
Product Class Support..................................................................1-44
Support for CEN-XFS ...................................................................1-44
Screen Management......................................................................1-45
Image and Media Support ...........................................................1-46
Voice Guidance .............................................................................1-46
Maximum State Number .............................................................1-47
Remote Key Management............................................................1-47
Changing the MAC Encryption Key ..........................................1-47
Dual-Mode Journal Printing........................................................1-48
Format of Journaled Messages....................................................1-48
APIs for C Exits to Print to Any Printer.....................................1-48
Night Safe.......................................................................................1-48
ActiveX Controls ...........................................................................1-48
Master Expansion State ................................................................1-49
.NET Assemblies for Advance NDC ..........................................1-49
Self-Service Terminal Configuration Component....................1-51
Configuration of Fixed Drives ....................................................1-51
PCI DSS Compliance ....................................................................1-51
Runtime Installation Directories.................................................1-52
Directories for Customisations....................................................1-52
Installation Types..........................................................................1-52
Custom Directory..........................................................................1-52
Media Entry Indicator (MEI) on Spray Dispensers..................1-52
Unsupported Features..................................................................1-53
Differences Between Advance NDC and NDC+.............................1-54
Aggregate Building.......................................................................1-55
Cash Dispenser—Beeping ...........................................................1-55
Cash Dispenser—Cassette Types ...............................................1-55
Cash Dispenser—Supplies Status...............................................1-55
TM-Alert.........................................................................................1-56
Document Processing Module ....................................................1-56
Coin Dispenser ..............................................................................1-59
Digital Audio Service ...................................................................1-61
State Types .....................................................................................1-62
Configuration Parameters............................................................1-63
Customisation Data Commands.................................................1-64
PIN Entry and Verification ..........................................................1-64
BAPE Emulation............................................................................1-65
Electronic Journal and Journal Printer Backup.........................1-65
Screen Data ....................................................................................1-67
K Screens ........................................................................................1-67
Diebold Emulation Mode Status Messages...............................1-67
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxii
APTRA Advance NDC, Developer’s Guide
Table of Contents
Status Messages.............................................................................1-67
Alarms and Tamper Indication...................................................1-68
Option Digits .................................................................................1-68
Supervisor Mode...........................................................................1-68
Differences in MACing ................................................................1-70
Communications Protocols .........................................................1-70
Basic Operator Panel (BOP).........................................................1-70
VGA Enhanced Rear Operator Panel (VEROP) .......................1-71
Graphics .........................................................................................1-71
Security Camera ............................................................................1-71
Software Management .................................................................1-72
Associated Keyboards ..................................................................1-72
Bunch Note Acceptor (BNA) and Cheque Processing Module
(CPM) ...........................................................................................1-72
Transaction Request Extension State .........................................1-73
Font Definition ..............................................................................1-73
Character Sets ................................................................................1-73
Localising Advance NDC ............................................................1-73
Unsolicited Status Messages .......................................................1-73
Multi-Media File Support ............................................................1-74
Number of Screens Supported....................................................1-74
Support for Screens.......................................................................1-74
Set Display Mode Control Sequence..........................................1-75
Passbook Printer Support ............................................................1-75
Roll Width and Left Margin ........................................................1-75
Envelope Dispensing....................................................................1-75
Remote Status Indicators .............................................................1-75
Aggregate Building .............................................................................1-76
Advance NDC Aggregate............................................................1-76
Customising Aggregates..............................................................1-76
User-Created Components ..........................................................1-76
Chapter 2
Installing Advance NDC on a Development PC
Overview ................................................................................................2-1
System Requirements ...........................................................................2-2
Installation Process................................................................................2-3
Before You Start ..............................................................................2-3
Installation Types............................................................................2-3
Installing Advance NDC on a Development PC........................2-4
After Installation .............................................................................2-5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xxxiii
Table of Contents
De-installing Advance NDC..........................................................2-5
Chapter 3
Migrating Existing NDC+ Applications to Advance NDC
Overview ................................................................................................3-1
Executing an Entire NDC+ Download ...............................................3-2
Changes Required...........................................................................3-2
Recreating Graphics ..............................................................................3-3
Cardholder Graphics ......................................................................3-3
Logo Control....................................................................................3-3
Picture Control ................................................................................3-3
Display Image Files Control ..........................................................3-4
Recreating Audio Files..........................................................................3-5
Recreating Animation Files..................................................................3-6
Changing RESRVD.DEF .......................................................................3-8
Recreating Communications Template Files.....................................3-9
Proving the Download Works ...........................................................3-10
Chapter 4
Upgrading from Earlier Releases of Advance NDC
Overview ................................................................................................4-1
Modularisation and the Single Executable ........................................4-2
New Authored States .....................................................................4-2
SSDS DLL Interface Worker ..........................................................4-3
New Application DLLs ..................................................................4-3
Feature Support .....................................................................................4-5
Changes to the Interface since Release 2.6 ..................................4-5
Communications .............................................................................4-7
RSA Initial Key Loading ................................................................4-7
Additional BNA Functionality......................................................4-7
Enhanced Night Safe ......................................................................4-7
Enhanced Configuration Parameters Load.................................4-7
BAPE Emulation..............................................................................4-8
EMV C Exits.....................................................................................4-8
Keyboard Data.................................................................................4-8
Supervisor Menus ...........................................................................4-8
Fault Display....................................................................................4-9
User Messages and User Terminal Data Implementation ........4-9
APTRA Simulator ...........................................................................4-9
Upgrading Your Release of Advance NDC.....................................4-10
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxiv
APTRA Advance NDC, Developer’s Guide
Table of Contents
Authored Customisations............................................................4-10
Worker Class Support ..................................................................4-11
C Exits.............................................................................................4-11
Cardholder Screen Display..........................................................4-12
Device Access ................................................................................4-12
Supplies Data Sources ..................................................................4-14
Fitness Data Sources .....................................................................4-15
Message Handling ........................................................................4-16
User Messages and User Terminal Data....................................4-17
Printing...........................................................................................4-18
STCONT File Updates..................................................................4-21
Promote Campaigns .....................................................................4-21
Chapter 5
Configuring Advance NDC and Associated Components
Overview ................................................................................................5-1
Automatic Configuration at Start-up .................................................5-2
SST Configuration Component.....................................................5-2
ANDCSST.XML Elements ............................................................5-4
Example ANDCSST.XML Extracts.............................................5-10
Configuring an Advance NDC Application....................................5-13
Advance NDC Registry Entries ..................................................5-13
CEN-XFS Logical Device Names ................................................5-16
ActiveXFS Aliases for Cash and Cheque Acceptors ................5-17
Status Handling.............................................................................5-17
Remote Status Indicators .............................................................5-17
Unsolicited Status Messages for External System Events.......5-18
Power-Up Status Message ...........................................................5-19
Registry Settings for Device Status Messages...........................5-19
Enabling Web Exits.......................................................................5-19
Specifying Local Customisation Data ........................................5-21
Changing the Next State Number ..............................................5-24
Security Cameras ..........................................................................5-24
Configuring Data Masking and Logging ..................................5-29
Support for DVDs on SSTs ..........................................................5-31
Unsupported Configuration Options ........................................5-32
Promote Flow Point Behaviour...................................................5-32
Configuration Files..............................................................................5-34
XML Configuration Files .............................................................5-34
.NET Class Configurator Files ....................................................5-37
Configuring Communications...........................................................5-40
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xxxv
Table of Contents
Service Class ..................................................................................5-40
Clearing the Communications Buffer ........................................5-40
Off-line Timer ................................................................................5-41
TCP/IP Configuration...................................................................5-41
Dialup Configuration ...................................................................5-45
Dialup Timers and Modem Baud Rate ......................................5-47
Configuring Diagnostics Options .....................................................5-49
Displaying Additional Diagnostics Menus ...............................5-49
Show/Hide Diagnostics Shortcut................................................5-49
Disabling Self-Test on Diagnostics Exit .....................................5-50
Configuring Service Providers ..........................................................5-51
Configuring Service Providers (SPs) for Reboot ......................5-51
Service Provider Reset Value ......................................................5-51
Service Provider Tracing..............................................................5-52
Configuring Service Provider Support for CEN-XFS
Versions........................................................................................5-52
Configuring SNMP Traps...................................................................5-54
No Transaction Traps ...................................................................5-55
Application Heartbeats ................................................................5-55
Advance NDC Mode Change Traps ..........................................5-56
Implementation of SNMP Traps.................................................5-56
Configuring .NET Archive Manager ................................................5-59
Configuration Properties .............................................................5-59
General Configuration .................................................................5-60
Archive Data Configuration Examples......................................5-61
SST Properties Configuration Examples ...................................5-64
Additional Configuration ............................................................5-66
Configuring .NET Retrieve Archive Task........................................5-69
Example Updates to Settings.......................................................5-69
Configuring the .NET NDC CRM Service .......................................5-72
Configuring SST Recovery .................................................................5-73
NDC Monitor.................................................................................5-73
Forced Reboot ................................................................................5-77
Resetting USB Devices .................................................................5-78
Uninterruptible Power Supply ...................................................5-81
Configuring Suspend Timeout ..........................................................5-82
Setting the Service Provider Timeout ........................................5-82
Setting the Application Timeout.................................................5-83
Configuring Supervisor Functionality .............................................5-84
Settlement Screen Customisation ...............................................5-84
Extended Add Cash Option ........................................................5-84
Rear Settlement..............................................................................5-85
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxvi
APTRA Advance NDC, Developer’s Guide
Table of Contents
Supervisor Alphanumeric Data Entry .......................................5-85
.NET Supervisor Task ..................................................................5-89
.NET Software Updates................................................................5-91
Promote/Copyfile..........................................................................5-94
Relate Supervisor Option.............................................................5-95
Configuring Multiple Destination Screens to Display Fixed
Drives ...........................................................................................5-95
Configuring the Default Location for Note Signatures ...........5-95
Configuring the Location and Format of Extracted
Signatures ....................................................................................5-96
Configuring Supervisor Entry/Exit Message ............................5-97
Configuring Cardholder Functionality ............................................5-98
Configuring Input Type, Buffer and Display Format .............5-98
Cardholder Alphanumeric Data Entry......................................5-99
Cardholder Verification State in STCONT..............................5-102
Confirmation Screens During Cash Deposit...........................5-103
Configuring Amount Entry.......................................................5-112
Validating Buffer Data ...............................................................5-113
Configuring Beep for Cardholder Transactions.....................5-115
Cardless Transactions.................................................................5-115
Configuring Keyboards ....................................................................5-121
Front Keyboard ...........................................................................5-121
Operator Keyboard.....................................................................5-122
Touch-screen Keyboards for Alphanumeric Data Entry ......5-124
Configuring Screen Displays ...........................................................5-127
Secure Key Entry.........................................................................5-127
Display Manager for HTML Screens .......................................5-127
Hide Taskbar ...............................................................................5-127
AVI System Limit........................................................................5-128
Advance NDC Display Components.......................................5-128
Advance NDC Display Runtime Settings ...............................5-148
Enabling Extended Screen Groups...........................................5-151
Configuring the Electronic Journal .................................................5-153
EJ Compression ...........................................................................5-153
EJ Privacy .....................................................................................5-153
Maximum EJ File Size ................................................................5-153
EJ Checksum................................................................................5-153
Automatic Initialisation Options ..............................................5-154
Delaying Initialisation During Transactions...........................5-158
EJ Backup Filenames ..................................................................5-158
Multiple Destinations for EJ Backup........................................5-159
Enhanced EJ Backup...................................................................5-160
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xxxvii
Table of Contents
EJ Level .........................................................................................5-161
Configuring Printers .........................................................................5-162
Journal Printer Status .................................................................5-162
Receipt Printer .............................................................................5-164
Statement Printer ........................................................................5-168
USB Statement Printer................................................................5-169
Form-Based Printing...................................................................5-169
USB Receipt and USB Journal Printers ....................................5-174
Non-Thermal Printers ................................................................5-177
Passbook Printer..........................................................................5-177
Configuring Readers .........................................................................5-180
Accepting Smart Cards in Motorised Card Readers..............5-180
Additional DASH Reader Fatal/Suspend Handling..............5-180
Barcode Reader Filter Configuration .......................................5-181
Configuring Coin Dispensers ..........................................................5-183
Registry Keys for the Coin Dispenser ......................................5-183
Setting the Currency ...................................................................5-183
Setting the Coin Value................................................................5-183
Setting the Low Threshold.........................................................5-184
Supplies and Severity Information...........................................5-184
Configuring Cash Handlers .............................................................5-186
Setting the Currency ...................................................................5-186
Setting the Media Type ..............................................................5-187
Setting the Denomination ..........................................................5-187
Setting the Cassette Identifier ...................................................5-187
Setting the Cash Unit Identifiers for Supervisor ....................5-187
Setting Multiple Currencies.......................................................5-188
Disabling Retract after Suspend ...............................................5-189
Reporting Pick Failure Errors....................................................5-190
Cash Handler with a Fifth Physical Cassette ..........................5-190
Enabling Support for Seven Cassette Types ...........................5-190
Setting Note Thresholds.............................................................5-191
Configuring the MEI for a Spray Dispenser ...........................5-192
Supplies and Severity Information...........................................5-193
Dual Cash Handler Configuration ...........................................5-194
Configuring Cash Acceptors............................................................5-199
Cash Acceptor Installation Settings..........................................5-199
Positioning the Reason for Note Refusal .................................5-201
Defining the Please Wait screen................................................5-201
Setting the Volume......................................................................5-201
Combined Cash Handler ...........................................................5-201
Setting the Insertion Limit for Bunches of Notes ...................5-201
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxviii
APTRA Advance NDC, Developer’s Guide
Table of Contents
Setting the Retry Limit for Note Insertion...............................5-202
Transaction Request Cumulative Counts................................5-202
Configuring Note Retract to Escrow........................................5-203
Enabling Direct Deposit .............................................................5-204
Off-line Cash Deposit Handling ...............................................5-206
Reading and Journaling Serial Numbers of Good Notes......5-208
Reconciliation List Customisation............................................5-209
Printing BNA Totals ...................................................................5-209
Reason for Refusing a Deposit ..................................................5-217
Localising Tamper Indication Journaling................................5-218
Note Type Mapping ...................................................................5-218
Journaling Note Configuration Failures..................................5-220
Journaling Note Validation Errors ...........................................5-221
Device M-Status Reporting........................................................5-221
Suspend Handling ......................................................................5-222
Error Recovery ............................................................................5-222
ECB 6 Considerations.................................................................5-224
Media Entry Indicator for a BNA .............................................5-229
Encash, Print and Set Next State...............................................5-229
Cash Deposit Exception Reporting ..........................................5-230
Journal Formats...........................................................................5-232
GBXX Money Insertion Time Limit..........................................5-238
GBXX Dynamic Note Sorting....................................................5-239
GBXX Cassette Configuration...................................................5-241
Deposit Cassette Maximum Threshold ...................................5-256
Configuring Cheque Processors......................................................5-257
Accessing Cheque Data..............................................................5-257
Cheque Processing Module.......................................................5-257
Bunch Cheque Acceptor ............................................................5-260
Cheque Amount Recognition....................................................5-263
ImageMark Passport ATM Image Agent ................................5-263
Envelope Dispenser ....................................................................5-269
Chapter 6
Configuring Voice Guidance
Overview ................................................................................................6-1
Introducing Voice Guidance................................................................6-2
Voice Guidance During a Transaction.........................................6-2
Configuring Voice Guidance ...............................................................6-5
Prompting for a Language.............................................................6-5
Automatic Language Selection .....................................................6-6
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xxxix
Table of Contents
Enabling Voice Guidance Without Host Updates......................6-6
Configuring Third-Party TTS Software .......................................6-6
Specifying the Character Encoding ..............................................6-7
Audio elements required in the XML Configuration File.........6-7
Other XML Files used in Voice Guidance ...................................6-8
Advance NDC Voice Guidance and Other Applications ..............6-10
Using Advance NDC Voice Guidance with Promote..............6-10
Using Advance NDC Voice Guidance with Display
Manager .......................................................................................6-11
XML Schema ........................................................................................6-12
Schema Elements...........................................................................6-20
Encoding Formats for Voice Guidance ......................................6-38
Example XML Configuration File .....................................................6-39
Voice-Guided Sessions without Host Update.................................6-44
No Host Update XML Elements .................................................6-44
Transaction Reply .........................................................................6-53
Interactive Transaction Response ...............................................6-57
Send Configuration Information ................................................6-61
Chapter 7
Introducing the Advance NDC Authored Applications
Overview ................................................................................................7-1
The APTRA Author...............................................................................7-2
Customisation Layer .............................................................................7-3
Customisation Layer Applications Catalog ................................7-3
State Types Catalog ........................................................................7-7
Customisation Layer Catalog........................................................7-9
Transaction Reply Functions Catalog ..........................................7-9
CDI - <name> Catalog ....................................................................7-9
NDC Core Catalog ..........................................................................7-9
NDC Transactions Catalog ............................................................7-9
NDC Encryption Keys Catalog .....................................................7-9
NDC Field Workers Catalog .........................................................7-9
Application Core..................................................................................7-10
Application Core Project..............................................................7-10
Application Core Catalog ............................................................7-18
User Controls Catalog ..................................................................7-18
User Stores and Signals Catalog .................................................7-18
Synchronising with the Customisation Layer ..........................7-18
Mode Handling .............................................................................7-19
Message Handling ........................................................................7-21
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xl
APTRA Advance NDC, Developer’s Guide
Table of Contents
Message Handler ..........................................................................7-24
Supervisor Mode .................................................................................7-29
Handle Switch Work Group........................................................7-30
Activating the Supervisor Application......................................7-31
Supervisor Project .........................................................................7-31
Shared Stores .................................................................................7-34
Testing the Advance NDC Application ...........................................7-35
Running in the PC Environment ................................................7-36
Running in the Author Environment.........................................7-36
Using the XFS Simulator..............................................................7-38
Simulating Communications.......................................................7-44
Simulating a Passbook Printer ....................................................7-44
Using the Command Line Utility......................................................7-46
The Customisation Data Database File......................................7-46
Using the Custdat.exe Utility ......................................................7-47
Error Messages ..............................................................................7-48
Chapter 8
Modifying the Customisation Layer
Overview ................................................................................................8-1
Modification Options............................................................................8-2
Level 1 Customisation....................................................................8-2
Level 2 Extensions and Enhancements........................................8-3
Methods of Enhancing the Customisation Layer.......................8-3
Before Modifying the Customisation Layer ......................................8-4
Customisation Guidelines .............................................................8-4
Impact of Changing the Customisation Layer............................8-5
Compatibility Considerations .......................................................8-5
Documenting Changes...................................................................8-6
Preparation Guidelines ..................................................................8-7
Level 1 Modification Example...........................................................8-10
Journal Level Trigger Value ........................................................8-10
Journaling Examples ....................................................................8-11
Level 2 Modification Examples .........................................................8-13
Replacing State Types with Workers .........................................8-13
Editing State Types Authored in Advance NDC .....................8-16
Creating New State Types ...........................................................8-16
Transaction Request/Reply ................................................................8-18
Before Modifying the Transaction Request/Reply ...................8-18
Adding Data Fields to a Transaction Request ..........................8-18
New Function IDs in a Transaction Reply ................................8-19
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xli
Table of Contents
New Printer Flags in a Transaction Reply.................................8-20
NDC Transaction Handler...........................................................8-20
Testing the Customisation Layer ......................................................8-25
Extending the Runtime Application .................................................8-26
Chapter 9
Enhancing the Application Core or Supervisor
Overview ................................................................................................9-1
Customising the Application Core .....................................................9-2
Overview of User Messages/Terminal Data ...............................9-2
Before Modifying the Application Core.............................................9-4
Compatibility Considerations .......................................................9-4
Preparation Guidelines ..................................................................9-4
Customisation Guidelines .............................................................9-4
Processing a New Message Class........................................................9-5
Default User Messages Implementation......................................9-5
Summary of Procedure ..................................................................9-7
Example User Messages Implementation ...................................9-8
Adding Additional Data to Terminal State Messages ...................9-11
Default User Terminal Data Implementation ...........................9-11
Procedure for Adding User Terminal Data...............................9-13
Example User Terminal Data Director.......................................9-13
Processing new Enhanced Configuration Parameters ...................9-15
Altering Modes ....................................................................................9-16
Start of Day and Initialise Tasks .................................................9-16
In Service Mode.............................................................................9-17
Out Of Service Mode ....................................................................9-17
Offline Mode..................................................................................9-17
Supervisor Mode...........................................................................9-18
Enhancing the Supervisor Application ............................................9-19
Customisation without Using APTRA Author ........................9-19
Customisation Using APTRA Author .......................................9-19
Chapter 10
Using User-defined CDI Stores
Overview ..............................................................................................10-1
UCDI Service ........................................................................................10-2
UCDI Initialisation File.......................................................................10-3
Persistence Levels ................................................................................10-4
Creating a UCDI Store ........................................................................10-5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xlii
APTRA Advance NDC, Developer’s Guide
Table of Contents
Chapter 11
Delivering an Advance NDC Aggregate to the SST
Overview ..............................................................................................11-1
Interactive Installation of Advance NDC ........................................11-2
Before You Start ............................................................................11-2
Installing Advance NDC on an SST ...........................................11-3
SST Directory Structure................................................................11-4
Starting the Advance NDC Application....................................11-5
Including the Runtime Only Component in an Aggregate...........11-6
Creating a Runtime Only Aggregate .........................................11-6
Advance NDC and APTRA Initial Unattended Installation.........11-7
Overview of Procedures to Prepare Advance NDC for IUI ...11-7
Preparing the APTRA XFS Aggregate .......................................11-8
Preparing the Advance NDC Aggregate...................................11-8
Preparing the Security Aggregate ..............................................11-9
Updating the IUI and Security Batch Files................................11-9
Producing the CD or DVD.........................................................11-10
Secure Initial Unattended Installation (IUI) ..................................11-12
Advance NDC and Security for APTRA .................................11-12
Advance NDC Customisations and Security for APTRA.....11-12
Implementing Security for APTRA XP with Advance NDC 11-12
NCR Encryptor Configuration ........................................................11-14
Registry Setting for EPP Devices ..............................................11-14
Registry Setting for BAPE Devices ...........................................11-14
Setting Basic or Enhanced Mode ..............................................11-14
Key Names...................................................................................11-15
Changing the Encryptor—Scenarios........................................11-16
Retaining Encryption Keys........................................................11-17
Troubleshooting Key Manager .................................................11-18
Preparing a Modified Advance NDC Aggregate .........................11-20
Creating Aggregate Subsets and Supersets ............................11-20
Tools Component........................................................................11-20
Extending the Supplied Application........................................11-21
Installing the Aggregate.............................................................11-22
De-installing the Aggregate ......................................................11-23
Post-Installation Activities.........................................................11-23
De-installing Advance NDC ............................................................11-24
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xliii
Table of Contents
Chapter 12
Installing and Configuring Troubleshooting Tools
Overview ..............................................................................................12-1
Advance NDC Troubleshooting Utilities.........................................12-2
Selecting a Debugging Utility .....................................................12-2
Event and Error Logs ..........................................................................12-4
Advance NDC Trace Information .....................................................12-5
Tracing from C++ Code ................................................................12-6
Tracing in the Author ...................................................................12-6
State Flow Tracing ...............................................................................12-9
Enabling State Flow Tracing........................................................12-9
State Flow Trace Journaling.........................................................12-9
Always On Tracing............................................................................12-11
Installing and Configuring Silent Debug .......................................12-12
Silent Debug Installation............................................................12-12
Configuring Silent Debug..........................................................12-13
Installing and Configuring DebugLog ...........................................12-16
DebugLog Installation................................................................12-16
Configuring DebugLog ..............................................................12-16
Using the Troubleshooting Tools ....................................................12-19
Troubleshooting with Problem Determination ......................12-19
Troubleshooting with Silent Debug .........................................12-22
Troubleshooting with DebugLog .............................................12-25
Chapter 13
Modifying the Advance NDC Applications
Overview ..............................................................................................13-1
Ways of Modifying Advance NDC...................................................13-2
Use an Existing Implementation.................................................13-2
Modify or Create an Implementation ........................................13-2
Programming Techniques ..................................................................13-4
C Exits .............................................................................................13-4
Using the Author ..........................................................................13-4
Further Reading ............................................................................13-6
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xliv
APTRA Advance NDC, Developer’s Guide
Table of Contents
Appendix A
Related Documentation
Overview ...............................................................................................A-1
Advance NDC Documentation ..........................................................A-2
APTRA Author Documentation.........................................................A-4
NDC+ Documentation .........................................................................A-6
Other NCR Documentation ................................................................A-7
CEN-XFS Documentation ...................................................................A-9
Appendix B
Advance NDC Workers Supplied
Overview ............................................................................................... B-1
Customisation Layer Workers............................................................ B-2
NDC Core Workers .............................................................................. B-4
Application Core Workers .................................................................. B-9
Passbook Printer Workers................................................................. B-12
Voice Guidance Workers................................................................... B-14
Miscellaneous Workers...................................................................... B-15
Basic Self-Service.......................................................................... B-15
Special Self-Service ...................................................................... B-16
Self-Service Core .......................................................................... B-16
ATM ............................................................................................... B-17
Appendix C
Common Data Interface Stores
Overview ............................................................................................... C-1
Barcode................................................................................................... C-3
BNA Accepted Denomination Counts .............................................. C-4
BNA Active Banknotes ........................................................................ C-5
BNA Counters....................................................................................... C-6
BNA Denomination Configuration ................................................... C-8
BNA Deposited Denomination Counts............................................. C-9
BNA MISC ........................................................................................... C-10
Buffers .................................................................................................. C-11
Coin Counters ..................................................................................... C-13
CPM ...................................................................................................... C-14
CPM MISC........................................................................................... C-15
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xlv
Table of Contents
Dialup................................................................................................... C-16
EJ Upload ............................................................................................. C-18
EMV ...................................................................................................... C-19
Encryptor Variant ............................................................................... C-20
Error Processing.................................................................................. C-21
Exit Migration ..................................................................................... C-22
FIT Data................................................................................................ C-24
Key Entry Mode.................................................................................. C-28
Misc Counters ..................................................................................... C-29
Note Counters ..................................................................................... C-30
Option Digit Stores............................................................................. C-32
Printing................................................................................................. C-33
Screen Display..................................................................................... C-35
Security................................................................................................. C-36
State Information ................................................................................ C-39
Supervisor............................................................................................ C-42
Terminal Configuration..................................................................... C-45
Timers................................................................................................... C-49
Transaction Processing Flags ............................................................ C-51
UCDI Stores......................................................................................... C-53
Voice Guidance Stores ....................................................................... C-54
Miscellaneous CDIs............................................................................ C-55
Accessing CDI Store Values .............................................................. C-56
Appendix D
Font Definition
Overview ...............................................................................................D-1
Defining Fonts.......................................................................................D-2
Creating Fonts ................................................................................D-2
Font Configuration ........................................................................D-2
Installing Fonts......................................................................................D-9
Checking the Fonts .............................................................................D-10
Appendix E
PCI DSS & PA-DSS Compliance in Advance NDC
Overview ............................................................................................... E-1
PA-DSS and Compliance with PCI DSS............................................ E-2
PCI DSS Requirements .................................................................. E-2
Advance NDC and PA-DSS Requirements................................ E-3
Other PA-DSS Requirements ....................................................... E-4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xlvi
APTRA Advance NDC, Developer’s Guide
Table of Contents
Advance NDC Modifications for PA-DSS Compliance.................. E-5
Debugging....................................................................................... E-5
Journaling........................................................................................ E-6
Cash-In Component ...................................................................... E-7
DAPI Requirements....................................................................... E-8
Supervisor Authentication ........................................................... E-8
Cheque Processing Solutions............................................................ E-10
Storing Cheque Images ............................................................... E-10
Displaying Cheque Images......................................................... E-10
Printing Cheque Images.............................................................. E-10
Deleting Cheque Images Securely............................................. E-10
Cheque Processing with ImageMark Passport........................ E-11
External Audits ................................................................................... E-13
Advance NDC Solutions and Compliance............................... E-13
Advance NDC Customisations and Compliance.................... E-13
Appendix F
Example Custom.ini Files
Overview ................................................................................................F-1
Runtime SST Example ..........................................................................F-2
Development Example .........................................................................F-4
Appendix G
User-Configurable States
Overview ...............................................................................................G-1
Web Exit State .......................................................................................G-2
State Table Parameters ..................................................................G-2
Tracking URLS ...............................................................................G-3
Extension to the Web Exit State ...................................................G-4
Web Exit Configuration.......................................................................G-6
WebExitURLTable.XML File ...........................................................G-6
Adding Websites to the Trusted Sites Zone...............................G-6
Updating STCONT ........................................................................G-7
Updating the State Flow ...............................................................G-7
Cardholder Verification State .............................................................G-9
Glossary
Glossary .................................................................................... Glossary-1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xlvii
Table of Contents
Index
Index ................................................................................................Index-1
User Feedback Form
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xlviii
APTRA Advance NDC, Developer’s Guide
List of Figures
List of Figures
Chapter 1
Introducing Advance NDC
Figure 1-1
Advance NDC Architecture .........................................1-2
Chapter 4
Upgrading from Earlier Releases of Advance NDC
Figure 4-1
Double-Width Printing Example ...............................4-19
Chapter 5
Configuring Advance NDC and Associated Components
Figure 5-1
Figure 5-2
Figure 5-3
Figure 5-4
Figure 5-5
Figure 5-6
Figure 5-7
Figure 5-8
XML Envelope Schema ...............................................5-35
Example Replacement XML .......................................5-37
APTRA and SNMP ......................................................5-54
Cardless Transaction Flow........................................5-119
Touch-screen Keyboard ............................................5-124
Example Dynamic Button Control Sequence.........5-145
Example hookConfig Extract..................................5-146
Maintaining the Aspect Ratio of Displayed Cheque
Images........................................................................5-147
Figure 5-9 Example Batch File.....................................................5-157
Figure 5-10 Default Input Rejected Reasons ...............................5-217
Figure 5-11 Default Cassette Names ............................................5-218
Figure 5-12 Note Mapping XML Extract .....................................5-220
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
xlix
List of Figures
Chapter 6
Configuring Voice Guidance
Figure 6-1
Figure 6-2
Figure 6-3
Figure 6-4
Figure 6-5
Figure 6-6
Figure 6-7
Figure 6-8
Figure 6-9
Figure 6-10
Figure 6-11
Figure 6-12
Figure 6-13
Figure 6-14
Figure 6-15
Figure 6-16
Voice Guidance During a Transaction ........................6-3
Configuring Multiple Voices ........................................6-7
VoiceGuidanceVoices Array.........................................6-7
Sample Voice Guidance XML Schema ......................6-12
Key Positions.................................................................6-37
Example Voice Guidance XML File...........................6-39
Original Transaction Reply.........................................6-54
Example Voice Guidance XML Extract.....................6-54
Example Screen Update XML Extract .......................6-55
Updated Transaction Reply ........................................6-55
Original Transaction Reply.........................................6-56
Example Print Data XML Extract...............................6-57
Updated Transation Reply..........................................6-57
Original ITR Message ..................................................6-59
Example XML Extract..................................................6-60
Updated ITR Message .................................................6-61
Chapter 7
Introducing the Advance NDC Authored Applications
Figure 7-1
Figure 7-2
Figure 7-3
Figure 7-4
Figure 7-5
Figure 7-6
Figure 7-7
Figure 7-8
Figure 7-9
Figure 7-10
Figure 7-11
Figure 7-12
Figure 7-13
Figure 7-14
Figure 7-15
Figure 7-16
Application Link Build Information............................7-4
Example of the Advance NDC Director in the
Customisation Layer....................................................7-6
Application Core Director...........................................7-11
AppCore Work Group.................................................7-11
Start Of Day Work Group ...........................................7-12
Keymanager Work Group ..........................................7-13
Initialisation Functions ................................................7-14
Mode Handler Director ...............................................7-16
Mode Handling ............................................................7-20
OOS Mode Change ......................................................7-20
Message Handling........................................................7-22
Process Message ...........................................................7-23
Application Core Handle Switch ...............................7-30
Activating the Supervisor Application .....................7-31
Supervisor Project ........................................................7-32
Supervisor Mode Start-Up ..........................................7-33
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
l
APTRA Advance NDC, Developer’s Guide
List of Figures
Figure 7-17 Advance NDC Test Environment
Directory Structure ....................................................7-36
Figure 7-18 Simulated Passbook Printer Setup.............................7-45
Chapter 8
Modifying the Customisation Layer
Figure 8-1
Figure 8-2
Figure 8-3
Modification Levels .......................................................8-2
NDC State Processing Executor .................................8-14
Exit List Attribute for the Exit Condition Tester .....8-15
Chapter 9
Enhancing the Application Core or Supervisor
Figure 9-1
Figure 9-2
User Messages Director.................................................9-6
User Terminal Data Director ......................................9-12
Chapter 11
Delivering an Advance NDC Aggregate to the SST
Figure 11-1 Command Dialog .........................................................11-8
Chapter 12
Installing and Configuring Troubleshooting Tools
Figure 12-1 Example Tracing Code ................................................12-6
Figure 12-2 Tracing in the Author Flow ........................................12-7
Figure 12-3 Example Tracing Script for the
Active Script Host Worker........................................12-7
Figure 12-4 Tracing with an Active Script Host Worker.............12-8
Figure 12-5 Example Transaction State Flow Journal Entry.......12-9
Figure 12-6 Example Transaction State Flow Journal Entry.....12-10
Figure 12-7 DebugLog Application Properties
Dialog Box .................................................................12-17
Figure 12-8 Example Script to Start Silent Debug ......................12-23
Figure 12-9 Example MESSAGEIN Log File ...............................12-24
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
li
List of Figures
Figure 12-10 Example Merged Trace File ......................................12-25
Appendix C
Common Data Interface Stores
Figure C-1
Example Code to Count Counterfeit Notes............. C-56
Appendix E
PCI DSS & PA-DSS Compliance in Advance NDC
Figure E-1
Customisation Audit Example .................................. E-14
Appendix F
Example Custom.ini Files
Figure F-1
Figure F-2
Runtime SST custom.ini example ................................F-2
Development custom.ini example ...............................F-4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lii
APTRA Advance NDC, Developer’s Guide
List of Tables
List of Tables
Preface
Table Pref-1 Navigation Elements .....................................................lxv
Chapter 1
Introducing Advance NDC
Table 1-1
Table 1-2
Table 1-3
Table 1-4
Table 1-5
Table 1-6
Table 1-7
Table 1-8
Table 1-9
Table 1-10
Table 1-11
Table 1-12
Table 1-13
Table 1-14
Use of the General Purpose Buffers...........................1-12
CDI Roles.......................................................................1-13
Cash Acceptor Menu Options ....................................1-37
Migration to CEN-XFS ................................................1-44
TM Alert ........................................................................1-56
DPM Message Types in Advance NDC....................1-57
DPM State Types in Advance NDC ..........................1-59
Coin Dispenser Differences ........................................1-59
Coin Message Types in Advance NDC.....................1-60
DAS Message Types in Advance NDC.....................1-62
Customisation Data Commands in Advance NDC 1-64
Status Message..............................................................1-68
Supervisor Functions Not Supported .......................1-69
Security Camera Message Types in Advance NDC 1-71
Chapter 3
Migrating Existing NDC+ Applications to Advance NDC
Table 3-1
Table 3-2
Table 3-3
Help for Recreating or Migrating Files .......................3-2
Audio File Handling in Advance NDC and NDC+ ..3-5
Video File Handling in Advance NDC and NDC+ ...3-6
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
liii
List of Tables
Chapter 4
Upgrading from Earlier Releases of Advance NDC
Table 4-1
Table 4-2
Table 4-3
Table 4-4
Table 4-5
Table 4-6
Table 4-7
Advance NDC File Locations .......................................4-6
Service Provider Device Access Details ....................4-12
Supplies Data Source Information.............................4-14
Fitness Data Source Information................................4-15
Message Handling Changes Summary.....................4-16
Message Handler Component ID ..............................4-17
Dual Mode Error Message Selection .........................4-21
Chapter 5
Configuring Advance NDC and Associated Components
Table 5-1
Table 5-2
Table 5-3
Table 5-4
Table 5-5
Table 5-6
Table 5-7
Table 5-8
Table 5-9
Table 5-10
Table 5-11
Table 5-12
Table 5-13
Table 5-14
Table 5-15
Table 5-16
Table 5-17
Table 5-18
Table 5-19
Table 5-20
Table 5-21
Table 5-22
Table 5-23
Table 5-24
Table 5-25
SST configuration component XML Elements ...........5-4
Examples of Application Links ..................................5-15
Aliases for Device Names ...........................................5-16
ActiveXFS Aliases ........................................................5-17
Enabling Web Exits ......................................................5-20
Tags Used in the Files Referenced in SCXLOC........5-22
Security Camera XML Elements ................................5-25
Camera Flow Points.....................................................5-28
Promote Flow Point Configuration ...........................5-32
Update Mode ................................................................5-36
No Transaction Traps ..................................................5-55
Bit Positions for Modes................................................5-55
NCR SNMP Service Traps ..........................................5-57
NCR SNMP Mode Change Traps ..............................5-57
GASPER-Compatible SNMP Traps ...........................5-58
Archiving User-Defined Files Properties..................5-66
Retrieve Archive Task Class IDs ................................5-69
NDC Monitor XML Elements.....................................5-74
Valid Timer Value Definitions ...................................5-76
USB Device Reset Rules...............................................5-79
Device Recovery Elements..........................................5-80
UPS Power Management ............................................5-81
Correcting Settlement Screen Customisation
Misalignment ..............................................................5-84
Supervisor Keyboard: Elements.................................5-87
SupervisorTaskWrapper Properties ..........................5-90
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
liv
APTRA Advance NDC, Developer’s Guide
List of Tables
Table 5-26
Table 5-27
Table 5-28
Table 5-29
Table 5-30
Table 5-31
Table 5-32
Table 5-33
Table 5-34
Table 5-35
Table 5-36
Table 5-37
Table 5-38
Table 5-39
Table 5-40
Table 5-41
Table 5-42
Table 5-43
Table 5-44
Table 5-45
Table 5-46
Table 5-47
Table 5-48
Table 5-49
Table 5-50
Table 5-51
Table 5-52
Table 5-53
Table 5-54
Table 5-55
Table 5-56
Table 5-57
Table 5-58
Table 5-59
Table 5-60
Table 5-61
Table 5-62
Table 5-63
Table 5-64
Table 5-65
Table 5-66
Display Data Format XML Schema ...........................5-99
NDC Keyboard XML Schema ..................................5-100
Cash Accept Screens Formatting Properties ..........5-104
Screen Control Character Sequences.......................5-108
Amount Entry XML Schema ....................................5-113
Buffer Validation XML Schema ...............................5-114
Configurable Alert Sounds .......................................5-115
Cardless Transaction Registry Entries ....................5-117
Key Mask Settings......................................................5-120
Binary to Decimal Conversion Example.................5-120
Front Keyboard Layout .............................................5-122
Offline Keyboard XML Elements.............................5-129
Advance NDC Display XML Elements...................5-135
Offline Screen Properties ..........................................5-148
Reserved Screen Property .........................................5-149
Screen Manager Properties .......................................5-149
Display Manager Properties .....................................5-150
Hide Mouse Pointer Property ..................................5-150
CRM Property.............................................................5-151
Journal Printer Registry Value .................................5-163
Cash Count Journal Screens .....................................5-163
Promote Coupon Printing.........................................5-166
Registry Entries for Configuring Forms .................5-169
Registry Entries for Configuring Fonts ..................5-174
Registry Entry for configuring LPI ..........................5-174
USB Receipt and Journal Registry Entries for
Raw Data ...................................................................5-175
Passbook Printer Registry Values............................5-178
Barcode Filter Structure Definition..........................5-181
Default Hopper Values..............................................5-183
Supplies and Severity ................................................5-184
Cash Unit Identifiers in Supervisor Screens...........5-188
MEI Spray Dispenser Registry Entries....................5-193
Supplies and Severity ................................................5-193
SDM Registry Entries ................................................5-200
Enabling Direct Deposit ............................................5-205
Examples of Strings for the Off-Line States Array 5-207
Default Settings for Reconciliation List...................5-209
Forms Used for BNA Note Counts..........................5-210
Counts for Note Groups............................................5-212
Counts for Note Totals ..............................................5-214
Enhanced Cash-In Formatter Properties ................5-215
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
lv
List of Tables
Table 5-67
Table 5-68
Table 5-69
Table 5-70
Table 5-71
Table 5-72
Table 5-73
Table 5-74
Table 5-75
Table 5-76
Table 5-77
Table 5-78
Table 5-79
Table 5-80
Print Cash-in Totals Properties ................................5-216
Note Mapping XML Structure .................................5-220
Example Note Mapping ............................................5-220
Error Recovery Configuration Classes....................5-222
ECB 6 Note Categories ..............................................5-224
BNA Journal Format Properties...............................5-232
XML Schema Elements ..............................................5-244
Recycling Unit Registry Entries Set by
Advance NDC ..........................................................5-251
Recycling Unit Registry Entries to be
Updated by User ......................................................5-253
Cheque Endorsement Form & Media Definitions.5-259
Cheque Deposit Filename Variables .......................5-265
Example Cheque Deposit Files.................................5-265
Transaction Data File: XML Elements.....................5-267
Check Bin Empty XML Tags.....................................5-269
Chapter 6
Configuring Voice Guidance
Table 6-1
Table 6-2
Table 6-3
XML Schema Elements ................................................6-20
Codes for Defined Keys...............................................6-38
No Host Update XML Schema Elements..................6-44
Chapter 7
Introducing the Advance NDC Authored Applications
Table 7-1
Table 7-2
Table 7-3
Table 7-4
Table 7-5
Table 7-6
Table 7-7
Table 7-8
Table 7-9
Table 7-10
Application Link and Build Information ....................7-4
Signal Values.................................................................7-18
Customisation Layer Status Values...........................7-19
Application Core Terminal Command Responses..7-24
Application Core Response Definitions....................7-25
Application Core Customisation Data Command
Responses ....................................................................7-27
Application Core Response Definitions....................7-27
Application Core Transaction Reply Command
Response......................................................................7-28
Application Core Response Definitions....................7-28
Shared Stores.................................................................7-34
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lvi
APTRA Advance NDC, Developer’s Guide
List of Tables
Table 7-11
Table 7-12
Table 7-13
Table 7-14
Table 7-15
Coin Dispenser Simulator Settings............................7-40
Logical Names for Cash Acceptors............................7-41
Cash Acceptor Capability Settings ............................7-42
BillAcceptor1 Output Settings....................................7-43
Custdat.exe Export Command Options....................7-47
Chapter 8
Modifying the Customisation Layer
Table 8-1
Table 8-2
Table 8-3
Table 8-4
Data Journaling Control ..............................................8-11
Data Journaling Table Key..........................................8-11
NDC Field Workers and CDI Stores .........................8-21
Extending the Advance NDC Runtime ....................8-26
Chapter 9
Enhancing the Application Core or Supervisor
Table 9-1
Customisable Parts of the Application Core ..............9-2
Chapter 10
Using User-defined CDI Stores
Table 10-1
Table 10-2
Table 10-3
Table 10-4
Table 10-5
Table 10-6
UCDI Initialisation File Format..................................10-3
Persistence of UCDI Stores .........................................10-4
UCDIstring(name) Property.......................................10-7
UCDIinteger(name) Property.....................................10-7
Boolean newUCDIstore(name, initval, thetype)
Method ........................................................................10-8
ResetPersistentStores() Method .................................10-8
Chapter 11
Delivering an Advance NDC Aggregate to the SST
Table 11-1
Table 11-2
Table 11-3
SST Directory Structure...............................................11-4
EncMode Values.........................................................11-15
KeyMan Values ..........................................................11-16
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
lvii
List of Tables
Table 11-4
Registry Data Type Prefixes .....................................11-22
Chapter 12
Installing and Configuring Troubleshooting Tools
Table 12-1
Table 12-2
Table 12-3
Table 12-4
Table 12-5
Table 12-6
Table 12-7
Table 12-8
Default Trace Stream Types........................................12-5
Silent Debug Installation Paths ................................12-12
Registry Entry for Silent Debug Start-up................12-13
Silent Debug Configuration Parameters .................12-14
.NET PCD Support Tasks..........................................12-20
Default Problem Determination Trace Settings .....12-21
Silent Debug Commands ..........................................12-22
MESSAGEIN Line Format ........................................12-23
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 Documentation .........................A-4
Additional Authoring Documentation ......................A-5
Additional NDC+ Documentation..............................A-6
Other NCR Documentation .........................................A-7
CEN-XFS Documentation ............................................A-9
Appendix C
Common Data Interface Stores
Table C-1
Table C-2
Table C-3
Table C-4
Table C-5
Table C-6
Table C-7
Table C-8
Table C-9
Table C-10
Barcode ........................................................................... C-3
BNA Accepted Denomination Counts ....................... C-4
BNA Active Banknotes ................................................. C-5
BNA Counters................................................................ C-6
BNA Denomination Configuration ............................ C-8
BNA Deposited Denomination Counts ..................... C-9
BNA Misc ..................................................................... C-10
Buffers ........................................................................... C-11
Coin Counters .............................................................. C-13
CPM............................................................................... C-14
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lviii
APTRA Advance NDC, Developer’s Guide
List of Tables
Table C-11
Table C-12
Table C-13
Table C-14
Table C-15
Table C-16
Table C-17
Table C-18
Table C-19
Table C-20
Table C-21
Table C-22
Table C-23
Table C-24
Table C-25
Table C-26
Table C-27
Table C-28
Table C-29
Table C-30
Table C-31
Table C-32
Table C-33
CPM Misc ..................................................................... C-15
Dialup CDI Store Workers......................................... C-16
EJ Upload...................................................................... C-18
EMV............................................................................... C-19
Encryptor Variant........................................................ C-20
Error Processing .......................................................... C-21
Exit Migration .............................................................. C-22
FIT Data ........................................................................ C-24
Key Entry Mode .......................................................... C-28
Misc Counters .............................................................. C-29
Note Counters.............................................................. C-30
Option Digit Stores ..................................................... C-32
Printing ......................................................................... C-33
Screen Display ............................................................. C-35
Security ......................................................................... C-36
State Information......................................................... C-39
Supervisor .................................................................... C-42
Terminal Configuration ............................................. C-45
Timers ........................................................................... C-49
Transaction Processing Flags..................................... C-51
UCDI Stores ................................................................. C-53
Voice Guidance Stores................................................ C-54
CDIs Outside Catalogs ............................................... C-55
Appendix D
Font Definition
Table D-1
Table D-2
Table D-3
Table D-4
Font Selection Escape Sequences ................................D-3
Font Designators ...........................................................D-4
Character Set Names and Values................................D-5
Field to Attribute Mappings ........................................D-6
Appendix E
PCI DSS & PA-DSS Compliance in Advance NDC
Table E-1
Table E-2
Table E-3
PCI DSS Requirements ................................................. E-2
Changes to Advance NDC for PA-DSS ..................... E-3
ImageMark Passport Requirements and PA-DSS
Compliance ................................................................ E-11
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
lix
List of Tables
Appendix G
User-Configurable States
Table G-1
Table G-2
Table G-3
Table G-4
Web Exit State ................................................................G-2
Web Exit Tracking URLs ..............................................G-3
Extension to the Web Exit State...................................G-4
Cardholder Verification State....................................G-10
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lx
APTRA Advance NDC, Developer’s Guide
Preface
About This Publication
About This Publication
This publication describes the following:




Installing and configuring APTRA Advance NDC
Upgrading existing APTRA Advance NDC applications
Enhancing the APTRA Advance NDC cardholder session,
transaction requests/replies and message handling
Migrating existing NCR Direct Connect Plus (NDC+) Native
Mode applications to the APTRA Advance NDC product.
For differences in functionality and operation that apply on other
vendors’ SSTs, refer to the APTRA Advance NDC, Multi-Vendor
Support Reference Manual.
For methods of extending, enhancing or modifying Advance NDC,
refer to the APTRA Advance NDC, Extending the Product IP.
Using this Publication
This publication can be viewed electronically or printed.
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. The page references for the current
revision are hyperlinked; page references for
earlier revisions are not always hyperlinked.
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.
Cross-References
Within the text, cross-references are provided to
other relevant information. This may be a table,
figure or section, or a particular field or element
within a table or a reference to an external web site.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
lxi
Preface
About This Publication
Conventions Used in This
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:
— Completing and posting the feedback form
— Sending email
— Completing the web form, if you have
access to the NCR intranet.
The following abbreviations are used in this publication.
Full Form
Abbreviation
APTRA Author
Author
Microsoft Windows
Windows
CEN-XFS 3.00 or later
CEN-XFS 3
HKEY_LOCAL_MACHINE
HKLM
In XML examples, bold text is used to highlight the elements
referred to in the example description.
Terms for Cash Acceptors
There are different types of cash acceptors as follows:





Devices that allow only single notes to be deposited
Devices that allow bunches of notes to be deposited
Devices that allow bunches of notes and/or cheques to be
deposited
Devices that allow bunches of notes to be deposited and can also
allow notes to be dispensed from separate cassettes (cash in/cash
out)
Devices that allow bunches of notes to be deposited and can also
allow notes to be dispensed from the same cassette (recycling).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lxii
APTRA Advance NDC, Developer’s Guide
Preface
About This Publication
The following table describes the terms used in this publication
when referring to cash acceptors and their variants:
Term
Refers to...
Cash acceptor
Generic term for any device that accepts note
deposits
See Note 1:
Recycling
unit/Recycler
Generic terms for any device that can accept note
deposits, dispense notes and recycle deposited notes
(that is, dispense the deposited notes)
SNA
Single note acceptor
An NCR term for a device that accepts deposits of
single notes
See Note 2:
BNA
Bunch note acceptor
An NCR term for a device that accepts deposits of
bunches of notes
See Note 2: and Note 3:
SDM
Scalable deposit module
An NCR device that can accept deposits of notes or
cheques in a single transaction.
See Note 1: and Note 2:
GBNA
Global bank note acceptor
An NCR term for a device with configurable
cassettes that can accept note deposits and can
dispense notes from separate cassettes
GBRU
Global bill recycling unit
An NCR term for a device that accepts note deposits
and can dispense notes using the same cassettes
GBXX
An NCR term used when referring to both the GBNA
and GBRU devices
See Note 3:
Note 1: Some cash acceptors can also accept cheques.
Note 2: Whenever a BNA is mentioned, the information also
applies to the SNA and SDM unless explicitly stated.
Note 3: Occasionally BNA and GBXX are used to refer to all
vendors’ devices, such as in some Supervisor menu options. When a
term is used generically, this is explained in the associated text.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
lxiii
Preface
About This Publication
What Is in This
Publication?
This publication consists of the following chapters and appendices.
Read ...
For ...
Chapter 1, “Introducing
Advance NDC”
Information about Advance NDC and
what documentation can be localised.
Chapter 2, “Installing
Advance NDC on a
Development PC”
Installing Advance NDC on your
development PC.
Chapter 3, “Migrating
Existing NDC+ Applications
to Advance NDC”
Migrating an existing NDC+ application
to Advance NDC.
Chapter 4, “Upgrading from
Earlier Releases of Advance
NDC”
Migrating an existing Advance NDC
application and which registry settings
you can modify for communications.
Chapter 5, “Configuring
Advance NDC and
Associated Components”
Information about the Advance NDC
Customisation Layer and Application
Core.
Chapter 6, “Introducing
Voice Guidance”
Information about voice guidance in
Advance NDC.
Chapter 7, “Introducing the
Advance NDC Authored
Applications”
The Advance NDC application flow in
the Author (the Customisation Layer,
Application Core and Supervisor
applications) and test the applications
on a development system
Chapter 8, “Modifying the
Customisation Layer”
For the customisation options available
in the Advance NDC Customisation
Layer and how to modify or enhance its
functionality.
Chapter 9, “Enhancing the
Application Core or
Supervisor”
For the customisation options available
in the Advance NDC Application Core
and how to modify or enhance it.
Chapter 10, “Using
User-defined CDI Stores”
For how to create and use User-defined
Common Data Interface (UCDI) stores.
Chapter 11, “Delivering an
Advance NDC Aggregate to
the SST”
Installing an Advance NDC application
on an SST.
Chapter 12, “Installing and
Configuring
Troubleshooting Tools”
The Advance NDC trace logs and how
to use the “Silent Debug” and
“DebugLog” applications to
troubleshoot trace information.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lxiv
APTRA Advance NDC, Developer’s Guide
Preface
About This Publication
Who Should Read This
Publication?
Read ...
For ...
Chapter 13, “Modifying the
Advance NDC
Applications”
For methods of modifying the Advance
NDC Applications
Appendix A, “Related
Documentation”
Information about the documentation
available to help you modify/enhance
an Advance NDC application or
migrate from NDC+.
Appendix B, “Advance NDC
Workers Supplied”
For descriptions of the workers
provided with Advance NDC.
Appendix C, “Common
Data Interface Stores”
For details of the Common Data
Interface (CDI) stores and UCDI stores
provided with Advance NDC.
Appendix D, “Font
Definition”
For defining and using fonts
Appendix E, “PCI DSS &
PA-DSS Compliance in
Advance NDC”
The changes introduced for compliance
with the Payment Application Data
Security Standard (PA-DSS) of the
Payment Card Industry Data Security
Standard (PCI DSS)
Appendix F, “Example
Custom.ini Files”
For custom.ini files for both runtime SST
and development environments.
Appendix G,
“User-Configurable States”
The main parts in implementing a Web
Exit state.
This publication is intended for you if you belong to one of the
following categories:





Users who want to run Advance NDC in a multi-vendor
environment
Advance NDC users who want the new functionality offered in
this release.
Advance NDC users who want to move to an SST environment
that is compliant with the interface specification for CEN-XFS 3
Current NDC+ Native Mode users who:
— Want more flexibility than the NDC+ product offers
— Intend to migrate from OS/2 to a Windows environment.
Users who want the benefits of NDC’s message interface, using
Self-Service Support. This includes current PAS/NIC and
Composer users who wish to utilise the NDC message interface.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
lxv
Preface
About This Publication
What Experience Should I
Have?
You are expected to be familiar with using the Windows operating
systems, and with either NDC+ or Advance NDC. In addition, if
you are going to develop your own states, supervisor features,
virtual controllers or hooks (Exits), you will need programming
experience in C, C++ or C#
For any Advance NDC customisation that requires programming to
the XFS interface, such as C Exits or Authored workers, you must be
familiar with the CEN-XFS standard and be experienced in
programming to the XFS interface.
If considering initial unattended installation (IUI), you require
knowledge of the following:




APTRA XFS
Security for APTRA
APTRA IUI
APTRA Aggregate Installer/Builder Tool.
Training
NCR recommends that NCR employees, partners and customers
complete appropriate training as follows:



NCR associates supporting APTRA Advance NDC: complete
the curriculum: "Supporting APTRA Advance NDC for a
Technical Audience".
NCR partners: contact your NCR Partner manager or
APTRAXpress partner team for suitable certification courses.
NCR customers: contact your local NCR office to arrange a
suitable training programme.
A full list of courses, including other useful courses such as those for
BNA devices, voice guidance and Display Manager, is available on
the NCR University web site (registered users only). A full list of
courses, including other useful courses such as those for BNA
devices, voice guidance and Display Manager for HTML screens, is
available on the NCR University web site (registered users only).
Support Information
If you have a problem using Advance NDC, try the following to
solve it:
1
Refer to the APTRA Author User’s Guide, Appendix A,
“Troubleshooting”, to see if you can resolve the problem
yourself.
Note: If an Advance NDC exception occurs on an SST where
Problem Determination Collection is running, details are written
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lxvi
APTRA Advance NDC, Developer’s Guide
Preface
About This Publication
to the Windows event log to assist in the resolution of the
problem.
The APTRA Author User’s Guide describes how to make use of
the information. For example, a domain number is provided,
which identifies the offending component. The domain numbers
associated with the Advance NDC product are 115
(Customisation Layer) and 116 (Application Core).
2
Contact your internal support person for help.
Note: For .NET components, such as the .NET Assemblies for
Advance NDC component, you must provide Problem
Determination trace files.
3
Contact your local NCR representative.
NCR provides a wide range of support programmes. For more
information, contact your local Account Team.
If you have any problems using this guide, there is a “User
Feedback Form” at the back of this guide, where you will find the
email and postal addresses for NCR. Please take the time to reply;
your comments will be appreciated.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
lxvii
Preface
About This Publication
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lxviii
APTRA Advance NDC, Developer’s Guide
Table of Contents
Introducing Advance NDC
Chapter 1
Introducing Advance NDC
Overview
1-1
Advance NDC Implementation
1-2
Application Core
Managing SST Modes
Message Handling
Activating the Customisation Layer and Supervisor
Enhancing the Application Core
1-4
1-4
1-4
1-5
1-5
Supervisor
1-7
Customisation Layer
State Type Modules
Upgrading from an Earlier Release of Advance NDC
Migrating from NDC+ to Advance NDC
Enhancing the Customisation Layer
1-8
1-8
1-8
1-8
1-9
Synchronisation Between Applications
1-10
Common Data Interface
Common Data Interface
General Purpose Buffers
Migrating from NDC+
Enhancing the Customisation Layer
User-defined Common Data Interface
1-11
1-11
1-11
1-12
1-13
1-13
Advance NDC Development
The Advance NDC Application
Supported Operating Systems
Feature Support
Dialup communications
1-15
1-15
1-15
1-15
1-15
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Introducing Advance NDC
Automatic Device Reset Functionality
Smart Dip Card Readers
Card Read PIN Entry Initiation State
Reporting Card Data
Secure Key Entry
Uninterruptible Power Supply (UPS)
Treatment of Notes After a Power Failure
Security Cameras
Configuring Denominations for NDC Cassette Types
Reporting Pick Failures
Support for Five Physical Cassettes
Dual Cash Handlers
Note Mix Selection
Cash Handler Retract Counts
Cash Dispenser Cassette Status
Automatic Error Recovery
Replenishment Status of Cash Dispenser Cassettes
Foreign Currency Exchange Transactions
Local Cash Dispense State
Cheque Processing Module (CPM)
Return of Invalid Cheques
Magnetic Ink Character Recognition
Display of Cheque Images
Amount Buffer Display in Bunch Cheque Transactions
Cardless Transactions
Alphanumeric Dialup
Enhanced EJ Features
Display and Print TCP/IP Configuration
Promote Coupon Printing During Transaction Reply
Promote Flow Points
Configure Statement Length
Long Receipt Handling
Configuration of Forms-Based Printing
Configuration of Amount Entry Length
Enable Web Exits
Local Customisation Data
Passbook Printer Worker Classes
Associated Keyboards for FDKs
Beep Configuration
Alphanumeric Data Entry
Validation of Host Responses to Transaction Requests
Supervisor Menus
Configuration of Cardless Transactions
Machine Number Entry
Supervisor Entry/Exit Message
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-16
1-16
1-16
1-16
1-17
1-17
1-17
1-17
1-18
1-18
1-18
1-18
1-19
1-19
1-19
1-19
1-20
1-20
1-20
1-20
1-22
1-22
1-22
1-23
1-23
1-23
1-24
1-25
1-25
1-25
1-26
1-26
1-26
1-26
1-27
1-27
1-27
1-28
1-28
1-29
1-29
1-29
1-29
1-29
1-30
Table of Contents
Introducing Advance NDC
SNMP
NDC Monitor
Archive Manager
Voice-Guided Sessions
Intelligent Fraud Device (IFD)
Receipt Capture Bin
Top Margin for Receipts
Displays
Fault Displays
Cardholder Display Status
Information Entry State
Data Copy and Compare State
Hide Taskbar
Transactions Based on Device Availability
Scalable Deposit Module
Remote Status Indicators (RSIs)
Customer Relationship Management (CRM)
Internet Protocols
Troubleshooting Assistance
Problem Determination
Silent Debug
DebugLog
Message Reflection
Cash Acceptors
Supervisor Options
Direct Deposits
Off-line Cash Deposit Handling
Dynamic Note Sorting
Fixed Cassette Mapping
ECB 6 Regulations
Error Recovery
Journaling
Printing Note Counts for Bunch Note Acceptors
Confirmation Screens
Configuration Files
Promote Flow Points
Tamper and Sensor Status Reporting
Product Class Support
Support for CEN-XFS
Screen Management
Screen Support
Display Management
Image and Media Support
Voice Guidance
Invalid XML File Handling
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-30
1-30
1-30
1-31
1-31
1-32
1-32
1-32
1-33
1-33
1-33
1-33
1-33
1-33
1-34
1-34
1-34
1-34
1-35
1-35
1-35
1-35
1-35
1-35
1-36
1-39
1-39
1-39
1-39
1-39
1-41
1-41
1-43
1-43
1-43
1-43
1-44
1-44
1-44
1-45
1-45
1-45
1-46
1-46
1-46
Table of Contents
Introducing Advance NDC
Maximum State Number
Remote Key Management
Certificates
Changing the MAC Encryption Key
Dual-Mode Journal Printing
Format of Journaled Messages
APIs for C Exits to Print to Any Printer
Night Safe
ActiveX Controls
Master Expansion State
.NET Assemblies for Advance NDC
Local Printing Functions
.NET Supervisor Tasks
Software Update
Self-Service Terminal Configuration Component
Configuration of Fixed Drives
PCI DSS Compliance
Masking of Sensitive Data
Runtime Installation Directories
Directories for Customisations
Installation Types
Custom Directory
Media Entry Indicator (MEI) on Spray Dispensers
Unsupported Features
Differences Between Advance NDC and NDC+
Aggregate Building
Cash Dispenser—Beeping
Cash Dispenser—Cassette Types
Cash Dispenser—Supplies Status
TM-Alert
Document Processing Module
Coin Dispenser
Digital Audio Service
State Types
Configuration Parameters
Report Card Data in Status Message
Customisation Data Commands
PIN Entry and Verification
PIN Entry States
PIN Block - No Encryption
BAPE Emulation
Electronic Journal and Journal Printer Backup
Electronic Journal Log File Checksum
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-47
1-47
1-47
1-47
1-48
1-48
1-48
1-48
1-48
1-49
1-49
1-49
1-50
1-50
1-51
1-51
1-51
1-51
1-52
1-52
1-52
1-52
1-52
1-53
1-54
1-55
1-55
1-55
1-55
1-56
1-56
1-59
1-61
1-62
1-63
1-63
1-64
1-64
1-64
1-64
1-65
1-65
1-65
Table of Contents
Introducing Advance NDC
EJ Log File Inspection (In Service Supervisor)
1-65
Tampered Journal Records
1-65
EJ File Format
1-66
Screen Data
1-67
K Screens
1-67
Diebold Emulation Mode Status Messages
1-67
Status Messages
1-67
Alarms and Tamper Indication
1-68
Option Digits
1-68
Supervisor Mode
1-68
Communications
1-69
Diagnostics
1-69
Miscellaneous Functions
1-69
Differences in MACing
1-70
Communications Protocols
1-70
Basic Operator Panel (BOP)
1-70
VGA Enhanced Rear Operator Panel (VEROP)
1-71
Graphics
1-71
Security Camera
1-71
Software Management
1-72
Associated Keyboards
1-72
Bunch Note Acceptor (BNA) and Cheque Processing Module
(CPM)
1-72
Transaction Request Extension State
1-73
Font Definition
1-73
Character Sets
1-73
Localising Advance NDC
1-73
Unsolicited Status Messages
1-73
Multi-Media File Support
1-74
Number of Screens Supported
1-74
Support for Screens
1-74
Set Display Mode Control Sequence
1-75
Passbook Printer Support
1-75
Roll Width and Left Margin
1-75
Envelope Dispensing
1-75
Remote Status Indicators
1-75
Aggregate Building
Advance NDC Aggregate
Customising Aggregates
User-Created Components
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-76
1-76
1-76
1-76
Table of Contents
Introducing Advance NDC
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Overview
A
Overview
1
This release of Advance NDC offers the following:


A multi-vendor environment supporting the same functionality
as a single-vendor environment, except for tally and error
reporting, which are not supported.
A migration path from NCR Direct Connect Plus (NDC+) Native
Mode to the NCR APTRA Author Environment (Author)
Note: The NDC+ Diebold Emulation product cannot be
migrated to Advance NDC. For more information, refer to the
APTRA Advance NDC, Overview.
This chapter discusses the following:




The Advance NDC applications
Advance NDC development
Differences between Advance NDC and NDC+
The Aggregate Builder Tool (ABT) and Advance NDC.
For information about running Advance NDC on other vendors’
SSTs, refer to the APTRA Advance NDC, Multi-Vendor Support
Reference Manual.
For information about new features in Advance NDC, refer to the
APTRA Advance NDC, Overview.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-1
Introducing Advance NDC
Advance NDC Implementation
Advance NDC Implementation
1
Advance NDC provides a single application executable, the
Application Core, which activates the Customisation Layer and
Supervisor application DLLs as required. Having a single
executable simplifies the synchronisation between the Application
Core, Customisation Layer and Supervisor. There are still three
authored projects in the Author, maintaining the division of
functionality, and they are ApplicationCore.mpj, Supervisor.mpj, and
CustomisationLayer.mpj.
The Application Core executable activates the two DLLs and
interacts with the Central application as shown in the following
diagram:
Figure 1-1
Advance NDC Architecture
Advance NDC
Customisation
Layer
Supervisor
Application
Core
Host
Application
The host application (also known as the Central application) resides
on a host or switch and interacts with Advance NDC on the SST to
perform self-service transactions and maintain the SST in operation.
As well as activating the Customisation Layer and Supervisor, the
Application Core performs the background processing activities
previously performed by the executable part of NDC+.
The Supervisor performs the ‘Out Of Service’ activities associated
with routine maintenance and replenishment. The Customisation
Layer performs the ‘In Service’ activities associated with the
cardholder.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-2
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Advance NDC Implementation
Shared data is used by the Application Core, Supervisor and
Customisation Layer. The repository that holds this data is called
the Common Data Interface (CDI).
The following sections describe each of these applications.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-3
Introducing Advance NDC
Application Core
Application Core
The Application Core is an authored application built as an
executable. It performs the following tasks:


Managing SST Modes
Managing the different modes the Self-Service Terminal (SST)
can operate in
Handling messages to and from the host
The Application Core is responsible for moving from one mode to
another, based on certain conditions of the Self-Service Terminal
(SST), as well as performing the functionality of each mode. The
Application Core activates the Customisation Layer or Supervisor
depending on the mode:
1
The modes are:




Out of Service
Supervisor—see Note:
In Service—the Customisation Layer executing states and
screens
Offline.
Note: Supervisor mode is entered only when the terminal is idle
and after the mode switch is moved to the ‘Supervisor’ position.
Supervisor mode functionality is provided by the Supervisor
application. For details, see “Supervisor” on page 1-7.
In addition to mode changes, there are other tasks that are
performed by the Application Core:




Message Handling
Power-up
Start of Day
Initialise
Suspend.
The Application Core either accepts or rejects the incoming
messages depending on the content of the message and the current
mode of the SST. This shields the Customisation Layer from any
message handling and retains the integrity of the NDC message
interface compatibility. Any messages received which are not valid
for a particular mode are rejected.
1
Central can send the following types of messages to the SST:


Terminal Commands
Customisation Data Commands
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-4
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Application Core


Transaction Reply
Host to Exit. That is, the message used by the host to
communicate with states, supervisor features, virtual controllers
or hooks developed by the user.
For details of these messages, refer to the APTRA Advance NDC,
Reference Manual and the APTRA Advance NDC, Extending the
Product publication for host to Exit messages.
Activating the
Customisation Layer and
Supervisor
1
The Application Core determines when to enter In-Service or
Supervisor mode. For In-Service mode, the Application Core
activates a cardholder session and passes control to the
Customisation Layer. When the transaction is complete, control is
returned to the Application Core. Any processing performed by the
Customisation Layer can only be done while the SST is In Service.
The Application Core controls the Customisation Layer by
communicating mode changes to and from In Service. However, if
the SST is in the middle of a cardholder session, the Customisation
Layer completes the current session before passing control back to
the Application Core.
For Supervisor mode, the Application Core activates a Supervisor
session and passes control to Supervisor. When the session is
complete, control is returned to the Application Core.
For more information, see “Synchronisation Between Applications”
on page 1-10.
Enhancing the Application
Core
1
The Application Core executes the fixed part of Advance NDC that
is not typically customised. Most developers will only wish to make
changes to the Customisation Layer but the Application Core can be
customised using the following:




Screen downloads
Configuration and/or Enhanced Configuration Parameter
downloads
Native Mode option digits
Reserved Screens.
The Application Core cannot be modified to the same extent as the
Customisation Layer. Any modifications to the Application Core
must be made by observing the customisation guidelines given in
Chapter 8, “Customisation Guidelines”. Conformance to the
guidelines will ensure the core NDC+ functionality (mode handling
and existing messages) remains intact and that minimal
redevelopment is required for subsequent releases of Advance
NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-5
Introducing Advance NDC
Application Core
Any Application Core customisations you make using the Author
will have to be re-applied to future releases of Advance NDC
Service Packs or updates. For this reason, NCR recommends you
avoid using the Author to customise the Application Core.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-6
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Supervisor
Supervisor
1
Supervisor is an authored application DLL activated by the
Application Core to perform Supervisor-related tasks.
You can customise or extend Supervisor functionality in the
following ways:




Modifying the text displayed in menus and messages
Modifying the text used for printing Security Trace Messages
Including your own Supervisor Exits
Adding Activate .NET Supervisor Tasks.
It is also possible to add new menus, functions and Activate .NET
Supervisor tasks using the APTRA Author, and then building the
application DLL. However, any Supervisor changes you make using
the Author will have to be re-applied to future releases of Advance
NDC or service pack updates. For this reason, NCR recommends
you avoid using the Author to enhance or extend the Supervisor
application.
For more information on how the Supervisor application handles
Supervisor Mode, see “Supervisor Mode” on page 7-17.
The Supervisor application uses the Common Data Interface (CDI)
to read and set configuration options and counters. For details of the
CDI, see the “Common Data Interface” on page 1-11.
To enable data to be shared between the Application Core and the
Supervisor application, some CDI stores are shared stores. These
stores are listed in “Shared Stores” on page 7-34.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-7
Introducing Advance NDC
Customisation Layer
Customisation Layer
The Customisation Layer is an authored application DLL that is
activated by the Application Core to handle all aspects of a
cardholder session (for example, Card Entry, Card Read, PIN Entry,
Transaction Request/Reply, Cash Dispense). In other words, it
performs the ‘In Service’ activities associated with the cardholder.
The Customisation Layer allows you to customise the behaviour of
the SST by modifying the behaviour of the cardholder session
without affecting the Application Core or the NDC message
interface. State type modularisation reduces the impact on your
customisations of any future Advance NDC release or update.
State Type Modules
Upgrading from an Earlier
Release of Advance NDC
1
1
The modularisation of state types and Transaction Reply functions
simplifies the Customisation Layer application DLL by separating
the state flow from state type implementation. Each authored state
type, including NDC states, has its own application DLL and each
state is executed by the NDC Processing State Executor worker.
Upgrading from an earlier release of Advance NDC may require
some additional configuration as all devices are now accessed
through an interface that is compliant with the CEN-XFS 3
specification.
State type modularisation means that any customisations to the
following may have to be re-applied:


State types
Transaction Reply functions.
However, for customisations to be performed or migrated, the state
flow can still be exited through the normal method of the 'Exit
Condition Tester' worker.
For details of the changes affecting customisation and configuration
in Advance NDC, see Chapter 4, “Upgrading from Earlier Releases
of Advance NDC”.
If you are upgrading to move to a multi-vendor environment, the
APTRA Advance NDC, Multi Vendor Support Reference Manual gives
details of the operational and other differences that apply on other
vendors’ SSTs.
Migrating from NDC+ to
Advance NDC
1
In Advance NDC, NCR provides a Customisation Layer, which
executes your existing NDC+ download. There is generally no need
to modify the download in any way.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-8
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Customisation Layer
The equivalent functionality of the Customisation Layer in NDC+ is
when NDC+ enters In Service mode and executes the downloaded
State flow, starting at State 0 (the Card Read or Card Read PIN
Entry Initiation state).
Chapter 3, “Migrating Existing NDC+ Applications to Advance
NDC”, describes how you can use Advance NDC to execute your
existing NDC+ download. However, NCR recommends you first
read this chapter and Chapter 2, “Installing Advance NDC on a
Development PC”.
Enhancing the Customisation Layer
1
After migrating to Advance NDC, you may want to offer, during In
Service mode, functionality that cannot be achieved using NDC+
state types. In NDC+ you were able to customise the behaviour of
the SST using data download messages. Advance NDC supports
this method of customisation and offers additional means of
enhancing Advance NDC using the Author.
You can enhance the Customisation Layer provided using the
APTRA Author and Authoring components (workers).
By modifying the Customisation Layer using the Author, you can
author new cardholder services and transactions, and incorporate
them as applications DLLs with no impact to the rest of the
application. Modifying the Customisation Layer is discussed in
“Modification Options” on page 8-2
Any modifications you make to the Customisation Layer using the
Author will have to be re-applied to future releases of Advance
NDC or service pack updates. However, only the affected state type
or Transaction Reply DLL will have to be rebuilt.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-9
Introducing Advance NDC
Synchronisation Between Applications
Synchronisation Between
Applications
The Application Core controls the activity of the Customisation
Layer and Supervisor applications and is responsible for managing
the different modes of the SST. The implementation of state types as
application DLLs has allowed all three authored applications to be
merged into one executable. This simplifies inter-process
communications and XFS session management.
The role of the Customisation Layer is to initiate a cardholder
session for cardholder transactions. For this processing to occur, the
SST must be in the In Service mode and ready to initiate a
cardholder session. The Application Core activates the
Customisation Layer to allow a cardholder session to be initiated
and the Card Read state is encountered first. At the end of a
transaction, the Session Complete condition is met and the flow
returns to the Application Core.
While the SST is In Service, the Application Core can query the
status of the Customisation Layer using a shared store provided by
the Customisation Layer. This is used to determine whether further
message processing or mode changes can take place at various
stages in the application execution (such as processing messages
while the SST is idle, waiting for a card to be entered).
How the Application Core controls the activities of the
Customisation Layer and Supervisor is described in “Synchronising
with the Customisation Layer” on page 7-18.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-10
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Common Data Interface
Common Data Interface
1
The Application Core, Customisation Layer and Supervisor share
data at runtime. The repositories that hold this data are called the
Common Data Interface (CDI) and the User-defined Common Data
Interface (UCDI).
Common Data Interface
1
The CDI consists of stores representing all of the data used
throughout an Advance NDC application. There are several
hundred CDI store workers, one for each piece of data.
The CDI stores are provided in “CDI - <name>” catalogs. For details
of the CDI stores provided and their use, see Appendix C,
“Common Data Interface Stores”.
Each piece of CDI data has a specific purpose and is used in
different parts of the Advance NDC application. For example, the
Operation Code Buffer is read by the Transaction Handler and
included in the Transaction Request Message. It is written to by
various state types, and may be written to by your Customisation
Layer.
The workers are grouped in catalogs according to their use.
Examples of CDI data are as follows:



Configuration options
FIT data
Transaction related buffers, such as the Operation Code Buffer,
Buffer A and Card Track 3 Data.
The CDI stores you are most likely to access are those in the “CDI Buffers” catalog.
General Purpose Buffers
1
Many of the buffers used in Advance NDC store a particular data
item, such as the Card Track 1 Data buffer for the Card Read state,
or the Amount buffer for the Amount Entry State. There are also
two general purpose buffers, Buffer B and Buffer C, which can be
used to store a variety of numeric data collected from the
cardholder. The functionality of the buffers is determined by the
download from Central, or a local customisation.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-11
Introducing Advance NDC
Common Data Interface
Different state types can populate these buffers or be used to check
the values stored in them, as follows:
Table 1-1
Use of the General Purpose Buffers
State Type
Description
H - Information Entry State
Used for data of up to 32 digits. Examples of the data that could be stored are: an
account number for a money transfer; or a mobile phone number when buying
more call time.
G - Amount Check State
Used to check the value of the buffers against specified limits.
R - Enhanced Amount Entry
State
Used when multi-language screens are required; the specified buffer stores the
amount entered by the cardholder. The maximum number of digits that can be
entered is determined by the size of the Amount buffer, 8 or 12 digits.
X - FDK Information Entry
State
The specified buffer stores a predefined number corresponding to the FDK
selected by the cardholder. For example, this could be used to offer fixed
amounts of cash to the cardholder.
z017 - Note Mix Selection
State
One or two buffers can be specified to store the following:

Amount entered by the cardholder. The maximum number of digits that can
be entered is determined by the size of the Amount buffer, 8 or 12 digits

Note mix requested by the cardholder.
If the same buffer is specified in both parameters, only the amount entered by
the cardholder is stored.
The locally stored data can be passed to Central, which must specify
transmission of the buffers, using a Transaction Request state if
required. Central also specifies which buffer to use.
In addition, Buffer B is used in an Interactive Transaction Response,
when a message is sent to the SST with screen data and specific keys
enabled. The key data entered by the cardholder at this screen is
stored in Buffer B and reported to the host in a second transaction
request message. If the cardholder presses the Cancel key, or does not
press a key before a timeout occurs, then the value C or T is
returned in the buffer to indicate the cardholder’s action.
For details of the state types, Transaction Requests and Interactive
Transaction Responses, refer to the Advance NDC Reference Manual.
Migrating from NDC+
If you are simply using Advance NDC to execute your existing
NDC+ download, you do not need to concern yourself with the
Common Data Interface as access to the CDI stores has been
implemented for you.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-12
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Common Data Interface
All of the data in Advance NDC will be accessed at the correct time
and place, whether it is from one of the NDC+ state types or from a
Transaction Request/Reply.
Enhancing the Customisation Layer
1
Whether you choose to enhance the Customisation Layer or extend
it by adding your own state types, you need to be aware of the
relevance of the Common Data Interface and the use of the CDI
workers we provide.
The CDI has the following roles:
Table 1-2
CDI Roles
Type of CDI Data
Role
Data used by the Advance
NDC application
Enables data sharing between state
types, the Transaction Request/Reply
mechanism and workers.
Data made available in NDC+
to allow you to develop Exits
(Shared Data)
Enables the migration of the Exit code
you have developed to Advance NDC.
The data that you need to access is dependent on what you want to
do. NCR has provided all of the data you will need.
If you are extending the Customisation Layer, you need to write to
the correct CDI workers before using the Transaction Request/Reply
mechanism. For example, you need to explicitly put a value in the
Operation Code Buffer, which is included in the Transaction
Request message. To do this, you write to the Operation Code Buffer
worker in the “CDI - Buffers” catalog, using a Setter/Assigner
worker.
For details of the Setter and Assigner workers, refer to the worker
class on-line help provided with the APTRA Author.
For details of the CDI stores you need to write to for each of the
Transaction Request Fields, see “Transaction Request/Reply” on
page 8-18.
For more details of NDC+ shared data, refer to the APTRA Advance
NDC, Extending the Product publication.
User-defined Common
Data Interface
1
The APTRAUSERCDI local service runs at start-up. It is identical to
the CDI in functionality, but also allows for the creation of new CDI
stores (called UCDI stores) without the need to modify the CDI C++
source code.
Like CDI stores, UCDI stores provide a means of sharing data
between applications. They hold string or integer data and may be
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-13
Introducing Advance NDC
Common Data Interface
persistent (persistent data is preserved across terminal
shutdowns/power failures).
UCDI stores can be created to share data between the Customisation
Layer and Application Core and in different programming
environments such as C, C++, Script, COM, Author and VB. For
example, you may use UCDI stores when supporting a third-party
device or when configuring new options or timers.
All UCDI stores must be cleared, initialised and set by your
application, as required.
An example of a UCDI store implementation is the CPM Cheque
Accept state (‘w’). The state uses a UCDI store named CPM cheque
present which checks if a cheque is present in the CPM device. The
store is used in the state and by Supervisor.
For details of the UCDI stores provided and their use, see
Appendix C, “Common Data Interface Stores”.
For more information on using UCDI stores, see Chapter 10, “Using
User-defined CDI Stores”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-14
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Advance NDC Development
Advance NDC Development
1
This section summarises the changes and additions made during
the development of releases of Advance NDC.
The Advance NDC
Application
1
Prior to Advance NDC 2.05, the Supervisor functionality was
contained in the Application Core. In Advance NDC 2.05, the
Supervisor functionality was moved from the Application Core into
a separate Supervisor application. This change meant that Advance
NDC comprised three applications developed using the APTRA
Author, NCR’s graphical development tool.
From Advance NDC 3.03, a single application executable is
provided, the Application Core, which activates the Customisation
Layer and Supervisor application DLLs as required. The separation
of the state flow from the state type implementation simplified the
Customisation Layer application DLL.
Supported Operating
Systems
Windows XP is supported in both development and runtime
environments.
1
Windows 7 and POSReady 7 are supported in runtime
environments only.
For details of operating system support, refer to the APTRA Advance
NDC, Overview.
Feature Support
1
The following sections describe the support offered by various
releases of Advance NDC.
Dialup communications
1
Advance NDC uses CCM VISA2 for dialup communications. For
details of the supported modems, refer to the CCM VISA2 release
bulletin.
There is an additional menu in Supervisor to configure most of the
dialup parameters. In the APTRA Author, there is a worker class,
NDC Dialup, and a CDI store, Dialup Flag, to handle dialup
communications in the Supervisor project.
From Advance NDC 3.04, TCP/IP configuration uses .NET CCM
TCP/IP support. For information on the development of
communications from release 3.04, see “.NET Assemblies for
Advance NDC” on page 1-49.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-15
Introducing Advance NDC
Advance NDC Development
Automatic Device Reset Functionality
1
Prior to Advance NDC 4.02, the CEN-XFS reset was only invoked
following errors reporting WFS_SYSE_HARDWARE_ERROR and
WFS_ERR_ACT_RESET system events. A 24-volt reset would also
occur if the device remained in a fatal condition following the
CEN-XFS reset.
From Advance NDC 4.02, the following improvements have been
made to the reset functionality on NCR SSTs with a USB
Miscellaneous Interface:



A 24-volt reset can be triggered if a communications failure is
reported with WFS_ERR_ACT_RESET or WFS_ERR_HW_MAINT
errors
The 24-volt reset can be configured to reset all USB devices
following a communications failure, so the SST does not need to
be restarted following the reset
A CEN-XFS reset does not need to be performed before a 24-volt
reset.
Note: The 24-volt reset is not supported for cash acceptors.
Smart Dip Card Readers
1
From Advance NDC 3.00, in the APTRA Author, a worker class,
Card ATR Reader, is available and a work group has been added to
the Card Acceptor worker class to provide smart card support.
Card Read PIN Entry Initiation State
1
From Advance NDC 4.02, the display of a PIN entry screen in the T
state (Card Read PIN Entry Initiation) while the card is being read is
optional.
Note: This optional configuration does not change the behaviour of
the Card Read PIN Entry Initiation state with a smart dip reader
when the chip on the card being read is successfully powered on. In
this case, the PIN entry screen is never displayed as part of the
processing for this state.
Reporting Card Data
Prior to Advance NDC 3.00.01, it was not possible to configure the
reporting of card data either to the journal or in status messages.
From Advance NDC 3.00.01, Enhanced Configuration option 37
(Print Track 2 to Journal) is supported. This option enables the
journaling of track 2 data, masked if required for PA-DSS
compliance.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-16
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
From Advance NDC 4.02, Enhanced Configuration option 41 (Send
Track Details on Card Retract) is supported. This option enables the
reporting of all card data in a Card Reader/Writer status message
following a card retract operation.
Secure Key Entry
1
From Advance NDC 3.00, manual entry of secure keys is supported
with a worker class, Secure Encryption Key Collector.
Note: Secure key entry offers standards compliance rather than
enhanced security. The decision to use secure key entry rather than
entering keys through the EOP is the responsibility of the financial
institution.
Uninterruptible Power Supply (UPS)
1
From Advance NDC 3.00, support for UPS devices enables the SST
to complete a transaction if a power failure occurs, and then go out
of service, or perform a controlled shutdown if the battery power
runs low.
Treatment of Notes After a Power Failure
1
Prior to Advance NDC 4.02, if the status of notes was unknown
following a power failure during a transaction, the notes were
treated as presented.
From Advance NDC 4.02, a configuration setting allows notes with
an unknown status following a power failure during a transaction
to be treated as not presented on Diebold SSTs.
Note: This configuration is intended for use on other vendors’ SSTs
only. It is not compliant with CEN XFS and must be used with
caution.
For details of the configuration, refer to Chapter 6, “Advance NDC
on Specific Vendors’ SSTs” in the APTRA Advance NDC,
Multi-Vendor Support Reference.
Security Cameras
1
From Advance NDC 4.00, support for cash deposit camera flow
points was withdrawn due to the change of implementation to
.NET.
From Advance NDC 4.01, two camera flow points are supported at
Cash Present and Cash Taken. Two cameras can be configured to
take pictures at both flow points using an XML-based configuration
file.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-17
Introducing Advance NDC
Advance NDC Development
From Advance NDC 4.02, support for .NET is introduced, allowing
the cash deposit flow points to be re-introduced and extended.
Configuring Denominations for NDC Cassette Types
1
Prior to Advance NDC 4.02, only one NDC cassette type could be
configured for each denomination.
From Advance NDC 4.02, a cassette unit identifier can be used to
configure the same denomination for multiple NDC cassette types.
Reporting Pick Failures
1
Advance NDC recognises consecutive pick failures occurring
during a single transaction or over several transactions. On NCR
SSTs with single cash handlers and four cassette types, consecutive
pick failures are reported as follows:


From Advance NDC 3.03, the first and second pick failures are
not reported as errors. The third pick failure is reported as a fatal
error.
From Advance NDC 4.02, this default reporting of pick failures
can be configured to report a routine error on the first pick
failure and a warning on the second pick failure. The third pick
failure is still reported as a fatal error.
Support for Five Physical Cassettes
1
From Advance NDC 4.01, the reporting of a physical fifth cassette is
supported on the Fault Display and in the Test Cash option in
Supervisor. Journaling of tamper indications for the fifth cassette is
also supported. Only four logical cassettes are supported, so at least
two physical cassettes must be configured as the same NDC cassette
type.
Dual Cash Handlers
1
From Advance NDC 3.01, cash handler capacity can be increased
without host impact.
A second cash handler can be added with the two cash handlers
reported as a single logical cash unit, therefore emulating a single
cash handler.
Dual cash handlers, if present, are supported as follows:




Increased cash handler capacity without host impact
The ability to use each cash handler for a different currency type
Two cash handlers are reported as a single logical cash unit
The option of using up to seven cassette types, depending on the
setting of Enahnced Configuration Parameter option 76
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-18
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Advance NDC Development

Separate and/or combined status reporting for hardware
configuration, supplies and fitness data.
From release 3.03, the combination of supported cash handlers can
include a recycling unit (GBRU).
From Advance NDC 4.02, a specific cash handler can, if configured,
be selected in the Clear Cash and Standard Cash functions on the
Supervisor Replenish menu. This means that reconciliation and
count clearing can be done separately for each cash handler in a
dual cash handler.
Note Mix Selection
1
From Advance NDC 4.02, the Note Mix Selection state allows
consumers to select their preferred note mix in cash dispense
operations using the FDKs.
Note: This state is not supported when dual cash handlers are
present.
Cash Handler Retract Counts
1
Prior to Advance NDC 4.01, the retract counts for dispense
operations were not maintained although the counts for notes
retracted during deposit operations were maintained. From
Advance NDC 4.01, the reporting of retract counts for dispense
operations can be configured if the SST contains a cash recycler and
recycling is enabled.
Cash Dispenser Cassette Status
1
From Advance NDC 4.00, if a cash dispenser cassette has an XFS
status of STATCUMANIP, STATCUNOVAL or STATCUNOREF at the
following times, the status of the cash dispenser cassette is cleared
using the XFS exchange operation (StartExchange/EndExchange):


At start of day
After cassette insertion.
If a cash dispenser cassette has a status of STATCUMANIP, this is
reported through the fault display and terminal commands.
Automatic Error Recovery
1
Prior to Advance NDC 04.01.01, automatic error recovery (AER)
was performed whenever the following hardware errors were
received from the Service Provider:


ACT_HWMAINT
ACT_RESET
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-19
Introducing Advance NDC
Advance NDC Development
From Advance NDC 04.01.01, AER was performed only when an
ACT_RESET error is received from the Service Provider.
From Advance NDC 4.02, AER is superceded by the reset
functionality described in “Automatic Device Reset Functionality”
on page 1-16.
Replenishment Status of Cash Dispenser Cassettes
1
In Advance NDC 3.04, the replenishment status of cassettes was
reported only for those cassettes that had been accessed during a
dispense operation.
From Advance NDC 4.00, the actual replenishment status of all
cassettes can be reported, not just those that have been accessed
during a dispense operation.
Foreign Currency Exchange Transactions
1
From Advance NDC 4.02, two new transaction reply functions
(function IDs ‘b’ and ‘f’) are provided for foreign currency exchange
transactions. They allow deposit and dispense operations to be
processed as a single function. Function ID ‘b’ allows cash to be
dispensed before notes are deposited and can be used only on SSTs
where the deposit device is physically different from the cash
dispenser. Function ID ‘f’ allows notes to be deposited before cash is
dispensed and can be used on any SST that supports cash
dispensing and depositing. ECB 6 functionality is supported for
both. Only notes can be deposited, but both notes and coins can be
dispensed.
Local Cash Dispense State
1
From Advance NDC 4.02, a new state is available to support local
transactions dispensing notes, coins or a combination of notes and
coins that can be completed without host interaction. This state can
be used, for example, in foreign currency transactions where the
consumer deposits notes in a foreign currency and receives cash,
which can be notes, coins or both, in the local currency.
Cheque Processing Module (CPM)
From Advance NDC 3.02, the Cheque Processing Module (CPM), if
present, is supported in Advance NDC as follows:





Additional information in various Terminal State messages
New Device Fault Status messages
New Configuration Parameters
New State Type - Cheque Accept State
Additional fields in Transaction Request and Transaction Reply
messages
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-20
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development










New printer flags in field ‘q’ of the Transaction Reply allowing
cheque endorsement and/or rubber stamping
Changes to the Close state
Changes to various Supervisor replenishment functions
Two Supervisor functions
Returns cheques not authorised by Central
Endorses and pockets authorised cheques
Takes a front and/or rear image of the cheque
Images can be rotated and resized and the codeline can be
masked for printing on the receipt printer
Changes to Start of Day
New CDI Stores.
For details of configuring cheque processors, see “Configuring
Cheque Processors” on page 5-257. For details of using the CPM,
refer to the following publications:


APTRA Advance NDC, Supervisor’s Guide
APTRA Advance NDC, Reference Manual.
Bunch Cheque Accept State In Advance NDC 3.04, the Bunch
Cheque Accept State implementation was the same as NDC+: when
the cardholder declined more time, the Timeout Next State number
was taken. From Advance NDC 4.00 onwards, the Cancel Next
State number is taken, which matches the CIC implementation.
Accepting Single Cheques on a Bunch Cheque Acceptor In
Advance NDC 03.02 and 03.03, access to the bunch cheque acceptor
was provided by the PTR SP. To use the PTR SP for single cheque
acceptance, the platform components had to be configured as
follows:
1
Set the USB SCPM component to the PTR class, as described in
the USB SCPM component release bulletin
2
Point to the Advance NDC defined forms and media definition
folders using the following registry entries:
1
1
HKLM\SOFTWARE\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDERS\
SCPMPTR\GENERAL_CONFIGS\FormsDir
HKLM\SOFTWARE\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDERS\
SCPMPTR\GENERAL_CONFIGS\MediaDir
In Advance NDC 03.02.xx, the definition folders were specified
as follows:
—
FormsDir
C:\XFS\Data\CPM\Forms
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-21
Introducing Advance NDC
Advance NDC Development
—
MediaDir
C:\XFS\Data\CPM\Media
In Advance NDC 03.03.xx, the definition folders were specified
as follows:
— For forms
C:\Program Files\NCR APTRA\Printing\CPM\Forms
— For media definitions
C:\Program Files\NCR APTRA\Printing\CPM\Media
From Advance NDC 3.04.xx, the bunch cheque acceptor was
supported through the .NET Assemblies for Advance NDC. For
details of this development, see “.NET Assemblies for Advance
NDC” on page 1-49.
From Advance NDC 4.02, a cheque returned by the host can be
endorsed during the Process Cheque Transaction Reply function
where the bunch cheque acceptor is configured as a single cheque
processor. This is also supported on single cheque processors that
support the endorsement of returned cheques.
Return of Invalid Cheques
1
Prior to Advance NDC 4.00, cheques detected as invalid by the
validation service were by default returned to the customer during
the Bunch Cheque Acceptance state. This happened at the
beginning of a transaction.
From Advance NDC 4.00, invalid cheques, as detected by the
validation service, can be marked for return and returned later in
the transaction. For off-line transactions, the cheques are returned
during the Bunch Cheque Handling state. For transactions
controlled by the host, the cheques are either returned or moved to
the deposit bin.
Magnetic Ink Character Recognition
1
From Advance NDC 4.00, Magnetic Ink Character Recognition
(MICR) reading for cheque processing can be disabled or enabled
through the registry.
Codeline Configuration In Advance NDC 3.02 and earlier
versions XFS returned codeline characters in cheque truncation
system (CTS) format. The following registry entry was set to 0:
HKLM\SOFTWARE\NCR\Advance NDC\CPM\MICRFormat
From Advance NDC 3.03, this registry entry is set to 1 and XFS
returns codeline characters in NCR format.
Information is provided on configuring the codeline for alternative
MICR fonts.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-22
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
Display of Cheque Images
1
Prior to Advance NDC 4.02, cheque images could be displayed
scaled according to the scanned image size.
From Advance NDC 4.02, additional local configuration provides
two further options, re-interpreting the Lift Cheque Image control,
as follows:


Scaling the cheque image according to the display size instead of
the scanned image size.
Scaling the cheque image to fit the screen display area and
maintain its aspect ratio. This prevents distortion of the
displayed image.
This configuration also applies to the Bunch Cheque Display Image
control.
Amount Buffer Display in Bunch Cheque Transactions
1
Prior to Advance NDC 4.02, the display of the Amount buffer using
the Bunch Cheque Value Display control was always aligned to the
right of the display area on the screen.
From Advance NDC 4.02, the alignment and format of the Amount
buffer during bunch cheque transactions depends on the Value
Format Screen field specified in the Bunch Cheque Value Display
control.
Cardless Transactions
1
From Advance NDC 3.01, a non-cash transaction can be started
without a card using FDKs, FDK emulation, or a numeric key
defined in the registry. This provides an alternative to using a card.
From Advance NDC 4.01, support for customer relationship
management (CRM) applications is provided for cardless
transactions where a FIT search is not performed.
From Advance NDC 4.02, a Supervisor option is available for
configuring cardless transactions. For further information see
“Configuration of Cardless Transactions” on page 1-29.
Alphanumeric Dialup
1
From Advance NDC 3.01, alphanumeric characters can now be
included in the following dial up fields:




BIN
TID
MODEM INI STR
PRIMARY NO
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-23
Introducing Advance NDC
Advance NDC Development


SECONDARY NO
N/A STRING
Enhanced EJ Features
1
Various electronic journal (EJ) options have been added since
release 3.01.
EJ Backup Mode In previous releases of Advance NDC, only the
latest copy of the EJ could be retained. From release 3.01, up to 1000
previous backups can be retained, depending on disk space. The
option is enabled through the Enhanced Configuration Parameters
download, or using the Supervisor Config menu. The format of the
EJ remains unchanged.
Host Control of BackUp Mode From release 3.02, the Enhanced
Configuration Parameters download method of updating the EJ
backup mode can be blocked. This option is enabled through the
Supervisor Config menu.
Multiple Destinations for EJ Backup In addition to retaining
multiple copies of the EJ, the destination for the EJ backup file can
be selected from available network and removable drives such as
CDRW, diskette or USB (Universal Serial Bus) drives. This option is
enabled through the Supervisor Config menu.
Maximum File Size From release 3.02, a maximum size can be set
for the EJ file. This can be a minimum of 1KB; the maximum
depends on available disk space. This option is enabled through the
Supervisor Config menu.
Automatic INIT From release 3.02, several options are available to
allow EJ initialisation (EJ INIT) to be run automatically, as follows:



1
1
1
1
1
Cutover
Scheduled
Agent
There is also an option to take a copy of the initialisation file after
completion of the initialisation operation. All these options are
enabled through the Supervisor Config menu.
From release 4.0, the EJ can be initialised after a settlement
transaction using a Supervisor option.
Direct EJ Backup From release 3.02, an emergency backup can be
made of the EJ file if, for example, there is insufficient disk space for
an initialisation operation. This is selected through the Supervisor
Replenish menu.
Compression of the EJ File From release 3.02, the EJ file can be
compressed as part of the initialisation operation.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-24
APTRA Advance NDC, Developer’s Guide
1
1
Introducing Advance NDC
Advance NDC Development
Privacy for the EJ File From release 3.02, the EJ file can be
compressed and password protected as part of the initialisation
operation.
1
Delay EJ Initialisation during Transactions From Advance NDC
4.02, scheduled EJ initialisation can be configured to wait until an
in-progress transaction completes. This avoids splitting the
journaling from one transaction over multiple EJ files.
Display and Print TCP/IP Configuration
1
1
From release 3.01, options are available through Supervisor to
display or print the current TCP/IP configuration information. If the
print option is selected, the default printer for the operator interface
is used (receipt printer for the facia interface and journal printer for
the operator interface).
From Advance NDC 4.01, the TTU form supplied is the standard
form provided with the CCM TCPIP component. Consequently,
some of the messages for the Message Format, PING, SSL and DNS
SUFFIX options in Supervisor have changed.
Promote Coupon Printing During Transaction Reply
1
From release 4.01, you can choose to print Promote coupons only
when a receipt is successfully printed. This can be configured using
a registry key. The coupon can be printed during Transaction Reply
functions.
Promote Flow Points
1
From Advance NDC 4.00, a new Promote flow point for Next State
and Print has been added to the existing flow.
From Advance NDC 4.01, two new Promote flow points have been
added to the cash deposit flow. Two new Promote flow points have
also been added to the cheque deposit flow.
PIN Acquired Flow Point Prior to Advance NDC 4.02, the PIN
Acquired flow point was displayed in the following situations:



1
PIN entry whether valid or invalid
PIN Cancel
Time-out during the PIN Entry state.
From Advance NDC 4.02, this flow point is displayed only after a
valid PIN entry. This flow point is configured by default for the
following states:



Card Read - PIN Entry Initiation (state T)
PIN Entry (state B)
Enhanced PIN Entry (state M)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-25
Introducing Advance NDC
Advance NDC Development

PIN and Language Select (state m).
For further information on Promote flow points supported by
Advance NDC, see “Promote Flow Point Behaviour” on page 5-32
and the APTRA Promote User’s Guide.
Configure Statement Length
1
From release 3.01 a maximum statement length for the statement
printer can be specified using a registry key. This allows the setting
of the maximum number of lines to be printed before a cut. This can
be used, for example, where black mark paper is not used and no
form feed is included in the Transaction Reply print data.
Long Receipt Handling
1
Prior to Advance NDC 4.02, long receipts (49 lines) were not
retracted if left at the exit slot or in the transport after a transaction.
From Advance NDC 4.02, a configurable registry entry is available
to define whether long receipts are to be retracted or not.
Configuration of Forms-Based Printing
1
The following updates have been made to the configuration of
forms-based printing.
Automatic Configuration of Receipt Media Size Prior to
Advance NDC 4.02, an empty string was sent to the service provider
if no media definition was provided and this caused the printing to
fail. A media definition was required to configure the media size for
receipt printing.
1
From Advance NDC 4.02, a null pointer is sent when no media
definition is provided. This means that, if the printer service
provider does not require a media definition file, printing does not
fail and different media sizes can be used during receipt printing.
Scaling Printed Graphics Prior to Advance NDC 4.02, graphics
were printed within the boundaries of the graphic field, but the
aspect ratio might not have been maintained.
1
From Advance NDC 4.02, whether a graphic is scaled to fit the
graphic field boundaries and whether the aspect ratio is maintained
can be configured.
Configuration of Amount Entry Length
From Advance NDC 4.00, the length of an amount entry can be
configured up to a maximum of 12 digits. Once the number of digits
reaches the maximum value, no more input is permitted.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-26
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
Enable Web Exits
1
From Advance NDC 3.01, support is provided for enabling web
Exits. Using web Exits provides a means to interact with the
consumer outside of the Advance NDC application.
From Advance NDC 3.03, support is provided for up to eight web
Exit state URLs.
From Advance NDC 4.02, table entry 7 of the Web Exit state can be
used to prevent the display of a web page. By default, the web page
is displayed. Hiding the web page means that script-only web pages
can be used to load web content, carry out processing and then
move to another page or state.
Local Customisation Data
1
From Advance NDC 3.01, local customisation data can be used to
replace or modify the data provided in host downloads.
The local data is provided by files placed directly on the SST.
From Advance NDC 4.0, you can also use a local file to specify the
Next State Number following a Transaction Reply.
From Advance NDC 04.01, local customisation download files are
loaded at the following points in the application:


At Start of Day.
After the host sends one or more download messages followed
by a go-in-service (GIS) message.
From Advance NDC 04.02, local customisation files are loaded
when a GIS message is received. Therefore, software management
can change local customisation files on the SST allowing Advance
NDC to read new customisation files after receiving the GIS
message.
Passbook Printer Worker Classes
1
In Advance NDC 2.5 and earlier, support for the passbook printer
was provided by the APTRA Advance Passbook component, an
optional component of APTRA Advance ADE, providing SST
runtime software and authoring components.
From Advance NDC 3.03, support is provided for the passbook
printer worker classes using the CEN-XFS interface, enabling you to
develop an authored flow for passbook transactions. The
functionality and usage of the worker classes are the same as in the
APTRA Advance Passbook component, except for the following:

When a runtime error occurs, an merror is not raised, but an
equivalent signal is generated by a worker
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-27
Introducing Advance NDC
Advance NDC Development


The Passbook Definition and Passbook Definer workers can
create media definitions and form definitions dynamically to
read and write data using the CEN-XFS interface; but it is better
to prepare the definitions manually for specific passbook
printers
Registry settings are used for the default location of the form
and media definitions, and control of page mark reading and
line number scanning
For more information, see “Passbook Printer” on page 5-177, and
refer to the Passbook Printer worker class help.
Associated Keyboards for FDKs
1
In Advance NDC 2.05, a physical keyboard could be defined by
associating a key position and a key code. The key position
identified the physical location of the key, and the key code defined
the value returned to the terminal when the key is pressed.
In the CEN-XFS environment, the physical keyboard is not defined
at the application level. Consequently, Advance NDC can only
allow mapping between logical CEN-XFS keys.
In Advance NDC 2.06, the following restrictions applied:



Nested keyboards were not supported
Screen and keyboard associations were ignored, as they
cannot be defined at application-level.
The Clear and Cancel key positions could not be swapped.
From Advance NDC 3.03, associated keyboards are supported for
physical and emulated FDKs only.
Associations between screens and keyboards for FDKs can be
created using the Screen And/Or Keyboard Data Load command.
Not all the Advance NDC state types support associated keyboards.
For more information, refer to “Chapter 4, Keyboard Data and
Layouts” in the APTRA Advance NDC, Reference Manual.
Beep Configuration
1
Beeps can be configured to sound at various points during
cardholder transactions.
Beep on Emulated FDK Selection From Advance NDC 4.00, a
beep can be configured to sound when an FDK is selected.
Beep on Card Eject and Cash Present From Advance NDC 4.00,
the beep sounded on card ejection or cash presentation can be
configured to use one of the sounds provided by the SIU SP.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-28
APTRA Advance NDC, Developer’s Guide
1
1
Introducing Advance NDC
Advance NDC Development
PC Beep From Advance NDC 4.01, the beep can be configured to
use either the PC beep or SIU SP beep.
Alphanumeric Data Entry
1
1
From Advance NDC 3.03, SMS-style alphanumeric key entry using
numeric keys is supported as an optional key entry mode in the
Information Entry ‘H’ state, table entry 9.
From Advance NDC 3.04, PC keyboard alphanumeric data entry is
also supported in the Information Entry (‘H’) state.
From Advance NDC 4.01, touch-screen keyboards can be
configured for consumer data input in the Information Entry state.
Validation of Host Responses to Transaction Requests
1
From Advance NDC 4.02, the Message Coordination Number can
be used in a Interactive Transaction Response to check that it
corresponds to the Transaction Request sent by the SST.
Enhanced Configuration Parameter 34 From Advance NDC 4.02,
Option 34 — MCN range, also defines how Transaction Replies and
Interactive Transaction Responses with incorrect MCNs are
processed.
Supervisor Menus
1
1
From Advance NDC 4.00, reserved screen M03 (Supervisor Access
menu) is no longer used. It has been replaced by screen m03 as it
includes an option for APTRA Promote, which is supplied with
Advance NDC.
Configuration of Cardless Transactions
1
From Advance NDC 4.02, an option is available on the Configure
menu in Supervisor to enable or disable cardless transactions and to
set or change the next state number. The cardless transactions status
and next state number are displayed and journaled along with other
configuration data. There is no host interaction associated with this
option.
Machine Number Entry
1
From Advance NDC 4.00, there is a Supervisor option to enter an
alphanumeric machine number at the SST.
From Advance NDC 4.01, fewer than six digits or characters can be
entered for a machine number, which is automatically padded with
leading zeros to make it the correct length of 6 digits.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-29
Introducing Advance NDC
Advance NDC Development
Supervisor Entry/Exit Message
1
From Advance NDC 4.01, an extra field can be added in Supervisor
entry and exit messages that will distinguish whether the message is
sent due to Supervisor mode change or simulated Supervisor entry
and exit. The field can be added using the registry. A message to set
the mode switch to normal is displayed on front interface and rear
interface. The message can be edited in reservd.def.
SNMP
1
From Advance NDC 4.02, SNMP Out of Service and In Service
mode change traps are issued when Advance NDC relinquishes or
regains control of the SST respectively although the mode does not
actually change.
From Advance NDC 4.02, the SNMP Agent is no longer supplied as
an optional component on the Advance NDC CD. For Windows XP
users, the SNMP Agent is now supplied with APTRA XFS. For
Windows 7 users, the Unified Agent SNMP Product replaces the
SNMP Agent. For further details, refer to the APTRA Advance NDC,
Overview.
NDC Monitor
1
Prior to Advance NDC 4.02, there was no way to detect that the SST
had stopped responding. If the SST stopped responding it became
unavailable for transactions but no indication could be given to the
host.
From Advance NDC 4.02, NDC Monitor can be used to detect a
freeze and take a defined recovery action. NDC Monitor does the
following:



Monitors application heartbeats
Polls the SST to check that it is responding
Checks the CPU usage.
If the application is unresponsive or no CPU usage is reported, NDC
Monitor can be configured to take either of the following actions:


Log an error
Reset the SST and log an error.
Archive Manager
From Advance NDC 4.00, the .NET Archive Manager component is
used to archive and manage data on the SST.
From Advance NDC 4.01, the ECB 6 database file can be archived
using the .NET Archive Manager. The .NET Archive Manager is
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-30
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
controlled from the Troubleshooting option on the Supervisor
Configure menu.
From Advance NDC 4.02, the .NET Archive Manager is configured
by default to remove PD investigation files after they have been
archived during a scheduled collection. PD investigations that are
active or paused are not deleted until the next scheduled archive
time arrives, providing these investigations have since completed.
Voice-Guided Sessions
1
In Advance NDC 3.03, voice-guided cardholder sessions were
introduced to provide configurable audio guidance during
transactions for visually impaired consumers using headphones or
speakers on the SST.
From Advance NDC 4.01, the Interactive Transaction Response
(ITR) message can be used to define screen data to display while
playing the audio guidance.
Prior to Advance NDC 4.02, the voice associated with a language
was defined in the VoiceDict.xml file.
From Advance NDC 4.02, the VoiceDict.xml file is no longer used.
Configuration of voices is optional. The association of voice and
language is configured in the AdvanceNDC.accfg file.
From Advance NDC 4.02, languages with accented or special
characters are supported using the character encoding specified in
the XML. For legacy configurations, the encoding of Spanish is
automatically converted to the correct ISO character code.
From Advance NDC 4.02, if only a single language is available for
voice-guided sessions, whether the consumer is prompted for a
language selection is configurable.
From Advance NDC 4.02, a language selected for the voice-guided
session can be applied automatically to the language selection
states. For backward compatibility, this can be disabled, meaning
that the consumer will have to select a languages more than once
during a session.
Voice-Guided Session Without Host Update From Advance
NDC 4.00, voice data can be provided locally rather than supplied
by the host in Interactive Transaction Response and Transaction
Reply messages.
Intelligent Fraud Device (IFD)
1
1
From Advance NDC 4.00, to support NCR’s Intelligent Fraud
Device, an IFD Alarm worker was provided.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-31
Introducing Advance NDC
Advance NDC Development
The IFD Alarm sensors that could be monitored, depending on the
installed hardware sensors and IFD configuration, were as follows:





Media In Sensor
Media Out Sensor
Cardholder Sensor
Service Sensor
Environment Sensor
Note: Advance NDC did not support the custom configuration of
the IFD sensors. If any of the sensors monitored by Advance NDC
were reconfigured, the alarms event monitoring may have stopped
working, or may have sent incorrect reports.
From Advance NDC 4.02, the IFD is not supported. Therefore, the
IFD Alarm worker class and IFD Alarm help have been removed
from the APTRA Author.
Receipt Capture Bin
1
From Advance NDC 4.00, the Error severity and Supplies status
fields of the unsolicited message for the Receipt printer will report
the receipt capture bin status.
From Advance NDC 4.02, there is a registry setting to configure
whether receipt capture fitness and supplies are reported in status
messages to the host.
Top Margin for Receipts
1
Prior to Advance NDC 4.02, the top margin of receipts for raw-data
printing could only be configured through screen ‘K01’. When
forms-based printing was introduced in Advance NDC 3.03, the top
margin could be configured through the registry for forms-based
printers only.
From Advance NDC 4.02, in addition to these two methods, a
Supervisor option on the Configure menu can be used to set the
receipt top margin for both raw-data and forms-based printing. The
registry is updated with any valid value entered using this option.
Displays
The Settlements supervisor transaction screens can be configured.
From Advance NDC 4.00, a single consolidated display interface for
the cardholder screen is provided. It is used to display the state flow
screens and customer relationship management (CRM) content
provided by APTRA Promote or APTRA Relate during a
transaction. For more information, see “Display Management” on
page 1-45.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-32
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
Replacing MPEG Animation Prior to Advance NDC 4.00, MPEG
animation files could not be replaced with a different animation
unless the file name and screen definition were also changed.
1
From Advance NDC 4.00, the changes to display management
removed this restriction.
Fault Displays
1
From Advance NDC 4.02, customisations can display messages on
the Fault Display. For example, a customisation can display
messages related to devices that are not managed by Advance NDC.
The author of the customisation is responsible for the accuracy of
the messages, which are defined using local customisation.
Cardholder Display Status
1
From Advance NDC 4.02, a registry setting can be used to include
or suppress cardholder display data in the Get Fitness response.
Information Entry State
1
From Advance NDC 3.03, this entry includes support for SMS and
PC keyboard data entry.
From Advance NDC 4.02 the buffer and display parameters used to
display consumer input in the Information Entry state (‘H’) can be
controlled using table entry 9. The parameters defined in the state
table can be overridden using an XML file.
Data Copy and Compare State
1
From Advance NDC 4.02, the Data Copy and Compare state can be
used to process buffer data locally instead of by the host. Valid
buffers are Buffer B, Buffer C and the Amount buffer. Data in two
buffers can be compared for validation or data can be copied from
one buffer to another.
Hide Taskbar
1
Previously in Advance NDC, the hidetb.exe program was used to
hide the Microsoft Start menu and the taskbar on the SST.
From Advance NDC 4.01, hidetb.exe is no longer used as hiding the
taskbar is controlled through the registry.
Transactions Based on Device Availability
1
From Advance NDC 4.00, the following allow screen content and
FDKs to be updated based on the availability of devices, to direct
the transactions offered:

Device Fitness Flow Select state
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-33
Introducing Advance NDC
Advance NDC Development


Dynamic display of text and buttons
Dynamic enabling of FDKs.
Scalable Deposit Module
1
From Advance NDC 4.00, support is extended to allow an NCR
scalable deposit module (SDM) to be configured as a cheque
processor that can accept cash or cheques.
Cash/Cheque Deposit Module From Advance NDC 4.02, the SST
is automatically configured for the Cash/Cheque Deposit Module
from Wincor if present on the SST.
Remote Status Indicators (RSIs)
1
1
In previous versions of Advance NDC, the red and yellow RSIs
were controlled by the platform and a registry configuration.
From Advance NDC 4.00, support for RSIs is extended to the red
and yellow RSIs through CEN XFS. No configuration is required.
Customer Relationship Management (CRM)
1
Advance NDC supports two CRM products: APTRA Promote for
customer-targeted marketing and advertising campaigns and
APTRA Relate for building relationships with customers.
APTRA Promote In previous releases, APTRA Promote was
disabled by default.
1
From Advance NDC 4.02, APTRA Promote is enabled by default.
NDC CRM Interface Worker Class In previous releases, at the
Author flow level, Advance NDC invoked Promote flow points and
informed Promote of application events using an Active Script Host
worker and the Promote Dialogs COM interface.
1
From Advance NDC 4.00, to provide the same level of functionality
for CRM through the new .NET CRM service, flow points and
events can now be invoked at the Author flow level and at .NET
state flow level for cash or bunch cheque deposits using an NDC
CRM Interface worker.
The NDC CRM Interface worker also allows new flow points to be
added to the existing Author flow if required.
NDC CRM Service From Advance NDC 4.00, the NDC CRM
Service provides support for the addition of new flow points in C
Exits and the existing Author flow and the configuration of a
campaign language and coupon printing.
Internet Protocols
1
From release 4.02, Advance NDC supports TCP/IP communications
protocol IPv6 as well as IPv4.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-34
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
Troubleshooting
Assistance
Advance NDC uses a variety of utilities to help in the identification
of errors when they occur.
1
Problem Determination
1
From Advance NDC 4.00, Problem Determination investigations
can be fully controlled through options on the Supervisor Configure
menu under Troubleshooting.
Always On Tracing From Advance NDC 4.02, Always On tracing
is used to store troubleshooting information for all .NET code. The
Always On traces are logged to Problem Determination even when
Problem Determination is disabled.
1
The Always On traces are collected by .NET Archive Manager. For
more information about .NET Archive Manager, see “Configuring
.NET Archive Manager” on page 5-59.
Silent Debug
1
From Advance NDC 3.02, support is provided for a utility called
Silent Debug that will perform trace capture on live SSTs.
From Advance NDC 4.02, there is a configurable registry setting to
run Silent Debug at start of day. This provides a level of
troubleshooting information for the APTRA Author and C++ code.
Archive Manager collects the Silent Debug logs.
DebugLog
1
From Advance NDC 3.02, support is provided for the DebugLog
utility.
Note: The DebugLog utility was available in previous releases of
Advance NDC but was not supported.
Message Reflection
1
From Advance NDC 3.02, support is provided for the reflection of
terminal to host messages using the virtual controller interface.
Previously, only host to terminal message reflection was supported.
Reflected messages are recorded in the MESSAGEOUT and MESSAGEIN
trace streams. Reflected messages in these trace streams can be
viewed using the Silent Debug or DebugLog utilities.
For information on viewing trace streams using Silent Debug or
DebugLog, see “Using the Troubleshooting Tools” on page 12-19.
Cash Acceptors
1
Cash acceptors are supported through ActiveXFS, making use of the
Cash Accept Service component.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-35
Introducing Advance NDC
Advance NDC Development
From Advance NDC 3.03, fault display and serial number reading
and logging (only to the EJ) are supported.
From Advance NDC 3.04, updates to the Cash Accept state for
returned notes are supported.
From Advance NDC 4.00, the following changes have been made:




Multi-vendor environments are supported, including support
for VDM mode
The number of acceptable note types has increased with no host
impact
Support for cash deposit has been re-implemented using .NET
technology?
Bunch Note Acceptor 1 (BNA 1) devices are not supported.
From Advance NDC 4.02, the following changes apply:




The number of attempts made by a consumer to re-insert
bunches of rejected notes is configurable
The number of bunches that a consumer can insert during a
single transaction can be configured
The destination of notes retracted when the consumer does not
remove refunded notes is configurable. If configured to retract
notes to the escrow, the cash acceptor remains in a fatal
condition until either the INIT BNA or Clear BNA Supervisor
options are performed. This allows first-line maintenance to
access notes retracted to the escrow
A flag for customisations if a host time-out occurs during a
transaction is provided by a new CDI store. This trigger can be
used, for example, to print a receipt.
Supervisor Options
In Advance NDC 3.04, the following changes were made to the
Supervisor Replenish menu:


Improvements to the reporting of counts and cleared notes in
the INIT BNA Supervisor option
New Supervisor options to display reconciliation (DSP BNA
RCNL) and print a reconciliation (PRN BNA RCNL) list for cash
acceptors.
In Advance NDC 4.00, option 82, GBNA.INI CONFIG, was
removed from the Configure menu as the associated .ini file was no
longer used.
From Advance NDC 4.02, option 82, BNA CASS CFG on the
Configure menu is used to configure cassettes in cash acceptors and
recycling units using the Cash In Module (CIM) XFS interface.
Option 82 displays the physical and logical configuration of each
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-36
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
cassette and can also be used to print this configuration. This option
can be used on all vendors’ SSTs but cannot be used to configure
NCR GBXX-specific settings, which continue to be configured using
option 39 GBXX CONFIG and the XML configuration file.
Advance NDC has the following Supervisor menu options for cash
acceptors if present:
Table 1-3
Cash Acceptor Menu Options
Menu
Option
Function
Configure
39 GBXX CONFIG
Configures the GBXX device
80 DISP CSH/ACC
CONFIG
Displays the cash acceptor
configuration
81 PRNT CSH/ACC
CONFIG
Prints the cash acceptor
configuration
82 BNA CASS CFG
Configures the XFS settings for
cassettes on cash acceptors and
recycling units
Any settings required
specifically for NCR GBXX
devices must be set using option
39 GBXX CONFIG
3 DISP CNTRS
Displays counters including cash
acceptor counters
4 PRNT CNTRS
Prints counters, including cash
acceptor counters
48 DSP BNA RCNL
Displays the cash acceptor
reconciliation list
See “Reconciliation Lists” on
page 1-38
49 PRN BNA RCNL
Prints the cash acceptor
reconciliation list
See “Reconciliation Lists” on
page 1-38
53 CLR BNA
Clears the counters used to track
note movement within any cash
acceptor
54 INIT BNA
Initialises the cash acceptor
55 CREATE SIGS
Creates signatures.
In a cash acceptor creates
signatures for counterfeit notes
as identified by ECB 6 regulation
Replenish
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-37
Introducing Advance NDC
Advance NDC Development
Menu
Option
Function
56 EXTRACT SIGS
Extracts signatures.
In a cash acceptor the extract
signature writes a selected range
of records from the ECB 6
transaction
58 DSP BNA CNTS
Displays the cash acceptor
counts
59 PRN BNA CNTS
Prints the cash acceptor counts
60 PRN BNA TTLS
Prints totals of the cash acceptor
counts
The counters that are included in
the printout can be configured
For details of the Replenish and Configure options for cash
acceptors, refer to the APTRA Advance NDC, Supervisor’s Guide.
Reconciliation Lists Prior to Advance NDC 4.02, the
reconciliation lists provided by the Supervisor Replenish menu had
the following issues:





When multiple currencies or multiple note revisions were
deposited, the counts may not have been correctly updated
When counts were full, the last row was overwritten in the
displayed reconciliation list
The date and time was displayed and printed
Only four fields were used in the displayed reconciliation list,
which means that there may have been unused space in the
screen
When multiple note revisions were defined for a single
denomination, the counts for each note revision were displayed
separately.
From Advance NDC 4.02, a new screen is displayed for each
currency and the reconciliation lists are improved as follows:





Counts are correctly updated, even if multiple currencies or
multiple note revisions are deposited
When counts are full, the last row of the displayed reconciliation
list is not overwritten
The date and time is printed but not displayed
The screen space is efficiently used
All note revisions for a single denomination are reported
together.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-38
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
Direct Deposits
1
From Advance NDC 4.01, if direct deposit is supported by the
hardware and if it is configured, cash will be deposited directly to
the cassettes without first being stored in the escrow. This provides
support for devices with no escrow and for depositing large
amounts using only one note validation. Only vaulted counts are
updated in status messages and journaled.
Single Note Acceptors From Advance NDC 4.01, single note
acceptors are supported. This allows consumers to pay bills using
direct deposit on financial kiosks.
Off-line Cash Deposit Handling
1
1
From Advance NDC 4.02, a new state, Cash Deposit Handling, is
available as an off-line alternative for the Media and Refund Media
transaction reply functions in the Cash Accept state. Both deposit
and refund functions can be used for refundable notes and the
deposit function can be used for direct deposit transactions.
Dynamic Note Sorting
1
In Advance NDC 3.01, support for dynamic note sorting was
introduced. This allowed the device to continue accepting notes and
to store them in sequenced cassettes. This functionality was
optional, and could be configured using registry settings.
In Advance NDC 4.00, support for dynamic note sorting was
removed.
From Advance NDC 4.01, dynamic note sorting is supported,
allowing a device to continue accepting notes after the cassette
originally configured for the note type becomes nearly full.
Dynamic note sorting is configured using the CashInCustom.accfg file
instead of the registry.
Fixed Cassette Mapping
1
Previous to Advance NDC 4.02, cash-in NDC cassette types were
automatically mapped to XFS logical cash units based on the
position of the cassette.
From Advance NDC 4.02, a mapping array in the
CashInCustom.accfg file allows a fixed mapping to be defined. If
defined, the fixed mapping overrides the automatic mapping.
ECB 6 Regulations
1
In Advance NDC 3.03, support for ECB 6 regulations was
introduced.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-39
Introducing Advance NDC
Advance NDC Development
In Advance NDC 3.04, support for the ECB 6 regulations was
extended as follows:


New status codes were added to report counterfeit and
suspect notes
For PA-DSS compliance, customer information was masked
in the ECB 6 database.
In Advance NDC 4.00 support for ECB 6 regulations was removed.
From Advance NDC 4.01 ECB 6 regulations are supported again, as
follows:







Status codes to report counterfeit and suspect notes
For PA-DSS compliance, masking of customer data in the
ECB 6 database
The signatures (serial numbers) of good notes, if read
successfully, are journaled only to the EJ. The number of
unsuccessful reads of serial numbers in a bunch of good
notes is also journaled only to the EJ. The parser used to read
the signature is configurable for supported hardware
variants.
The .NET Class Configurator files can be used to configure
whether unsolicited messages are sent when counterfeit or
suspect notes are identified.
The Write Signatures option on the Supervisor Replenish
menu has been removed. The operation is now part of the
Extract Signatures option.
In status messages and the journal, the escrow counts field
reports the count of notes that have been inserted, regardless
of physical location.
Reporting counterfeit and suspect counts in ECB 6 messages
is now cumulative for each transaction, not for each
operation. If direct deposit is used, only the vaulted counts
are updated.
Reporting of Counterfeit or Suspect Notes From Advance NDC
4.02, notes identified as counterfeit or suspect under the ECB 6
regulations can be reported in the Transaction Request message.
The Transaction Request state (‘I’) defines whether these optional
fields are included.
Signatures in the ECB 6 Database In Advance NDC 3.04,
signatures of counterfeit or suspect notes were not logged to the
ECB 6 database unless ECB 6 was enabled.
From Advance NDC 4.01, signatures retrieved for counterfeit or
suspect notes are always logged to the ECB 6 database, regardless of
the ECB 6 settings.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-40
APTRA Advance NDC, Developer’s Guide
1
1
Introducing Advance NDC
Advance NDC Development
Error Recovery
1
In Advance NDC 4.00, error recovery was enhanced to support
additional journaling, consolidation of error recovery behaviour at
different times and the ability to configure automatic error recovery.
From Advance NDC 4.01, recovery from a Suspend state is
supported without the need to treat the cash acceptor as if it were in
a fatal condition.
From Advance NDC 4.02, an XML file can be used to log exceptions,
retract operations, and host time-outs occurring during deposit
transactions. The file logs all status messages for note acceptors,
with the exception of a successful operation (‘w0’), a time-out or the
consumer requesting a refund or cancelling the transaction during
the Cash Accept state (‘w1’). The log file can be printed, archived
and cleared using options on the Supervisor Replenish and
Configure menus.
Automatic Error Recovery From Advance NDC 3.03, automatic
error recovery (AER) is supported.
1
In Advance NDC 3.04, the encash counts (the bank’s money) were
updated whenever notes were retained.
From Advance NDC 4.00, if the money belongs to the consumer, the
retract counts are updated.
From Advance NDC 4.01, there is a configurable option to move the
notes to the appropriate recovery destination, according to
ownership of the money as follows:


Retract bin for the consumer’s money
Cassettes for the bank’s money.
This option is configured by default to retain notes left in the device
in the recovery destination, which can be automatically selected.
Journaling
1
The following sections describe the improvements and
enhancements to journaling in Advance NDC.
Journaling the Cassette Status From Advance NDC 3.01, cassette
status can be optionally reported in the host message when
Enhanced Configuration option 45 is set to enable the extended
message format.
Journaling Reject Counts In Advance NDC 3.04 and earlier, the
returned count in the journal consisted of the total number of
recognised note types refunded to the cardholder plus the total
number of invalid notes that were rejected. The invalid notes were
also journaled in the reject count.
1
1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-41
Introducing Advance NDC
Advance NDC Development
From Advance NDC 4.00, the returned count in the journal is
replaced by the refunded count. The refunded count includes only
the total number of recognised note types refunded to the
cardholder. The total number of invalid notes is now journaled only
in the reject count.
Journaling the Escrow Status In Advance NDC 3.04, when the
number of notes inserted exceeded the escrow capacity, the message
REJECT COUNTS NOT UPDATED - ESCROW FULL was journaled.
1
From Advance NDC 4.01, if the inserted notes exceed the escrow
capacity, the message ESCROW FULL (reserved screen t19) is
journaled.
Note: On SSTs with GBXX devices, this message can also indicate
that a large number, for example 50, invalid notes have been
inserted.
Journaling Note Counts In Advance NDC 3.04, if automatic error
recovery was enabled and a power failure occurred with notes in
the escrow, then, after power up, an unsolicited message was sent to
the host correctly reporting the vaulted counts.
1
From Advance NDC 4,01, if the vaulted counts are not accurately
reported due to platform limitations, the message COUNTS MAY BE
INACCURATE (reserved screen U0151) is journaled.
From Advance NDC 4.01, if notes are detected at the exit slot during
AER, the message NOTES DETECTED AT EXIT SLOT (reserved
screen U0135) is journaled.
From Advance NDC 4.02, if notes are detected in the escrow during
AER, the message NOTES DETECTED IN THE STACKER (reserved
screen U0171) is journaled. If a retract operation is performed,
RETRACT TO <RetractArea%> (reserved screen U0172) is journaled.
In this screen, the <RetractArea%> variable identifies the
destination of the retracted notes.
Configuring Journaling From Advance NDC 4.00, journaling is
configured using the Journal Level option on the Configure menu in
Supervisor mode. Improvements are also extended to journaling
and its configuration when the device status is reported to the host.
In Advance NDC 4.00, the registry entries defining the format of
journal entries were replaced by configuration settings in the
AdvanceNDC.accfg file.
From Advance NDC 4.01, the formatting of journal entries is
defined in the CashInCustom.accfg file.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-42
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
From Advance NDC 4.02, cash counts are included by default when
the maximum journal level is configured. The journaling of the cash
counts can be disabled by editing reserved screens.
For details of the levels and their configuration, see “Journal
Formats” on page 5-232.
Printing Note Counts for Bunch Note Acceptors
1
From Advance NDC 4.02, there is an option, Print BNA Totals, on
the Supervisor Replenish menu to print the number of notes in
different groups such as deposited, rejected, retracted and refunded
by denomination, and print the total counts. The journal printer, the
receipt printer or both can be selected to print the counts through
the Set Printer option on the Configure menu in Supervisor.
Confirmation Screens
1
From Advance NDC 4.00 dynamic confirmation screens used in the
Cash Accept state are supported. These replace the basic
confirmation screens, M10, M11, M13 and M14.
From Advance NDC 4.01, the dynamic content of the Confirmation
screens used in the Cash Accept state is configured using the
CashInCustom.accfg file instead of using the registry. New
configuration options have also been added.
Configuration Files
1
Prior to Advance NDC 4.00, if a GBXX device was detected, a
GBNA.ini file was created.
From Advance NDC 4.00, the GBNA.ini file is no longer used. It is
replaced by the note type mapping XML file.
From Advance NDC 4.01, NDC note types are mapped
automatically on a one-to-one basis to XFS note types by default. It
is also possible to either group note types by currency and
denomination or to use an XML configuration file to define the
mapping and grouping. For details of the note type mapping XML
file, see “Note Type Mapping” on page 5-170.
From Advance NDC 4.01, the cash-in entries in the
AdvanceNDC.accfg file are in new files, CashInCore.accfg and
CashInCustom.accfg to help simplify maintenance and configuration.
Promote Flow Points
1
Support for Promote flow points in cash deposits, which was
available in Advance NDC 3.04 but not in 4.00, is available from
Advance NDC 4.01.01.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-43
Introducing Advance NDC
Advance NDC Development
Tamper and Sensor Status Reporting
From Advance NDC 4.01, tamper and sensor status reporting is
supported for cash-in cassettes with sensors. If a cassette is inserted
or removed, this is reported to the host and journaled, except if the
cassette is manipulated during Vendor Dependent Mode (VDM).
Product Class Support
1
From release 4.00, Advance NDC supports the reporting of the
SelfServ 22e product class in hardware configuration messages.
From release 4.01, Advance NDC supports the reporting of the
following SelfServ product classes in hardware configuration
messages:




SelfServ 4
SelfServ 8
SelfServ 16
SelfServ 42.
From release 4.02, Advance NDC supports the reporting of the
SelfServ 14 product class (2014) in hardware configuration
messages.
Support for CEN-XFS
1
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. This allows
Advance NDC to run in a multi-vendor environment. CEN-XFS
support was introduced in phases as described in the following
table:
Table 1-4
Migration to CEN-XFS
Advance NDC Version
Interface
2.05
ADI2
2.06
ADI2 and CEN-XFS 2.00
3.00-3.01
ADI2 and CEN-XFS 3.00
3.02-4.02
CEN-XFS 3.00 to 3.03 and
CEN-XFS 3.10
Service providers compliant with CEN-XFS 3.10 are as follows:

Bunch Cheque Deposit (Advance NDC 3.04)
For details of the specific devices accessed through ADI2 or
CEN-XFS and for information describing of how this affects
customised applications, see Chapter 4, “Upgrading from Earlier
Releases of Advance NDC”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-44
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
Screen Management
1
Advance NDC provides support for and management of screens as
described in the following sections.
Screen Support
1
Prior to Advance 2.06, Advance NDC supported up to 999 screens.
From Advance NDC 2.06, up to 9999 screens are supported.
From Advance NDC 4.02, the screen numbers defined in state tables
are extended from 000-999 to 000-Z99. The alphanumeric character
is mapped to a numeric value to allow the direct specification of
3599 screens. Applying language offsets allows all 9999 screens to be
referenced from the state tables if necessary.
A configuration option allows screen base and group sizes to be
extended to increase the available number of multi-language
screens.
Display Management
1
From Advance NDC 4.00, the integrated consumer interface
displays screen data from the host or stored as local customisation
data. The screen data is converted to a supported screen definition
format before being displayed.
Media Formats Advance NDC supports a wide range of media
formats, as described in “Image and Media Support” on page 1-46.
Dynamic Screens Dynamic screen content, such as text and
buttons, can be used to implement dynamic menus. The dynamic
menu can accurately reflect the availability of various transactions
without the need for updates from the host.
1
1
Advance NDC 4.00 includes new escape sequences that enable
buttons and the provide dynamic text for screen display.
CRM Content The integrated consumer interface delivers any
configured CRM content to the screen at the correct time. The
content must be provided by the APTRA Promote and APTRA
Relate products and flow points in the Advance NDC state flow
control requests for CRM content.
1
Font Definition Prior to release 4.0, the font definition file
(fontdefs.txt) was used to define the fonts used by Advance NDC for
screen display.
1
From Advance NDC 4.0, fonts are defined using the integrated
consumer interface XML configuration file.
Other Vendors’ SSTs Prior to Advance NDC 4.02, the labels
displayed on-screen for FDKs did not always align with the physical
key locations on some other vendors’ SSTs.
1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-45
Introducing Advance NDC
Advance NDC Development
From Advance NDC 4.02, the screen display can be automatically
scaled on other vendors’ SSTs to align FDK labels to physical
positions if necessary. Further configuration settings can also be
defined to improve the display. For deployment in mixed networks,
XML configuration files can be defined to allow the correct
re-scaling to be performed.
For further information on the configuration and deployment of the
scaled screen displays, refer to the APTRA Advance NDC,
Multi-Vendor Support Reference Manual.
Image and Media Support
1
From Advance NDC 4.00, an integrated consumer display interface
is provided, with support for image and animation file formats as
well as NDC screens and off-line screen files.
Formats such as GIF, JPEG and PNG are supported. In addition,
media formats such as animated and transparent GIF, and
transparent PNG are supported.
From Advance NDC 4.01, the PCX format is no longer supported. If
a host download contains a reference to a PCX file in a screen
definition, Advance NDC discards the PCX extension and searches
for a match on the filename in a supported format. For example, if
the download contains graphic1.pcx, a match would be found with a
file called graphic1.png.
Microsoft DirectShow is used to render video files to the screen.
This allows support for a wide range of video formats, such as
WMV, AVIs, MPEGs and animated GIFs. Free support for common
formats, such as DIVX and QuickTime (.mov), is available through
third-party DirectShow codecs. DirectShow codecs also provide
support for audio file formats, such as MP3 and AAC.
For more information about image and multi-media file formats,
refer to the following:


Voice Guidance
1
For image and animation file formats, the “Picture and
Animation Formats” topic in the APTRA Author help
For multi-media video, chapter 3, “Screen Data” in the APTRA
Advance NDC Referance Manual.
Advance NDC uses voice guidance to allow any prompts on the
screen in the consumer transaction flow to be spoken.
Invalid XML File Handling
In Advance NDC 3.04, if an invalid AudioGuidanceData.xml file was
copied manually to the SST, it was deleted.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-46
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Advance NDC Development
If an AudioGuidanceDataLocal.xml file that contained invalid data
was manually copied to the SST, it was not deleted, however,
AudioGuidanceData.xml was deleted whether valid or invalid.
In both cases, a message in the NoAudio.xml file was played to
indicate that voice guidance was temporarily unavailable on the
SST.
In Advance NDC 4.02, if an invalid AudioGuidanceData.xml or
AudioGuidanceDataLocal.xml file is manually copied to the SST, no
files are deleted. A message in the NoAudio.xml file is played to
indicate that voice guidance is temporarily unavailable on the SST.
Maximum State Number
1
In Advance NDC 2.05, the maximum number of valid states was
increased from 750 to 999. Each ‘Next State Number’ entry in the
APTRA Advance NDC, Reference Manual, Chapter 2 “State Tables”
had a possible range of 000-254 or 256-999.
From Advance NDC 3.02, the maximum number of valid states is
increased from 999 to 46655. This is achieved by introducing
support for alphanumeric state numbers in state tables. Depending
on the number system specified in Enhanced Configuration
Parameter option 80, each ‘Next State Number’ entry in the APTRA
Advance NDC, Reference Manual, Chapter 2 “State Tables” has a
possible range as follows:


Remote Key Management
1
000-254 or 256-999 using the decimal (base 10) system
000-254 or 256-ZZZ using the alphanumeric (base 36) system.
From Advance NDC 2.06, for SSTs fitted with an Encrypting PIN
Pad (EPP), the loading of the initial encryption keys (A key, B key
and V key) using RSA encryption is supported as an alternative to
local entry in Supervisor mode.
In Advance NDC 3.02, worker classes were added to support
enhanced remote key management.
From Advance NDC 4.00, a modifier is available as part of remote
key management. This provides information to the host in
identifying whether the EPP is PCI DSS compliant or not.
Certificates
1
From Advance NDC 4.01.01, remote key management using
certificates is supported on other vendors’ SSTs where supported by
the XFS platform. NCR SSTs continue to use signatures.
Changing the MAC
Encryption Key
1
In previous releases, the MAC encryption key could not be updated
while the SST was In-Service. From Advance NDC 3.03, the MAC
encryption key can be updated using the Extended Encryption Key
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-47
Introducing Advance NDC
Advance NDC Development
Change message at any point after it is initially entered, except
when a transaction is in process, the terminal is in Suspend mode, or
when the operator is executing a Supervisor settlement transaction.
Dual-Mode Journal
Printing
Format of Journaled
Messages
APIs for C Exits to Print to
Any Printer
1
1
From Advance NDC 2.06, additional functionality on the Supervisor
Configure menu supports dual-mode journaling, which allows both
a paper journal to be printed and an electronic journal (EJ) to be
created.
In previous releases, group separators were not included when a
message was journaled. From Advance NDC 4.02, group separators
are represented by asterisks on both the EJ and hardcopy journal.
This improves the readability of the journaled message.
From Advance NDC 4.00, in addition to the PrintToJournal API, the
following APIs are provided for C Exits:
1


PrintToReceipt
PrintToStatement
For further details, refer to the APTRA Advance NDC, Extending the
Product publication.
Night Safe
ActiveX Controls
1
1
Up to Advance NDC 2.06, the night safe was supported for both
basic and enhanced variants. In Advance NDC 3.00, only the basic
night safe was supported. From Advance NDC 3.03, both the basic
and enhanced night safes are supported.
In Advance NDC 2.x, ActiveX Controls were used in a
single-vendor environment and used ADI. These controls contained
a complete worker hierarchy. Three files were delivered as part of
the ActiveX Control. Controls were registered using the regsvr32.exe
application provided with Windows.
From Advance NDC 3.03, ActiveX Controls are XFS-based. These
controls wrap the application DLL file and provide an interface to
use the application DLL file in different environments. Four files are
delivered as part of the ActiveX Control. Controls are registered
using the Assembly Registration tool (regasm.exe) provided with the
.NET 2.0 runtime installation.
Note: Any Globally Unique Identifiers assigned to ActiveX
Controls built using Advance NDC 2.x cannot be maintained in
Advance NDC 3.x. This is due to a difference in registering C++
COM Controls and .NET ActiveX enabled controls.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-48
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Advance NDC Development
Master Expansion State
1
In previous versions of Advance NDC, the available characters used
to indicate which state type is referenced in the State Type field
were almost exhausted.
From Advance NDC 3.03, the available state types have been
extended by defining a Master Expansion State, State ‘z’. The first
entry in the Master Expansion State defines the new state type.
.NET Assemblies for
Advance NDC
From version 3.04, a new component is included to provide the
following features:
1


Bunch cheque acceptors are supported as CPM devices, with
additional support as follows:
— New states to support bunch cheque acceptance
— New control sequences to support bunch cheque acceptance
— Support for offline bunch cheque solutions, including
transaction receipt printing
— Support for dynamic screen content for bunch cheque
acceptance through Display Manager
— Configuration at start of day through a configuration file
Extended Supervisor options for TCP/IP communications.
From Advance NDC 4.00, the following apply to the .NET
Assemblies for Advance NDC component:


Cash-in functionality is implemented through the .NET
Assemblies for Advance NDC.
Cardholders can unmark cheques they have incorrectly marked
for return, instead of having to perform another cheque deposit
transaction. This facility to toggle between marking and
unmarking cheques is controlled through the Cheque Detail
Display state. For details of this state, refer to Chapter 2, “State
Tables” in the APTRA Advance NDC, Reference Manual.
From Advance NDC 4.01, TCP/IP configuration in Supervisor
allows you to add, delete or edit the four optional parameters to
configure security certificates, as follows:




4 Received Certificate Issuer
5 Received Certificate Subject
9 Supplied Certificate Identifier
10 Supplied Certificate Subject
Local Printing Functions
1
From Advance NDC 4.02, places known as print points are available
in the transaction flow to allow printing to be initiated by Advance
NDC rather than by the host. This functionality can be used, for
example, in local states and customisations. For details of using
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-49
Introducing Advance NDC
Advance NDC Development
these print points refer to Chapter 10, “Developing Hooks” in
APTRA Advance NDC, Extending the Product.
.NET Supervisor Tasks
1
From Advance NDC 4.00, there is support for including Activate
.NET Supervisor Tasks (Supervisor tasks) through either of the
following:


The existing Supervisor Exit Executor worker, which does not
require any authoring updates, but limits the inclusion of
Supervisor tasks to the first two levels of the Supervisor menus
The new Supervisor Task Executor worker, which requires
authoring updates, but allows the inclusion of a Supervisor task
anywhere in the Supervisor application flow.
APTRA Promote From Advance NDC 4.00, the APTRA Promote
CRM product is supported using .NET Supervisor Tasks on the
Access menu.
1
The following changes are made to the Supervisor Access menu to
support Promote:


The Copyfile option is replaced by the Promote/Copyfile option,
which offers the following:
— The same functionality offered by the previous Copyfile
function
— A Promote sub-menu that allows you to enable or disable
Promote, copy campaigns, delete campaigns and export logs
containing details of Promote screens and coupons.
The Promote option is removed.
APTRA Relate From Advance NDC 4.00, the APTRA Relate CRM
product is supported using .NET Supervisor Tasks on the Access
menu. Option 21, Relate menu, is provided to enable or disable
Relate.
Troubleshooting From Advance NDC 4.00, Problem
Determination investigations and the retrieval of archives are
supported using .NET Supervisor Tasks. Option 44,
Troubleshooting on the Configure menu provides access to both of
these options.
Software Update
From Advance NDC 4.02, there is an option on the Misc Funcs
menu in Supervisor to install or update software and configuration
files from removable media and without using a PC keyboard. The
option uses the .NET Software Update Tasks component to copy or
execute files.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-50
APTRA Advance NDC, Developer’s Guide
1
1
1
Introducing Advance NDC
Advance NDC Development
Self-Service Terminal
Configuration Component
1
From Advance NDC 4.00, the Self-Service Terminal Configuration
component (SST configuration component) runs automatically
following installation to configure the SST. The devices present on
the SST are identified using an XML-based configuration file, which
also defines the configuration settings.
The configuration component can be used on SSTs from NCR and
other vendors.
The SST configuration component replaces any cash-in,
printer-specific and vendor-specific registry files. The
AdvanceNDC.reg and NDC_SP.reg files are retained, with the SST
configuration component providing additional settings.
From Advance NDC, 4.01, the SST configuration component can be
used on all NCR SSTs.
Configuration of Fixed
Drives
PCI DSS Compliance
1
1
From Advance NDC 4.01, a preconfigured location on a fixed drive
is provided as the default location for the storage of note signatures.
This can be changed by editing the CreateSignaturesPath
property in the Class Configurator file, AdvanceNDC.accfg.
Advance NDC 3.04 obtained PA-DSS compliance certification from
the PCI Securities Standards Council (PCI SSC), following
assessment and submission of an audit report by a PCI DSS
Qualified Security Assessor. The updates made are described in
Appendix E, “PCI DSS & PA-DSS Compliance in Advance NDC”.
Masking of Sensitive Data
1
From Advance NDC 4.00, additional registry keys are provided to
enable or disable the masking of sensitive customer data in trace
data when troubleshooting. Data sent in an Interactive Transaction
Reply or a Transaction Reply to the Message In window, or printer
data sent to the OOXFS window in DebugLog and Silent Debug, can
now be masked.
Interactive Transaction Reply The Screen Data field (field j) and
the Trailer field (field k) can be masked when an Interactive
Transaction Reply is written to the Message In window. The
masked characters will be replaced by asterisks.
Transaction Reply From Advance NDC 3.04, the following fields
of the Transaction Reply message are masked before being logged
in the "Message In" window of Debug Log or Silent Debug:




1
1
Track 1 data
Track 2 data
Track 3 data
Exit data buffers M, N , O, P, Q and R.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-51
Introducing Advance NDC
Advance NDC Development
From Advance NDC 4.00, it is possible to enable or disable masking
of the Screen Display Update and Printer Data fields through the
registry. The masked characters will be replaced by asterisks.
Printer Data Logging From Advance NDC 4.00, it is possible to
configure whether printer data sent to the journal, receipt and
statement printers is also logged to the OOXFS window of Debug
Log or Silent Debug.
Note Acceptor Unsolicited Messages From Advance NDC 4.01,
cardholder data is masked with asterisks.
Runtime Installation
Directories
1
From Advance NDC 3.04, during a runtime installation, the
C:\SSDS path is no longer used for files, although it is still available
for backward compatibility with customer Exits.
Any files previously installed to C:\SSDS\DLL or C:\SSDS\APPS
are now installed to C:\Program Files\NCR APTRA\Advance NDC
and its subdirectories. This includes application files, DLL files,
media files, and configuration files.
Prior to Advance NDC 4.00, customisations, such as customer Exits,
were installed to C:\SSDS\DLL.
Directories for
Customisations
1
From Advance NDC 4.00, customisations must be installed as
follows:


Installation Types
1
On an SST, C:\Program Files\NCR APTRA\Advance NDC
On a development PC, C:\NTGlobal\AANDCAPPS.
From Advance NDC 3.01, all installation options are available for
selection from a single Advance NDC aggregate.
From Advance NDC 4.00, a smaller Runtime-only installer is also
provided as an alternative to the Combined installer for use on
SSTs.
Custom Directory
1
Media Entry Indicator
(MEI) on Spray Dispensers
From release 3.01, a directory containing all modified files and
registry settings, called the custom directory, replaces the Advance
NDC Support component containing the supportfiles subdirectory.
Prior to Advance NDC 4.02, the MEI on spray dispensers was never
turned on.
1
From APTRA Advance NDC 4.02, there is a configuration option to
enable the MEI and to specify the length of time it flashes during a
dispense operation on a spray dispenser. Using registry entries, the
MEI can be configured to delay flashing until just before notes are
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-52
APTRA Advance NDC, Developer’s Guide
1
1
Introducing Advance NDC
Advance NDC Development
presented and also to continue flashing for a few seconds after the
last note has been dispensed.
Unsupported Features
1
From release 3.00, the EPP in BAPE emulation mode is no longer
supported in Advance NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-53
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Differences Between Advance NDC
and NDC+
To compare the overall features offered by NDC+ with those offered
by Advance NDC, refer to the APTRA Advance NDC, Overview.
The Customisation Layer allows you to customise the behaviour of
the SST to a greater extent than was available in NDC+.
This section discusses specific operational differences between
Advance NDC and NDC+. It focuses on the features in NDC+ that
are either not available in Advance NDC or operate differently.
These operational differences include:



























Aggregate Building
Cash dispenser beeper
Cash dispenser cassette types
TM-Alert
Document Processing Module (DPM)
Coin Dispenser
Digital Audio Service (DAS)
State Types
Configuration Parameters
Customisation Data Commands
PIN Entry and Verification
BAPE emulation
Electronic Journal and Journal Printer Backup
Screen Data
K Screens
Diebold Emulation Mode Status Messages
Status Messages
Alarms and Tamper Indication
Option Digits
Supervisor Mode
Differences in MACing
Communications Protocols
Basic Operator Panel (BOP)
VGA Enhanced Rear Operator Panel (VEROP)
Security Camera
Software Management
Associated Keyboards
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-54
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Differences Between Advance NDC and NDC+













Transaction Request Extension State
Font Definition
Character Sets
Localising Advance NDC
Unsolicited Status Messages
MPEG and PCX File Support
Number of Screens Supported
Support for Screens
Set Display Mode Control Sequence
Passbook Printer Support
Roll Width and Left Margin
Envelope Dispensing
Remote Status Indicators.
For information on the BNA and CPM devices, see “Advance NDC
Development” on page 1-15.
Aggregate Building
1
From Advance NDC 2.05, the Aggregate Builder Tool has been used
to define component aggregates.
For an introduction to building aggregates with Advance NDC, see
“Aggregate Building” on page 1-76.
Cash Dispenser—Beeping
Cash Dispenser—Cassette
Types
Cash Dispenser—Supplies
Status
1
In NDC+, when option A was set to Action (do not retract notes),
option B was ignored; so the beeper did not sound. In Advance
NDC, the behaviour of option B, when set to Action, depends on the
setting of option A. For details, refer to the APTRA Advance NDC,
Supervisor’s Guide.
In NDC+, up to four cassette types were supported.
1
In Advance NDC, Enhanced Configuration option 76 controls the
number of supported cassette types. By default, this option is set to
support up to four cassette types. For further details of option 76,
refer to the APTRA Advance NDC, Reference Manual.
In NDC+, the current supply status was reported for repeated
transactions, even where the supply status remained the same.
1
In previous releases of Advance NDC, the supply status was
reported as 0 - ‘no new state’ for repeated transactions if the supply
status remained the same.
From Advance NDC 3.03, the supply status reported is that of the
cassette referenced by the transaction. If the status remains the same
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-55
Introducing Advance NDC
Differences Between Advance NDC and NDC+
as the previous transaction, it does not change to 0 - ‘no new state’.
The purge bin never reports 0.
Following a retract operation in NDC+, only the supplies status of
the dispensing cassette type was reported.
In Advance NDC, the supplies status of all cassettes are reported
following a retract operation.
TM-Alert is not supported by Advance NDC.
TM-Alert
1
The following table details which message types associated with
TM-Alert are handled differently by Advance NDC.
Table 1-5
TM Alert
Message
Class
Message
Sub-Class
Message
Destination
Differences
5
-
TM-Alert
Terminal
This message from the Central application is not supported. If
it is sent, Advance NDC responds with a Command Reject or
Specific Command Reject (E01).
3
-
TM-Alert
Central
As a result of the above, Advance NDC does not send this
message to the Central application.
Document Processing
Module
The Document Processing Module (DPM) is not supported in
Advance NDC.
1
Advance NDC behaves in the same way as NDC+ when running on
an SST where a DPM device is not present.
The following table details the message types associated with this
device which are handled differently by Advance NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-56
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Table 1-6
DPM Message Types in Advance NDC
Message
Class
Message
Sub-Class
Message
Destination
Differences
1
1
Transaction Request
Central
If the DPM fields are requested for inclusion in
this message, they will be included. Although all
DPM data (such as Read Zones) is initialised, it is
never written to by Advance NDC.
NCR recommends you do not request inclusion of
the DPM related fields.
1
2
2
2
Device Fault Status
Information
Central
Advance NDC will not send any Unsolicited or
Solicited Device Fault Status messages for the
DPM.
1
2
Sensors Device Fault
Status Information
Central
For the Sensors device, byte 19 of the Device Status
is not reported as it relates to the DPM.
2
2
Send Configuration
Information Terminal
State Message
Central
DPM, and DPM Tamper Indicator (TI) and Coin TI
fields are included in this message, if specified, but
will always indicate that the device is not
configured.
2
2
Send Supply Counters
Terminal State
Central
DPM fields are not included in this message.
2
2
Send Tally Information
Terminal State
Central
Not supported in Advance NDC.
A default message is always returned in which
zeros are reported for the DPM.
2
2
Send Error Log
Information Terminal
State
Central
Not supported in Advance NDC.
DPM fields are not included in the SST Device
Error Logs.
2
2
Hardware
Configuration Data
Terminal State
Central
There will be no Device Identifier/Configuration
for the DPM in this message (Device Identifier ‘]’).
If a Depository is present, Device Identifier ‘F’ will
have a Hardware Configuration of ‘02’ for PPD
(Programmable Printing Depository) reported
rather than ‘04’ for DP-ATM Depository.
If a Statement printer is present, Device Identifier
‘V’ will have a Hardware Configuration of ‘01’ for
standard Statement printer reported rather than
‘05’ for 5665 Statement printer.
If an Envelope Dispenser is present, Device
Identifier ‘\’ will have a Hardware Configuration
of ‘01’ reported rather than ‘02’ for DP-ATM
Envelope Dispenser.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-57
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Message
Class
Message
Sub-Class
Message
Destination
Differences
There will be no Device Identifier/Configuration
for DPM TI (‘_’).
2
2
Supplies Data Terminal
State
Central
There will be no Device Identifier/Supplies for
DPM.
DPM TI is never reported.
2
2
Fitness Data Terminal
State
Central
There will be no Device Identifier/ Fitness for the
DPM.
DPM TI is never reported.
2
2
Tamper and Sensor
Status Data Terminal
State
Central
In field g2, the value of the sensor status is derived
from the XFS HRESULT.
In field g3 (Tamper Indicator Identifier ‘B’) the
status of each Tamper Indicator is reported.
This field is always 13 bytes in length. Bytes 1-7
are derived from XFS.
Bytes 8-12 deal with the coin dispenser.
Byte 13 is always ‘0’, indicating DPM TI is not
present.
In field g4 (Extended Tamper Indicator Identifier
‘C’) the status of each extended Tamper Indicator
is reported.
4
-
Transaction Reply
Terminal
Functions ‘S’ and ‘T’ are not supported by
Advance NDC. If they are specified, a Command
Reject or Specific Command Reject (E02) is
reported. These functions are rejected at the
earliest stage, with no validation or use of the
DPM data in the Transaction Reply.
Printer Flags ‘;’ and ‘<’ are ignored by Advance
NDC.
3
1
Override Reserved
Screens Command
Terminal
This Customisation Data Command (Message
Identifier ‘G’) is accepted, but the ‘Type D’
reserved screens are not used by Advance NDC. A
Ready 9 message is returned.
3
1
Configuration/
Enhanced
Configuration
Parameters Load
Terminal
These Customisation Data Commands (Message
Identifiers ‘3’ and ‘A’) are accepted. See
“Configuration Parameters” on page 1-63.
The following table details which state types associated with the
DPM device are handled differently by Advance NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-58
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Table 1-7
DPM State Types in Advance NDC
Coin Dispenser
1
State Type
Description
Close
The extension to this State related to DPM
error handling and screens is ignored.
Courtesy Amount
Verification
This State does nothing other than take the
exit specified by Table Entry 4 (CAV
Unavailable Next State Exit).
DPM Document Accept
This State does nothing other than take the
exit specified by Table Entry 6 in Extension
3 (Exception Type 3 Next State Exit).
Enhanced Amount Entry
The “Start CAV” extension to this State is
ignored by Advance NDC.
The differences between using a coin dispenser with NDC+ and
using a coin dispenser with Advance NDC are detailed in Table 1-8.
Table 1-8
Coin Dispenser Differences
NDC+
Advance NDC
Supported a coin dispenser with four hopper types
By default, Advance NDC is NDC+ compatible and
configured to support only four hopper types.
However, support for up to eight hopper types can be
set using Enhanced Configuration option 79
Supported a coin dispenser with a maximum dispense
of 25 coins
Supports the dispense of coins up to the maximum
reported by the hardware SP
Coins can be dispensed using the Display and Print
function
Coins cannot be dispensed using the Display and Print
function
Coins cannot be dispensed without notes
Coins can be dispensed without notes; a cash
dispenser does not have to be present for a coin
dispense
A low condition is reported immediately, then the
transaction continues
A low condition is reported at the end of the
transaction
The STD COIN Supervisor option prints all counters
before performing the CLR COIN, ADD COIN and
CHECK CDM Supervisor options
The STD COIN Supervisor option prints the coin
counters before performing the CLR COIN, ADD
COIN, and CHECK COIN Supervisor options
If no coin dispenser is configured, Advance NDC returns the same
message as NDC+ when running on an SST where a coin dispenser
is not present.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-59
Introducing Advance NDC
Differences Between Advance NDC and NDC+
The following table details which message types associated with
this device are handled differently by Advance NDC.
Table 1-9
Coin Message Types in Advance NDC
Message
Class
Message
Sub-Class
Message
Destination
Differences
1
1
Transaction Request
Central
If option 79 is set to 000, the message has the same
format as in NDC+ with field ‘r’ containing the
number of coins dispensed in the last transaction.
If option 79 is set to 001, the number of coins
dispensed is reported in the ‘ce1’ to ‘ce<n+1>’
fields (derived from buffer f) and field ‘r’ is set to
zero.
1
2
2
2
Device Fault Status
Information
Central
If option 79 is set to 000, device fault status
information is sent for four hopper types.
If option 79 is set to 001, device fault status
information is sent for the number of hopper types
reported in the Hardware Configuration message.
A minimum of four hopper types are reported.
The Advance NDC message also reports hopper
type severities and the actual coins dispensed.
2
2
Send Configuration
Information Terminal
State Message
Central
If specified, a Tamper and Sensor Status Data
message is returned for the coin dispenser. The
information is extended, as shown in Tamper and
Sensor Status Data Terminal State below.
2
2
Send Supply Counters
Terminal State
Central
Using the command modifiers for Command
Code ‘4’, it is possible to select the basic or
extended message format.
The basic message format is as NDC+ (command
modifier 1).
The extended message format differs from NDC+.
It allows the reporting of more than four hopper
types (command modifier 2).
2
2
Send Tally Information
Terminal State
Central
This is not supported in Advance NDC. For
further information, refer to the Advance NDC,
Reference Manual.
2
2
Send Error Log
Information Terminal
State
Central
This is not supported in Advance NDC. For
further information, refer to the Advance NDC,
Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-60
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Message
Class
Message
Sub-Class
2
Message
Destination
Differences
2
Hardware
Configuration Data
Terminal State
Central
If enhanced configuration option 79 is set to 001,
the coin dispenser configuration data is extended
from 2 to 7 bytes.
This provides additional information on the
number of hopper types and the maximum coins
per dispense.
2
2
Supplies Data Terminal
State
Central
Extended to allow the reporting of more than four
hopper types.
2
2
Fitness Data Terminal
State
Central
Extended to allow the reporting of more than four
hopper types.
2
2
Tamper and Sensor
Status Data Terminal
State
Central
In field g2, the value of the sensor status is derived
from the XFS HRESULT.
In field g3 (Tamper Indicator Identifier ‘B’) the
status of each Tamper Indicator is reported.
This field is always 13 bytes in length. Bytes 1-7
are derived from XFS.
Bytes 8-12 deal with the coin dispenser.
Byte 13 is always ‘0’, indicating DPM TI is not
present.
In field g4 (Extended Tamper Indicator Identifier
‘C’) the status of each extended Tamper Indicator
is reported.
4
-
Transaction Reply
Terminal
Extra fields for more than four hopper types are
used if option 79 is set to 001.
Printer Flags ‘;’ and ‘<’ are ignored by Advance
NDC.
3
1
Override Reserved
Screens Command
Terminal
This Customisation Data Command (Message
Identifier ‘G’) is accepted, but the ‘Type D’
reserved screens are not used by Advance NDC. A
Ready 9 message is returned.
3
1
Configuration/
Enhanced
Configuration
Parameters Load
Terminal
These Customisation Data Commands (Message
Identifiers ‘3’ and ‘A’) are accepted. See the
“Configuration Parameters” section.
Digital Audio Service
1
From Advance NDC 3.03, voice guidance is supported, but differs
significantly from the Digital Audio Service (DAS) added to NDC+
release 6.
The DAS provided a limited set of messages which could be sent in
transaction replies for account balances and general transaction
data. In Advance NDC, a full solution is offered, called Voice
Guidance, to assist visually impaired cardholders throughout
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-61
Introducing Advance NDC
Differences Between Advance NDC and NDC+
transactions. Support is provided for use of a text-to-speech engine
or recorded voice data.
The Audio Control State is not supported by Advance NDC.
An XML configuration file is used in Advance NDC to define the
audible echo of the keyboard instead of the Enable Audible Echo of
Keyboard configuration parameter.
Antex audio files cannot be played in Advance NDC, but
industry-standard audio files that are supported by the Windows
Media Player can be used. For details, see “Recreating Audio Files”
on page 3-5. Advance NDC also supports the use of third-party
Text-to-Speech (TTS) software to render the audio messages.
The following table details which message types associated with the
DAS are handled differently by Advance NDC.
Table 1-10
DAS Message Types in Advance NDC
Message
Class
Message
Sub-Class
Message
Destination
Differences
4
-
Transaction Reply
Terminal
Two Printer Flags are supported for voice guidance. In
addition to Printer Flag ‘>’, supported in NDC+ as
“Annunciated Voice”, Printer Flag ‘w’ can also be used
to identify audio data for voice guidance.
3
1
Enhanced
Configuration
Parameters Load
Terminal
This Customisation Data Command (Message Identifier
‘A’) is accepted, but the Enable Audible Echo of
Keyboard parameter is ignored. See “Configuration
Parameters” on page 1-63.
State Types
1
Advance NDC handles the following state types differently from
NDC+:









Close - see “Document Processing Module” on page 1-56
Courtesy Amount Verification - see “Document Processing
Module”
DPM Document Accept - see “Document Processing Module”
Enhanced Amount Entry - see “Document Processing Module”
Audio Control State - see “Digital Audio Service” on page 1-61
PIN Entry - see “PIN Entry States” on page 1-64
Enhanced PIN Entry - see “PIN Entry States”
Card Read - PIN Entry Initiation - see “PIN Entry States”
Smart FIT check - refer to the APTRA Advance NDC, Reference
Manual, Chapter 12, ‘Smart Card Handling’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-62
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Configuration Parameters
1
The following Configuration and/or Enhanced Configuration
Parameters may be downloaded, but are ignored by Advance NDC:













Card Read Error Threshold
Card Write Error Threshold
Timers:
— 70 (DASH ‘Remove Card’ Screen Delay Timeout is not
supported)
— 91 (In Service Inspection Timeout is not supported)
— 97 (Door Access Open Timeout is not supported)
Diebold Status Reporting for Vandal Guard (Diebold is not
supported)
Tamper Indication Control Option
Extended Status Control Option
Optical Sensor Option (CIM86 is not supported)
Journal Printer Backup Log Tamper Option
Touch Screen Error Reporting Option (Touch Screen errors are
not reported because, unlike S4, Self-Service Support does not
support a proprietary Touch Screen device)
Remote Status Indicators (RSI) and the Remote Relay option
(RSIs are enabled as described in “Remote Status Indicators” on
page 5-17 and Remote Relay is not supported)
TPA Informed of SM Activity Option (not applicable with
Self-Service Support)
Enable Audible Echo of Keyboard
Non-Magnetic Card Accept.
Report Card Data in Status Message
1
The following Enhanced Configuration Parameter options allow
card data to be included in status messages:


Print Track 2 to Journal (option 37). As in NDC+, this option
allows the track 2 data to be printed. In Advance NDC, the
format of the printed information is defined using reserved
screen t15
Send Track Details on Card Retract (option 41). In NDC+, this
option allowed all the data read from the card to be included in
the status message when a card jam occurred. In Advance NDC,
this option allows all the data read from the card to be included
in the status message when a card is retracted.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-63
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Customisation Data
Commands
Advance NDC handles Customisation Data Commands differently
from NDC+, as listed in the following table:
1
Table 1-11
Customisation Data Commands in
Advance NDC
Message
Class
Message
Sub-Class
3
Message
Destination
Differences
1
Diebold PIN
Information Load
Terminal
This Customisation Data Command (Message Identifier
‘4’) is accepted, however the downloaded data is not
stored because it is never used in Advance NDC. A
Ready 9 message is returned.
3
1
Override
Reserved Screens
Command
Terminal
This Customisation Data Command (Message Identifier
‘G’) is accepted; the ‘Type D’ reserved screens are used
by Advance NDC for EMV Exits.
3
1
Configuration/
Enhanced
Configuration
Parameters Load
Terminal
These Customisation Data Commands (Message
Identifiers ‘3’ and ‘A’) are accepted. For details of
unsupported options, see the “Configuration
Parameters” on page 1-63.
PIN Entry and Verification
1
The following PIN Verification methods are not supported by
Advance NDC:




Local Diebold PIN Verification
Local GBP PIN Verification
Atalla PIN Verification
Remote BANKSYS PIN Verification.
PIN Entry States
1
In Advance NDC, the numeric keypad must be used for PIN entry.
As a result of this, the following state types do not support the use
of the Touch Screen in Advance NDC:



PIN Entry
Enhanced PIN Entry
Card Read - PIN Entry Initiation.
PIN Block - No Encryption
A value of 4 for the FIT field PINPD means no Encryption of the PIN
Block. This value is not supported in Advance NDC as it breaches
the use of Secure PIN Entry and results in the PIN being sent to the
Central application in clear text.
In Advance NDC, use of Secure PIN Entry means the PIN the
cardholder enters is not available to the application.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-64
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Specifying a value of 4 for PINPD will result in the Cancel Next
State being taken in PIN Entry states.
BAPE Emulation
1
Electronic Journal and
Journal Printer Backup
The EPP in BAPE emulation mode is not supported in Advance
NDC.
The following journal-related features are not supported, or are
supported differently in Advance NDC.
1
Electronic Journal Log File Checksum
1
This feature is supported differently in Advance NDC.
In NDC+, when the Electronic Journal (EJ) was initialised (using the
INIT EJRNL Supervisor function) with an eight-byte ASCII numeric
string (which acted as a checksum) added to the end of both the file
copied to diskette (ejxxxxxx.nnn) and the backup log file (ejrcpy.log).
This checksum was also logged at the start of the new journal log
file (ejdata.log).
In Advance NDC, this checksum feature has also been implemented
as part of the Electronic Journal functionality. However, the
checksum can be turned off using a registry setting. For details of
turning off the checksum, see “EJ Checksum” on page 5-153.
Note: Adding a checksum results in a longer initialisation process
that increases with larger EJ files. For details of the INIT EJRNL
option, refer to the APTRA Advance NDC, Supervisor’s Guide.
EJ Log File Inspection (In Service Supervisor)
1
This feature is not supported in Advance NDC.
If the EJ was configured and the SST had a rear operator panel,
NDC+ supported inspection of the EJ log file and the copying of
sections of the log file to diskette (as DOS text) while the SST was in
any Mode. Additionally, copying sections of the log file to a printer
was supported while the SST was in Supervisor Mode.
Tampered Journal Records
1
This feature is not supported in Advance NDC.
If Journal Printer Backup was configured, NDC+ applied an
integrity check to all records passing through the Journal Printer
Backup disk buffer. If an integrity error occurred on a reprint
record, NDC+ supported several different courses of action (all
configured by the Journal Printer Backup Log Tamper Enhanced
Configuration Parameter) as follows:
a
No action
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-65
Introducing Advance NDC
Differences Between Advance NDC and NDC+
b
Printed the defective (‘tampered’) record, bracketed by >> and
<< characters
c
Sent an unsolicited status message, including the last Security
Trace Number, its date and time stamp, and the record offset, to
the Central application
d
In addition to option c, wrote the defective journal record to a
file on the system disk (up to ten defective records).
In the case of option d, subsequent access to these files used the
FREE JDATA Supervisor function, enabled or disabled by a
Terminal Command from Central.
This ‘tamper’ feature has not been implemented as part of the
Journal Printer Backup functionality in Advance NDC, as follows:



No checks are made for ‘tampered’ reprint records
No unsolicited status messages relating to this feature are sent to
the Central application
The FREE JDATA Supervisor function has not been
implemented. However, if the Enable Free JData Terminal
Command is received from the Central application, it will be
handled by Advance NDC in the same manner as by NDC+.
Setting the associated Enhanced Configuration Parameter (22)
will have no effect on the system, as it will be ignored by
Advance NDC.
EJ File Format
This feature is supported differently in Advance NDC.
The EJ file contains the same printable characters as were logged
using NDC+. However, there may be additional Advance NDC
specific printer control codes present in the file.
In NDC+, the EJ file size was fixed at 1.44 MB. Advance NDC,
allows a file size to be set for the EJ of at least 1K. The maximum that
can be set is calculated using the available disk space. For details,
see “Maximum EJ File Size” on page 5-153.
Advance NDC also does the following to the EJ log file:



Adds an end date stamp
Allows password protection and compression
Allows compression without password protection.
If you have developed a tool to view the Electronic Journal file,
ensure that it ignores irrelevant control characters.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-66
APTRA Advance NDC, Developer’s Guide
1
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Screen Data
1
The following Screen Data features are not supported by Advance
NDC:



Set display mode control - ignored, because the screen
resolution cannot be changed at runtime
Voice - Antex Audio files are not supported. Instead
industry-standard Sound Blaster WAVE (.wav) and MIDI (.mid)
audio files can be used. For details, see “Recreating Audio Files”
on page 3-5.
Animation - VGM.ani files and Autodesk FLIC (.fli or .flc)
animation files are not supported. Instead, Microsoft AVI (.avi)
movies and industry standard MPEG (.mpg) video/audio files
can be used. For details, see “Recreating Animation Files” on
page 3-6.
The following screen resolutions are not supported:


640 x 350 x 16
320 x 200 x 256.
Advance NDC supports resolutions of 640 x 480 and above. For
details, see “Recreating Graphics” on page 3-3.
K Screens
1
In NDC+, screens K04, K05, and K06 were sent to the printers on exit
from NDC+ to prepare for diagnostics.
In Advance NDC, these screens are not used. For details, refer to the
APTRA Advance NDC, Reference Manual.
Diebold Emulation Mode
Status Messages
Status Messages
1
1
No Diebold Emulation Mode Status messages are sent to the Central
application because Advance NDC only supports NCR Native
Mode.
Advance NDC does not send Unsolicited/Solicited Device Fault
Status information messages for the following devices:



Touch Screen Keyboard - unlike S4, Self-Service Support does
not support a proprietary Touch Screen device
Document Processing Module - device not supported. See
“Document Processing Module” on page 1-56
Door Access - device not supported.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-67
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Table 1-12
Status Message
Message
Class
Message
Sub-Class
1
2
1
Message
Destination
Differences
2
2
Card Reader/Writer
Device Fault Status
Information
Central
The Transaction/Device Status values of ‘6’ to ‘9’ are
not reported, because the CIM86 Card Reader is not
supported.
Similarly, the Error Severity is always one byte.
2
Sensors Device Fault
Status Information
Central
See “Document Processing Module” on page 1-56.
Alarms and Tamper
Indication
In NDC+, alarms and tamper indications were reported while in
diagnostics.
1
Advance NDC does not report alarms and tamper indications while
in Vendor Dependent Mode (VDM). However, on NCR hardware,
Advance NDC does report alarms and tamper indications for cash
and coin dispensers on exit from VDM.
For the Cardholder Display Alarm, reporting of unsolicited
messages is controlled by option 32 of the Enhanced Configuration
Parameters Load message.
The sending of cardholder display status in Get Fitness responses
can be controlled by a registry setting.
Option Digits
1
The following Option Digits (specified in Supervisor mode) can be
entered but are ignored:


Option Digit 3, Part B
Option Digit 7, Part B.
Option Digit 7, Part C - SOH reporting is handled differently by
Self-Service Support compared to NDC+.
For details of Option Digits, refer to the APTRA Advance NDC,
Supervisor’s Guide.
Supervisor Mode
1
Advance NDC does not use reserved screens M10, M11 and M13 to
define key positions on the cardholder keyboard. Instead, Advance
NDC Supervisor mode uses the default keyboard layouts provided
in NDC+.
Instead of reserved screen M03, Advance NDC uses reserved screen
m03.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-68
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Differences Between Advance NDC and NDC+
If you wish to change the key positions and return code, you can do
so using the TTU SP configuration for rear operator access or the
PIN SP configuration for front operator access.
The following Supervisor functions are not supported by Advance
NDC:
Table 1-13
Supervisor Functions Not Supported
Present in the Advance
NDC Supervisor Menu?
Menu
Options
Select Menu
SET SW0 - SET SW3
CSOH 2
CSOH 3
TM-ALERT
NO
Replenish Menu
DUMP IMAGES
YES
Configure Menu
VOLUME SST
VOLUME JACK
YES
Access Menu
INIT SUP SOH
INIT INS SOH
FREE JDATA
NO
For details of the behaviour in Advance NDC of the unsupported
functions, refer to the APTRA Advance NDC, Supervisor’s Guide.
Communications
1
Advance NDC provides Supervisor menus for configuring CCM
VISA2 dialup or TCP/IP communications with Central. These
menus are accessed by selecting the required menu function on the
Configure menu.
If you wish to use CCM VISA2 dialup, or TCP/IP to communicate
with the host, refer to the APTRA Advance NDC, Supervisor’s Guide
for details of the TCP/IP and dialup configuration menus. For
additional communications configuration, see “Configuring
Communications” on page 5-40.
Diagnostics
1
If you move the mode switch to Normal, then exit Diagnostics in
Advance NDC, the SST returns to In Service or Out of Service mode.
In NDC+, this returned you to Supervisor mode.
Miscellaneous Functions
1
Advance NDC provides a Select menu item for Miscellaneous
Functions (‘MISC FUNCS’). The MISC FUNCS menu contains
options for journaling the EMV smart card application component
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-69
Introducing Advance NDC
Differences Between Advance NDC and NDC+
versions (‘PRNT CMPNT VERS’) and smart card hardware version
(‘PRNT SCRW VERS’), if present.
Differences in MACing
1
If the security flags are such that flag 1 is FALSE and flag 2 is TRUE,
a Message Authentication Code (MAC) value is expected at the end
of the following messages, but it is not checked:





Transaction Reply
Customisation Data State Tables Load Command
Customisation Data FIT Data Load Command
Customisation Data MAC Field Selection Load Command
Dispenser Currency Cassette Mapping.
When security flag 1 is set to FALSE (do not check MAC in
incoming messages), no attempt is made to determine whether or
not a MAC exists in the message. When security flag 2 is set to
TRUE, this indicates that a MAC is expected. Do not use this
combination of security flags because the consequences are as
follows:


Some invalid messages may be rejected with a different reject
status from before. This is not seen as an issue, as invalid
messages should not be sent to a live SST.
Messages that are valid, but do not have a MAC attached when
one is expected, will be accepted. Previously such messages
would have been rejected.
In the Message Authentication Field Selection Load message, EMV
field offsets differ in that NDC+ used offset 35 and Advance NDC
uses offset 36. This means that you cannot use the same Message
Authentication Field Selection Load message if you wish to use
selective MACing on EMV ICC data with Advance NDC and NDC+
based terminals.
Communications Protocols
1
APTRA Communications Connection Manager (CCM) is used in
Advance NDC to support the following protocols for
communications:



Basic Operator Panel
(BOP)
1
TCP/IP
VISAII
All protocols supported by the PCCM service except for IBM
3600 Loop communications.
The Basic Operator Panel (BOP) is not supported by Advance NDC.
Although the Supervisor interface has the same look and feel as in
NDC+, menus can only be displayed on the front interface or the
Enhanced Operator Panel (EOP).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-70
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Differences Between Advance NDC and NDC+
VGA Enhanced Rear
Operator Panel (VEROP)
Graphics
1
1
In NDC+, the VGA Enhanced Operator Panel (VEROP) could be
used in EOP emulation mode. However, Self-Service Support does
not support the VEROP in EOP emulation mode. Advance NDC
supports Enhanced Operator Panel (EOP), a Graphical Operator
Panel (GOP) or a Compact Operator Panel (COP).
In NDC+, the config.con file was needed to successfully display logos
and pictures. The files used were the Gxx.pcx files
In Advance NDC, the config.con file is no longer required. The
names of the files required to successfully display logos and
pictures in Advance NDC are described in “Recreating Graphics”
on page 3-3.
From Advance NDC 4.01, the .pcx format is no longer supported.
For compatibility, the pictures can still be defined as
<picture>.pcx in the screen definitions, but a supported file
format must be used for all graphic files on the SST.
From Advance NDC 4.01, the graphics files are Gxx.png files.
Security Camera
1
In NDC+, a single integrated security camera was supported with
two timers. Advance NDC can support up to 3 cameras at different
positions: person, exit slot and room. An XML file is used to
configure the flow points at which pictures can be taken. Each flow
point can obtain multiple images.
On the Replenish menu in Supervisor, the fill camera option is
renamed SECURITY CAMERA and provides the following options
for cameras:



TEST CAMERA (NDC+ had the Fill Camera function for this)
COPY SNAPSHOTS
DELETE SNAPSHOTS.
The following table details which message types associated with the
security camera are handled differently by Advance NDC.
Table 1-14
Security Camera Message Types in
Advance NDC
Message
Class
Message
Sub-Class
2
2
Message
Destination
Differences
2
Send Tally Information
Terminal State
Central
Tally information is not supported.
2
Send Error Log Information
Terminal State
Central
Error Log information is not supported.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-71
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Software Management
1
In NDC+, a message was sent to the Central application (Message
Class 4, Sub-Class 1) giving information on the status of any
Software Management installation.
In Advance NDC, there is no interaction between Advance NDC
and the Software Management components running in the SST.
Therefore, Advance NDC will never send Message Class 4 to
Central and the Enhanced Configuration Parameter ‘TPA Informed
of SM Activity Option’ is not used.
Associated Keyboards
1
In NDC+, a screen displayed during a State Type could optionally
have had an associated keyboard definition, to let you define which
keys to enable and the return code for each key.
In Advance NDC, these associated keyboards are supported with
the following release restrictions due to service provider limitations:


Bunch Note Acceptor
(BNA) and Cheque
Processing Module (CPM)
1
For Advance NDC 3.00 to 3.02, these associated keyboards were
ignored.
From Advance NDC 3.03, associated keyboards are supported
for FDKs only. For further details, see “Associated Keyboards
for FDKs” on page 1-28.
The Bunch Note Acceptor (BNA) and the Cheque Processing
Module (CPM) are new features with Advance NDC. See “Advance
NDC Development” on page 1-15 for further information on their
development histories.
The Bunch Note Acceptor (BNA), if present, is supported in
Advance NDC as follows:











Additional information in various Terminal State Messages
Terminal Command - Retrieve Note Definitions
Device Fault Status messages
Configuration Parameters
State Type - Cash Accept State
Additional fields in Transaction Request and Reply messages
Three transactions - two Encash functions and a Refund
transaction
Changes to various Supervisor replenishment functions
Specific Supervisor functions
Changes to Start of Day
CDI Stores.
For details of using the BNA, refer to the following publications:


APTRA Advance NDC, Supervisor’s Guide
APTRA Advance NDC, Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-72
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Differences Between Advance NDC and NDC+
Transaction Request
Extension State
In NDC+, you could not add new data fields to the Transaction
Request message.
1
In Advance NDC, the Transaction Request Extension State has been
modified to allow you to add new data fields to the Transaction
Request message. For more details, see “Adding Data Fields to a
Transaction Request” on page 8-18.
In NDC+, you could not define alternative fonts to those provided.
Font Definition
1
In Advance NDC, you can define alternative fonts to those provided
with Advance NDC. These alternative fonts can be third-party
fonts, or fonts you have developed.
For more information, see Appendix D, “Font Definition”.
Character Sets
1
The following NDC+ designated character sets are not supported in
Advance NDC:







Localising Advance NDC
1
‘6’ (Customer Graphics 1)
‘8’ (Customer Graphics 3)
‘9’ (Customer Graphics 4)
‘<’ (Chinese 3)
‘=’ (Chinese 4)
‘@’ (Chinese 7)
‘A’ (Chinese 8).
To aid your understanding of the Advance NDC Customisation
Layer and Application Core, and the NDC-specific workers
provided with Advance NDC, on-line information in UK English is
available in the form of On-line Help and Component Descriptions.
You can translate the on-line information if required. To learn how
to do this, refer to the APTRA Advance ADE, Local Language
Customisation Guide.
For details of the files which contain the on-line information to be
translated, refer to the text files
<global>\Custom\CustomisationLayer\rt115_cust.txt and
<global>\Custom\ApplicationCore\rt116_cust.txt.
Unsolicited Status
Messages
1
NDC+ sent unsolicited status messages immediately when the SST
was in In Service mode. With Advance NDC, unsolicited status
messages may also be sent at different times. In Advance NDC,
unsolicited messages are not always sent immediately, but at
defined points in the application. This difference does not cause
incompatibility issues for hosts.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-73
Introducing Advance NDC
Differences Between Advance NDC and NDC+
You may find that some unsolicited status messages, which were
not sent in NDC+, are sent to Central in Advance NDC. For
example, if the currency dispenser shutter is jammed closed when a
present is attempted, Advance NDC sends a Suspend unsolicited
status message to Central. With NDC+, this Suspend message was
not sent.
In Advance NDC, unsolicited status messages are used to report
any change of condition at the terminal, as follows:



Recognition of an external event
Supplies problems
Device errors.
Note: Unsolicited messages are not generally used to report
device errors at Start of Day. If required at this time, Central
must use Terminal Commands to query the current SST device
status.
Multi-Media File Support
Number of Screens
Supported
Support for Screens
1
NDC+ supported MPEG files through the hardware, but Advance
NDC uses a proprietary implementation together with the
appropriate codecs installed on the SST to render multi-media video
files such as AVIs, and MPEGs. On Windows, Windows Media
Player uses the DirectX interface for video rendering. For details of
formats supported on Windows, refer to the Microsoft article
“Windows Media Player Multimedia File Formats” (article ID
316992) at http://support.microsoft.com.
NDC+ supported up to 999 screens. From Advance NDC 2.06, up to
9999 screens are supported.
1
From Advance NDC 4.02, the screen numbers defined in state tables
are extended from 000-999 to 000-Z99. The alphanumeric character
is mapped to a numeric value to allow the direct specification of
3599 screens. Applying language offsets allows all 9999 screens to be
referenced from the state tables if necessary. A configuration option
allows screen base and group sizes to be extended to increase the
available number of multi-language screens.
1
The following differences exist between NDC+ screens and
Advance NDC screens:


Z screens — In NDC+, Z screens were used to display state of
health screens on the BOP. Advance NDC does not support the
BOP, so Z screens are not used
X screens — In NDC+, X screens were used to display state of
health information on the EOP or front screen. In Advance
NDC, X screens are used for audio messages
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-74
APTRA Advance NDC, Developer’s Guide
Introducing Advance NDC
Differences Between Advance NDC and NDC+

Set Display Mode Control
Sequence
Passbook Printer Support
Roll Width and Left
Margin
Envelope Dispensing
C05 screen — In NDC+, if a card jam occurred resulting in a
suspend condition, screen C05 and another ‘card could not be
read’ screen were displayed. In Advance NDC, only screen C05
is displayed in this situation.
In NDC+, the Set Display Mode control sequence could be used.
1
1
1
1
Advance NDC does not support this control sequence.
In NDC+, passbook transactions were handled by the DPM.
Advance NDC does not support the DPM and does not provide a
runtime implementation for the passbook printer. Instead, passbook
printer worker classes are provided to enable the development of an
authored flow in the APTRA Author to support passbook
transactions.
In NDC+, you could set the Roll width and Left margin for journal
and receipt printers. In Advance NDC, these options are applied to
receipt printers only.
In NDC+, an envelope could only be dispensed using NDC State C
(Envelope Dispenser State).
In Advance NDC, if the NDC Envelope Dispenser state (state C) is
used, an envelope is dispensed.
In addition, the application uses registry settings to determine the
following envelope dispensing behaviour:


Remote Status Indicators
1
Dispense an envelope during the Deposit and Print function if
NDC State C (Envelope Dispenser State) has not been used
(default Advance NDC behaviour).
Do not dispense an envelope during the Deposit and Print
function. (NDC+ behaviour).
In NDC+, Remote Status Indcators were set using the envelope
dispenser status configuration option.
From Advance NDC 4.00 Remote Status Indicators handling
matches the Fault Display. For details, see the APTRA Advance NDC,
Supervisor’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
1-75
Introducing Advance NDC
Aggregate Building
Aggregate Building
Using the Aggregate Builder Tool (ABT) , you have control over the
components to be installed on the development PC or the SST. For
information about the ABT, refer to the on-line help provided with
the tool.
Advance NDC Aggregate
1
There is only one Advance NDC installable aggregate. The
aggregate provides the following installation options:




Development
Development and Simulation
Runtime SST
Documentation Only.
For details of the components in the Advance NDC Package, refer to
the APTRA Advance NDC, Overview.
Customising Aggregates
1
You can customise the provided aggregate installation by using the
Aggregate Builder Tool (ABT) on the development PC. For details,
see “Preparing a Modified Advance NDC Aggregate” on
page 11-20.
You can also use the ABT to control the installation of components
on a development PC, using a similar process.
User-Created Components
1
Using the Component Builder, you can build your own components
(for example, a custom presentation client) to add to an aggregate.
For guidance, refer to the Component Builder on-line help.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-76
APTRA Advance NDC, Developer’s Guide
1
Table of Contents
Installing Advance NDC on a Development PC
Chapter 2
Installing Advance NDC on a
Development PC
Overview
2-1
System Requirements
2-2
Installation Process
Before You Start
Default Installation Folder
Author User IDs
Installation Types
Combined Installer
Runtime Only Installer
Installing Advance NDC on a Development PC
After Installation
Custom Directory
Working Directory for the APTRA Author
Creating a Modified Aggregate for the SST
De-installing Advance NDC
2-3
2-3
2-3
2-3
2-3
2-3
2-4
2-4
2-5
2-5
2-5
2-5
2-5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Installing Advance NDC on a Development PC
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Installing Advance NDC on a Development PC
Overview
B
Overview
2
The Advance NDC package includes the Advance NDC product
together with other associated products.
This chapter provides additional information about installing
Advance NDC on your development PC and what to do after
installation.
For details of installing Advance NDC on an SST, see Chapter 11,
“Delivering an Advance NDC Aggregate to the SST”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
2-1
Installing Advance NDC on a Development PC
System Requirements
System Requirements
2
For details of the hardware required and prerequisite software for
your development PC, refer to the APTRA Advance NDC Overview
(PDF) which is available in the APTRA online documentation after
Advance NDC has been installed.
For last-minute information refer to the appropriate release bulletin.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-2
APTRA Advance NDC, Developer’s Guide
Installing Advance NDC on a Development PC
Installation Process
Installation Process
2
Before installing the Advance NDC software, ensure you have
gathered all the information that you will require, as described in
the following sections.
Before You Start
2
If the development PC has Advance NDC 3.01 or earlier installed,
you must follow the instructions described in “De-installing
Advance NDC” on page 11-24.
Default Installation Folder
2
By default, the C:\NTGlobal folder will be used as the Advance
NDC global directory. You can change this location during
installation.
Author User IDs
2
If you want to add User IDs during installation, ensure that you
have the details ready before you begin the installation and use the
recommended format.
Before using the Author for the first time, you must set up at least
one User ID. This can be completed as the last step of installation, or
at a later time, using the User ID utility.
For details of this utility and reserved User IDs, refer to the APTRA
Author User’s Guide.
Installation Types
2
Two installers are provided with Advance NDC, the Combined
installer, which contains all installation types, and the Runtime
Only installer for SSTs, which is a smaller alternative to the
Combined installer.
Combined Installer
2
The combined installer offers the following installation methods in
the Target Environment window:


Runtime SST
Development and Simulation
Note: The following options are also listed:
— Development. This is the same as the Development and
Simulation option
— Simulation. NCR recommends that the Simulation option is
not used.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
2-3
Installing Advance NDC on a Development PC
Installation Process

Documentation Only.
For information about the components that are installed on the
development PC or SST, refer to the APTRA Advance NDC Overview
(PDF), which is available in the APTRA online documentation or in
the root directory of the CD-ROM.
Runtime SST
For the SST, select the Runtime SST option.
Development and Simulation For the development PC, the
Development and Simulation option provides the same
functionality as the Development option, and also allows you to run
simulations of your developments.
Documentation Only To see the documentation before installing
the Advance NDC software, select the Documentation Only option .
This will install all the documentation for Advance NDC and other
components in the Advance NDC aggregate. You do not need to
de-install the documentation before installing the software.
Runtime Only Installer
The Runtime Only intaller provides an alternative method of
installing on an SST. It installs the runtime version of Advance NDC
without offering a choice of installation types. For details of using
the Runtime Only installer, see Chapter 11, “Delivering an Advance
NDC Aggregate to the SST”.
Installing Advance NDC
on a Development PC
2
Caution:
Installing Advance NDC on a development PC for the first time is
like installing any software package on the Windows XP operating
system.
If you have an installation of Advance NDC 3.01 or earlier, this must
be removed first. For details, refer to “De-installing Advance NDC”
on page 11-24.
To install Advance NDC, perform the following steps:
1
Insert the APTRA Advance NDC Package CD-ROM into the
CD-ROM drive of the development PC.
2
Run the setup.exe file located in the root directory and follow the
on-screen instructions for the installation type you require.
The other choices on this screen allow you to do the following:


Read the APTRA Advance NDC Overview (PDF)
Read the release bulletins.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-4
APTRA Advance NDC, Developer’s Guide
2
2
2
2
Installing Advance NDC on a Development PC
Installation Process
3
After installation is complete, read and follow the instructions in
“After Installation” on page 2-5.
The Silent Debug utility and the DebugLog tool are installed with
Advance NDC. For further information on troubleshooting utilities,
see Chapter 12, “Installing and Configuring Troubleshooting
Tools”.
After Installation
2
Once you have successfully installed Advance NDC on your
development PC, you need to set up required files and folders to
use the Aggregate Builder Tool and/or the APTRA Author for any
modifications you intend making to the Advance NDC application
supplied in the Advance NDC Package.
Custom Directory
2
The custom directory contains your DLLs and any other modified
files and can be created anywhere within an APTRA component
directory.
Any folder containing _comp.ini is recognised by the ABT as an
APTRA component directory.
You must create the custom.ini file, which is used to locate new files
or registry settings to update the supplied application. All registry
entries and source and target file names are held in the custom.ini
file.
For details, see “Preparing a Modified Advance NDC Aggregate”
on page 11-20.
Working Directory for the APTRA Author
2
To use the APTRA Author, you need to create a working directory
to store your projects and generate a final build. For details, refer to
the APTRA Author, User’s Guide.
For information on the Advance NDC application flow and testing
the applications in the Author, see Chapter 7, “Introducing the
Advance NDC Authored Applications”.
Creating a Modified Aggregate for the SST
2
You can modify the software to create an aggregate using the
Aggregate Builder Tool. For more information, see Chapter 11,
“Delivering an Advance NDC Aggregate to the SST”.
De-installing Advance
NDC
2
If you want to re-install Advance NDC, you must first remove the
existing Advance NDC installation and any associated software that
has been installed separately.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
2-5
Installing Advance NDC on a Development PC
Installation Process
If you re-install Advance NDC to the same location, it overwrites
most of the contents of the Advance NDC directories, so you need to
take copies of any files you wish to keep. Complete the following
steps:
1
If you have carried out any development under the root
directory of Advance NDC (default name is <drive>:\ntglobal), or
have changed any files under it, back up the development or
changed files.
2
In the Windows Control Panel, use Add or Remove Programs to
first remove any Advance NDC service pack, then the Advance
NDC components. Files created after the installation of Advance
NDC, such as custom.dat, user ID files and CDI data files, will
not be deleted. It is up to you to keep or delete them.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-6
APTRA Advance NDC, Developer’s Guide
Table of Contents
Migrating Existing NDC+ Applications to Advance NDC
Chapter 3
Migrating Existing NDC+
Applications to Advance NDC
Overview
3-1
Executing an Entire NDC+ Download
Changes Required
3-2
3-2
Recreating Graphics
Cardholder Graphics
Logo Control
Picture Control
Display Image Files Control
3-3
3-3
3-3
3-3
3-4
Recreating Audio Files
3-5
Recreating Animation Files
3-6
Changing RESRVD.DEF
3-8
Recreating Communications Template Files
3-9
Proving the Download Works
3-10
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Migrating Existing NDC+ Applications to Advance NDC
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Migrating Existing NDC+ Applications to Advance NDC
Overview
C
Overview
3
This chapter guides you through the migration of an existing NDC+
application to Advance NDC.
This chapter provides information on:


How to migrate an NDC+ download, including the creation of:
— Graphics files
— Audio files
— Animation files
— Reserved screens
— Communications Template files
Proving the download works.
Note: Advance NDC supports Display Manager, which provides
support for HTML screens, including images and video, and
Advance NDC display for a variety of multi-media formats on the
cardholder display.
For information on migrating existing NDC+ Exits, refer to the
APTRA Advance NDC, Extending the Product publication.
For information on screen formatting in Advance NDC, refer to
Chapter 3, “Screen Data” in the APTRA Advance NDC, Reference
Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
3-1
Migrating Existing NDC+ Applications to Advance NDC
Executing an Entire NDC+ Download
Executing an Entire NDC+
Download
Migrating an existing NDC+ application to Advance NDC may
require some changes, which are summarised in this section. The
Customisation Layer supplied by NCR enables you to use your
existing NDC+ download in a Windows XP environment,
unchanged.
The Customisation Layer handles the download and execution of
NDC+ customisation data (States Types, Screen Data, Printer Data,
Configuration Parameters and Financial Institution Tables). There
is no need for you to make any authoring changes using the
APTRA Author.
Note: If you want to familiarise yourself with the application flow,
you can do so using the Author. See Chapter 7, “Introducing the
Advance NDC Authored Applications”. If you intend enhancing
the Customisation Layer, see Chapter 8, “Modifying the
Customisation Layer”. To enhance the Application Core, see
Chapter 9, “Enhancing the Application Core or Supervisor”.
Changes Required
3
Table 3-1
Help for Recreating or Migrating Files
To successfully run your Customisation Layer application, you may
need to recreate or migrate certain files, as described in the
following table, which contains links to the relevant sections in this
chapter:
To...
See...
Recreate graphics files
“Recreating Graphics” on page 3-3
Recreate audio files using new
tools
“Recreating Audio Files” on
page 3-5
Recreate animation files using
new tools
“Recreating Animation Files” on
page 3-6
Recreate communications
template files
“Recreating Communications
Template Files” on page 3-9
Edit resrvd.def if you have made
changes to it
“Changing RESRVD.DEF” on
page 3-8
Migrate Exits used in your NDC+
application
APTRA Advance NDC, Extending
the Product
After carrying out the relevant changes, you can proceed to
“Proving the Download Works” on page 3-10.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-2
APTRA Advance NDC, Developer’s Guide
3
Migrating Existing NDC+ Applications to Advance NDC
Recreating Graphics
Recreating Graphics
3
Advance NDC does not support the 640 x 350 and 320 x 200 screen
resolutions used in NDC+. Advance NDC only supports screen
resolutions of 640 x 480 and above.
If you have created your own graphics for display in NDC+, you
may need to recreate them. If you try to display one of your current
NDC+ graphics using Advance NDC, the vertical dimension of the
graphic, as displayed on the screen, will be reduced by
approximately 28%.
After recreating your own graphics, copy them to your custom
directory. This includes them in the aggregate when you export it
from the Aggregate Builder Tool. For further information on the
custom directory and building a new aggregate, see “Preparing a
Modified Advance NDC Aggregate” on page 11-20.
Although you need to recreate your graphics, download screens do
not usually require any changes, as the same screen controls as in
NDC+ are supported (or ignored if not supported; for example, the
‘Set Display Mode Control’ is ignored if sent).
Cardholder Graphics
3
To take account of the different screen resolutions supported, the
Screen Type ‘G’ cardholder graphics (G00, G01 and G03-G06)
supplied with NDC+ have been recreated. For more information,
refer to the APTRA Advance NDC, Reference Manual.
The provided graphics are located in the <global>\final\xfs\dll
directory.
Copy the required graphics to your custom directory. This includes
them in the aggregate when you export it from the Aggregate
Builder Tool for installation on an SST.
Logo Control
3
Logos must have a file name of the format logoxx.yyy, where xx is
the two digit number representing the logo (for example, 00) and
yyy is its file extension.
For details of the supported file formats, search for “Picture and
Animation File Formats” in the APTRA Author online help.
Picture Control
3
Pictures must have a file name of the format picxxx.yyy, where xxx
is the three-digit number representing the picture (for example, 000)
and yyy is its file extension.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
3-3
Migrating Existing NDC+ Applications to Advance NDC
Recreating Graphics
Although in NDC+ pictures could be referenced by a number of
between one and three digits, Advance NDC requires that the file
name has three digits, with leading zeros if necessary, for example,
pic020.yyy. You do not need to modify the screen definitions. A
screen definition of ESC ‘P’ 2 20 ESC ‘\’ will display the file
pic020.yyy.
For details of the supported graphics file formats, search for
“Picture and Animation File Formats” in the APTRA Author online
help.
Display Image Files
Control
An AVI file-name prefix must not exceed eight characters, that is,
the name must conform to the 8.3 format (<filename>.avi).
3
The deafult path for an image file is C:\Program Files\NCR
APTRA\Advance NDC\Media.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-4
APTRA Advance NDC, Developer’s Guide
Migrating Existing NDC+ Applications to Advance NDC
Recreating Audio Files
Recreating Audio Files
3
Advance NDC does not support NCR’s proprietary Antex audio
board. Therefore, Antex audio files cannot be played in Advance
NDC.
Instead audio files with the appropriate codec installed on the SST,
and any installed text-to-speech software, are supported.
The same host (Central) interface for playing audio is supported. As
in NDC+, a screen control results in an audio file being played.
The following table identifies how Advance NDC handles playing
audio files compared with NDC+.
Table 3-2
Audio File Handling in Advance NDC and
NDC+
NDC+
Advance NDC
Number of standard
messages provided
10 Antex audio files
10 WAVE/MIDI
audio files (same
messages as in
NDC+)
Screen control plays a
message identified by
a number
‘xx’ or ‘xxx’
‘xx’ or ‘xxx’
Audio file format
(where ‘xx’ or ‘xxx’
maps the file to a
message number)
daudioxx.msg or
daudixxx.msg
daudioxx.yyy or
daudixxx.yyy
(see step 1)
To play message number ‘xx’ or ‘xxx’, you need to do the following:
1
Re-record or save the audio file as a .wav or .mid file.
Note: The file must follow the same fixed naming convention
used in NDC+. That is, daudioxx.yyy or daudixxx.yyy, where xx
or xxx is the message number and yyy is wav/mid.
2
Copy the file to your custom directory.
By following the file format, file name convention and directory
location specified, the audio files will be included in the aggregate
when you export it from the Aggregate Builder Tool. For
information about using the Aggregate Builder Tool with Advance
NDC, see “Aggregate Building” on page 1-76.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
3-5
Migrating Existing NDC+ Applications to Advance NDC
Recreating Animation Files
Recreating Animation Files
Advance NDC does not support proprietary VGM .ani animation
files, or Autodesk FLIC (.fli or .flc) animations.
File formats such as Microsoft AVI (.avi) movies and
industry-standard MPEG (.mpg) video/audio files are supported.
Other file formats such as animated GIFs are supported if the
relevant codecs are installed on the SST. For more information about
the various supported file formats, refer to the following:


Chapter 3, “Screen Data” in the APTRA Advance NDC Reference
Manual
“Picture and Animation File Formats” in the APTRA Author
online help.
Note: There is a system-imposed limit on the number of AVI files
that can be used. For further information, see “AVI System Limit”
on page 5-128.
The same host (Central) interface for playing animations is
supported. As in NDC+, a Picture control or Display Image Files
control can be used to display an animation file.
The following table identifies how Advance NDC handles
displaying animation and video files compared with NDC+.
Table 3-3
Video File Handling in Advance NDC and
NDC+
NDC+
Advance NDC
Control displays a
picture (animation)
identified by a
number
‘x’
‘x’
Mapping between
picture (animation/
video) file and
number is specified
by (Picture control
only)
config.con
A fixed mapping
convention is used
picxxx.yyy
(see step 1)
To display an animation or video file with number ‘xxx’, complete
the following:
1
Create the animation or video in a supported file format.
Note: 1. To display an animation or video file using a Picture
Control sequence, Advance NDC requires that the file name has
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-6
APTRA Advance NDC, Developer’s Guide
3
Migrating Existing NDC+ Applications to Advance NDC
Recreating Animation Files
three digits, with leading zeros if necessary, for example,
pic020.avi.
Note: 2. If the animation is played using the Display Image Files
control, no mapping is required.
2
Copy the file to your custom directory.
By following the file format, file-name convention and directory
location specified, the animation or video file will be included in the
aggregate when you export it from the Aggregate Builder Tool.
For information about using the Aggregate Builder Tool with
Advance NDC, see “Aggregate Building” on page 1-76.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
3-7
Migrating Existing NDC+ Applications to Advance NDC
Changing RESRVD.DEF
Changing RESRVD.DEF
If you have made any changes to the RESRVD file in NDC+, you
will need to re-apply these changes to the resrvd.def file in Advance
NDC.
Note: The resrvd.def file must not contain any TAB characters. Use
the SPACE character instead.
To apply changes without editing the supplied resrvd.def file, do the
following:
1
Create a file that uses the same format as the resrvd.def file, but
which contains your changes
2
Create the following registry entry with the name of your file as
the data:
HKLM\SOFTWARE\NCR\Advance NDC\supervisor\
UseAdditionalReservedScreenFile
Valid values are blank for no additional reserved screen file, or the
name of the file, for example resrvd.4012.
The supplied resrvd.def file will be loaded, and then any additional
file is loaded. If any screens are duplicated in the additional file, the
original version is overwritten.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-8
APTRA Advance NDC, Developer’s Guide
3
Migrating Existing NDC+ Applications to Advance NDC
Recreating Communications Template Files
Recreating Communications
Template Files
3
When an SST running NDC+ software was installed in a network,
its communications had to be configured before it could
communicate with Central.
The communications service was configured by creating a
communications template file (CTF) using the NCR
Communications Template Generator. The communications
template file contained protocol-dependent configuration
parameters.
One of the parameters you defined in the CTF was the name of the
connection to use when sending messages to and receiving
messages from Central. Although NDC+ did not know the name of
the connection specified in the CTF, it was able to communicate
with the Central application using an alias name of
‘COMMUNICATIONS’.
Owing to the differences in the way Self-Service Support handles
communications compared with S4, the alias name
‘COMMUNICATIONS’ cannot be used in Advance NDC. Instead,
the Application Core uses the connection name ‘TPA
CONNECTION’. This means when you create your CTF, you must
define the name of the comms connection as ‘TPA CONNECTION’.
For details of creating a CTF for use by an SST running Advance
NDC, refer to the APTRA Communications Feature, User’s Guide.
Note 1: If the name you specify in the CTF for the connection is not
‘TPA CONNECTION’, a communications link will not be
established.
Note 2: If you are using TCP/IP communications, you will not need
to recreate your CTF as TCP/IP communications configuration is
performed using the TCP/IP Configuration menus in Supervisor
mode. For details, refer to the APTRA Advance NDC, Supervisor’s
Guide.
For information about registry and other settings that can be
modified for communications, see “Configuring an Advance NDC
Application” on page 5-13.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
3-9
Migrating Existing NDC+ Applications to Advance NDC
Proving the Download Works
Proving the Download Works
After you have made the necessary changes to migrate graphics,
audio and animation files and NDC+ Exits, you may want to install
Advance NDC on an SST to confirm that it works correctly with
your NDC+ download.
For details of how to install an Advance NDC application on an SST,
see Chapter 11, “Delivering an Advance NDC Aggregate to the
SST”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-10
APTRA Advance NDC, Developer’s Guide
3
Table of Contents
Upgrading from Earlier Releases of Advance NDC
Chapter 4
Upgrading from Earlier Releases of
Advance NDC
Overview
4-1
Modularisation and the Single Executable
New Authored States
SSDS DLL Interface Worker
New Application DLLs
DLLs for Authored State Types
DLLs for Transaction Reply Functions
DLLs for the Cash-In Component
4-2
4-2
4-3
4-3
4-3
4-4
4-4
Feature Support
Changes to the Interface since Release 2.6
ADI2 to CEN-XFS
Advance NDC and Updates for Security for APTRA
Communications
RSA Initial Key Loading
Additional BNA Functionality
Enhanced Night Safe
Enhanced Configuration Parameters Load
BAPE Emulation
EMV C Exits
Keyboard Data
Supervisor Menus
Fault Display
User Messages and User Terminal Data Implementation
APTRA Simulator
4-5
4-5
4-5
4-6
4-7
4-7
4-7
4-7
4-7
4-8
4-8
4-8
4-8
4-9
4-9
4-9
Upgrading Your Release of Advance NDC
Authored Customisations
Customisations in the Customisation Layer
Worker Class Support
C Exits
EMV/CAM2 Exits for APTRA Advance NDC
Cardholder Screen Display
4-10
4-10
4-10
4-11
4-11
4-11
4-12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Upgrading from Earlier Releases of Advance NDC
Device Access
Supplies Data Sources
Fitness Data Sources
Message Handling
User Messages and User Terminal Data
Printing
Printer Variants
Receipt Printer
Journal Printer
STCONT File Updates
Promote Campaigns
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-12
4-14
4-15
4-16
4-17
4-18
4-18
4-18
4-20
4-21
4-21
Upgrading from Earlier Releases of Advance NDC
D
Overview
Overview
4
Prior to Advance NDC 2.05, the Supervisor functionality was
contained in the Application Core, and two separate authored
executables were provided that formed the Advance NDC runtime.
From Advance NDC 2.05, Advance NDC consisted of three
authored applications: the Customisation Layer, the Application
Core, and a separate Supervisor application containing all the
Supervisor functionality from the Application Core.
With the move to the CEN-XFS interface, the structure of the
Advance NDC application did not change and wherever possible,
existing functionality remained unchanged.
From Advance NDC 3.03, the applications have been further
simplified, particularly the Customisation Layer, through the
following:



Modularisation of state types
Modularisation of reply functions for the Transaction Request
state type
The introduction of a single executable replacing the three
executables previously supplied.
Note: The three authored projects are still supplied with
Advance NDC.
The objectives are to reduce the work required to re-implement or
re-apply customisations, and help simplify maintenance.
This chapter describes the differences you need to be aware of when
upgrading your Advance NDC installation from an earlier version,
as follows:





Modularisation
Feature support
Device access and data sources
Message handling and printing
Configuration
For more information about the structure of Advance NDC, see
Chapter 1, “Introducing Advance NDC”.
For information about configuration of Advance NDC see
Chapter 5, “Configuring Advance NDC and Associated
Components”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-1
Upgrading from Earlier Releases of Advance NDC
Modularisation and the Single Executable
Modularisation and the Single
Executable
If you have customised previous versions of Advance NDC using
the APTRA Author, the move to a single executable and
modularisation of state types will affect you. However, the benefits
will be clear in future Advance NDC releases and updates, as they
will be simpler to incorporate into your application.
Prior to Advance NDC 3.03, three application executables were
released: ApplicationCore.exe, CustomisationLayer.exe and
Supervisor.exe. When a product update or new version was released,
the impact to users of the product varied depending on the level of
customisation they had already performed on the various authored
projects, with customisations being re-applied to the updated or
new version to ensure nothing was lost.
Any product update to the Customisation Layer meant users had to
rebuild the whole of the application to pick up any change, unlike a
C++ code change, which was, and is, provided as an updated DLL in
a service pack. An updated DLL has minimal impact on customised
versions of Advance NDC as the only integration required is
configuration to ensure the appropriate versions of DLLs are
present in the system.
With the adoption of the modularised approach a single executable
is provided, ApplicationCore.exe. The other two are now application
DLLs. As the state types have also been separated from the
Customisation Layer into application DLLs, a small author project
containing the updated state type can be delivered. A decision can
then be made if the authored update affects any existing
customisation. If no change is required, the DLL can be delivered to
the SST like a C++ update.
If an authored update is required, the affected state type is updated
(or customisations are re-applied to it), re-built and delivered to the
SST. Any changes are local to the area of customisation, and
therefore have a smaller re-implementation impact. Only changes to
the Author worker class interface, such as new workers or changes
to attributes, require all application DLLs to be built again.
New Authored States
4
Prior to Advance NDC 3.03, when a new authored state was added,
the Customisation Layer project had to be updated to directly
reference the Authored state type. Now the NDC Processing State
Executor is used to execute a state type through the SSDS DLL
Interface worker.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-2
APTRA Advance NDC, Developer’s Guide
4
Upgrading from Earlier Releases of Advance NDC
Modularisation and the Single Executable
SSDS DLL Interface
Worker
4
The SSDS DLL Interface worker has always been used to split up
large authored applications, by adding a Director as the Top Worker
in an application and building a Final application.
The application DLL can then be referenced in the original
application by the SSDS DLL Interface worker, which loads and
executes the DLL as if it were still part of the application.
This principle provides the basis of the state type modularisation
with a modification to the SSDS DLL Interface worker, and the
addition of an attribute called Application Link. This allows each
application-related state type in the Customisation Layer to be an
application DLL, loaded and executed by the SSDS DLL Interface
worker.
New Application DLLs
Separate application DLLs have been created for the following:
4





Suspend mode, which has functionality shared between the
authored states
Cardholder session
Supervisor session
Each of the authored state types and transaction reply functions
(listed below)
The cash-in component (listed below).
DLLs for Authored State Types
4
The top-level director of each of the authored state types is now the
top worker of an application. Each application has been built to
produce the DLL, FRF, and STR files required to be referenced by
the SSDS DLL Interface worker. The following, state-type
application DLLs are provided:













Card Read states (state types A and T)
Card Insert (z008)
PIN Entry states (B and M)
Customer Selectable PIN (b)
PIN And Language Select (m)
Close (J)
Transaction Request (I)
Cheque Accept (w)
Smart FIT Check (k)
Envelope Dispense (C)
Card Write (L)
Camera Control (N)
Cardholder Authorised Verification (O)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-3
Upgrading from Earlier Releases of Advance NDC
Modularisation and the Single Executable


Barcode Read (&)
Web Exit (user-defined)
State type DLLs are initiated from the STCONT file and executed
using the NDC Processing State Executor worker, For details of the
changes to STCONT, see “STCONT File Updates” on page 4-21 and
refer to the APTRA Advance NDC, Extending the Product publication.
DLLs for Transaction Reply Functions
4
The Transaction Request state type has had all its reply functions
modified to reference a DLL for each reply function containing the
implementation, as follows:
















Deposit And Print
Dispense And Print
Display And Print
Print Immediate
Next State and Print
Night Safe Deposit
Parallel Eject/Dispense and Print (Fast Cash)
Card Before Cash
Card Before Dispense and Print
Print Statement and Wait
Print Statement and Next State
Process Cheque
Local Cash Dispense state (z010)
Data Copy and Compare state (z013)
Cash Deposit Handling state (z014)
Note Mix Selection state (z017)
DLLs for the Cash-In Component
The cash-in component also has a set of application DLLs, as
follows:





BNA Start of Day
BNA Event Monitor
BNA Close State
BNA Reconfigure Cassettes
BNA Tamper Indication
For details of the registry settings for the transaction reply
functions, cash-in component, cardholder session and supervisor
session, see “Registry Entry for Application Links” on page 5-13.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-4
APTRA Advance NDC, Developer’s Guide
4
Upgrading from Earlier Releases of Advance NDC
Feature Support
Feature Support
4
This section describes changes in the implementation, functionality
or operations of features compared to earlier versions of Advance
NDC. For details of differences that apply only on other vendor’s
SSTs, refer to the APTRA Advance NDC, Multi-Vendor Support
Reference Manual.
Changes to the Interface
since Release 2.6
Devices that were previously accessed through ADI2 or CEN-XFS 2
are now accessed through the CEN-XFS 3 interface.
4
The content of messages is derived from the XFS data and mapped
to the equivalent NDC message. In cases where an exact match is
not possible, the closest compatible message is generated.
Access to the BNA device was through ActiveX, but now the
ActiveXFS interface is used. Access to the CPM device was through
ActiveX, but now the CEN-XFS interface is used. Access to the
drives and cardholder display is still through the operating system.
ADI2 to CEN-XFS
4
In Advance NDC 2.06, the following devices were accessed through
ADI2:







Swipe Reader
3 Track Write Reader
Spray Dispenser
Alarms
Night Safe Depository
Statement Printer
Encryptor.
In Advance NDC 2.06, the following devices were accessed through
CEN-XFS 2. Prior to Advance NDC 2.06, they were supported
through ADI2:








MCRW Tk123
Smart MCRW
Dip
Smart/DIP Card Readers (without smart functionality)
Cardholder and Operator Keyboards
Cash Dispenser
Envelope Dispenser and Depository
Receipt Printer
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-5
Upgrading from Earlier Releases of Advance NDC
Feature Support




Journal Printer
TI Bins (Alarms)
System Display
Media Entry Indicators.
In Advance NDC 3.00, the device access changed to CEN-XFS 3.
For details of access to all devices in Advance NDC, see “Device
Access” on page 4-12.
Advance NDC and Updates for Security for APTRA
From APTRA Advance NDC 2.6, all files created at runtime,
including the EJ and hardcopy backup files, are located in
C:\Program Files\NCR APTRA\Advance NDC\Data to allow
read/write access under Security for APTRA. The c:\ssds folder has
been maintained for backward compatibility, but is not used by
Advance NDC.
The following table gives details of the files that have been moved to
C:\Program Files\NCR APTRA\Advance NDC\Data.
Table 4-1
Advance NDC File Locations
Previous Path and Filename
Description
C:\pmdata\pmpageentry
Persistent memory file
C:\windows\system32\custom.dat
NDC download backup
file
C:\keystore.txt
C:\keystore.tmp
Security related files
C:\FONTDEFS.INI
C:\FONTDEFS.TXT
Font related files
C:\windows\system32\NDCDATAA.DAT
C:\windows\system32\NDCDATAD.DAT
System settings backup
files
C:\ssds\apps\ERJCPY.LOG
C:\ssds\apps\ERJCPY.IDX
C:\ssds\apps\EJDATA.LOG
C:\ssds\apps\EJDATA.IDX
C:\ssds\apps\HBDATA.LOG
C:\ssds\apps\HBDATA.IDX
Journal related files
C:\windows\system32\ucdiini.txt
C:\windows\system32\ucdipers.dat
User defined storage
files
C:\ndcrcpt
resrvd.def K07 screen
See Note 1:
C:\frontimg.bmp
resrvd.def C07 screen
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-6
APTRA Advance NDC, Developer’s Guide
4
Upgrading from Earlier Releases of Advance NDC
Feature Support
Note 1: This is the path for printer graphic file images. It is not
defined in resrvd.def for Advance NDC so that printer driver
defaults are used.
Communications
4
RSA Initial Key Loading
4
In Advance NDC, the default setup for communications is TCP/IP,
which is configured through the Supervisor Access menu. For
PCCM, or CCM VISA2 dialup communications, the registry must be
edited. For details of all registry keys for communications, see
“Configuring Communications” on page 5-40.
In Advance NDC 2.06, support for RSA encryption was introduced.
On SSTs with an EPP, the initial encryption keys (A key, B key and
V key) can be downloaded from Central using RSA encryption
instead of being entered locally in Supervisor mode.
Before using RSA encryption, the Host Security Module (HSM) on
the host and the EPP on the SST must perform an authentication
process that meets the requirements described in the APTRA
Advance NDC, Reference Manual in Chapter 11, “Security Features”.
Additional BNA
Functionality
4
From Advance NDC 3.00, as well as including transaction counts in
the Transaction Request message, option 45 of the Enhanced
Configuration Parameters Load is used to configure the following:


Reporting of retract operations
Number of notes to accept (up to 90 or more than 90)
The reporting of individual cassette status through an extended
message format is included from Advance NDC 3.01.
From Advance NDC 4.01, you can choose whether to handle a
Suspend condition as a Fatal condition or a Suspend condition. If
you require compatibility with earlier releases, you must handle a
Suspend condition as a Fatal condition
Enhanced Night Safe
In Advance NDC 2.06, the enhanced night safe was supported.
4
In versions 3.0 to 3.02, the enhanced night safe was not supported,
as the variant information was unavailable.
From Advance NDC 3.03 support for the enhanced night safe is
included.
Enhanced Configuration
Parameters Load
4
Enhanced Configuration Parameters Load messages are handled as
previously, except for MCRW Enhanced Card Drive (ECD) Security
Jitter. Option number 46, which is used to set the registry key for
MCRW Enhanced Card Drive (ECD) Security Jitter, takes effect only
when the SST is reset.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-7
Upgrading from Earlier Releases of Advance NDC
Feature Support
Note: If this option is set, any card reader security options set
outside Advance NDC, such as through the Card Reader Property
pages, are lost.
BAPE Emulation
EMV C Exits
4
4
From Advance NDC 3.00, the EPP in BAPE emulation mode is not
supported; therefore the full EPP functionality must now be used.
As in Advance NDC 2.06, the Advance NDC application will
operate with existing EMV C Exits that are EMV Level 2 compliant.
For details of the EMV release to use, see “EMV/CAM2 Exits for
APTRA Advance NDC” on page 4-11.
For voice guidance, when an EMV C Exit builds a screen, you must
include an audio escape sequence in the Exit that corresponds to
placeholders in the voice guidance XML configuration file. All fixed
audio messages are stored in the XML file, but dynamic audio data
can also be referenced. For details of the audio escape sequence to
use with EMV C Exits, refer to the APTRA Advance NDC, Reference
Manual. For details of the XML configuration file for voice guidance,
see Chapter 6, “Configuring Voice Guidance”.
Keyboard Data
4
From Advance NDC 2.06, the following configuration parameters
are not supported:

Downloadable keyboard definitions. If different keyboard
layouts are required, they must be specified through the PIN
service provider.
Note: From Advance NDC 3.03, downloadable keyboard
definitions are supported for physical and emulated FDKs.

Cancel/Clear swap option.
Note: The FDK swap option is supported as it applies only to
the front keyboard and to some state types that require dynamic
swapping at application runtime.
Supervisor Menus
From Advance NDC 3.00, Supervisor has option 38 on the
4
Configure menu leading to submenus for dialup communications
functions. For full details of the dialup menu functions, refer to the
APTRA Advance NDC, Supervisor’s Guide.
From Advance NDC 3.01, alphanumeric entry can be used for
certain functions.
For more information about configuring dialup communications,
see “Configuring Communications” on page 5-40.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-8
APTRA Advance NDC, Developer’s Guide
Upgrading from Earlier Releases of Advance NDC
Feature Support
Fault Display
4
While an SST is in service, messages about device faults are
displayed cyclically on the rear operator panel. These messages give
information about devices requiring attention soon, such as Receipt
Low, and devices in a fatal condition, such as Cash Handler Fatal.
The messages also give details of the corrective measures necessary
to maintain an operational SST.
When the SST is in Supervisor mode, the fault display can be
displayed on request using one of the Supervisor functions. This
applies to both front and rear interfaces.
Note: Fault display is not supported for DASH devices.
Prior to Advance NDC 2.06, the FDK H key was used to invoke fault
display. From Advance NDC 2.06, the SELECT menu option 26 FAULT DISPLAY is used. The CANCEL key is used to exit the Fault
Display and return to the SELECT menu.
As all the device status information is provided through XFS, fault
display messages indicate the device or type of device and, where
possible, give extra details such as “CASH HANDLER FATAL,
SHUTTER JAMMED” to enable the operator to identify the failure.
The Fault Display shows all faults on one screen if possible, using
additional screens if necessary. The operator is given enough time to
read them as the value of Timer 92 is extended based on the number
of text lines displayed at a time. If there are no faults, the fault
display shows reserved screen E1903 NUMBER OF FAULTS = 0.
The text strings for fault messages can be localised by editing
resrvd.def. They are contained in the screen group Ennnn.
User Messages and User
Terminal Data
Implementation
APTRA Simulator
4
4
Prior to Advance NDC 2.06, User Messages and User Terminal Data
were implemented as ActiveX controls. From Advance NDC 2.06,
they are implemented in the Application Core, with unchanged
functionality. For information about these changes and their impact
on customised applications, see “User Messages and User Terminal
Data” on page 4-17.
From Advance NDC 3.03, the APTRA Simulator is a separate
product and is available through NCR. The APTRA Simulator
product includes several component parts, including the XFS
Simulator and its documentation.
For information about using the simulator, see “Testing the
Advance NDC Application” on page 7-35 and refer to the release
bulletin.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-9
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
Upgrading Your Release of Advance
NDC
4
If you use the Advance NDC application as provided by NCR, you
will be able to upgrade with only a few configuration changes,
described in “Configuring an Advance NDC Application” on
page 5-13.
As devices are now accessed through the XFS interface instead of
ADI2, changes will be required if you have done any or all of the
following:



Added any new ADI2 device-handling functionality
Applied customisations to Author applications that include
workers which are now unsupported or changed
Created your own User Messages or added your own data to
Terminal State messages.
The device status information is maintained for compatibility with
previous versions of Advance NDC.
If you have applied authored customisations to state types or
transaction reply functions, or authored your own, you will need to
consider the impact of modularisation and how you want to
proceed.
Authored Customisations
4
Instead of building three executables from the three projects in the
Author, only one executable is built, ApplicationCore.exe. The
Customisation Layer and Supervisor projects are built as
application DLLs for the cardholder and supervisor sessions.
There is no change to the way customisations are re-applied to the
Supervisor or Application Core projects but state type
modularisation has changed how customisations are re-applied in
the Customisation Layer.
Customisations in the Customisation Layer
Two new catalogs are provided in the Author, as follows:


State Types, for the application DLLs relating to state types
Transaction Reply Functions for the application DLLs relating to
transaction reply functions
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-10
APTRA Advance NDC, Developer’s Guide
4
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
For each state type customisation or transaction reply function,
complete the following:
Worker Class Support
4
1
In the Author, open the Customisation Layer project and
associated catalogs, including the State Types and Transaction
Reply Functions catalogs, which are nested within the
Customisation Layer Applications catalog.
2
Select the appropriate state type from the catalog and apply
your customisations to it.
3
Test and build.
When testing a large authored application, each application DLL
must be tested individually. You must test and then build lowerlevel DLLs before testing and building the DLLs and EXEs that
use them. NCR recommends that you avoid overwriting
existing DLLs by building to a DLL of a different name. For
more information, see “Testing the Advance NDC Application”
on page 7-35. While testing an authored application DLL, other
authored application DLLs can be used, but they will exhibit the
functionality of a Build Final DLL, not a Test DLL.
4
Repeat for each customisation and finally build the
Customisation Layer.
5
If necessary, update the Application Links registry key to point
to the customised version. For details, see “Registry Entry for
Application Links” on page 5-13.
If your application uses workers that either function differently or
are not supported in multi-vendor Advance NDC, you will need to
assess the extent of the changes required before you migrate your
application. An alternative to using an unsupported worker is to
use an authored Exit state.
For more information about worker class support in Advance NDC,
building an application and the locations for customised files, refer
to the APTRA Author, User’s Guide.
C Exits
4
C Exits are supported in a multi-vendor environment, though C
Exits written for an earlier release of Advance NDC will need
modification if they access devices.
EMV/CAM2 Exits for APTRA Advance NDC
4
For EMV Exits support, you must use a version that is certified with
the current version of Advance NDC. For details of certified
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-11
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
versions, refer to the APTRA Advance NDC Package Release
Bulletin.
Cardholder Screen Display
Device Access
4
4
As Advance NDC now uses integrated displays for cardholder
screen display, if an application has previously hosted Advance
NDC in a child window you must now develop an Exit to
communicate using the DisplayScreen and DisplayString
application programming interfaces provided by ndccust.lib. For
further information on using these APIs, refer to Chapter 4,
“Sharing Data with Advance NDC” in the APTRA Advance NDC,
Extending the Product publication.
The following table gives details of the service providers used for
device access. Device identifiers are present in terminal
configuration Terminal State messages. They indicate the device to
which the data in the message applies. For some supported variants,
it is not always possible to identify each unique variant, for
example, the DIP readers.
For details of the hardware configuration data associated with each
device, refer to the APTRA Advance NDC, Reference Manual,
Appendix E, “Device Identifiers”.
Table 4-2
Service Provider Device Access Details
Device ID
Device Name
Device Variant
Device Access
Comment
D
Magnetic Card
Reader/Writer
Track 2
IDC SP
Read only
Track 1/2/3 MCRW
IDC SP
Write on track 3 only
PC Dip Reader
IDC SP
—
3 Track Write MCRW
IDC SP
—
Track 2 Smart Card Reader
IDC SP
—
Track 1/2/3 Smart Card Reader
IDC SP
—
3 Track Write Smart Card Reader
IDC SP
—
Track 2/3 Dip MSR
IDC SP
Variant returned as
Track 2/3 Reader
Track 1/2 Dip MSR
IDC SP
—
Track 1/2 Swipe Reader
IDC SP
—
Dip and Smart Hardware () Card
Reader
IDC SP
—.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-12
APTRA Advance NDC, Developer’s Guide
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
Device ID
Device Name
Device Variant
Device Access
Comment
E
Cash Handler
Standard cash handler
CDM SP
—
Spray dispenser
CDM SP
—
Dual cash handler
CDM SP
—
DEP SP
—
Dot matrix
PTR SP
—
Thermal
PTR SP
—
Dot matrix
PTR SP
—
Thermal
PTR SP
—
DEP SP
—
NBS encryptor
PIN SP
This is reported for
BAPE/HI-BAPE
EPP encryptor
PIN SP
—
F
Envelope Depository
G
Receipt Printer
H
Journal Printer
K
Night Safe
Depository
L
Encryptor
M
Camera
All variants
CAM SP
—
O
Off-Line Flex Disk
1.44 Mb Flex Disk Drive
O/S
2.88 Mb Flex Disk Drive
O/S
Access to the diskette
drive is through the
operating system and is
vendor-independent
P
TI Bins (Alarms)
All variants
SIU SP
—
Q
Cardholder
Keyboard
Standard (BAPE) keyboard
PIN SP
—
EPP keyboard
PIN SP
—
Keyboard plus FDKs (enhanced)
TTU SP
This is reported for the
Enhanced Operator
Panel
O/S
Access to display, touch
screen, and voice
functions is through the
operating system and is
vendor-independent
R
Operator Keyboard
S
Cardholder Display
V
Statement Printer
All variants
PTR SP
—
Y
Coin Dispenser
All variants
CDM SP
—
Z
System Display
Enhanced display
(16 x 32)
TTU SP
—
[
Media Entry
Indicators
SIU SP
—
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-13
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
Device ID
Device Name
Device Variant
\
Envelope Dispenser
q
Cheque Processing
Module (CPM)
w
Bunch Note Acceptor
(BNA)
Supplies Data Sources
4
Device Access
Comment
DEP SP
—
All variants
Bunch cheque acceptor
PTR SP
IPM SP
—
All variants (including GBXX)
ActiveXFS
—
The following table gives details of the information source for
device supplies data.
For details of the supplies data associated with each device, refer to
the APTRA Advance NDC, Reference Manual, Appendix E, “Device
Identifiers”.
Table 4-3
Supplies Data Source Information
Device ID
Device Name
Supplies Data
Data source
D
Magnetic Card
Reader/Writer
Card capture bin
XFS IDC
E
Cash Handler
Cash handler reject bin
XFS CDM
Cash handler cassette types
1 to 7
XFS CDM
F
Envelope
Depository
Envelope deposit bin
XFS DEP
G
Receipt Printer
Receipt printer paper
XFS PTR
Receipt printer ribbon
XFS PTR
Receipt printer print-head
01 (Good State) always
returned
DSM
Receipt printer knife
01 (Good State) always
returned
DSM
Capture bin
0 Capture bin not present
1 Good
4 Overfill
XFS PTR
Journal printer paper
XFS PTR
Journal printer ribbon
XFS PTR
Journal printer print-head
DSM
Night safe bin
XFS DEP
H
K
Journal Printer
Night Safe
Depository
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-14
APTRA Advance NDC, Developer’s Guide
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
Fitness Data Sources
4
Device ID
Device Name
Supplies Data
Data source
V
Statement
Printer
all variants
All supplies data
XFS PTR
Y
Coin Dispenser
Coin dispenser module and
all hopper types
XFS CDM
\
Envelope
Dispenser
Envelope dispenser hopper
XFS DEP
w
Bunch Note
Acceptor (BNA)
all variants
All BNA cassettes
ActiveXFS
The following table gives details of the information source for
fitness data.
For details of the fitness data associated with each device, refer to
the APTRA Advance NDC, Reference Manual, Appendix E, “Device
Identifiers”.
Table 4-4
Fitness Data Source Information
Device ID
Device Name
Fitness Data
Data source
D
Magnetic Card
Reader/Writer
Magnetic Card
XFS IDC
E
Cash Handler
Cash handler reject bin
XFS CDM
Cash handler cassette types
1 to 7
F
Envelope
Depository
Depository
XFS DEP
G
Receipt Printer
Receipt Printer
XFS PTR
Capture bin
0 No error or not supported
4 Fatal
For details, see the note on
4-16.
H
Journal Printer
Journal Printer
XFS PTR
K
Night Safe
Depository
Night Safe
XFS DEP
L
Encryptor
Encryptor
XFS PIN
Q
Cardholder
Keyboard
Cardholder Keyboard
XFS PIN
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-15
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
Device ID
Device Name
Fitness Data
Data source
V
Statement
Printer
Statement Printer
XFS PTR
Y
Coin Dispenser
Coin dispenser module and
all hopper types
XFS CDM
\
Envelope
Dispenser
Envelope Dispenser
XFS DEP
q
Cheque
Processing
Module (CPM)
CPM
XFS PTR
w
Bunch Note
Acceptor (BNA)
BNA
ActiveXFS
Note: The Supplies and Fitness data sources for the Receipt printer
capture bin will always be reported as zero if the printer does not
have a capture bin.
Message Handling
For devices accessed through XFS, the message format is unchanged
but the content of both solicited and unsolicited status messages is
derived differently.
4
The following table summarises the changes that apply to the
devices listed earlier in this chapter under “Changes to the Interface
since Release 2.6” on page 4-5. For further details of messages, refer
to the APTRA Advance NDC, Reference Manual, Chapter 9, “Terminal
to Central Messages.
Table 4-5
Message Handling Changes Summary
Status Descriptor
Field
Description
Comment
‘C' - Specific Command Reject
g1 = ‘C’
g2 = 02
The message is not
accepted while diagnostics,
or clear SOH level 2 or
level 3 is in progress.
This is returned when the
application has passed control to
Vendor Dependent Mode (VDM).
1 - Send Configuration
Information
g3
g5
g6
Device Severity
Supplies Status
Sensor Status
The value is derived from
information provided by the SP.
‘H’ - Hardware
Configuration Data
g4
Hardware Configuration
The device configuration is derived
from the XFS capabilities.
‘I’ - Supplies Data
g2
Supplies Status
Supplies data is derived from XFS.
‘F' - Terminal State
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-16
APTRA Advance NDC, Developer’s Guide
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
Status Descriptor
Field
Description
Comment
‘J’- Fitness Data
g2
Fitness
Device fitness is derived from XFS.
‘K’ - Tamper and Sensor
Status data
g2
g3
Sensor Status
Tamper Status
The value is derived from XFS.
As the DPM is not supported,
character 13 is always set to 0.
‘L’ - Software ID and
Release Number data
g2
Release Number Identifier
For example, the value is 040000 for
Advance NDC 4.00.
g3
g4
g5
Error Severity
Diagnostic Status
Supplies Status
The value is derived from XFS
information.
'8' - Device Fault
For full details of the status message format and fields, refer to the
APTRA Advance NDC, Reference Manual.
User Messages and User
Terminal Data
4
If you have created new Message Classes or included additional
data in Terminal State messages, you will have to import your code
into the Application Core, where the functionality that used to be
provided in separate ActiveX controls is now supported directly by
the Message Handler for each mode.
You import your User Messages director or User Terminal Data
director for each mode as required. The following table gives the
component ID of the Message Handler director where you insert
your code.
Table 4-6
Message Handler Component ID
Mode
Message Handler Component ID
Out-of-Service
11L286B7
Supervisor
15L302B7
In-Service
69L302B7
Complete the following steps:
1
Make a copy of the Advance NDC application and open the
Application Core project.
2
Import your User Messages director or User Terminal Data
director from the old catalog into the Application Core.
3
Insert your User Messages or Terminal Data director under the
Message Handler director for the required mode, replacing the
default implementation of the User Messages director or the
User Terminal Data director.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-17
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
Printing
4
In Advance NDC 2.06, access to the receipt, journal and envelope
printers was changed to the CEN-XFS interface. From Advance
NDC 3.00, access to the statement printer is also through the
CEN-XFS 3 interface. From Advance NDC 3.02, support for USB
receipt and journal printers is supported using the PrintRawData
command, and in release 3.03 dynamic XFS form generation is
supported for SelfServ Receipt, Journal and Statement printers.
The NDC printer control sequences are still supported under the
NDC message format and the existing workers. A conversion DLL
is called, which uses entries in the registry to do one of the
following:


Convert the NDC print control codes to vendor-specific codes
Generate a series of XFS forms. For these, the conversion DLL
returns the names of the XFS forms to be printed.
For further information on printing, refer to the APTRA Advance
NDC, Reference Manual, Chapter 5 “Printer Data” and Appendix B
“Character Sets”.
Printer Variants
4
If text-only support is offered by the SP, the default printer
configuration is for thermal printers. Where a non-thermal printer is
configured, the registry can be set so that all unsupported
commands are stripped before the data is sent to the printer.
Graphics and barcode sequences are most likely to be unsupported
by dot matrix printers.
Receipt Printer
4
The receipt printer can support double-width printing, the euro
symbol and printing a footer, as follows.
Double-Width Printing Using the Normal Receipt Page worker,
double-width text can be printed on a receipt printer by selecting
the appropriate character set in the Paragraph Text attribute of the
Print Paragraph worker. This is illustrated in Figure 4-1 below.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-18
APTRA Advance NDC, Developer’s Guide
4
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
Figure 4-1
Double-Width Printing Example
4
Double-width text is specified by putting the control character ESC,
followed by ‘(‘ and the ‘>’ designator, before the text you want to
make double width, as shown in the Multi Line String Editor. For
example, 1BH 2BH ‘>’ ‘text’ prints the text double-width. At the
end of the text, the default character set must be set back with
‘ESC(1’.
Euro Symbol Printing The euro symbol is specified by using the
control character ESC, followed by ‘(’, the ‘R’ designator and the
dollar sign ‘$’. For example, 1BH 28H ‘R’ ‘$’ selects the
international character set Alpha 6, and prints the euro symbol.
4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-19
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
After the euro symbol, the default character set must be restored
with ‘ESC(1’.
NDC Print Footer Worker To facilitate the printing of receipts, a
new worker class was introduced in Advance NDC 2.06. This
worker prints to a receipt any remaining preprint information not
printed by Print Buffer, and ejects the receipt. For details, refer to the
Advance NDC Worker Class help in the Author.
Journal Printer
When hardcopy backup is set from the host (enhanced
configuration option 16 or 17), status messages for the physical
printer and hardcopy backup are reported to the host. When the EJ
is selected by the user at the SST (option 1 from 30 SET JRNL in the
Supervisor Configure menu), messages are reported for the EJ.
To improve the readability of journaled messages, group separators
are represented as asterisks in both the EJ and hardcopy journal.
If either the EJ or hardcopy backup log (ejdata.log or hbdata.log)
reaches its size limit, and automatic initialisation by cutover is not
enabled, a fatal error message is sent and the printer enters a fatal
state. A warning message is also sent when the EJ log is 90% full. For
information on automatic initialisation by cutover, see “Cutover” on
page 5-154.
From release 3.01, the following EJ options are available:

Enhanced EJ backup, providing the following choices:
— A single backup file using Standard EJ backup
— Up to 1000 backup files depending on disk space using
Multiple EJ backup.
For details, see “Enhanced EJ Backup” on page 5-160.

Multiple destinations, allowing the choice of available
destinations for the backup file. For details, see “Multiple
Destinations for EJ Backup” on page 5-159.
From release 3.02, the following EJ options are available:



The host control of the EJ backup mode can be disabled. For
details, see “Disable Host Control of Enhanced EJ Backup” on
page 5-161.
The initialisation operation can be run automatically in a
number of ways. An optional copy of the EJ file can also be
made following the automatic initialisation. For details, see
“Automatic Initialisation Options” on page 5-154.
The EJ file can be compressed. For details, see “EJ Compression”
on page 5-153.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-20
APTRA Advance NDC, Developer’s Guide
4
4
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC

A maximum size for the EJ file can be set. For details, see
“Maximum EJ File Size” on page 5-153.
For information on using all EJ options, refer to the APTRA Advance
NDC, Supervisor’s Guide.
Dual Mode Operation From Advance NDC 2.06 onwards, dual
mode operation is supported. When dual mode is selected (option 2
from 30 SET JRNL in the Supervisor Configure menu), only
messages for the physical printer are sent to the host. No status
messages for the EJ or hardcopy backup are sent unless enhanced
configuration option 35 is set as follows:
Table 4-7
Dual Mode Error Message Selection
Value
Effect in Dual Mode
000
Send unsolicited error messages for the physical journal
printer only (the default value)
001
Send unsolicited error messages for the physical journal
printer and EJ only
002
Send unsolicited error messages for both EJ and hardcopy
backup
4
Note: When the journal printer is set to dual mode, hardcopy
backup is automatically enabled. If option 16 or 17 is sent from the
host, it will be ignored.
STCONT File Updates
4
From Advance NDC 3.02, the STCONT file supports alphanumeric
state entries for up to 46655 state numbers.
The STCONT file has been modified so that all state parameters
referring to state numbers have their limit set to ZZZ (base 36). For
any new states, the limits of state parameters that represent state
numbers must be set to ZZZ.
Nested extension states are also supported, as described in the
APTRA Advance NDC, Extending the Product publication.
From Advance NDC 3.03, the STCONT file is used to configure the
calling of authored state types, using the keyword 'Application
Link' as the C Exit function name. This indicates to the state
execution system that the DLL is loaded and executed through the
SSDS DLL Interface worker. For details, refer to the APTRA Advance
NDC, Extending the Product publication.
Promote Campaigns
4
All Promote campaigns must be created using the appropriate
version of APTRA Promote Manager. If you have existing
campaigns, you may need to recreate them.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
4-21
Upgrading from Earlier Releases of Advance NDC
Upgrading Your Release of Advance NDC
For further information on Promote campaigns, refer to the APTRA
Promote User’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-22
APTRA Advance NDC, Developer’s Guide
Table of Contents
Configuring Advance NDC and Associated Components
Chapter 5
Configuring Advance NDC and
Associated Components
Overview
5-1
Automatic Configuration at Start-up
SST Configuration Component
Advance NDC Startup
ANDCSST.XML Elements
Example ANDCSST.XML Extracts
Receipt Printer XML
Defining Class Sub-Types
5-2
5-2
5-3
5-4
5-10
5-10
5-12
Configuring an Advance NDC Application
Advance NDC Registry Entries
Registry Entry for Application Links
Examples of Application Links
Performance and Memory Considerations
CEN-XFS Logical Device Names
ActiveXFS Aliases for Cash and Cheque Acceptors
Status Handling
Remote Status Indicators
Unsolicited Status Messages for External System Events
Unsolicited Status Messages for Cash Handlers
Power-Up Status Message
Registry Settings for Device Status Messages
Cardholder Display
Receipt Capture Bin
Enabling Web Exits
Configuring the Web Exit State
Specifying Local Customisation Data
SCXLOC File
LOCAL File
Changing the Next State Number
Example of StateTranslator.xml
Security Cameras
Using the XML File
Using the NDC Camera Service
5-13
5-13
5-13
5-15
5-15
5-16
5-17
5-17
5-17
5-18
5-18
5-19
5-19
5-19
5-19
5-19
5-20
5-21
5-21
5-23
5-24
5-24
5-24
5-24
5-27
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Configuring Advance NDC and Associated Components
Flow Points Defined for the Security Cameras
Example of Adding Flow Points
Configuring Data Masking and Logging
Interactive Transaction Response
Transaction Reply
Printer Data Logging to the OOXFS Trace Stream
Support for DVDs on SSTs
Required API
Re-writable and Dual-layer DVDs
Unsupported Configuration Options
Promote Flow Point Behaviour
Configuration Files
XML Configuration Files
Configuration Update Control
.NET Class Configurator Files
Conventions For Multiple Files
Creating Classes
Class Configurator Files
5-28
5-29
5-29
5-30
5-30
5-31
5-31
5-31
5-31
5-32
5-32
5-34
5-34
5-34
5-37
5-38
5-38
5-39
Configuring Communications
5-40
Service Class
5-40
TCP/IP Setting
5-40
CCM PCCM Setting
5-40
CCM VISA2 Setting
5-40
Clearing the Communications Buffer
5-40
Off-line Timer
5-41
TCP/IP Configuration
5-41
Configuring TCP/IP
5-41
Configuring Network Connections and Communications
Links
5-42
Internet Protocols
5-43
Dialup Configuration
5-45
Status Message Suppression
5-45
Alphanumeric Entry
5-46
Preconfiguration
5-46
Connect Life Time
5-46
Copy On/Off
5-46
XML Restrictions
5-47
Diagnostics
5-47
Dialup Timers and Modem Baud Rate
5-47
Activity Timer
5-47
Error Redial Timer
5-47
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Configuring Advance NDC and Associated Components
Timer 3
Modem Connect Timer
Dial on Send Timer
5-48
5-48
5-48
Configuring Diagnostics Options
Displaying Additional Diagnostics Menus
Show/Hide Diagnostics Shortcut
Disabling Self-Test on Diagnostics Exit
5-49
5-49
5-49
5-50
Configuring Service Providers
Configuring Service Providers (SPs) for Reboot
Service Provider Reset Value
Service Provider Tracing
Configuring Service Provider Support for
CEN-XFS Versions
5-51
5-51
5-51
5-52
Configuring SNMP Traps
No Transaction Traps
Application Heartbeats
Advance NDC Mode Change Traps
Service State Changes
Implementation of SNMP Traps
NCR SNMP Implementation
GASPER-Compatible Implementation
5-54
5-55
5-55
5-56
5-56
5-56
5-56
5-57
Configuring .NET Archive Manager
Configuration Properties
General Configuration
Scheduling Archives
Setting the Default Collection Directory
Deleting Old Archives
Archive Data Configuration Examples
Archiving PD Investigation Files
Archiving XFS Trace Files
Archiving Event Logs
Archiving EJ Data Files
Archiving ECB 6 Database File
Archiving Unhandled Exception Handler (UEH) Files
SST Properties Configuration Examples
Owner Details
SST and Network ID
Postal Address
5-59
5-59
5-60
5-60
5-60
5-60
5-61
5-61
5-62
5-62
5-63
5-63
5-64
5-64
5-65
5-65
5-65
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-52
Table of Contents
Configuring Advance NDC and Associated Components
Additional Configuration
Archiving User-Defined Files
Archiving Registry Keys
5-66
5-66
5-67
Configuring .NET Retrieve Archive Task
Example Updates to Settings
Changing the Export Folder
Changing the User Response Timeout
Changing the Date Format
Using Only Removable Drives
Excluding CD and DVD Drives
Changing the Number of Days to Search
5-69
5-69
5-70
5-70
5-70
5-71
5-71
5-71
Configuring the .NET NDC CRM Service
5-72
Configuring SST Recovery
NDC Monitor
Enabling NDC Monitor
NDC Monitor XML Elements
Defining the States to Monitor
Forced Reboot
Resetting USB Devices
Device Recovery XML File
Device Recovery Schema
Uninterruptible Power Supply
5-73
5-73
5-73
5-74
5-75
5-77
5-78
5-80
5-80
5-81
Configuring Suspend Timeout
Setting the Service Provider Timeout
Setting the Application Timeout
5-82
5-82
5-83
Configuring Supervisor Functionality
Settlement Screen Customisation
Extended Add Cash Option
Rear Settlement
PIN Entry
Dummy PIN Block
Supervisor Alphanumeric Data Entry
Supervisor Keyboard XML Configuration File
.NET Supervisor Task
Developing a New .NET Supervisor Task
Integrating New or Existing .NET Supervisor Tasks
5-84
5-84
5-84
5-85
5-85
5-85
5-85
5-86
5-89
5-89
5-89
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Configuring Advance NDC and Associated Components
.NET Software Updates
5-91
Configuring the Installation Script
5-91
Configuring the Copy File Directory
5-92
.NET Software Update Service
5-93
Security Considerations
5-93
Promote/Copyfile
5-94
Configuring the Export File Path
5-94
Relate Supervisor Option
5-95
Configuring Multiple Destination Screens to Display Fixed
Drives
5-95
Configuring the Default Location for Note Signatures
5-95
Configuring the Location and Format of Extracted
Signatures
5-96
Configuring Supervisor Entry/Exit Message
5-97
Configuring Cardholder Functionality
Configuring Input Type, Buffer and Display Format
Cardholder Alphanumeric Data Entry
Configuring SMS-style Data Entry or PC Keyboard
Cardholder Verification State in STCONT
Confirmation Screens During Cash Deposit
Cash Accept Screen Formatter Classes
ECB 6 Dialog Class
Configuring Amount Entry
Configuring Amount Entry Length
Configuring Whole Amount Entry
Validating Buffer Data
Configuring Beep for Cardholder Transactions
PC Beep
Cardless Transactions
Supervisor Configuration of Cardless Transactions
Registry Configuration of Cardless Transactions
Key Mask Definition
5-98
5-98
5-99
5-100
5-102
5-103
5-103
5-111
5-112
5-112
5-112
5-113
5-115
5-115
5-115
5-116
5-116
5-120
Configuring Keyboards
Front Keyboard
Audible Alert on Emulated FDK Selection
Operator Keyboard
Touch-screen Keyboards for Alphanumeric Data Entry
Keyboard Definitions
Defining the Screen
Customising a Keyboard Definition
Touch-screen Keyboard Display
5-121
5-121
5-122
5-122
5-124
5-124
5-124
5-125
5-126
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Secure Key Entry
Display Manager for HTML Screens
Hide Taskbar
AVI System Limit
Advance NDC Display Components
Offline Keyboard Layouts
Advance NDC Display Configuration File
Advance NDC Display Runtime Settings
Offline Screens
Reserved Screens
Screen Manager Class
Display Manager Class
Hide Mouse Pointer
Customer Relationship Management
Enabling Extended Screen Groups
5-127
5-127
5-127
5-127
5-128
5-128
5-128
5-134
5-148
5-148
5-148
5-149
5-150
5-150
5-151
5-151
Configuring the Electronic Journal
EJ Compression
EJ Privacy
Maximum EJ File Size
EJ Checksum
Automatic Initialisation Options
Cutover
Scheduled
Agent
Automatic Initialisation Copy Drive
Initialisation After Settlement
Delaying Initialisation During Transactions
EJ Backup Filenames
EJFileDateFormat
EJShortFilename
Multiple Destinations for EJ Backup
Enhanced EJ Backup
Maximum Number of Backups
Disable Host Control of Enhanced EJ Backup
EJ Level
Journal Page Workers
5-153
5-153
5-153
5-153
5-153
5-154
5-154
5-154
5-156
5-157
5-158
5-158
5-158
5-158
5-159
5-159
5-160
5-160
5-161
5-161
5-161
Configuring Printers
Journal Printer Status
Journal Printer Level
Receipt Printer
5-162
5-162
5-163
5-164
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Configuring Advance NDC and Associated Components
Receipt Handling
Promote Coupons
Top Margin of Receipts
Statement Printer
USB Statement Printer
Form-Based Printing
Registry Entries for Configuring Forms
Registry Entries for Configuring Fonts
Registry Entry for Configuring LPI
USB Receipt and USB Journal Printers
Registry Entry for Receipt Retract
Creating Graphics Files
Non-Thermal Printers
Passbook Printer
Implementation
5-164
5-165
5-167
5-168
5-169
5-169
5-169
5-173
5-174
5-174
5-175
5-175
5-177
5-177
5-178
Configuring Readers
Accepting Smart Cards in Motorised Card Readers
Additional DASH Reader Fatal/Suspend Handling
Barcode Reader Filter Configuration
Example Barcode Filter Configuration File
5-180
5-180
5-180
5-181
5-182
Configuring Coin Dispensers
Registry Keys for the Coin Dispenser
Setting the Currency
Setting the Coin Value
Setting the Low Threshold
Supplies and Severity Information
5-183
5-183
5-183
5-183
5-184
5-184
Configuring Cash Handlers
Setting the Currency
Setting the Media Type
Setting the Denomination
Setting the Cassette Identifier
Setting the Cash Unit Identifiers for Supervisor
Setting Multiple Currencies
Disabling Retract after Suspend
Reporting Pick Failure Errors
Cash Handler with a Fifth Physical Cassette
Enabling Support for Seven Cassette Types
Setting Note Thresholds
Low Threshold
5-186
5-186
5-187
5-187
5-187
5-187
5-188
5-189
5-190
5-190
5-190
5-191
5-191
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Configuring Advance NDC and Associated Components
Maximum Threshold
Configuring the MEI for a Spray Dispenser
Supplies and Severity Information
Replenishment Status of Cassettes
Dual Cash Handler Configuration
Setting the Cash Handler Priority
Setting the Counter Entry Mode
Setting the Counter Clearing Mode
Status Reporting
Cash Handler Status Message
Interlock Handling
Tamper Indication
5-192
5-192
5-193
5-194
5-194
5-195
5-195
5-196
5-196
5-196
5-198
5-198
Configuring Cash Acceptors
5-199
Cash Acceptor Installation Settings
5-199
Scalable Deposit Module
5-200
Positioning the Reason for Note Refusal
5-201
Defining the Please Wait screen
5-201
Setting the Volume
5-201
Combined Cash Handler
5-201
Setting the Insertion Limit for Bunches of Notes
5-201
Setting the Retry Limit for Note Insertion
5-202
Transaction Request Cumulative Counts
5-202
Configuring Note Retract to Escrow
5-203
Enabling Retract to the Escrow
5-203
Automatic Error Recovery
5-204
Journaling
5-204
Enabling Direct Deposit
5-204
Setting the Direct Deposit Limit
5-205
Off-line Cash Deposit Handling
5-206
Off-line States Array
5-207
Example of the Off-line States Array
5-208
Reading and Journaling Serial Numbers of Good Notes
5-208
Reading the Serial Numbers of Good Notes
5-208
Journaling the Serial Numbers of Good Notes to the EJ 5-208
Reconciliation List Customisation
5-209
Printing BNA Totals
5-209
Currency Names Mapping Array
5-210
Counts Configuration Array
5-210
Available Counts
5-211
Enhanced Cash-in Formatter
5-215
Print Cash-in Totals
5-216
Reason for Refusing a Deposit
5-217
Localising Tamper Indication Journaling
5-218
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Configuring Advance NDC and Associated Components
Note Type Mapping
Using the Note Type Mapping XML File
Journaling Note Configuration Failures
Journaling Note Validation Errors
Device M-Status Reporting
Suspend Handling
Error Recovery
Error Recovery Modes
Recovery Destination
Reason for Failed Recovery
ECB 6 Considerations
ECB 6 Note Categories
Counterfeit and Suspect Notes
ECB 6 Modes
ECB 6 Database Support Utility
Media Entry Indicator for a BNA
Encash, Print and Set Next State
Cash Deposit Exception Reporting
Enabling Exception Reporting for Cash Acceptors
Configuring the Report Format
Error Screen Display Timer
Configuring the Receipt Service
Journal Formats
Class Configurator Configuration
Reserved Screen Configuration
Journaling Retract Counts
GBXX Money Insertion Time Limit
GBXX Dynamic Note Sorting
Scenario 1: No All-in Cassette Configured
Scenario 2: All-in Cassette Configured
GBXX Cassette Configuration
Cassette Configuration Using Supervisor
XML Schema
GBXX Configuration File
Registry Entries for Recycling Units
Fixed Cassette Mapping for Recycling
Maximum Accepted Notes
Deposit Cassette Maximum Threshold
Configuring Cheque Processors
Accessing Cheque Data
Cheque Processing Module
Cheque Images on Two-Sided Thermal Printers
Resizing the Image
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-218
5-219
5-220
5-221
5-221
5-222
5-222
5-223
5-223
5-224
5-224
5-224
5-225
5-227
5-228
5-229
5-229
5-230
5-230
5-230
5-231
5-231
5-232
5-232
5-235
5-238
5-238
5-239
5-240
5-240
5-241
5-241
5-243
5-249
5-251
5-254
5-256
5-256
5-257
5-257
5-257
5-258
5-258
Table of Contents
Configuring Advance NDC and Associated Components
Form and Media Definitions
Magnetic Ink Character Recognition (MICR) Option
Bunch Cheque Acceptor
Configuring the Codeline
Suppressing Status Messages
Accepting Cheques in a Single Orientation
Supporting a Cheque Validation Service
Retrieving the Cheque Image Path
Retrieving the Scan After Endorsement Setting
Endorsing Cheques Returned by the Host
Cheque Amount Recognition
ImageMark Passport ATM Image Agent
Envelope Dispenser
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-259
5-260
5-260
5-260
5-260
5-261
5-262
5-262
5-262
5-262
5-263
5-263
5-269
Configuring Advance NDC and Associated Components
Overview
E
Overview
5
This chapter describes how to configure Advance NDC and any
associated components, including the following:





Automatic configuration carried out by the Self-Service
Terminal Configuration component
Communications and service providers
Diagnostics and SST management
Cardholder and Supervisor functionality
Devices.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-1
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Automatic Configuration at Start-up
The Self-Service Terminal Configuration component (SST
configuration component) runs automatically before Advance NDC
starts. A default configuration file is provided in Advance NDC,
complete with settings for all vendors’ SSTs. This file does not need
to be updated unless you are using different or additional hardware
to that included in the default file. Example configuration settings
are given in “Example ANDCSST.XML Extracts” on page 5-10. The
SST configuration component will not perform any further
configuration unless new devices are detected or the
ANDCConfig.NDC file is not located, as described in “SST
Configuration Component”.
The SST configuration component uses a configuration file
(ANDCSST.xml) to identify the XFS devices present on the SST and
configure the devices for the vendor platform. The SST
configuration component schema, ANDCSST.xsd, defines the
structure of the configuration file as described in Table 5-1, “SST
configuration component XML Elements” on page 5-4.
The device settings given in this chapter are set using the SST
configuration component. If the settings are to be updated you must
edit the ANDCSST.xml file accordingly. If you edit the registry
entries directly, the settings will be overwritten next time the SST
configuration component runs.
SST Configuration
Component
5
After the initial installation, the SST configuration component is run
to apply the configuration settings defined for devices found on the
SST and create the ANDCConfig.NDC file. The SST configuration
component also starts the platform before Advance NDC starts. For
subsequent startups, any new devices will be configured, but full
re-configuration is performed only if the file does not exist.
The location of the file is as follows:
C:\Program Files\NCR APTRA\Advance NDC\Config
If the ANDCConfig.NDC file is not found in this location, a full
re-configuration is performed before Advance NDC starts.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-2
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Advance NDC Startup
5
If the ANDCConfig.NDC file is not found, full configuration is
required and the following steps are completed:
1
AppLoader.exe calls startapps.cmd, which calls startapps.vbs
2
The VBscript, startapps.vbs, calls
NCR.APTRA.NDC.SST.Configuration.exe and waits for
NCR.APTRA.NDC.SST.Configuration.exe to complete
3
NCR.APTRA.NDC.SST.Configuration.exe loads the SST
configuration component (ANDCSST.xml)
4
The SST configuration component identifies the available XFS
services by checking the registry
5
The SST configuration component tries to open each service and
records the status, capability and vendor name for each
successfully opened service. If a service is available, it is
recorded in the Persistent Services List (PSL), as described in
“Persistent Service List” on page 5-4. If a service is not available,
the Advance NDC alias is set to " " and the Active XFS alias is
set to "Not Used"
6
The SST configuration component identifies the configuration
actions in the ANDCSST.xml file that match the identified
services
7
The SST configuration component completes the required
actions
8
The SST configuration component creates the ANDCConfig.NDC
file
9
The SST configuration component restarts the SST to complete
the configuration
10 The VB script, startapps.vbs, calls Applicationcore.exe to start
Advance NDC.
On subsequent start-ups, the following occurs:


If the ANDCConfig.NDC file is found and new devices are
detected, the SST configuration component completes the
configuration actions defined for the new devices.
If the ANDCConfig.NDC file is found and no new devices are
detected, no configuration is performed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-3
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Persistent Service List The PSL includes all services that have
been identified as available. This ensures that they are not
configured again unless the ANDCConfig.NDC file is deleted.
If a service is not available, it is not included in the list and is
reopened each time the SST configuration component runs to check
whether it has become available. This allows devices that are
physically present, but temporarily unavailable to be configured
when they become available.
The PSL contains the SP name and the alias mapping information.
ANDCSST.XML Elements
5
Table 5-1 describes the elements used in the ANDCSST.xml file. The
default file installed with Advance NDC is located in the following
folder:
C:\Program Files\NCR APTRA\Advance NDC\Config
Table 5-1
SST configuration component XML
Elements
Element
Description
ANDCSSTConfiguration
Mandatory.
This is the root element.
The whole file is enclosed within ANDCSSTConfiguration tags.
Nested elements:

AppConfig

Platform

ANDCDevice

ANDCActions
AppConfig
Mandatory.
Allows for fine-tuning of the configuration process.
The Timeout attribute defines the length of the time-out applied when opening
XFS services.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-4
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Element
Description
Platform
Optional.
Identifies the platform by the PIN Service vendor. If no PIN Service vendor is
provided, the vendor name is taken from the last service listed in the
HKEY_USERS\.DEFAULT\XFS\LOGICAL_SERVICES registry key.
The Vendor attribute identifies the name of the vendor. The string must match
the name given in the entries under the
HKLM\SOFTWARE\XFS\SERVICE_PROVIDERS key.
The WaitTime attribute specifies the time in milliseconds to wait between
stopping and attempting to restart the platform.
Nested elements:

StartAndWait

Stop
StartAndWait
Mandatory.
Defines the Microsoft batch processing commands used to start the platform and
wait for the start process to complete.
Stop
Mandatory.
Defines the Microsoft batch processing commands used to stop the platform.
If this command fails and the Unhandled Exception Handler (UEH) is installed
and configured to reboot the SST, the SST is rebooted.
ANDCDevice
Mandatory.
Identifies the XFS device. This is used to associate the instance of the device with
the XFS service and describes the configuration for the device.
The alias attribute contains the Advance NDC alias for the device and is used to
populate the Aliases registry entries. There must be one ANDCDevice element for
each entry under the HKLM\SOFTWARE\Advance NDC\Aliases registry key.
The Active XFS alias registry entries under the HKLM\SOFTWARE\ActiveXFS
key are also populated by the SST configuration component.
Nested elements:
Identification

Configuration

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-5
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Element
Description
Identification
Mandatory.
Identifies the XFS service.
This is achieved by matching the following attributes to data retrieved from the
XFS service:

xfsclass. The name of the CEN XFS class

xfsclasstype. The CEN fwType Capability used to determine the use of
the class

compound. Whether the class is a compound class. This can have a value of
True, False or N/A. A value of N/A indicates that this attribute is not used
for identification

xfsclasssubtype. Differentiates devices of the same subtype. This is used
only to differentiate different types of scanners of the printer class.
Note: Compound devices are identified by their class, for example cash-recycling
devices have two Identification elements, one for CIM and one for CDM.
Configuration
Mandatory.
Describes how to configure the device identified in the Identification
element.
Nested elements:

Configure

Vendor
Configure
Mandatory.
Describes the actions taken to configure the device. The actions apply to all
instances of the device identified in the ANDCDevice element regardless of
vendor.
The Actionlist attribute identifies the ActionList element containing the
configuration instructions. The Actionlist attribute must match the name
attribute of the ActionList element for the configuration. If no match is found,
an error is written to the PD log but processing continues.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-6
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Element
Description
Vendor
Optional.
Describes how to configure the device identified in the Identification
element for a specific vendor.
The SST configuration component searches the Vendor elements until it matches
the vendor name retrieved from the XFS registry area.
The name attribute contains the name of the vendor as entered in the
HKLM\SOFTWARE\XFS\SERVICE_PROVIDERS registry key.
Nested elements:

Configure
Note: When the Configure element is placed below the Vendor element, the
configuration instructions apply only to the specified vendor.

Provider
Provider
Optional.
Identifies the service provider when specific settings need to be based on the
presence of that service provider.
The name attribute contains the name of the service provider as entered in the
HKEY_USERS\.DEFAULT\XFS\LOGICAL_SERVICES registry key.
Nested elements:
Configure

HardwareName

Note: When the Configure element is placed below the Provider element,
the configuration instructions apply only to the specified service provider.
HardwareName
Optional.
Identifies the hardware installed on the SST where this cannot be determined
from the provider name.
The NameID attribute contains an identifier string for the hardware that can
appear in the extra detail in the XFS capabilities command. The string used must
uniquely identify the required hardware device from those supported by the
provider.
Nested elements:
Configure

Note: When the Configure element is placed below the HardwareName
element, the configuration instructions apply only to the specified hardware.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-7
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Element
Description
ANDCActions
Mandatory.
Identifies the configuration actions performed on any supported SST. The actions
are identified by name and linked with the identified devices.
Nested elements:

ActionList
ActionList
Mandatory.
Contains the steps used in applying the named configuration.
The name attribute matches the Actionlist attribute of the Configure
element for the configuration.
The description attribute provides an optional free-text description of the
configuration and is used for tracing to Problem Determination.
Nested elements:
Action

ClassConfiguration

FileOperation

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-8
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Element
Description
Action
Mandatory.
Describes the settings to apply to the Windows registry or file system for the
identified configuration.
The implements attribute identifies the action to be applied to the registry or a
file as follows:
registry
Contains a registry setting in the format of Microsoft
.rgs files. For details of these files, refer to
http://support.microsoft.com/kb/310516
Note: The RegistryEditorVersion part of the .rgs
file syntax is not required as this is added by the
component.
reservedregistry
Contains a registry setting that is only applied where a
condition defined in the description attribute occurs
in the related component
file
Contains a file copy operation in the following format:
<full path of source>||<full path to
destination>
The source file is copied to the path specified as the
destination. If the destination file already exists, it is
deleted before the copy is performed
Alternatively, you can use the FileOperation
element
reservedfile
Contains a file copy operation that is only applied
where a condition defined in the description attribute
occurs in the related component
If the implements attribute is set to reservedregistry or reservedfile,
the description attribute can define the following conditions:

CDMHWSensorsPresent. The action is applied only if there are hardware
sensors on the CDM cassettes

CDMHWSensorsNotPresent. The action is applied only if no hardware
sensors are present on the CDM cassettes
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-9
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Element
Description
ClassConfiguration
Describes the settings to apply to the .NET Class Configurator files for the
identified configuration. For further information on the .NET Class Configurator
files, see “.NET Class Configurator Files” on page 5-37.
The classID attribute identifies the class to update using the class ID used in the
.NET Class Configurator file
The property attribute identifies the property to update within the specified
class ID
The setvalue attribute identifies the new default value to apply to the specified
property
The file attribute specifies the .NET Class Configurator file containing the
specified class ID. This attribute is not required if this is the AdvanceNDC.accfg file
The description attribute provides an optional free-text description of the
configuration and is used for tracing to Problem Determination .
FileOperation
Provides an alternative to using the file value in the Action element
The source attribute defines the source file to copy
The destination attribute defines the target file. If the target file is already
present, it is deleted before the copy is performed. If the path does not exist, it is
created
The operation attribute is always copy
The description attribute provides an optional free-text description of the
configuration and is used for tracing to Problem Determination
Example ANDCSST.XML
Extracts
The following sections provide examples of configuration settings
defined in the ANDCSST.xml file.
5
Receipt Printer XML
5
The following extracts set up a receipt printer for use by Advance
NDC.
Defining the Alias
follows:
The alias for the device in the registry is set as
<ANDCDevice Alias="Receipt Printer">
If an XFS receipt printer service is found, the following registry
setting is populated with the logical service name:
HKLM\SOFTWARE\NCR\Advance NDC\Aliases
For further information on aliases, see “CEN-XFS Logical Device
Names” on page 5-16.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-10
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
Receipt Printers on NCR SSTs The following extract shows the
device section of the ANDCSST.xml file for receipt printers on an
NCR SST:
5
<ANDCDevice Alias="Receipt Printer">
<Identification xfsclass="WFS_SERVICE_CLASS_PTR"
xfsclasstype="WFS_PTR_TYPERECEIPT" compound="False"/>
<Configuration>
<Configure actionlist="General Receipt Forms
Parameters"/>
<Configure actionlist="BMP Conversion"/>
<Configure actionlist="Receipt Forms debug off"/>
<Configure actionlist="General Receipt Forms
Controls"/>
<Configure actionlist="General Receipt Forms LPI"/>
<Configure actionlist="General Receipt Fonts"/>
<Vendor name="NCR Corporation">
<Configure actionlist="NCR Receipt Forms
Parameters"/>
<provider name="ReceiptPrinter1">
<!-- SDC printers -->
<HardwareName NameId="RPNT-01-PcThermal">
<Configure actionlist="NCR SDC Receipt Rawdata"/>
<Configure actionlist="Set Receipt printer
Dynamic forms off"/>
<Configure actionlist="Promote Coupon Receipt
Low Res"/>
</HardwareName>
<!-- Universal Printers -->
<HardwareName NameId="RPNT-01-UsbThermal">
<Configure actionlist="Set Receipt printer
Dynamic forms on"/>
<Configure actionlist="NCR Universal Receipt
Raw Data"/>
<Configure actionlist="Promote Coupon Receipt
High Res"/>
</HardwareName>
<!-- Leap Printer -->
<HardwareName
NameId="RPNT-01-UsbThermal,DEVVAR=8">
<Configure actionlist="Leap Printer"/>
<Configure actionlist="Set Receipt printer
Dynamic forms on"/>
</HardwareName>
</provider>
</Vendor>
</Configuration>
</ANDCDevice>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-11
Configuring Advance NDC and Associated Components
Automatic Configuration at Start-up
BMP Conversion Action The following extract shows the
definition of the actions to take to covert graphics files to BMP files
for forms printing:
5
<ANDCActions>
<ActionList name="BMP Conversion">
<Action description="graphic file extensions to replace
with .BMP for forms printing." Implements="registry">
[HKEY_LOCAL_MACHINE\SOFTWARE\NCR\Advance NDC\PRINTING]
/FORMS_GRAPHICS_EXT="PRN,GPH,LGO"
</Action>
</ActionList>
</ANDCActions>
This configuration is applied to every receipt printer as the
configuration is defined at device level rather than vendor or
provider level.
Defining Class Sub-Types
The following extract differentiates a barcode reader and a CPM
from other types of scanner and printer classes:
<ANDCDevice Alias="Barcode Reader">
<Identification xfsclass="WFS_SERVICE_CLASS_PTR"
xfsclasstype="WFS_PTR_TYPESCANNER"
xfsclasssubtype="WFS_PTR_READBARCODE"/>
</ANDCDevice>
<ANDCDevice Alias="Cheque Processor">
<Identification xfsclass="WFS_SERVICE_CLASS_PTR"
xfsclasstype="WFS_PTR_TYPESCANNER"/>
</ANDCDevice>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-12
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Configuring an Advance NDC
Application
5
This section describes the configuration settings used by Advance
NDC.
For details of configuring troubleshooting utilities, see Chapter 12,
“Installing and Configuring Troubleshooting Tools”.
Advance NDC Registry
Entries
The root registry key for Advance NDC is as follows:
HKLM\SOFTWARE\NCR\Advance NDC
5
All registry settings for Advance NDC are in subkeys of this entry.
Registry Entry for Application Links
5
The registry includes the DLL location for authored state types, the
cardholder session, the Supervisor session and the transaction reply
functions as string values under the following key:
HKLM\SOFTWARE\NCR\Advance NDC\Application Links
Transaction reply functions and states are executed using the SSDS
DLL Interface worker and the load methods available (either load at
start of day or on activation of the worker) apply only to them. State
types are initiated from the STCONT file and executed using the
NDC Processing State Executor worker.
The string value must specify the name of the APTRA Author
Application DLL to be loaded, with or without a fully qualified
path. The format for a string value added to a *.reg file is as follows:
<Application Link>=<DLLNAME>
The default values, which are provided in AdvanceNDC.reg, are as
follows:
Reply Function Deposit And Print=
ReplyDepositAndPrint
Reply Function Dispense And Print=
ReplyDispenseAndPrint
Reply Function Display And Print=
ReplyDisplayAndPrint
Reply Function Print Immediate=ReplyPrintImmediate
Reply Function Next State And Print=
ReplySetNextStateAndPrint
Reply Function Night Safe Deposit=
ReplyNightSafeDepositAndPrint
Reply Function Fast Cash=
ReplyParallelEjectDispenseAndPrint
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-13
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Reply Function Card Before Cash=ReplyCardBeforeCash
Reply Function Card Before Dispense And Print=
ReplyCardBeforeParallelDispenseAndPrint
Reply Function Print Statement And Wait=
ReplyPrintStatementAndWait
Reply Function Print Statement And Next State=
ReplyPrintStatementAndSetNextState
Reply Function BNA Refund=
ReplyBNARefundAndSetNextState
Reply Function BNA Encash=
ReplyBNAEncashAndSetNextState
Reply Function BNA Encash And Wait=
ReplyBNAEncashAndWait
Reply Function Process Multiple Cheques=
ReplyProcessMultipleCheques
Reply Function Process Cheque=ReplyProcessCheque
Cardholder Session=CustomisationLayer
Supervisor Session=Supervisor
Suspend Mode=SuspendMode
BNA Start Of Day=BNAStartOfDay
BNA Event Monitor=BNAEventMonitor
BNA Close State=BNACloseState
BNA Reconfigure Cassettes=BNAReconfigureCassettes
BNA Tamper Indication=BNATamperIndication
State Card Read=StateCardRead
State PIN Entry=StatePINEntry
State Transaction Request=StateTransactionRequest
State Close=StateClose
State Card Write=StateCardWrite
State Customer Selectable PIN=
StateCustomerSelectablePIN
State Cash Accept=StateCashAccept
State Cheque Accept=StateChequeAccept
State Smart FIT Check=StateSmartFITCheck
State PIN And Language=StatePINAndLanguage
State Web Exit=StateWebExit
State Cardholder Authorised Verification=
StateCardholderAuthorisedVerification
State Barcode Read=StateBarcodeRead
State Camera Control=StateCameraControl
State Insert Card=StateInsertCard
The name is fixed (for example, State Close) but you can change
the data value (for example, StateClose) to point to your own DLL.
The default registry settings do not specify a path and assume the
DLLs will be loaded at start of day. The format of the string data is
as follows:
DLLNAME[;LoadMethod]
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-14
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
The DLLNAME value is the name of the authored DLL and can include
a fully qualified path. If the path is not specified, the standard
search strategy is used to find the DLL.
The LoadMethod parameter is optional. If it is not specified, the
semi-colon (;) may also be omitted and the default value is assumed.
If specified, it must be preceded by the semi-colon. Values for
LoadMethod are case sensitive as follows:

PRELOAD — DLL to be loaded at start of day (the default)

ONSTART — DLL to be loaded the first time the worker is started
Examples of Application Links
5
The following table shows the format of the optional elements of the
registry settings:
Table 5-2
Examples of Application Links
Registry Entry Data Value
Description
C:\Program Files\NCR APTRA\Advance NDC\DLL\APP1.DLL ;
PRELOAD
Loads the DLL in the specified
location at start of day.
APP1.DLL ; ONSTART
Searches for APP1.DLL and loads
the DLL when the worker is started
APP1.DLL
Searches for APP1.DLL and loads
the DLL at start of day
Performance and Memory Considerations
5
Performance and memory requirements dictate which load method
to use for each DLL, as follows:


PRELOAD causes the delay for loading the DLL to occur at start of
day. There will therefore be no delay when the SSDS DLL
Interface worker is started. Memory will always be allocated for
the DLL resulting in an increased memory footprint for the
application. Use this load method when the worker is likely to
be started during the execution of the application.
ONSTART causes the delay for loading the DLL to occur when the
worker is started for the first time only. There will be a delay
during the execution of the application, but if the worker is
never started, no memory will be allocated resulting in a smaller
memory footprint for the application. Use this load method
when the worker is unlikely to be started during the execution
of the application.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-15
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
CEN-XFS Logical Device
Names
5
When a CEN-XFS session is opened, WFSOpen(), a logical device
name is supplied, for example, PinPad1 on NCR SSTs. As this
name is vendor-dependent, Advance NDC defines configurable
device-name aliases in the registry to handle it, as described in
Chapter 5, “Setting up the Terminal” of the Multi-Vendor Support
Reference Manual. The values defined by these configurable aliases
should be used to open a CEN-XFS session. The registry key is the
following:
HKLM\SOFTWARE\Advance NDC\Aliases
Note: A single SST can be configured for either an envelope
depository or a cheque processor, but not both. If both devices are
attached, the device alias for the unused device must be removed
from the registry. For example, remove the device alias for the
Envelope Depository to use only a bunch cheque acceptor.
On NCR SSTs, the settings are as follows:
Table 5-3
Aliases for Device Names
Device Name Alias
NCR SP Device Name
Card Reader
IDCardUnit1
Cash Dispenser
CurrencyDispenser1
BillDispenser1
Cash Dispenser Second
CurrencyDispenser2
CurrencyDispenser1 (if Cash Dispenser is set to
BillDispenser1)
BillDispenser1 (if Cash Dispenser is set to
CurrencyDispenser1)
Coin Dispenser
CoinDispenser1
Cash Acceptor
See “ActiveXFS Aliases for Cash and Cheque
Acceptors” on page 5-17
Night Safe
NightSafe1
Journal Printer
JournalPrinter1
Document Printer
StatementPrinter1
Receipt Printer
ReceiptPrinter1
Passbook Printer
PassbookPrinter1
PIN Pad
PinPad1
Sensors, Doors and Indicators
SIU
Envelope Depository
Envelope1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-16
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Device Name Alias
NCR SP Device Name
Text Terminal Unit
TextTerminalUnit1
Vendor Dependent Mode
VendorDependentMode1
Cheque Processor
ChequeProcessor1
IPM
ItemProcessing1
Barcode Reader
BarcodeReader1
Security Camera
Camera1
These aliases contain different values for every vendor. The
configuration of these values is part of the vendor-specific setup.
Note: Not all these aliases are currently being used in Advance
NDC.
ActiveXFS Aliases for Cash
and Cheque Acceptors
5
Active XFS are set to point to the appropriate service provider for
the cash or cheque acceptor hardware variant in use under the
following registry entry:
HKLM\SOFTWARE\ActiveXFS\Aliases\
Table 5-4 lists the Active XFS aliases, the service provider device
name values and the hardware variants.
Table 5-4
ActiveXFS Aliases
ActiveXFS Alias
SP Device Name
NCR Hardware Variant
CashInModule1
CashInModule1
BillAcceptor1
BNA, SNA, SDM
GBRU, GBNA
ItemProcessing1
BunchCheque1
Bunch cheque acceptor
For further information on the service providers, refer to the
APTRA on-line documentation under ActiveXFS Controls.
Status Handling
5
Remote Status Indicators
5
As devices are accessed through the CEN-XFS interface, the status
information from XFS is mapped to the corresponding Advance
NDC status.
No configuration is required as Advance NDC fully controls the
Remote Status Indicators (RSIs). The operation of the RSIs
corresponds to the information given in the Fault Display option of
the Supervisor Select menu. For details of RSIs, refer to Chapter 7,
“Error and Exception Reporting and Recovery” in the APTRA
Advance NDC, Supervisor’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-17
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Unsolicited Status
Messages for External
System Events
5
Advance NDC can send unsolicited status messages to the host for a
system event (WFS_SYSTEM_EVENT) that occurs on a device in
response to a command issued in another process, even though
there is no outstanding WFS command in Advance NDC (no
execute command is issued in Advance NDC).
This feature can be used for Exits, web Exits and external
applications that access SST devices but cannot handle the system
events caused by device errors. The Exits and external applications
must be CEN-compliant and supported by NCR.
This feature applies to all devices. It is enabled through the
following DWORD registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\
Extensions\External System Events\
ProcessSystemEventsForAllDevices
Valid values are as follows:


0 = disabled (the default)
1 = enabled
If the value is invalid or does not exist, the feature is disabled.
If the feature is enabled, Advance NDC sends an unsolicited status
message to the host whenever a system event occurs for a device. In
certain situations, this can result in duplicate unsolicited status
messages being sent to the host, for example, when an execute
complete message is followed by a system event message.
Unsolicited Status Messages for Cash Handlers
A suspend unsolicited status message can be sent at any time to the
host when a cash handler enters Suspend mode and Enhanced
Present Sequence 2 (EPS 2) / Dispenser Security Enhancement
hardware is present. The EPS2 allows the dispenser severity to be
set to suspend when tampering is suspected.
The sending of suspend unsolicited status messages is enabled
using the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\Extensions\
External System Events\EPS2Enabled
Valid values (DWORD) are as follows:


0 = disabled (the default)
1 = enabled
If the value is invalid or does not exist, the cash handler severity is
not forced into Suspend mode and no suspend unsolicited status
message is reported to the host.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-18
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Power-Up Status Message
5
A power-up message can be sent to the host when communications
are restored. This is configured using the following DWORD
registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\
PowerUpOnCommsRestore
Valid values are as follows:


Registry Settings for
Device Status Messages
5
0 = Do not send (default)
1 = Send
By default, some data is suppressed in certain device status
messages sent to the host, for example, cardholder display fitness
status. The data can be included in the status messages by editing
the registry.
Cardholder Display
5
The following DWORD registry value configures whether the
fitness status for the cardholder display is included in fitness status
messages sent to the host:
HKEY_LOCAL_MACHINE\SOFTWARE\NCR\Advance NDC\Network
SupressCardholderDisplayFitness
Valid values are as follows:


1 = Do not send the fitness status (default)
0 = Send the fitness status.
Receipt Capture Bin
5
The following DWORD registry value configures whether the
supplies status and fitness status for the receipt capture bin are
included in status messages to the host:
HKEY_LOCAL_MACHINE\SOFTWARE\NCR\Advance NDC\Network
SupressReceiptRetractBinSupplies
Valid values are as follows:


Enabling Web Exits
5
1 = Do not send supplies/fitness status (default)
0 = Send supplies/fitness status.
Advance NDC can use a web Exit to display screens and interact
with the consumer outside of Advance NDC. The Advance NDC
state flow is exited and full control passed to a web browser with no
need for a host change to the existing state flow.
Note: The web Exit maintains the web browser session using
Display Manager instead of the web Exit state control process. For
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-19
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
details of Display Manager, refer to the APTRA Advance NDC, User
Guide for Display Manager.
Enabling web Exits involves the following:
1
Altering the state flow to introduce the new state
2
Activating the web Exit state
3
On exiting the web Exit state on completion of the web Exit,
passing control back to Advance NDC.
The web Exit state can be executed anywhere within the state flow
where an Exit state can be executed.
Configuring the Web Exit State
To configure the web Exit state, complete the following steps:
1
Assign any available state type letter. This is used to represent
the state.
2
Associate state type parameters containing the state type and
state information for each web Exit state that can be executed.
3
Populate the state table parameters with the updated web state
parameters using local customisation.
4
Configure Internet Explorer so that the web pages used within
the web Exit state are added to the list of trusted web sites.
Appendix G, “User-Configurable States” provides the following
information on enabling web Exits:
Table 5-5
Enabling Web Exits
Item
Description
State table parameters
To control the behaviour of the web
Exit.
Tracking URLs
To communicate the state of the web
browsing to Advance NDC
Extension to Web Exit state
To specify the state numbers to execute
WebExitURLTable.xml
To get the URL path, based on the URL
index table entry in the Web Exit state
flow
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-20
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Specifying Local
Customisation Data
5
Item
Description
Adding Exit web pages to
trusted sites zone
To allow cross-frame security
Updating STCONT
To register the state type letter and
location of the web exit
Updating the state flow
To call the Exit at the appropriate time
Local customisation data can be specified in files placed on the SST.
This data can be used to extend or modify data provided in host
downloads. Local customisation data files are loaded at the
following points in the application:


At Start of Day.
After a go-in-service (GIS) message is received. Therefore,
software management can change local customisation files on
the SST allowing Advance NDC to read new customisation files
after receiving the GIS message.
Note: Keyboard mapping can also be defined using the local
customisation data. For details of associated keyboards, see
“Associated Keyboards for FDKs” on page 1-28.
To use local customisation data, the following registry entry must
be set to '1':
HKLM\Software\NCR\Advance NDC\Local Data Available
The files containing the customisation data are either defined within
the SCXLOC file or contained within the LOCAL file.
The SCXLOC file takes precedence, so if it is present on the SST, any
LOCAL file is ignored.
If neither file is found, no local customisation can take place.
Note: If you are testing on a development system, the SCXLOC
and LOCAL files, and any referenced files must be located in the
C:\Program Files\NCR APTRA\Advance NDC directory. This is the
default path at installation.
SCXLOC File
5
SCXLOC is a control file created on the SST and picked up from the
first location found, as defined in the path environment variable in
the System folder under the Windows Control Panel. The file
contains a list of files to be applied as local customisation files,
allowing you to define local customisation groups as separate files.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-21
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Each message is listed on a separate line, and the maximum file size
for SCXLOC is 1024 bytes.
All the files referenced must also be placed in the path defined in the
PATH variable on the SST. As some methods of file copying do not
support filenames with spaces, avoid using spaces in the filenames.
Any screens, states or FITs that are part of the host download, but
are not being locally customised should not be included in these
files.
The referenced files can contain multiple customisations, but each
customisation can be no more than 1024 bytes.
Example SCXLOC File The following is an example of an
SCXLOC file, referencing four files:
5
LOCSC1
LOCSC2
LOCST1
LOCFI1
Example Referenced Files The following list provides examples
of the four files referenced in the example SCXLOC file. The tags
used in the examples are defined as follows:
Table 5-6
Tags Used in the Files Referenced in
SCXLOC
Tag
Hex Code
Description
<fs>
1CH
Field separator
<ff>
0CH
Clear screen character
<si>
0FH
Shift in cursor position character
<ex>
03H
End of text character.
Note: You must use this tag as a line delimiter as the
line-feed or carriage return characters cannot be
used.
Note: The maximum length of each message is limited to 1024
bytes.

LOCSC1:
The following example defines the locally customised screen
identified as 010:
3<fs><fs><fs>11<fs>010<ff><si>DDPLEASE INSERT YOUR
CARD<si>FDTO BEGIN A TRANSACTION<ex>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-22
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application

LOCSC2:
The following example defines the locally customised screen
identified as 11:
3<fs><fs><fs>11<fs>011<fs><ff><si>EGWE ARE UNABLE<si>GDTO
PROCESS YOUR CARD<ex>

LOCST1:
The following example defines the locally customised states
identified as 000 and 095:
3<fs><fs><fs>12<fs>000A010001011002002002001095<fs>095J01
1000011011011000011000<ex>

LOCFI1:
The following example defines the locally customised FIT table
identified as 000:
3<fs><fs><fs>15<fs>00000025525525525525500000001200001500
0000
000255000000000000000000000000000000000000000000000000000
0000
00000<ex>
LOCAL File
5
The LOCAL file contains all locally customised screens, states and
FIT Tables in a single file. The file must be created in a directory
defined in the path variable.
Any screens, states or FITs that are part of the host download, but
are not being locally customised should not be included in this file.
The file is in message file format, which mimics the download from
the host.
The maximum length of a message is 1024 bytes.
Example LOCAL File The following is an example of a LOCAL
file, with definitions for locally customised screens identified as 010
and 011, states identified as 000 and 095, and a FIT table identified
as 000.
5
For an explanation of the tags used, see Table 5-6, “Tags Used in the
Files Referenced in SCXLOC” on page 5-22.
3<fs><fs><fs>11<fs>010<ff><si>DDPLEASE INSERT YOUR
CARD<si>FDTO BEGIN A TRANSACTION<fs>
011<ff><si>EGWE ARE UNABLE<si>GDTO PROCESS YOUR
CARD<ex>3<fs><fs><fs>12<fs>000A010001011002002002001095<fs>09
5J011000011011011000011000<ex>3<fs><fs><fs>15<fs>000000255255
2552552550000000120000150000000002550000000000000000000000000
00000000000000000000000000000000000<ex>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-23
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Changing the Next State
Number
5
A Transaction Reply message contains the state number for the next
state to be executed. This configuration allows you to redirect the
state number provided in the message without any host impact.
Redirecting the next state number is done through a configuration
file, StateTranslator.xml. As this file is not provided on the SST by
default, you must create it in C:\Program Files\NCR
APTRA\Advance NDC\Config. After creating the file, add the
elements and attributes as described in the example below.
Example of StateTranslator.xml
5
This is an example of changing the next state number from 300 to
500 and 400 to 600 for Transaction Request state number 123:
<StateTranslator>
<State Number=”123”>
<Translate NextStateNum=”300” TranslateTo=”500”/>
<Translate NextStateNum=”400” TranslateTo=”600”/>
</State>
</StateTranslator>
These elements and attributes are validated through the
StateTranslator.xsd file, which is available as part of the Advance
ANDC installation.
Security Cameras
5
Security camera configuration for USB cameras is defined using the
NDCSecurityCamera.xml file.
Support for .NET components is provided through the NDC
Camera Service. This is configured as described in “Using the NDC
Camera Service” on page 5-27.
Using the XML File
The NDCSecurityCamera.xml file can be updated through software
distribution, local modification or the XML Configuration
Download message. For details of the XML envelope that must be
used with the NDCSecurityCamera.xml file, see “XML Configuration
Files” on page 5-34. For details of the XML Configuration Download
message refer to Chapter 10, “Central to Terminal Messages” of the
APTRA Advance NDC, Reference Manual.
The security camera schema, NDCSecurityCamera.xsd, defines the
structure of the configuration data as described in Table 5-7,
“Security Camera XML Elements” on page 5-25.
The NDCSecurityCamera.xml and NDCSecurityCamera.xsd files are
stored in the following location:
C:\Program Files\NCR APTRA\Advance NDC\Config
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-24
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Each camera can be configured for one of the following positions:



Person
ExitSlot
Room
The camera positions are then set in the NDCSecurityCamera.xml file
for different flow points which further trigger the associated
camera.
Table 5-7
Security Camera XML Elements
Element
Description
SecurityCameraClass
Mandatory.
This is the root element.
The whole file is enclosed within SecurityCameraClass tags.
Nested elements:

SecurityCameraDevice

SnapshotsFolder

Compression

FlowPointType
SecurityCameraDevice
Mandatory.
Appears only once.
Identifies the device as a security camera. The required DeviceID attribute
identifies the security camera being configured.
Nested elements:

Name

Instance
Name
Mandatory.
Identifies the logical name of the CEN XFS camera device class.
Instance
Mandatory.
The security camera device to which the configuration applies.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-25
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Element
Description
SnapshotsFolder
Mandatory.
Appears only once for each device.
Identifies the folder in which the camera files are stored. The optional Capacity
attribute fixes the size of the folder in megabytes (MB). The default capacity is
2000 MB. The optional Path attribute specifies the location of the folder in which
the camera files are stored. The default path is C:\Program Files\NCR
APTRA\Advance NDC\Snapshots. The path length must not exceed 220
characters.
Compression
Optional.
Appears only once.
Identifies whether the images are to be compressed. Valid values are as follows:
0 - Do not compress the images. This is the default
1 - Compress the images.
FlowPointType
Mandatory.
Identifies flow points in a transaction that triggers an associated camera to take a
picture. The required Name attribute identifies the flow point using the name
given in “Camera Flow Points” on page 5-28. Each flow point can appear only
once.
Nested elements:

Delay

Number

NoOfSnapshots

CameraPosition
Delay
Optional.
Identifies the delay in milliseconds between images taken by the security camera
at this flow point. The default is 2000, which is the minimum time required to take
and process an image.
Number
Mandatory.
Identifies the flow point using the number given in “Camera Flow Points” on
page 5-28.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-26
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Element
Description
NoOfSnapshots
Optional.
Identifies how many images should be taken by the security camera at this flow
point.
Valid values are as follows:
1 - Take one image at this flow point (default)
2 - Take two images at this flow point
3 - Take three images at this flow point.
Note: For the Supervisor flow point, this must be set to 1.
CameraPosition
Optional.
Identifies the camera that is used to take the image at this flow point. The default
is to use the first security camera be be configured at feature-level.
Valid values are as follows:
Room
Person
ExitSlot
Using the NDC Camera Service
5
The .NET Class Configurator creates the NDC Camera Service at
start of day as defined in the following extract from the
AdvanceNDC.accfg file:
<Class ID="NDCCameraService"
Name="NCR.APTRA.NDC.CameraService"
Assembly="NCR.APTRA.NDC.CameraService.dll"
CreateAlways="true" >
</Class>
The NDC Camera Service implements the IJournalService
interface and is added as a configuration property to the following
flow classes in the NCR.APTRA.NDC.CashInFlows.dll assembly:




NCR.APTRA.NDC.CashInFlows.CashAcceptStateFlow
NCR.APTRA.NDC.CashInFlows.CashInCloseFlow
NCR.APTRA.NDC.CashInFlows.EncashReplyFlow
NCR.APTRA.NDC.CashInFlows.RefundReplyFlow
These classes define the camera service used to take pictures during
the transaction. The values can be any string representing a camera
service, by default all are set to "NDCCameraService"
The flow point is passed to the NDC Camera Service using the
DataRecord parameter of the Record method. The RecordType of
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-27
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
the DataRecord is a string representation of the flow point type, the
NDC Camera Service converts the RecordType to the flow point
number and sets CDI 1376 (Camera Flowpoint) before activating the
Take Picture worker.
To use a third-party camera solution, you must write your own
camera service implementing the IJournalService interface.
Flow Points Defined for the Security Cameras
The flow points at which the security cameras are triggered are
predefined as described in Table 5-8.
Table 5-8
Camera Flow Points
Flow Point Number
Flow Point Name
000
N State
001
Card Inserted
002
Card Taken
003
Card Captured
004
PIN Entered
005
Transaction Request Sent
006
Transaction Reply Received
007
Cash Presented
008
Cash Taken
009
Card Ejected
010
Cash Retracted
011
Cash Deposit Enabled
012
Rejected Notes Taken
013
Notes Deposit Confirmed
014
Notes Deposit Cancelled
015
Receipt Taken
016
Notes Refunded
017
Refunded Notes Taken
018
Notes Inserted
019
Cheque Inserted
020
Cheque Taken
021
Cheque Ejected
022
Cheque Captured
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-28
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Flow Point Number
Flow Point Name
023
Envelope Deposited
024
Supervisor Test
025
Cardless Initiation
026
CashPresented_2ndCamera
027
CashTaken_2ndCamera
028
Input Refused
029
Notes Encash Success
030
Notes Encash Failed
031
Notes Refund Failed
032
CashIn Retract Success
033
CashIn Retract Failed
Example of Adding Flow Points
5
The following extract shows the default configuration for the
SelfServ SSTs for the second camera:
<SecurityCameraClass
xmlns="http://www.ncr.com/APTRA/NDC/SecurityCamera"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.ncr.com/APTRA/NDC/SecurityCame
ra NDCSecurityCamera.xsd">
<SecurityCameraDevice DeviceId="1">
<Name>Camera1</Name>
<Instance>1</Instance>
<SnapshotsFolder>C:\Program Files\NCR APTRA\Advance
NDC\Snapshots</SnapshotsFolder>
<Flowpoint>000</Flowpoint> <!-- N State -->
<Flowpoint>002</Flowpoint> <!-- Card Taken -->
<Flowpoint>007</Flowpoint > <!-- Cash Presented -->
<Flowpoint CameraPosition="ExitSlot" NoOfSnapshots="1"
Delay="2000">026</Flowpoint > <!--CashPresented_2ndCamera -->
<Flowpoint CameraPosition="ExitSlot" NoOfSnapshots="1"
Delay="2000">027</Flowpoint > <!--CashTaken_2ndCamera-->
<Flowpoint NoOfSnapshots="2" Delay="3000">008</Flowpoint>
<!-- Cash Taken -->
</SecurityCameraDevice>
</SecurityCameraClass>
Configuring Data Masking
and Logging
5
Customer-sensitive data from Interactive Transaction Responses
and Transaction Replies can be masked before the trace data is
output to the Message-In trace stream of Silent Debug and
DebugLog. The masked data is replaced by asterisks.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-29
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
If the application is compliant with the PCI DSS (Payment Card
Industry Data Security Standard), you must mask this data. For
more details of the PCI DSS, see Appendix E, “PCI DSS & PA-DSS
Compliance in Advance NDC”.
Data sent to the journal, receipt and statement printers can be
logged to the OOXFS trace stream of DebugLog and Silent Debug or
the logging can be disabled.
The configuration for data masking in the Message-In trace stream
and printer data logging to the OOXFS trace stream can be changed
through the registry.
Interactive Transaction Response
5
Masking of the Screen Data field and the Trailer field (fields ‘j’ and
‘k’) is enabled or disabled using the following DWORD entry in the
registry:
HKLM\SOFTWARE\NCR\Advance NDC\Security\ITR MASKING
Valid values are as follows:


0 = disable masking (show message data as sent from the host)
1 = enable masking
The default value is 0. If an invalid value is specified or the key does
not exist , the default value is used.
When Advance NDC is installed, the value of this entry is explicitly
set to 1.
Transaction Reply
Masking of the Screen Display Update field and the Printer Data
field (fields ‘n’ and ‘r’ is enabled or disabled using the following
DWORD entry in the registry:
HKLM\SOFTWARE\NCR\Advance NDC\Security\TR REPLY MASKING
Valid values are as follows:


0 = disable masking (show message data as sent from the host)
1 = enable masking
The default value is 0. If an invalid value is specified or the key does
not exist , the default value is used.
When Advance NDC is installed, the value of this entry is explicitly
set to 1.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-30
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Printer Data Logging to the OOXFS Trace Stream
5
Printer data logging is enabled and disabled using the following
DWORD entry in the registry:
HKLM\SOFTWARE\NCR\Advance NDC\Security\
EXCLUDE PRINTER DATA
Valid values are as follows:


0 = log printer data
1 = do not log printer data
The default value is 0. If an invalid value is specified or the key does
not exist, the default value is used.
When Advance NDC is installed, the value of this entry is explicitly
set to 1.
Support for DVDs on SSTs
The following Supervisor functions support the use of DVD drives:
5

COPY ON/OFF (on the Dialup Configuration menu)

RETRIEVE ARCHIVE (on the Troubleshopoting menu)

PD INVESTIGATION (on the Troubleshopoting menu)

INIT EJRNL (Initialise electronic journal)

RCOPY EJRNL (Recopy electronic journal)


DIRECT EJ BACKUP
AUTOMATIC INIT COPY DRIVE
CREATE SIGS (Create signatures)

EXTRACT SIGS (Extract signatures)

DVD drivers can also be used with Silent Debug.
Required API
5
To write data to a DVD, Image Mastering API version 2.0
(IMAPIv2.0) for Microsoft Windows XP must be installed. To
download and install the API, refer to Microsoft support article
932716. IMAPIv2.0 is included with Windows 7.
Note: IMAPIv2.0 is not required for writing data to CDs.
Re-writable and Dual-layer DVDs
5
It is not possible to create multi-sessions when writing to re-writable
and dual-layer DVDs. This means that if one of these DVD types is
inserted into the DVD drive and the DVD already contains some
data, then no further data can be written to it. There is no issue
creating multi-sessions on CDs, DVD-R or DVD+R DVDs.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-31
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Unsupported
Configuration Options
Promote Flow Point
Behaviour
The following configuration options are not supported:

5

Cancel/Clear swap option
Download of keyboard definitions other than FDK associations.
The configuration settings for the Promote flow points described in
Table 5-9, are stored in the in the following registry key:
5
HKLM\SOFTWARE\NCR\Advance NDC\Promote
Table 5-9
Promote Flow Point Configuration
Flow Point
Registry Entry
Values
Approving Transaction
Display Multiple Approving
Transaction
0 = The flow point is displayed only
the first time the Transaction
Request state is executed in a
sequence of chained transactions.
1 = The flow point is displayed
every time the Transaction Request
state is executed in a sequence of
chained transactions (default).
Goodbye
Close Flowpoint Location
1 - The flow point is executed before
any device tidy-up is performed.
2 - The flow point is executed after
device tidy-up is performed
(default).
Goodbye
Close Flowpoint on
Successful Transaction
0 – The flow point is executed
regardless of transaction success
status or card capture status.
1 – The flow point is executed if
the Last Status Issued byte in field 'r'
of the Transaction Request
is set to 1 (good termination sent)
and the consumer’s card is
ejected successfully.
See Note 1: and Note 2:
For further information on Promote flow points supported by
Advance NDC, refer to the APTRA Promote User’s Guide.
Note 1: For chained transactions, the Last Status Issued byte is
updated for every Transaction Reply. Therefore, only the Last Status
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-32
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring an Advance NDC Application
Issued byte in the final Transaction Request is used to trigger the
flow point.
Note 2: If the Close Flowpoint on Successful Transaction is
set to 1, the Goodbye flow point is executed based on the Last Status
Issued byte if the following apply:


The Close Flowpoint Location is set to 1. This also applies for
cardless transactions
The Transaction Reply function ejects the card in the Close state.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-33
Configuring Advance NDC and Associated Components
Configuration Files
Configuration Files
5
Two types of configuration file are used to configure Advance NDC,
as follows:


XML configuration files that can be updated through software
distribution, local modification or the XML Configuration
Download message from the host
.NET Class Configurator files that are installed with Advance
NDC.
General information on each of these methods is provided in the
sections below. Further information on specific configuration
carried out using either of these methods is referenced from each
section.
XML Configuration Files
5
If you are using an XML configuration file updated through the
XML Configuration Download message, the configuration data in
field ‘j’ consists of two parts, as follows:


Configuration Update Control. This is an XML envelope used
for all XML configuration files. For details, “Configuration
Update Control”, below
Embedded configuration data. This is defined in a schema
specific to the device or feature being configured. For details of
the devices and features using XML configuration files, see the
following:
— “Security Cameras” on page 5-24
— “Resetting USB Devices” on page 5-78
— “Supervisor Alphanumeric Data Entry” on page 5-85
— “Cardholder Alphanumeric Data Entry” on page 5-99
— “Configuring Whole Amount Entry” on page 5-112
— “Validating Buffer Data” on page 5-113
— “Advance NDC Display Components” on page 5-128
— “Barcode Reader Filter Configuration” on page 5-181
— “Configuring Voice Guidance” on page 6-5.
For details of the XML Configuration Download message refer to
the APTRA Advance NDC, Reference Manual.
Configuration Update Control
The Configuration Update Control encloses the device or
feature-specific embedded configuration data. It defines the type of
configuration data included and how this is applied to any existing
configuration. The XML envelope schema,
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-34
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuration Files
NDCConfigurationControl.xsd, defines the structure of the data, as
illustrated in Figure 5-1.
Figure 5-1
XML Envelope Schema
<?xml version "1.0" encoding="UTF-9"?>
<xs:schema xmlns="http://www.ncr.com/APTRA/NDC/ConfigUpdateControl"
xmlns:xs="http://www.w3.org/201/XMLSchema"
targetNamespace="http://www.ncr.com/APTRA/NDC/ConfigUpdateControl"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:element name="ConfiguationUpdateControl">
<xs:complexType>
<xs:sequence>
<xs:element name="UpdateMode">
<xs:complexType>
<xs:choice>
<xs:element name="ReplaceFile">
<xs:compleType/>
</xs:element>
<xs:element name="InsertNodeBefore">
<xs:complexType>
<xs:attribute name="NodePath" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="AddNodeAfter">
<xs:complexType>
<xs:attribute name="NodePath" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="ReplaceNode">
<xs:complexType>
<xs:attribute name="NodePath" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="DeleteNode">
<xs:complexType>
<xs:attribute name="NodePath" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element name="Content" type="xs:anyType" minOcurs="0"/>
</xs:sequence>
<xs:attribute name="Filename" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
</xs:schema>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-35
Configuring Advance NDC and Associated Components
Configuration Files
Note: Multiple XML declaration tags must not be included within
the body of XML data; therefore this tag must be omitted from the
embedded file. The XML declaration tag defined for the XML
envelope is used within the saved embedded file.
The XML envelope consists of an attribute that defines the file to be
updated and two nodes, as follows:


The Update Mode node defines the type of update to be made,
as described in Table 5-10, “Update Mode”
The Content node contains the embedded configuration data, as
shown in “Example Replacement XML for a Barcode Reader”
below.
Table 5-10
Update Mode
Element
Description
ReplaceFile
Indicates that the whole file is to be replaced
InsertNodeBefore
Indicates that the new data is to be inserted before the node identified by
the XLink definition in the NodePath attribute
Not supported
AddNodeAfter
Indicates that the new data is to be added after the node identified by the
XLink definition in the NodePath attribute
Not supported
ReplaceNode
Indicates that the new data is to replace the node identified by the XLink
definition in the NodePath attribute
Not supported
DeleteNode
Indicates that the node identified by the XLink definition in the NodePath
attribute is to be deleted
Not supported
Example Replacement XML for a Barcode Reader Figure 5-2
shows the content passed in the XML Configuration Download
when the Barcode Reader file is to be replaced. The white space
must be omitted in the actual download, but is included here to aid
legibility.
Note: The data can be split into more than one part if the length
exceeds the maximum message size.
For further information on the Barcode Reader configuration data,
see “Barcode Reader Filter Configuration” on page 5-181.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-36
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuration Files
Figure 5-2
Example Replacement XML
<?xml version="1.0" encoding="UTF-"?>
<ConfigurationUpdatedControl xmlns="http://www.ncr.com/APTRA/NDC/ConfigUpdateControl"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.ncr.com/APTRA/NDC/ConfigUpdateControl
NDCConfigUpdateControl.xsd" Filename="NDCBarcodeReader.xml">
<UpdateMode>
<ReplaceFile></ReplaceFile>
</UpdateMode>
<Content>
<BarcodeReaderClass xmlns="http://www.ncr.com/APTRA/NNDC/BarcodeReader"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.ncr.com/APTRA/NDC/BarcodeReader NDCBarcodeReader.xsd">
<BarcodeReaderDevice DeviceID="f">
<Name>Barcode1</Name>
<Instance>1</Instance>
<BarcodeFilter>
<Index>1</Index>
<Offset>0</Offset>
<Filter>1234@@45</Filter>
</BarcodeFilter>
<BarcodeFilter>
<Index>2</Index>
<Offset>0</Offset>
<Filter>Bill%%12345@@</Filter>
</BarcodeFilter>
</BarcodeReaderDevice>
</BarcodeReaderClass>
</Content>
</ConfigurationUpdateControl>
.NET Class Configurator
Files
5
The .NET Class Configurator instantiates and configures objects
used by an application as defined in XML files with a file extension
of accfg.
Advance NDC uses the .NET Class Configurator for the
initialisation and configuration of many of the internal .NET
components.
For details of the .NET Class Configurator, including details of the
XML schema, refer to the APTRA online documentation under
.NET Class Configurator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-37
Configuring Advance NDC and Associated Components
Configuration Files
The following files contain configuration settings that are applied in
order by the .NET Class Configurator:
Caution:
1
AdvanceNDC.accfg
2
CashInCore.accfg
3
CashInCustom.accfg
You must not edit any content in the CashInCore.accfg file.
The class configurator files are installed to C:\Program Files\NCR
APTRA\Advance NDC\Config. Advance NDC loads the
AdvanceNDC.accfg file, which contains entries to include other .accfg
files in the order that they appear.
Conventions For Multiple Files
5
The definition of Class ID elements can be split among multiple files
as the .NET Class Configurator merges the definitions. If there is
any duplication or overlap, any later definitions replace the earlier
definitions.
The .NET Class Configurator does not merge Array ID definitions,
and later definitions in any file fully replace any earlier definitions
whether or not there is any duplication or overlap.
Creating Classes
The following entry in a class configurator file creates an AANDC
Configuration class, based on the
NCR.APTRA.Configuration.Registry implementation class in the
NCR.APTRA.Configuration.dll file:
<Class ID=”AANDC Configuration”
Name=”NCR.APTRA.Configuration.Registry”
Assembly=”NCR.APTRA.Configuration.dll”/>
The following entry in a class configurator file creates an NDC
Configuration class, based on the
NCR.APTRA.NDC.Configuration.ConfigurationData
implementation class in the NCR.APTRA.NDC.Configuration.dll file:
<Class ID=”NDC Configuration”
Name=”NCR.APTRA.NDC.Configuration.ConfigurationData”
Assembly=”NCR.APTRA.NDC.Configuration.dll”/>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-38
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuration Files
Class Configurator Files
5
For further Advance NDC configuration defined using a class
configurator file, see the following sections:









“Configuring .NET Archive Manager” on page 5-59
“Configuring .NET Retrieve Archive Task” on page 5-69
“Configuring the .NET NDC CRM Service” on page 5-72
“Integrating New or Existing .NET Supervisor Tasks” on
page 5-89
“Promote/Copyfile” on page 5-94
“Relate Supervisor Option” on page 5-95
“Confirmation Screens During Cash Deposit” on page 5-103
“Advance NDC Display Components” on page 5-128
“Advance NDC Display Runtime Settings” on page 5-148
.NET Assemblies Component Configuration For details of the
contents of the .NET Assemblies for Advance NDC, refer to Chapter
4, “The Advance NDC Package” of the APTRA Advance NDC,
Overview.
5
For further configuration settings for components included in the
.NET Assemblies for Advance NDC component, see the following
sections:




“TCP/IP Configuration” on page 5-41
“Configuring Cash Acceptors” on page 5-199
“Bunch Cheque Acceptor” on page 5-260
“ImageMark Passport ATM Image Agent” on page 5-263
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-39
Configuring Advance NDC and Associated Components
Configuring Communications
Configuring Communications
5
Some of the settings described in this section can be accessed
through the Configure menu in Supervisor. Changes made using
the Configure menu overwrite changes made through the registry
entries. NCR recommends using the Configure menu to change
these settings.
For details of the configuration options available through the
Supervisor, refer to chapter 4, “Configure Menu” of the APTRA
Advance NDC, Supervisor’s Guide.
Service Class
5
The service class specifies the communications type configured on
the SST and is specified through the following registry entry
HKLM\SOFTWARE\NCR\Advance NDC\VPIComms\VPICommsServiceProgID
This setting can be configured through the Select Communications
Type option on the Supervisor Configure menu.
TCP/IP Setting
5
The setting for TCP/IP is the default, as follow:
NCRaVPITCPIP.TCPIPCommsService
Advance NDC will use the .NET VPITCPIP component at runtime.
CCM PCCM Setting
5
For SSTs using a PCCM-based protocol, change the setting to the
following:
NCRaVPIPCCM.PCCMCommsService
For details of PCCM, refer to the following:


APTRA Communications Feature, User’s Guide
APTRA Documentation | CCM PCCM.
CCM VISA2 Setting
For SSTs using CCM VISA2, change the setting to the following:
NCRaVPIVISA2.VISA2CommsService
Clearing the
Communications Buffer
5
On power up or following a communications recovery, the
communications buffer can be cleared to prevent the host receiving
confusing responses due to message buffering. Clearing the buffer is
set using the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\VPIComms\ClearCommsBuffer
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-40
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Communications
Valid values are as follows:
0 - clear the communications buffer (default).
1 - retain the messages in the communications buffer.
Off-line Timer
5
When off-line mode is entered, Advance NDC checks every five
seconds whether communication has been re-established by the
communications protocol. If the communications connection is
re-established, this timer is cancelled. If the connection is not
re-established before this timer expires, the communications link is
closed for 10 seconds, then re-opened. This timer and the
five-second test of the communications state are then restarted.
To configure the number of seconds before timer expiry, edit the
following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\VPIComms\OffLineTimer
The default value is 600 seconds and the valid range of values is
0-99999.
TCP/IP Configuration
5
TCP/IP configuration is supported through the .NET VPITCPIP
component, which allows SSTs to connect to a TCP/IP network
providing extended security options to comply with PA-DSS.
Configuring TCP/IP
5
The .NET VPITCPIP component supports the following:


IPv4 and IPv6 protocols
Secure sockets layer (SSL) for the encryption of transmitted data
and the decryption of received data. Valid certificates are
required for successful communications.
In Supervisor, options on the Configure menu allow the
configuration of the TCP/IP settings as well as Windows, firewall
and SSL settings, and some diagnostics features such as PING.
Configuring TCP/IP through Supervisor applies only to the Local
Area Connection. For details of configuring other connections, see
“Configuring Network Connections and Communications Links”
on page 5-42.
The .NET VPITCPIP Supervisor tasks are responsible for displaying
Supervisor screens and updating the
TCPIPCommunicationsServiceConfig.xml file, located in the
C:\Program Files\NCR APTRA\Advance NDC\Config folder.
Normally, this file does not need to be modified directly but it can
be used to deploy the same settings across a whole network without
configuring each SST separately through Supervisor.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-41
Configuring Advance NDC and Associated Components
Configuring Communications
If any of the TCP/IP configuration parameters are modified through
the Configure menu, a reboot is required before the change is
recognised by .NET VPITCPIP or for the update of the local network
configuration to take effect. After making such changes, the
operator is given the opportunity to reboot immediately or later.
The registry setting to enable TCP/IP is described in “Service Class”
on page 5-40.
For more information about TCP/IP configuration, refer to the
APTRA online documentation under .NET CCM TCPIP.
Domain Name Server If you are using .NET VPITCPIP and want
to configure a domain name server (DNS), you must make updates
using the TCP/IP Configuration menu in Supervisor through option
11, DNS Address. For IPv6, only the primary DNS can be entered.
XP Keep Alive This option can be enabled or disabled through
option 17 on the TCP/IP Configuration menu. The Keep Alive
option is enabled by default. When enabled, the Keep Alive settings
are controlled by the following registry entry:
5
5
HKLM\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters
The values are in milliseconds for the following:
KeepAliveInterval
KeepAliveTime
Note: If a message exceeds 4 KB in size, a command reject will be
returned.
SSL Configuration The Secure Socket Layer (SSL) is enabled and
disabled using option 18 on the Supervisor TCP/IP Configuration
menu. SSL supports the encryption of transmitted data and the
decryption of received data.
5
Optionally, you can add, edit or delete the details of received and
supplied certificates using the Received Certificate Issuer, Received
Certificate Subject, Supplied Certificate Identifier and Supplied
Certificate Subject options. Selecting any of these options calls the
corresponding .NET TCP/IP Supervisor task and updates the
corresponding entry in the TCPIPCommunicationsServiceConfig.xml
file.
Configuring Network Connections and Communications
Links
If you want either a network connection other than Local Area
Connection or different communications links, these require
updates to the configuration files or Author.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-42
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Communications
Network Connections The ConnectionNameToUpdate property
in the AdvanceNDC.accfg file specifies the network connection to be
configured where there are multiple Windows TCP/IP connections,
for example, an SST with multiple network cards.
5
The default network connection setting in the AdvanceNDC.accfg file
is as follows:
<Class ID="SetNetworkAddressTask"
Name="NCR.APTRA.TcpipSupportTask.SetNetworkAddress"
Assembly="NCR.APTRA.TcpipSupportTask.dll">
<!-- can be used to configure any connection by any name-->
<Interface>
<Property Name="ConnectionNameToUpdate" Value="Local
Area Connection"/>
</Interface>
</Class>
Note: Any configuration other than Local Area Connection cannot
be amended through Supervisor.
Communications Links The default link name is TPA
CONNECTION. If more than one communications link is required
or you want to use a different name, complete the following steps:
1
In the APTRA Author, modify the NAME attribute for the NDC
Comms Connection ID worker to include a value for the new
link ID.
2
In TCPIPCommunicationsServiceConfig.xml, add an entry with a
corresponding link ID.
5
Note: The new link will not be configurable through Supervisor as
only the TPA CONNECTION entry for .NET VPITCPIP can be
modified through the TCP/IP Configuration menu.
Internet Protocols
5
Advance NDC supports TCP/IP communications using either IPv4
or IPv6.
On Windows XP machines, support for IPv6 must be installed by
executing the following at the command line:
netsh interface ipv6 install
When Advance NDC is installed, the default entry mode in
Supervisor is IPv4. The entry mode can be changed to IPv6 through
option 20 IPV4/IPV6 on the TCP/IP Configuration menu in
Supervisor or through the registry.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-43
Configuring Advance NDC and Associated Components
Configuring Communications
The currently selected IP address entry mode is stored in the
following DWORD registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\VPIComms
IPv6AddressEntryMode
Valid values are as follows:
0 = IPv4 entry mode (the default)
1 = IPv6 entry mode
IPv6 Restrictions For other options available on the TCP/IP
Configuration menu, the following restrictions apply :



5
Subnet Mask (option 10 ) — applies only to IPv4
Windows Internet Name Service (option 12) — not supported
for IPv6
Firewall (option 14) — not supported for IPV6
Note: As the DHCP server normally configures an IPv6 network,
IPv6 local area network settings need not be configured through
Supervisor.
For further information, refer to the .NET TCP/IP Supervisor Tasks
On-line Documentation.
Functions in Supervisor An IPv6 address can be entered or
viewed through the following Supervisor options on the TCP/IP
Configuration menu:
0 RMT ADDRESS
2 LCL ADDRESS
6 DISP TCP/IP
7 PRINT TCP/IP
8 PING
9 GATEWAY
11 DNS ADDRESS (ENTER PRIMARY DNS)
Changes made for IPv6 through Supervisor menu options update
the TCPIPCommunicationsServiceConfig.xml file accordingly. IPv6
addresses are expressed in standard hexadecimal notation, for
example, 2002:877f:7a5b::877f:7a5b.
IPv6 is also supported when the network hosts are specified by
name, but this requires IPv6 support on the configured domain
name server.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-44
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Communications
Configuring Advance NDC as a TCP Server Advance NDC can
be configured as a TCP server accepting connections from any host,
as follows:
1
Specify the remote host as one of the following:
0.0.0.0 for IPv4
:: for IPv6
2
Ensure no firewall on the SST prevents the expected incoming
connections.
5
For details of the Supervisor functions for configuring TCP/IP
communications, refer to Chapter 4, “Configure Menu” of the
APTRA Advance NDC Supervisor’s Guide.
Dialup Configuration
5
Dialup communications is enabled through the registry, as
described in “Service Class” on page 5-40, or by using the Configure
menu in Supervisor:
Configuration is required for both the application and lower-level
(modem) communications. Configuration values are located as
follows:

For the application parameters, under the following registry
key:
HKLM\SOFTWARE\NCR\Advance NDC\VPIComms\dialup

For the protocol and modem parameters, in the XML file for
CCM VISA2, VISA2CommunicationServiceconfig.xml. This file has
default values only and is not preconfigured.
Status Message Suppression
5
When a deposit cassette reaches the low threshold, an unsolicited
cash handler device status message is sent to Central. This message
is sent each time the cassette is used until the cassette either runs out
of notes or is replenished. In some dialup environments, these
repeated messages can impact the network by requiring additional
dial-outs. As this can lead to additional network costs and reduction
in the cost advantages of dialup communications, Advance NDC
has introduced a method of suppressing these messages.
The number of messages to send for each cassette before
suppressing any further messages is set using Application
Parameters under 38 - DIALUP on the Configure menu in
Supervisor. This updates the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\VPIComms\Dialup\
SuppressCashLow
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-45
Configuring Advance NDC and Associated Components
Configuring Communications
Valid values are as follows:


0 to disable message suppression (default)
1-9 to specify the number of messages sent for a cassette before
suppression.
Alphanumeric Entry
5
A defined set of alphanumeric values and special characters can be
configured for the following:






Communications access routing information using the bank
identification number (BIN)
Terminal Identification (TID) information
Primary Number used when first dialling
Secondary Number used if connection to the primary number
fails
Modem Initialisation String
Network Address String.
The values can also be configured by any of the following methods:



Preconfigured and deployed at rollout
Edited directly on a development system
Modified on a secure system using the Supervisor Copy
Off/Copy On function.
Preconfiguration
5
If the XML file for CCM VISA2 is to be preconfigured, the
restrictions described below in “XML Restrictions” must be applied.
Any preconfiguration entry must have a CommsLinkID of TPA
CONNECTION and there must only be one
VISA2CommunicationsLink element in the file.
Connect Life Time
5
On this menu, the two options have the following meaning:


Normal = in transaction
Pre-Dial = in session.
Copy On/Off
To facilitate configuration, or modification that is unique to a
particular SST, an option is provided in the Supervisor Configure
menu to transfer the XML configuration file or the application
registry settings, in XML format, to and from removable media. This
functionality can be used, for example, to configure the SST at start
of day.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-46
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Communications
The function does not validate any changes made to the XML file. It
is responsibility of the person making the change to ensure the
validity both of syntax and values.
XML Restrictions
5
Certain characters are treated by XML as special characters. For
example, an ampersand (&) is a XML special character and must be
entered using the ASCII decimal value (38) as &#38; in XML.
NCR recommends that you have a knowledge of XML before
editing the XML file, or use an XML editor.
Diagnostics
5
For dialup diagnostics to work correctly, configuration is required,
either through preconfiguration or through transfer to removable
media.
The screens for dialup diagnostics are the forms supplied with CCM
VISA2, not those in resrvd.def.
For details of the diagnostic tests available, refer to the APTRA
Advance NDC, Supervisor’s Guide.
Note: Localisation of these forms is not supported.
Dialup Timers and Modem
Baud Rate
5
Except for Timer 3, which is sent from Central, the timers and baud
rate are configurable for numeric entry through the Dialup Config
menu in Supervisor. The duration of the application timers is set in
accordance with the settings for the modem timers.
Setting the timers to the correct value is important for dialup
communications to function correctly. For details of the timers and
the calculations to use when determining the length of time to set,
refer to Chapter 13, “CCM VISA2 Dialup System” in the APTRA
Advance NDC, Reference Manual.
Activity Timer
5
This timer must be set to a large value, determined by how often the
host is expected to send messages in quiet periods. The default
value is 3000 seconds.
Error Redial Timer
5
This timer specifies how long the application will wait before it tries
dialling again to establish a connection after an error has been
experienced with a previous attempt. This timer should be set to a
shorter value than the Activity Timer. The default is 300 seconds.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-47
Configuring Advance NDC and Associated Components
Configuring Communications
Timer 3
5
The duration of this timer (communications response timer,
downloaded from the host) has to be sufficient to allow the dialup
connection to complete its operations. In non-dialup systems, Timer
3 normally has a value of 20 to 30 seconds. In a dialup system the
typical value is 40 to 60 seconds.
Modem Connect Timer
5
The Modem Connect Timer determines how long CCM VISA2 will
wait for an attempt to connect to the host before signalling an error.
The duration of this timer must be shorter than Timer 3.
Dial on Send Timer
The duration of this timer must be at least as long as the time taken
to transmit the longest message and receive the corresponding
reply.
For EJ upload, the Dial on Send timer determines the amount of
time the host has available to send an acknowledgement to an EJ
upload message. The call will be disconnected after the Dial on Send
timer expires.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-48
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Diagnostics Options
Configuring Diagnostics Options
5
This section describes the following:



Displaying Additional
Diagnostics Menus
5
Displaying additional diagnostics menus
Showing or hiding the diagnostics shortcut
Disabling self-test on exiting diagnostics.
Where there is no access to VDM and VDA diagnostic support, you
can choose to display additional diagnostics menus within
Supervisor. These menus allow the display of information on the
fitness of present and installed XFS devices. You can then perform a
reset, and in some cases a self test, where required.
By default these menus are not shown, and can only be displayed by
updating the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\Diagnostics\
MVDiagnostics
Valid values are as follows:
0 - hide the diagnostics menus. This is the default.
1 - display the diagnostics menus.
When operator intervention is required in diagnostics, a timeout is
applied. For example, following a reset of the card reader, an
operator must enter a card. If no card is entered before the specified
timeout period, the test times out. The timeout period is set in the
following entry:
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\Diagnostics\
Timeout
Valid values are entered in seconds. The default is 7 seconds.
Show/Hide Diagnostics
Shortcut
5
At any time on a Graphical Operator Panel (GOP), or when the
Select menu is displayed in Supervisor on any other type of display,
a diagnostics shortcut allows entry to the VDM and replicates the
shortcut provided with APTRA XFS.
Note: If the diagnostic shortcut is selected while a cardholder
transaction is in progress, entry to the VDM occurs only after the
transaction has completed.
Depending on the type of display, the diagnostic shortcut is either
the Mini Self-Service Assistant (MSSA), or the text ‘SERVICE
ASSIST’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-49
Configuring Advance NDC and Associated Components
Configuring Diagnostics Options
By default, the diagnostics shortcut is displayed, but it can be
hidden using the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\supervisor\MAST
Valid values for this entry are as follows:
0 to hide the diagnostics shortcut
1 to show the diagnostics shortcut (default).
The following are also required to display the MSSA icon:


Disabling Self-Test on
Diagnostics Exit
5
The correct product class must be entered in the System
Application configuration
The Self-Service Assistant aggregate must have been installed
with XFS and its default settings must remain unchanged.
When the APTRA Self-Service Assistant is installed, a self test of
devices with hardware problems is performed on exit from VDM.
You can disable this self test using the following registry entry:
HKLM\SOFTWARE\NCR\APTRA Self-Service Support (NCR
Features)\Task API\PerformTestOnExit
Valid values for this entry are as follows:
0 to disable the self test
1 to enable the self test (default).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-50
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Service Providers
Configuring Service Providers
5
The Advance NDC installation configures the NCR service
providers (SPs) to ensure they will function with Advance NDC.
For SP configuration on other vendors’ SSTs, refer to the
vendor-specific documentation and the APTRA Advance NDC,
Multi-Vendor Support Reference Manual.
Configuring Service
Providers (SPs) for Reboot
5
If an internal error is detected in a service provider, the default
registry settings will reboot the SST. The default setting is as
follows:
HKLM\SOFTWARE\NCR\XFS IDC SERVICE PROVIDER\XFS-Framework\
Interoperability
RunInternalErrorExecutable=00000001 (DWORD)
Service Provider Reset
Value
5
By default, one attempt can be made to clear a device fault before
intervention is required through the System Application or other
Vendor Dependent Mode (VDM).
To support error recovery guidelines for deposit transactions, the
number of attempts to clear a device fault on a cash acceptor can be
configured by adding the following entry to the registry:
HKLM\SOFTWARE\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDERS\
MultipleResetSOH = "1" (DWORD)
If this registry entry is set to 1, multiple resets can be called on the
NCR service providers. This registry entry must be set to 1 to ensure
the success of automatic error recovery, the BNA initialisation
option on the Supervisor Replenish menu and the clearing of the
device when exiting Supervisor after a failed attempt to reset during
a Supervisor transaction.
Note: When not in Supervisor mode, no more than two attempts
that fail will be made. When in Supervisor mode, error recovery is
always attempted when the BNA initialisation option is run from
the Supervisor Replenish menu or on exit from Supervisor if the
device is not in a good state.
The following scenario illustrates how a single attempt to clear a
device fault can affect Advance NDC:

The reset command sent on Supervisor exit is not successful
where a previous attempt to reset a device has been made and
the System Application has not been used to clear the device in
the meantime.
If a reset fails, use the System Application to clear the device.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-51
Configuring Advance NDC and Associated Components
Configuring Service Providers
The CEN-XFS standard does not allow a vendor-dependent
application, such as the System Application, to be launched when
other CEN-XFS compliant applications are not in VDM. If the
System Application is launched outside Advance NDC, for example
from the desktop, an encryptor error is reported when the encryptor
is next used from within Advance NDC. Therefore, only start the
System Application using the Supervisor menu unless Advance
NDC is not currently running.
Service Provider Tracing
5
During installation, Advance NDC turns off SP tracing (0) under the
following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\TraceLevel
For further information on SP tracing and the settings for this
registry entry, refer to the APTRA on-line documentation under
APTRA XFS | Programmer’s Reference | XFS Service Providers |
XFS Service Provider Errors.
Configuring Service
Provider Support for
CEN-XFS Versions
5
The following configuration is included to support future CEN-XFS
features and functionality in the product. The configuration must
not be changed unless the release bulletin contains details of
acceptable changes.
Where a device is capable of supporting later versions of CEN-XFS
than the service provider is able to support, each device alias (see
“CEN-XFS Logical Device Names” on page 5-16) can be configured
for Advance NDC to restrict the range of CEN-XFS versions
supported by that device.
The following example shows the SPVersionRange registry entry
configured for a card reader with the CEN-XFS version range
specified as 3.00 to 3.03:
HKLM\SOFTWARE\NCR\Advance NDC\SPVersionRange\
Card Reader = "03 00 03 03"
The SPVersionRange string registry value must contain four sets of
two-digit pairs separated by spaces. In the example above, the first
and second pairs (03 00) indicate that the version range starts at
CEN-XFS 3.00 and the third and fourth pairs (03 03) show that the
version range ends with CEN-XFS 3.03.
In the above example, the IDC service provider is opened using the
latest CEN-XFS version that it supports in the range specified. If the
card reader supports CEN-XFS versions 3.00 to 3.02, then CEN-XFS
3.02 is the version used. However, if the card reader supports
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-52
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Service Providers
CEN-XFS 3.00 to 3.10, the version used is 3.03 as versions beyond
that are outside the range specified in the registry entry.
If Advance NDC is updated to support later versions of the
CEN-XFS interface for a particular device, this support must be
enabled by extending the range in the registry entry. Therefore,
using the example above, if the card reader is updated to support
CEN-XFS 3.10, the entry must be updated as follows:
HKLM\SOFTWARE\NCR\Advance NDC\SPVersionRange\
Card Reader = "03 00 03 10"
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-53
Configuring Advance NDC and Associated Components
Configuring SNMP Traps
Configuring SNMP Traps
5
Advance NDC supports the sending of application-related Simple
Network Management Protocol (SNMP) traps. When changes in
state occur in Advance NDC, events (known as traps) are sent by
the SNMP agent to the SNMP manager. Only the traps detailed here
originate in Advance NDC. All other traps, for events such as
hardware state changes, originate in APTRA XFS.
Further information on SNMP traps is available as follows:


On Windows XP, the SNMP Agent is supplied with APTRA
XFS. Refer to the APTRA SNMP Agent, Reference Manual
On Windows 7, a licence must be purchased for the Unified
Agent SNMP product as described in the Advance NDC,
Overview. Refer to the online documentation provided with the
product.
The ideal communications flow is illustrated in the following figure:
Figure 5-3
APTRA and SNMP
To send SNMP traps, Advance NDC requires a TCP/IP connection
to the SNMP server. The following types of trap are sent:



No transaction
Application heartbeats
Mode changes.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-54
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring SNMP Traps
No Transaction Traps
5
Table 5-11
No Transaction Traps
No transaction traps allow monitoring of the health and availability
of the SST. The traps are described in the following table.
Trap
Description
NOTRAN9
No transaction or mode change has occurred during the
specified period when the SST was in the defined mode
or modes.
NOTRAN0
A transaction has occurred.
To configure the period between sending NOTRAN9 traps, set the
following registry entry to the required period in seconds:
HKLM\SOFTWARE\NCR\Advance NDC\SNMP\NoTransactionDelay
By default, this is set to 0 to disable the sending of transaction traps.
The minimum period is 5 seconds and the maximum is 86400
seconds (24 hours).
To configure the modes in which transaction traps are sent, set the
following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\SNMP\SendNOTRAN9
By default, this is set to 1 to send transaction traps only when the
SST is in service. The modes are defined using any combination of
the bit settings described in the following table. For example, to
enable traps for all modes, SendNOTRAN9 must be set to 15.
Table 5-12
Bit Positions for Modes
Application Heartbeats
5
Bit
Mode
0
In Service
1
Out of Service
2
Offline
3
Supervisor
Regular signals (heartbeats) from the Customisation Layer of
Advance NDC allow Central to monitor the communications
connections.
By default, the initial heartbeat is generated at Start of Day with
subsequent heartbeats generated every 30 minutes. These timings
can be changed by editing the HeartBeatDelay registry entry
under the following registry key
HKEY_LOCAL_MACHINE\SOFTWARE\NCR\Advance NDC\SNMP.
As there is no dependency on other signals, you can choose to
reduce or increase the period between heartbeats.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-55
Configuring Advance NDC and Associated Components
Configuring SNMP Traps
The value for this registry entry is given in seconds. The default is
1800 seconds (30 minutes).
The NCR SNMP implementation uses the Generate Heartbeat type
trap.
The GASPER-compatible implementation uses the Report State type
trap: see Table 5-8 for further details.
Advance NDC Mode
Change Traps
5
Advance NDC mode changes generate traps to report application
events that require logging or possible action by the SNMP
manager.
The NCR SNMP implementation uses a pair of traps listed in tables
“NCR SNMP Service Traps” and “NCR SNMP Mode Change
Traps” on page 5-57.
The GASPER-compatible implementation uses only the traps listed
in table “GASPER-Compatible SNMP Traps” on page 5-58.
Service State Changes
5
When Advance NDC relinquishes control of the SST to another
application or process, an Out of Service mode change trap is sent
although no actual mode change occurs. When Advance NDC
regains control of the SST, an In Service mode change trap is sent
although, again, no actual mode change occurs.
Implementation of SNMP
Traps
There are two methods of implementing application heartbeat and
mode change traps in Advance NDC, as follows:
5


As described in “NCR SNMP Implementation” on page 5-56
GASPER-compatible as described in “GASPER-Compatible
Implementation” on page 5-57.
Note: “No transaction” traps apply to both implementations.
NCR SNMP Implementation
To use this implementation, set the following registry entry to 1:
HKLM\SOFTWARE\NCR\ Advance NDC\SNMP\NCRSNMP
Two types of traps can be sent, as follows:


NCR SNMP Service traps
NCR SNMP Mode Change traps.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-56
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring SNMP Traps
An NCR SNMP Service trap shows whether the SST is in or out of
service, as follows:
Table 5-13
NCR SNMP Service Traps
Severity (Enum)
Meaning in Advance NDC
0
SST is in service
2
Supervisor mode has been entered; SST is either out of
service or in offline mode
An NCR SNMP Mode Change trap identifies the mode change, as
follows:
Table 5-14
NCR SNMP Mode Change Traps
Application
Name (String)
Event (String)
Severity
(Enum)
Meaning in Advance
NDC
“AA-NDC”
“IN_SERVICE”
0
Normal operation
- In service
or
Advance NDC
has regained
control of the SST
from another
application or
process
“AA-NDC”
“OUT_OF_SERVICE”
2
Critical
- Out of service
or
Advance NDC
has relinquished
control of the SST
to another
application or
process
“AA-NDC”
“OFFLINE_MODE”
2
Critical
- Offline
“AA-NDC”
“SUPERVISOR_MODE”
2
Critical
- Supervisor
“AA-NDC”
“SUSPEND_MODE”
2
Critical - Suspend
condition
“AA-NDC”
“UnKnown”
1
Warning
- State Unknown
GASPER-Compatible Implementation
5
To use this implementation, set the following registry entry to 0:
HKLM\SOFTWARE\NCR\Advance NDC\SNMP\NCRSNMP
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-57
Configuring Advance NDC and Associated Components
Configuring SNMP Traps
Note: This is the default setting for this registry entry
The application heartbeat and mode change traps are given in the
following table:
Table 5-15
GASPER-Compatible SNMP Traps
Name (String)
Data (String)
Alert Hint
Meaning within Advance NDC
“APTRA WEBATM STATUS”
“1”
TRUE
In Service
or
Advance NDC has regained
control of the SST from
another application or
process
“APTRA WEBATM STATUS”
“2”
TRUE
Out of Service
or
Advance NDC has
relinquished control of the
SST to another application
or process
“APTRA WEBATM STATUS”
“3”
TRUE
Supervisor
“APTRA WEBATM STATUS”
“4”
TRUE
Exit Supervisor
“APTRA WEBATM STATUS”
“5”
TRUE
Suspend
“APTRA WEBATM STATUS”
“I”
TRUE
Offline
“APTRA WEBATM STATUS”
“J”
TRUE
Unknown
“APTRA WEBATM HEARTBEAT”
DD/MM/YYYY hh:mm:ss
(current date and time)
TRUE
Heartbeat
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-58
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
Configuring .NET Archive Manager
5
Advance NDC uses the .NET Archive Manager component to
archive and manage data on the SST.
The .NET Archive Manager is configured using the
AdvanceNDC.accfg file installed with Advance NDC. For
information on the AdvanceNDC.accfg file see “.NET Class
Configurator Files” on page 5-37.
For further information on the .NET Archive Manager, refer to the
APTRA online documentation under .NET Archive Manager.
Configuration Properties
5
The StdArchiveManager class is responsible for managing and
packaging all archive data. It provides configuration properties that
can be edited using any XML or text editor to perform the following
tasks:





Scheduling archives
Setting the default collection directory
Deleting old archives
Configuring the data to archive
Configuring SST properties
The following example from the AdvanceNDC.accfg file shows the
configurable properties that are available for the
StdArchiveManager class.
<Class ID="StdArchiveManager"
Name="NCR.APTRA.ArchiveMan.StdArchiveManager"
Assembly="NCR.APTRA.ArchiveMan.dll" CreateAlways="true">
<Interface>
<Property Name="CollectDir" Value="C:\Program
Files\NCR APTRA\Advance NDC\Data\Archives"/>
<Property Name="ArchiveScheduler"
Value="Scheduler"/>
<Property Name="DeleteOlderThan" Value="8"/>
<Property Name="NetworkID" Value=""/>
<Property Name="OperateInService" Value="True"/>
<Property Name="AMProviders"
Value="AMProviderArray"/>
<Property Name="TerminalService"
Value="TerminalService"/>
</Interface>
</Class>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-59
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
General Configuration
5
The default general configuration settings described in the
following sections are provided by Advance NDC in the
AdvanceNDC.accfg file and can be edited using any XML or text
editor.
Scheduling Archives
5
To configure the scheduler, edit the default configuration settings in
the AdvanceNDC.accfg file shown in the following example:
<ClassID="Scheduler" Name="NCR.APTRA.ArchiveMan.Scheduler"
Assembly="NCRAPTRAArchiveMan.dll">
<Interface>
<Property Name="Enabled" Value="False"/>
<Property Name="ScheduledDays"
Value="ScheduledDaysArray"/>
<Property Name="ScheduledTime" Value="03:00"/>
</Interface>
</Class>
To change the time that files are archived each day, update the
ScheduledTime property to the desired time. The default time is
03:00; the time is given in the 24 hour format.
To change the days that the Archive Manager runs, edit the
ScheduledDaysArray. For example, to set the Archive Manager to
run on Mondays, Wednesdays and Fridays, edit the array as
follows:
<Array ID="ScheduledDaysArray">
<Element Value="Monday"/>
<Element Value="Wednesday"/>
<Element Value="Friday"/>
</Array>
Setting the Default Collection Directory
5
The default collection directory setting in the AdvanceNDC.accfg file
is as follows:
<Property Name="CollectDir" Value="C:\Program Files\
NCR APTRA\Advance NDC\Data\Archives/>
If you want to archive files to a different folder, update the path
accordingly.
Deleting Old Archives
Archive Manager deletes exported files a specified number of days
after the creation date. After each export, the timestamps are
checked and files are deleted if they are older than the value in the
DeleteOlderThan value.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-60
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
The default setting is as follows:
<Property Name="DeleteOlderThan" Value="8"/>
Archive Data
Configuration Examples
The .NET Archive Manager can run at a pre-configured time to
archive the following data:
5






Investigation and trace files, such as those produced by Problem
Determination and the XFS platform
Log files, such as the EJ data log (ejdata.log) and event logs
ECB 6 database file
Registry keys
User-configured files
User-configured folders
The archived data is saved to a selected destination drive under the
directory specified in the AdvanceNDC.accfg file.
To archive a file, it must be included as a class element in the
AdvanceNDC.accfg file and the ID attribute of the class element must
be defined in the following array:
<Array ID="AMProviderArray">
<Element Value="AMProviderFiles1"/>
<Element Value="AMProviderUEH"/>
<Element Value="AMProviderFiles2"/>
<Element Value="AMProviderXFSLog1"/>
<Element Value="AMProviderInvestigation1"/>
<Element Value="AMProviderEventLog1"/>
<Element Value="AMProviderECB6Log"/>
<Element Value="AMProviderAlwaysOn1"/>
</Array>
The default general configuration examples in the following
sections are included in the AdvanceNDC.accfg file and can be edited
using any XML or text editor.
Archiving PD Investigation Files
5
The following example shows the default XML entry in the
AdvanceNDC.accfg file. This covers collecting and removing archives
for PD investigation files.
<Class ID="AMProviderInvestigation1"
Name="NCR.APTRA.ArchiveMan.AMProviderInvestigation"
Assembly="NCR.APTRA.ArchiveMan.dll">
<Interface>
<Property Name="Groups"
Value="AMProviderInvestigation1Groups"/>
<Property Name="RemoveTrace" Value="True"/>
</Interface>
</Class>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-61
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
<Array ID="AMProviderInvestigation1Groups">
<Element Value="PD INVESTIGATIONS"/>
</Array>
By default, PD investigation files are archived to a group named
PD INVESTIGATIONS. To change the name of the group, edit the
appropriate value in the AMProviderInvestigation1Groups array.
By default, the .NET Archive Manager deletes PD investigation files
that have been archived during a scheduled collection. PD
investigations that are active or have been paused are not deleted
until the next scheduled archive time arrives, providing they have
completed. To disable automatic deletion of archived PD
investigation files, set the RemoveTrace property to False.
If a problem occurs during the removal of a PD investigation during
an archive, an exception is logged in the event log.
Archiving XFS Trace Files
5
In the default entry, XFS trace files are archived to the XFS LOGS
group, as follows:
<Class ID="AMProviderXFSLog1"
Name="NCR.APTRA.ArchiveMan.AMProviderXFSLog"
Assembly="NCR.APTRA.ArchiveMan.dll">
<Interface>
<Property Name="Groups"
Value="AMProviderXFSLog1Groups"/>
</Interface>
</Class>
<Array ID="AMProviderXFSLog1Groups">
<Element Value="XFS LOGS"/>
</Array>
To change the name of the group, edit the appropriate value in the
AMProviderXFSLog1Groups array.
Archiving Event Logs
In the default entry, event logs are archived to the Event Logs
group, as follows:
<Class ID="AMProviderEventLog1"
Name="NCR.APTRA.ArchiveMan.AMProviderEventLogs"
Assembly="NCR.APTRA.ArchiveMan.dll">
<Interface>
<Property Name="Groups"
Value="AMProviderEventLog1Groups"/>
</Interface>
</Class>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-62
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
<Array ID="AMProviderEventLog1Groups">
<Element Value="Event Logs"/>
</Array>
To change the name of the group, edit the appropriate value on the
AMProviderEventLog1Groups array.
Archiving EJ Data Files
5
Advance NDC uses the AMProviderFiles class provided by the
Archive Manager to archive the EJ data log (ejdata.log) file. In the
default entry, EJ data files and EJ backup files are archived in the EJ
DATA LOGS group. The following is provided in the
AdvanceNDC.accfg file.
<Class ID="AMProviderFiles1"
Name="NCR.APTRA.ArchiveMan.AMProviderFiles"
Assembly="NCR.APTRA.ArchiveMan.dll">
<Interface>
<Property Name="Groups"
Value="AMProviderFiles1Groups"/>
<Property Name="SourcePath" Value="C:\Program Files\NCR
APTRA\Advance NDC\Data"/>
<Property Name="SearchPattern" Value="EJDATA.LOG"/>
<Property Name="Recursive" Value="False"/>
<Property Name="RemoveTrace" Value="False"/>
</Interface>
</Class>
<Array ID="AMProviderFiles1Groups">
<Element Value="EJ DATA LOGS"/>
Note: As Advance NDC does not archive EJ backup files by default,
additional configuration information must be added to the
AdvanceNDC.accfg file. An example of this configuration and a
description of user-defined properties is provided in “Archiving
User-Defined Files” on page 5-66.
Archiving ECB 6 Database File
5
Advance NDC uses the AMProviderFiles class provided by the
Archive Manager to archive the ECB 6 database file. In the default
entry, the ECB 6 database file is archived in the ECB6 LOGS group.
The following is provided in the AdvanceNDC.accfg file.
<Class ID="AMProviderECB6Log"
Name="NCR.APTRA.ArchiveMan.AMProviderFiles"
Assembly="NCR.APTRA.ArchiveMan.dll">
<Interface>
<Property Name="Groups"
Value="AMProviderECB6Groups"/>
<Property Name="SourcePath" Value="C:\Program
Files\NCR APTRA\Advance NDC\PersistedData\ECB6Log"/>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-63
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
<Property Name="SearchPattern" Value="*.SDF "/>
<Property Name="Recursive" Value="False"/>
<Property Name="RemoveTrace" Value="False"/>
</Interface>
</Class>
<Array ID="AMProviderECB6Groups ">
<Element Value="ECB6 LOGS "/>
</Array>
<Array ID=" AMProviderArray ">
<Element Value=" AMProviderECB6Log "/>
</Array>
If the SST does not have a cash acceptor, attempts to archive the ECB
6 database file can be prevented by deleting or commenting out the
above configuration from the AdvanceNDC.accfg file.
Archiving Unhandled Exception Handler (UEH) Files
5
Advance NDC uses the AMProviderFiles class provided by the
Archive Manager to archive Unhandled Exception Handler (UEH)
files. In the default entry, the UEH files are archived in the UEH
LOGS group.The following is provided in the AdvanceNDC.accfg file.
<Class ID="AMProviderUEH"
Name="NCR.APTRA.ArchiveMan.AMProviderFiles"
Assembly="NCR.APTRA.ArchiveMan.dll">
<Interface>
<Property Name="Groups" Value="AMProviderUEHGroups"/>
<Property Name="SourcePath" Value="C:\Program Files\NCR
APTRA\Exception Handling"/>
<Property Name="SearchPattern" Value="*.log"/>
<Property Name="Recursive" Value="True"/>
<Property Name="RemoveTrace" Value="False"/>
</Interface>
</Class>
<Array ID="AMProviderUEHGroups">
<Element Value="UEH LOGS"/>
</Array>
SST Properties
Configuration Examples
SST properties can be configured in the AdvanceNDC.accfg file using
the TerminalInfo class as shown in the example below:
5
<Class ID="TerminalInfo"
Name="NCR.APTRA.TermSrvSDK.StdTerminalInfo"
Assembly="NCR.APTRA.TermSrvSDK.dll">
<Interface>
<Property Name="TerminalOwner" Value="OwnerDetails"/>
<PropertyName="NetworkIdentity"
Value="NetworkIdentityArray"/>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-64
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
<Property Name="TerminalLocation"
Value="PostalAddress"/>
</Interface>
</Class>
The following sections provide default configuration examples for
SST properties. These examples are included in the
AdvanceNDC.accfg file and can be edited using any XML or text
editor.
Owner Details
5
To specify the name of a financial institution and any other
identification details, you can use the BankName and BankID
properties on the OwnerDetails class as shown in the example
below:
<Class ID="OwnerDetails"
Name="NCR.APTRA.TermSrvSDK.StdOwnerDetails"
Assembly="NCR.APTRA.TermSrvSDK.dll">
<Interface>
<Property Name="BankName" Value="ABC Bank"/>
<Property Name="BankID" Value="ABC123"/>
</Interface>
</Class>
SST and Network ID
5
To specify the ID for an SST or network, you can use the TerminalID
and NetworkID properties on the NetworkIdentity1 class as shown in
the example below:
<Class ID="NetworkIdentity1"
Name="NCR.APTRA.TermSrvSDK.StdNetworkIdentity"
Assembly="NCR.APTRA.TermSrvSDK.dll">
<Interface>
<Property Name="TerminalID" Value="12345"/>
<Property Name="NetworkID" Value="22222"/>
</Interface>
</Class>
Note: The NetworkIdentity1 class is an element in the
NetworkIdentity array shown in the example below:
<Array ID="NetworkIdentityArray">
<Element Value="NetworkIdentity1"/>
</Array>
Postal Address
5
To specify the address for a financial institution, you can use the
Address, PostalCode, City, StateProv and Country
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-65
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
properties on the PostalAddress class as shown in the example
below:
<Class ID="PostalAddress"
Name="NCR.APTRA.TermSrvSDK.StdPostalAddress"
Assembly="NCR.APTRA.TermSrvSDK.dll">
<Interface>
<Property Name="Address" Value="AddressArray"/>
<Property Name="PostalCode" Value="DD1 3XX"/>
<Property Name="City" Value="Dundee"/>
<Property Name="StateProv" Value="Angus"/>
<Property Name="Country" Value="UK"/>
</Interface>
</Class>
Note: The AddressArray value is a array as shown in the example
below:
<Array ID="AddressArray">
<Element Value=""/>
</Array>
Additional Configuration
5
The following sections describe how to add configuration settings
that are not already included by default in the AdvanceNDC.accfg
file.
Archiving User-Defined Files
You can use Archive Manager to archive any user-defined files or
folders by including the file or folder under the
NCR.APTRA.ArchiveMan.AMProviderFiles class. The properties
are:
Table 5-16
Archiving User-Defined Files Properties
Property
Description
Groups
Specifies the group into which the file or folder is
archived. By default the group name is
FILESGROUP
SourcePath
Specifies the path of the file or folder to be archived
SearchPattern
Specifies the name of the files or folders to be
archived as specified in SourcePath. An asterisk
can be used as a wildcard.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-66
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
Property
Description
Recursive
Specifies whether to archive sub-directories. If the
value is True, sub-directories are archived.
RemoveTrace
Specifies whether to delete the files in the
SourcePath after archiving them. If the value is
True, the files are deleted. Any file that cannot be
deleted because it is locked by another process
causes an exception. By default, the value is False
and files are not deleted.
For example, Advance NDC does not archive EJ backup files by
default. To archive the files, add the following to the
AdvanceNDC.accfg file.
<Class ID="AMProviderEJBackupFiles"
Name="NCR.APTRA.ArchiveMan.AMProviderFiles"
Assembly="NCR.APTRA.ArchiveMan.dll">
<Interface>
<Property Name="Groups"
Value="AMProviderFiles1Groups"/>
<Property Name="SourcePath" Value="C:\Program
Files\NCR APTRA\Advance NDC\Data\EJBackups"/>
<Property Name="SearchPattern" Value="EJ*.*"/>
<Property Name="Recursive" Value=" False"/>
<Property Name="RemoveTrace" Value="False"/>
</Interface>
</Class>
<Array ID="AMProviderArray">
<Element Value=" AMProviderEJBackupFiles "/>
</Array>
Note: The EJ backup files are stored in the EJ Backups folder.
Archiving Registry Keys
5
By default, Archive Manager does not archive any registry keys.
The steps below show the configuration information that must be
added to the AdvanceNDC.accfg file:
1
Add the following configuration to the AdvanceNDC.accfg file:
<Class ID="AMProviderRegistryHive1"
Name="NCR.APTRA.ArchiveMan.AMProviderRegistryHives"
Assembly="NCR.APTRA.ArchiveMan.dll">
<Interface>
<Property Name="RegistryKeys"
Value="RegistryKeysArray"/>
</Interface>
</Class>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-67
Configuring Advance NDC and Associated Components
Configuring .NET Archive Manager
<Array ID="RegistryKeysArray">
<Element Value="" />
</Array>
2
Add the registry keys to be archived as the elements of Array ID
RegistryKeysArray. For example, to archive the
HKLM\SOFTWARE\NCR\Advance NDC registry key add the
following to AdvanceNDC.accfg :
<Array ID="RegistryKeysArray">
<Element Value=
"HKEY_LOCAL_MACHINE\SOFTWARE\NCR\Advance NDC " />
</Array>
3
Update the Array ID AMProviderArray to include
AMProviderRegistryHive1 as shown below:
<Array ID="AMProviderArray">
<Element Value="AMProviderRegistryHive1"/>
</Array>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-68
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring .NET Retrieve Archive Task
Configuring .NET Retrieve Archive
Task
5
Advance NDC uses the .NET Retrieve Archive component to select
and export the archives on the SST.
The .NET Retrieve Archive component is configured using the
AdvanceNDC.accfg file. Default configuration settings are included
in the AdvanceNDC.accfg file installed with Advance NDC. For
further information about the AdvanceNDC.accfg file, see “.NET
Class Configurator Files” on page 5-37.
The examples in this section illustrate how the RETRIEVE ARCHIVE
option of the Configure menu in Supervisor mode can be updated
using the AdvanceNDC.accfg file.
Example Updates to
Settings
The examples in the following sections show how to update the
settings in the Retrieve Archive Supervisor option.
5
If you want to change the setting for more than one of the tasks,
make updates to the entries for each option. The tasks are identified
and defined under the class IDs described in Table 5-17, “Retrieve
Archive Task Class IDs”.
Table 5-17
Retrieve Archive Task Class IDs
Task
Class ID
Create archive and export
ArchiveNowAndExport
Export all archives
ExportAllArchives
Export archives from last 7 days
ExportConfiguredDaysArchives
Expert archives from last 24 hours
ExportLast24HrsArchives
Display all archives to allow selection and
export the selected archive
DisplayAllArchivesAndExportSelected
Display archives for the last 7 days to allow
selection and export the selected archive
DisplayAndExportConfiguredDaysArchive
Display archives for the last 24 hours to allow
selection and export the selected archive
DisplayLast24HrsArchivesAndExportSelected
Search archives by date to allow selection and
export the selected archive
SearchArchiveByDateAndExport
Display all archive groups to allow selection
and export the selected group
DisplayAllGroupsAndExportSelected
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-69
Configuring Advance NDC and Associated Components
Configuring .NET Retrieve Archive Task
Task
Class ID
Display archive groups for last 7 days to allow
selection and export selected group
DisplayAndExportArchiveGroupForConfiguredDays
Display archive groups for last 24 hours to
allow selection and export selected group
Display24HrsArchiveGroupAndExportSelected
Search archive group by date to allow selection
and export the selected group
SearchArchiveGroupByDateAndExport
Changing the Export Folder
5
By default, archives are exported to the ATEXports folder on the
selected destination drive. To change the folder used, you must add
the following entry to each menu option entry that you want to
update:
<Property Name="ExportFolder" Value="<folder name>"/>
The following example shows option 0 SEARCH BY FILE updated
to change the default folder to which the archives are exported to
RetrievedArchives:
<Class ID="DisplayAllArchivesAndExportSelected"
Name="NCR.APTRA.RetrieveArchiveTasks.ExportArchives"
Assembly="NCR.APTRA.RetrieveArchiveTasks.dll">
<Interface>
<Property Name="ArchiveManagerInstance"
Value="StdArchiveManager"/>
<Property Name="ArchiveSearchOption"
Value="SelectArchive"/>
<Property Name="UserActivityTimeout" Value="30"/>
<Property Name="ExportFolder"
Value="RetrievedArchives"/>
</Interface>
</Class>
Changing the User Response Timeout
5
To change the default time in seconds allowed for a user to respond,
update the value of the UserActivityTimeout property. The
default time allowed for a user response is 30 seconds.
Changing the Date Format
By default, the ddmmyyyy date format is used when entering the
date. The following example changes the format to mmddyyyy:
<Class ID="SearchArchiveByDateAndExport"
Name="NCR.APTRA.RetrieveArchiveTasks.ExportArchives"
Assembly="NCR.APTRA.RetrieveArchiveTasks.dll">
<Interface>
<Property Name="ArchiveManagerInstance"
Value="StdArchiveManager"/>
<Property Name="ArchiveSearchOption"
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-70
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring .NET Retrieve Archive Task
Value="SelectArchive"/>
<Property Name="DateSearchOption" Value="Specify"/>
<Property Name="UserActivityTimeout" Value="30"/>
<Property Name="EnterMonthFirst" Value="True"/>
</Interface>
</Class>
Using Only Removable Drives
5
To list only removable drives for selection as the destination for the
archive, change the value of the ListNonRemovableDrives
property to False.
Excluding CD and DVD Drives
5
To disable the inclusion of CD and DVD drives in the list of
destination drives for the archive, change the value of the
EnableCDDVDBurning property to false.
Changing the Number of Days to Search
5
By default, option 1 on the Enter Search Option screen displays files
created over the last 7 days. The following example changes the
search to display files created over the last 10 days:
<Class ID="DisplayAndExportConfiguredDaysArchive"
Name="NCR.APTRA.RetrieveArchiveTasks.ExportArchives"
Assembly="NCR.APTRA.RetrieveArchiveTasks.dll">
<Interface>
<Property Name="ArchiveManagerInstance"
Value="StdArchiveManager"/>
<Property Name="ArchiveSearchOption"
Value="SelectArchive"/>
<Property Name="DateSearchOption" Value="LastXDays"/>
<Property Name="NumberOfDays" Value="10"/>
<Property Name="UserActivityTimeout" Value="30"/>
</Interface>
</Class>
Note: If you change the number of days to search, you must also
update screen m36 in resrvd.def. In the above example, option 1 has
to be updated to read “LAST 10 DAYS ARCHIVE”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-71
Configuring Advance NDC and Associated Components
Configuring the .NET NDC CRM Service
Configuring the .NET NDC CRM
Service
The .NET NDC CRM Service interacts with CRM services such as
Targeted Marketing Promote and Targeted Marketing Customer
Power for the display and retrieval of campaigns, printing of
coupons and generation of events for process completion. The
service handles the time-out for targeted messaging response and
displays the minimum and maximum time for the display of a
targeted message or campaign.
The .NET NDC CRM Service component is configured using the
AdvanceNDC.accfg file, which also includes the default configuration
settings. For further information about the AdvanceNDC.accfg file,
see “.NET Class Configurator Files” on page 5-37.
Note: To use the .NET NDC CRM Service, APTRA Promote or
APTRA Relate must be enabled through Supervisor options on the
Access menu.
The LanguageMapping property defines the supported language
and its corresponding screen offset in Advance NDC. Based on the
current language selection, the screen offset is mapped to the
respective language code for the CRM.
The default language is English (000=eng), the following example
shows the property updated to the offset for Spanish:
<Property Name="LanguageMapping" Value="300=spa"/>
For details on how Advance NDC handles multi-language screen,
refer to Chapter 3 “Screen Data” in the APTRA Advance NDC
Reference Manual
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-72
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring SST Recovery
Configuring SST Recovery
5
This section describes the following:



NDC Monitor
5
Detecting and recovering from freeze conditions
Forced rebooting of an SST
Resetting USB devices.
The NDC Monitor application can be used to manage the status of
the SST as follows:



Polling the SST at defined intervals to check that the SST is
responding
Checking the CPU consumption of the application identified in
the XML configuration file
If a freeze condition is detected, resetting the SST and/or
reporting an error.
Note: If the SST is to be reset when a freeze condition is
detected, no attempt is made to return the card to the consumer
before the reset. Depending on the capability of the card reader,
the card is either returned following the reset or it is retained.
By default, NDC Monitor is disabled. If enabled as described in
“Enabling NDC Monitor”, NDC Monitor detects that the SST has
become unresponsive at the following times:



Start of day
When the SST is in service
During the execution of monitored states.
NDC Monitor is configured using the NDCMonitor.xml file,
described in “NDC Monitor XML Elements” on page 5-74. The
monitored states and associated timeout intervals are defined using
the AdvanceNDC.accfg file as described in “Defining the States to
Monitor” on page 5-75.
Enabling NDC Monitor
5
By default, NDC Monitor is disabled. To enable NDC Monitor, edit
C:\Program Files\NCR APTRA\Advance NDC\StartApps.vbs by
removing the apostrophe from the start of the following line:
‘oShell.Run "NCR.APTRA.NDC.Monitor.exe ""C:\Program Files\NCR
APTRA\Advance NDC\Config\NDCMonitor.xml""", 0, false
Note: NCR recommends that you investigate the cause of freeze
conditions if they occur.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-73
Configuring Advance NDC and Associated Components
Configuring SST Recovery
NDC Monitor XML Elements
Table 5-18, “NDC Monitor XML Elements” describes the elements
used in the NDCMonitor.xml file. The default file installed with
Advance NDC is in the following folder:
C:\Program Files\NCR APTRA\Advance NDC\Config
Table 5-18
NDC Monitor XML Elements
L
Element
Description
NDCMonitor
Mandatory.
This is the root element.
The whole file is enclosed within NDCMonitor tags.
Nested elements:
ResetATMOnHang

ResponseDelay

CycleDelay

CheckCPUConsumption

ApplicationToMonitor

ResetATMOnHang
Mandatory.
Defines whether to reset the SST when a freeze condition is detected.
Valid values are as follows:

true - Reset the SST and log an error to the event log

false - Log an error to the event log. This is the default.
ResponseDelay
Mandatory.
Defines the period in seconds that NDC Monitor waits for a response from
the monitored application after sending a test message.
The default is 5.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-74
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring SST Recovery
Element
Description
CycleDelay
Mandatory.
Defines the interval in seconds at which NDC Monitor sends a test
message.
After Advance NDC starts, NDC Monitor waits for the period defined by
this element before checking the availability of the application.
If a freeze condition is detected and ResetATMOnHang is set to false,
NDC Monitor is stopped immediately after the error is logged.
The default is 60.
If this element is set to 0, no test messages are sent.
CheckCPUConsumption
Mandatory.
Defines whether to check the CPU consumption of the monitored
application.
Valid values are as follows:

true - Check CPU consumption. This is the default

false - Do not check CPU consumption
ApplicationToMonitor
Mandatory.
Identifies the application to be monitored using the name used to identify
the application window.
The default is SSDSAPP_ApplicationCore.
Defining the States to Monitor
5
Only the standard states provided by Advance NDC can be
monitored. NDC Monitor cannot monitor user-defined states or C
Exits.
The AdvanceNDC.accfg file contains all the states that can be
monitored in the HangMonitorStateTypes array. The states are
commented out by default.
Note: The names of the state types must not be changed.
Each state type has a corresponding timer value. These monitoring
timers are independent of the timer values downloaded from the
host. NDC Monitor uses monitoring timers to identify when a freeze
condition has occurred during state execution. Defining a
monitoring timer value of 0 disables the monitoring of the
associated state.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-75
Configuring Advance NDC and Associated Components
Configuring SST Recovery
There are two ways to edit the AdvanceNDC.accfg file to define the
states to monitor, as follows:
1
Uncomment only the states you want to monitor
2
Uncomment the whole array and set the monitoring timer value
for states you do not want to monitor to 0.
Monitoring Timers NDC Monitor starts a monitoring timer when
a state starts and stops the monitoring timer when the state finishes.
If the state has not completed before the defined monitoring timer
value is reached, a freeze condition is assumed and NDC Monitor
takes the action defined in the NDCMonitor.xml file.
5
Note: You must ensure that the defined monitoring timer values
allow sufficient time for the completion of the associated state,
including any potential interaction with the consumer.
Valid Timer Numbers Valid timer numbers are as follows:







Timer0 to Timer10 inclusive
Timer61
Timer63
Timer77 to Timer78 inclusive
Timer80 toTimer83 inclusive
Timer86 to Timer87 inclusive
Timer91 to Timer97 inclusive.
Valid Timer Value Definitions The following table describes the
valid formats that can be used to define the monitoring timer
values:
Table 5-19
Valid Timer Value Definitions
Example of Valid Format
Description
<Element Value="CashAccept=Timer1 + 30" />
The value defined by the cardholder
time-out response timer (Timer 01) plus 30
seconds for execution of the Cash Accept
state
<Element Value="ChequeAccept=Timer1+30" />
The value defined by Timer 01 plus 30
seconds for execution of the Cheque Accept
state
<Element Value="InfoEntry=Timer0 * 2" />
The value defined by the cardholder
keyboard response time timer (Timer 00)
multiplied by 2 for execution of the
Information Entry state
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-76
5
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring SST Recovery
Example of Valid Format
Description
<Element Value="FourFDKSelect=Timer0*2 + 10" />
The value defined by Timer 00 multiplied
by 2 plus 10 seconds for execution of the
Four FDK Selection state
<Element Value="AmountEntry=Timer0" />
The value defined by Timer 00 for
execution of the Amount Entry state
<Element Value="AmountCheck=30" />
Allow 30 seconds for execution of the
Amount Check state
For details of the timers, refer to Chapter 7, “Configuration
Parameters” in the APTRA Advance NDC, Reference Manual.
Whenever the Time-Out state is entered, the current monitoring
timer is restarted to allow the state to complete if the consumer
requests more time.
Timer Restarts Whenever the communication message time-out
interval timer (Timer 03) is started during the Transaction Request
state, the monitoring timer is restarted. Timer 03 is started
whenever a message is expected from the host and can be started
multiple times during execution of the Transaction Request state.
Invalid Timer Numbers If an invalid timer number or an invalid
format is used, a timer value of 0 is used and the associated state
type is not monitored.
Forced Reboot
5
5
5
An unhandled exception may occur where the SST does not reboot.
A forced reboot can be configured to ensure that a reboot occurs at
these times. The reboot timer starts as soon as the Advance NDC
applications generate any kind of exception and the following
message is logged to the event log:
Advance NDC raised an unhandled exception
Message: <message>
Reason: <reason>
Advance NDC will reboot in <timer> seconds
The registry entry used to configure a forced reboot timer is:
HKLM\SOFTWARE\NCR\Advance NDC\RebootTimeout
By default, this is set to 240 seconds (0xF0). The minimum time that
can be set in this registry entry is 60 seconds.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-77
Configuring Advance NDC and Associated Components
Configuring SST Recovery
If the Unhandled Exception Handler (UEH) is not configured as the
exception handler, the SST is not rebooted and the following
message is logged to the event log:
Advance NDC raised an unhandled exception
Message: <message>
Reason: <reason>
NCR UEH is not configured as the exception handler
Note: This registry entry does not override the normal exception
handling. However, if no reboot occurs before the forced reboot
timer expires, it ensures that a reboot occurs following an exception.
Resetting USB Devices
5
There are two types of reset that can be attempted when errors are
reported for USB devices, as follows:


XFS reset. This is a software reset to clear device errors and is
supported on all SSTs. The reset is performed only on the
specific device
Express recovery (24-volt reset). This allows the 24-volt power
supply for NCR devices connected using a USB Miscellaneous
Interface to be turned off and on. Express recovery is only
attempted for communications failures on version 6.01 and later
of the APTRA XFS platform. The decision to reset is made on an
individual device basis, but the reset is performed across all USB
devices.
Note: Express recovery is not supported for cash acceptors.
Only one reset is attempted for each device. If the reset fails, no
further resets are attempted and the device remains unavailable
until an operator intervenes.
If a communications error is detected, the Service Providers can
raise an exception that results in a reboot of the SST. This is disabled
by Advance NDC at installation using the following registry entry:
HKLM\WOSA/XFS_ROOT\SERVICE_PROVIDERS\ExceptionOnCommsFail
Valid values are as follows:


0 = Do not raise an exception (set by Advance NDC at
installation)
1 = Raise an exception (SP default setting).
An XFS reset is attempted if the device is included in the
DeviceRecovery.xml file and the EnableXFSReset attribute is set to 1.
A 24-volt reset is attempted if the following conditions are met:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-78
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring SST Recovery


The device is included in the DeviceRecovery.xml file and the
Enable24vReset attribute is set to 1
No unsuccessful attempt to reset the device has occurred. A
further reset will not be attempted in this situation until
Supervisor mode has been entered and exited.
USB devices are reset based on the APTRA XFS guidelines, as
described in the following table:
Table 5-20
USB Device Reset Rules
Circumstance
System Event
Reset Description
No COMMS_FAIL is reported
WFS_SYSE_HARDWARE_ERROR with
dwAction=WFS_ERR_ACT_RESET
An XFS reset is attempted based on
the configuration in the
DeviceRecovery.xml file for the device
WFS_SYSE_HARDWARE_ERROR with
dwAction=WFS_ERR_ACT_HWMAINT
No reset is triggered and the device
remains unavailable until an
operator intervenes
WFS_SYSE_HARDWARE_ERROR with
dwAction=WFS_ERR_ACT_RESET
An XFS reset is attempted based on
the configuration in the
DeviceRecovery.xml file for the device
WFS_SYSE_HARDWARE_ERROR with
dwAction=WFS_ERR_ACT_HWMAINT
No reset is triggered and the device
remains unavailable until an
operator intervenes
WFS_SYSE_HARDWARE_ERROR with
dwAction=WFS_ERR_ACT_RESET
An express recovery (24-volt reset) is
performed
WFS_SYSE_HARDWARE_ERROR with
dwAction=WFS_ERR_ACT_HWMAINT
An express recovery (24-volt reset) is
performed if configured in the
DeviceRecovery.xml file
WFS_SYSE_HARDWARE_ERROR with
dwAction=WFS_ERR_ACT_RESET
An XFS reset is attempted based on
the configuration in the
DeviceRecovery.xml file for the device
WFS_SYSE_HARDWARE_ERROR with
dwAction=WFS_ERR_ACT_HWMAINT
No reset is triggered and the device
remains unavailable until an
operator intervenes
Another vendor’s platform is
in use
COMMS_FAIL is reported and
express recovery is
supported
COMMS_FAIL is reported and
express recovery is not
supported
Both the XFS reset and the 24-volt reset are fully configured and
controlled by the DeviceRecovery.xml file described in the next
section. By default, both XFS reset and 24-volt reset are enabled for
all devices. For more information on the schema used by the
DeviceRecovery.xml file, see “Device Recovery Schema” on page 5-80.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-79
Configuring Advance NDC and Associated Components
Configuring SST Recovery
Device Recovery XML File
5
The DeviceRecovery.xml configuration file, installed in C:\Program
Files\NCR APTRA\Advance NDC\Config, can be updated either by
using the XML Configuration Download message or by local
modification. For details of the XML envelope that must be used
with this configuration file, see "XML Configuration Files", on page
5-34. For details of the XML Configuration Download message refer
to Chapter 10, “Central to Terminal Messages” of the APTRA
Advance NDC, Reference Manual.
The device recovery configuration file includes the USB devices as
<Resource> elements. For example, for the receipt printer, the
device name must be given as follows:
<Resource EnableXFSReset ="1" Enable24vReset ="1">Receipt
Printer</Resource>
The device names in the DeviceRecovery.xml must be the same as the
alias’ names provided under the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\Aliases
For further information on aliases, see "CEN-XFS Logical Device
Names", on page 5-16.
The XML entry is case sensitive. If either the configuration file or the
schema contain invalid data or do not exist, all reset functions are
turned off.
Note: If no attributes are defined for a device in the XML file, then
no XFS reset or 24-volt reset commands are sent to the device.
Device Recovery Schema
The schema, DeviceRecovery.xsd, defines the structure of the
configuration data for the resets described in Table 5-21, “Device
Recovery Elements”.
Table 5-21
Device Recovery Elements
Element
Description
ActiveDeviceList
The whole file is embedded within ActiveDeviceList tags.
This is the root element
Nested elements:

Resource
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-80
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring SST Recovery
Element
Description
Resource
Defines the device alias name.
The following attributes define whether a reset is enabled or disabled for the
device:

EnableXFSReset
Mandatory
Defines whether XFS reset is enabled for the device
Valid values are as follows:
0 - XFS reset is disabled
1 - XFS reset is enabled (default)

Enable24vReset
Mandatory
Defines whether express recovery is enabled for the device
Valid values are as follows:
0 - Express recovery is disabled
1 - Express recovery is enabled (default)
Uninterruptible Power
Supply
Table 5-22
UPS Power Management
5
UPS devices are supported through the SIU service provider (SIU
SP) and can be configured through the System Application. For full
configuration details refer to the APTRA on-line documentation
under APTRA XFS | Programmer’s Reference | Feature
Management | Power Supplies | PCUnintPowerSupply. A
summary of UPS power management is given in the following table.
Mains Failed
Battery Low
Action taken
False
False
SST runs as normal using the mains supply
False
True
SST switches to Out of Service until the battery
level exceeds the low threshold, at which point
it goes in service. If the mains power fails
again during this period, SST performs a
controlled shutdown.
True
False
SST switches to Out of Service
True
True
SST performs a controlled shutdown
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-81
Configuring Advance NDC and Associated Components
Configuring Suspend Timeout
Configuring Suspend Timeout
As devices are now accessed through the CEN-XFS interface,
clearing the Suspend mode is controlled by the SPs, but the
CEN-XFS specification does not define whether applications can
clear Suspend mode themselves.
The Advance NDC application detects a Suspend mode at the end
of the Close state and before the idle loop recommences. The SP
clears the Suspend state at the SP level, after the timeout defined in
the SP configuration.
When the SST detects that a device has been tampered with, the
application goes out of service temporarily and the SST goes into
Suspend mode until one of the following occurs:




The host sends a go-in-service (GIS) message
The host sends a out-of-service (OOS) message
The application Suspend timeout expires
Supervisor is entered by pressing the Mode switch.
The SST does not go into Suspend mode until the end of the
transaction in which tampering has been detected.
When the SST attempts to come out of Suspend mode, the SP
attempts to clear the device that caused the suspension of service. If
this succeeds then the SST is no longer suspended.
The SPs have their own configurable timers for coming out of
Suspend mode and will attempt to clear the devices when these
timers expire. SPs report devices as still in the Suspend state
(WFS_STAT_DEVUSERERROR) until the SP timers expire. Registry
entries are used to set the SP timers.
Although the host removes the application from the Suspend state,
a command to change the mode (Supervisor, In Service, Out of
Service, Initialise or Power-up) will not be actioned nor will a Ready
9 response be sent until the SP has cleared the device Suspend state.
When the Suspend state is cleared, Advance NDC responds to the
terminal command and then sequentially processes all other
messages received.
Setting the Service
Provider Timeout
5
The Suspend Timeout registry entry is located in the
GENERAL_CONFIGS subkey for each supported SP. The default
timeout duration for Advance NDC is 120 seconds, which is the
minimum duration recommended in Advance NDC. For more
information about setting the Suspend Timeout registry entry, refer
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-82
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Suspend Timeout
to the APTRA on-line documentation, under APTRA XFS |
Programmers Reference | XFS Service Providers.
Ensure that the SP timers are set to a value greater than the time it
takes to complete a transaction. If the value is less, the application
will not enter the Suspend state even though the host receives a
Suspend message. This is the equivalent of the application going
into a Suspend state and coming out again after a very short
application timeout.
Note: The SP Suspend Timeout for recycling units is set by
Advance NDC to the maximum limit of 900 seconds. This means
that Advance NDC can issue the reset command to bring the
recycling unit out of suspend in any of the following situations:



A go in service or go out of service message is sent
The timeout for Advance NDC expires
Supervisor mode is entered or exited.
For more information, see “GBXX Cassette Configuration” on
page 5-241.
For more information about Suspend time outs, refer to the
Extensions for Financial Services (XFS) interface specification (CWA
14050).
Setting the Application
Timeout
5
The Advance NDC application timeout is set to 5 minutes (300
seconds). The timer can be changed through the Author (Timer
worker “5 Mins”). The application timeout must always be longer
than that of the service provider (SP). This will allow the SP to clear
the device ready for use by the application. If the application timer
setting is less than the SP timer, the application will stay in the
Suspend state until the SP timer expires. Moreover, if the host sends
a GIS or OOS message, the SST will stay in Suspend mode until the
SP timer expires.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-83
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
Configuring Supervisor
Functionality
This section describes the functionality that can be configured for
Supervisor.
Where configuration is done using the class configurator file,
default configuration settings are included in the AdvanceNDC.accfg
file installed with Advance NDC. For information on the
AdvanceNDC.accfg file see “.NET Class Configurator Files” on
page 5-37.
Settlement Screen
Customisation
5
The Supervisor settlement screens can be configured. Changing
these screens may overwrite the input data, or result in
misalignment. If this happens, update the Operator Echo workers in
the Application Core to reposition the input data. The affected
screens and associated workers are shown in Table 5-23.
Table 5-23
Correcting Settlement Screen
Customisation Misalignment
Screen Number
Operator Echo Worker Name
i93
One Key Input: 1
i94
32 Key Input
i95
i98
8 Key Input
12 Key Input
For further information on the screens, refer to the APTRA Advance
NDC, Reference Manual. For further information on the workers,
refer to the Author on-line help.
Extended Add Cash
Option
5
The Extended Add Cash option on the Configure menu in
Supervisor is offered, in particular, for use on multi-vendor
networks. It can be configured as follows:

The currencies that are displayed on the Update SP Currency ID
screen are configurable using the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\supervisor\CurrencyIDs

The names used to identify the physical position of the cassettes
are configurable using the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\Physical Cassettes
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-84
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality

The currencies that are displayed on the Update Currency ID
screen are configurable using the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\CurrencyIDs
This key contains four entries. If a value is changed, the currency
ID must be a valid ISO currency code.
For more information about the Extended Add Cash Supervisor
option, refer to the APTRA Advance NDC, Supervisor’s Guide.
For more information about configuring currencies on other
vendors’ SSTS, refer to the APTRA Advance NDC, Multi-Vendor
Support Reference Manual.
Rear Settlement
5
Rear settlement is available on DAPI 7 firmware only. To configure
the PIN Entry and PIN Block for rear settlement transactions, use
the following:
PIN Entry
5
To configure PIN entry on the rear display of an SST with a
PCI-compliant EPP, use the EnhancedOptionDigit6A entry under
the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\supervisor\Rear Settlement
The default value is 0 which is used if the entry does not exist or if it
contains an invalid value. If the value is set to 0, the value is ignored
and PIN entry is required at the front interface only.
If the value is set to 1, PIN entry can be performed at the rear
interface. A dummy PIN block is included in the Transaction
Request Message if Message Mode Option digit 6A is
enabled.Details of the option digit are given in Appendix
Dummy PIN Block
5
To configure the number of zeros to include in a dummy PIN block
in the Transaction Request Message, use the DummyPINBlockZeros
entry under the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\supervisor\Rear Settlement
Valid values are 1 to 32. The default value is 6, which is used if the
key does not exist or if it contains an invalid value.
Supervisor Alphanumeric
Data Entry
Alphanumeric data entry is supported in the SMS style using either
numeric keys or through a PC keyboard if one is available.
5
As well as alphanumeric input in the range 0-9, A-F, the SMS
keyboard input system allows users to enter data in the full
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-85
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
alphanumeric range (0-9, a-z and A-Z). The SMS keyboard system
also supports data entry using a PC keyboard.
SMS-style data entry is enabled by default and the data is collected
and processed by an SMS Data Collector worker. This worker is
configured through an XML configuration file,
SupervisorKeyboard.xml, which is provided in Advance NDC in
C:\Program Files\NCR APTRA\Advance NDC\Config. The XML
defines the alphanumeric values associated with each key, as
described in “Supervisor Keyboard XML Configuration File” below.
An associated XML schema file, SupervisorKeyboard.xsd, is also
provided in the same location to validate SupervisorKeyboard.xml.
The schema ensures that all values are within defined ranges, and
all required entries are present, and in their correct location.
The configuration file can be updated locally or through XML
Configuration Download message from the host. For details of the
XML envelope that must be used with this configuration file, see
“XML Configuration Files” on page 5-34. For details of XML
Configuration Download, refer to the APTRA Advance NDC,
Reference Manual.
Supervisor Keyboard XML Configuration File
<?xml version="1.0" encoding="utf-8"?>
<SupervisorKeyboard
xmlns=http://www.ncr.com/APTRA/NDC/SupervisorKeyboard
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.ncr.com/APTRA/NDC/
SupervisorKeyboard SupervisorKeyboard.xsd">
<SupervisorKeyboardType>SMS</SupervisorKeyboardType>
<SMSKeyboardConfiguration>
<SMSKeyboardLayout>
<Key0>0</Key0>
<Key1>1</Key1>
<Key2>abc2</Key2>
<Key3>def3</Key3>
<Key4>ghi4</Key4>
<Key5>jkl5</Key5>
<Key6>mno6</Key6>
<Key7>pqrs7</Key7>
<Key8>tuv8</Key8>
<Key9>wxyz9</Key9>
</SMSKeyboardLayout>
<SMSEntryDelay>2000</SMSEntryDelay>
<SMSKeypressBeep>KeypressBeep1</SMSKeypressBeep>
<SMSNextCharBeep>NextCharBeep1</SMSNextCharBeep>
</SMSKeyboardConfiguration>
</SupervisorKeyboard>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-86
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
Table 5-24
Supervisor Keyboard: Elements
Element
Description
Range of Values
Default Value
SupervisorKeyboardType
Specifies the keyboard type:
If SMS, input is through the TTU or
the PINpad depending on the
interface.
If PCKeyboard, input is through
the standard PC keyboard
regardless of the interface.
SMS
PCKeyboard
SMS
SMSKeyboardConfiguration
SMS-style keyboard configuration
information, with the following
nested elements:

SMSKeyboardLayout

SMSEntryDelay

SMSKeypressBeep

SMSNextCharBeep
-
-
SMSKeyboardLayout
Defines the key mapping, with
Key0 to Key9 nested
-
-
Key0
SMS character string representing
one or more indexed characters
when key 0 is pressed; must be
lowercase
Any string
0
Key1
SMS character string representing
one or more indexed characters
when key 1 is pressed; must be
lowercase
Any string
1
Key2
SMS character string representing
one or more indexed characters
when key 2 is pressed; must be
lowercase
Any string
abc2
Key3
SMS character string representing
one or more indexed characters
when key 3 is pressed; must be
lowercase
Any string
def3
Key4
SMS character string representing
one or more indexed characters
when key 4 is pressed; must be
lowercase
Any string
ghi4
Key5
SMS character string representing
one or more indexed characters
when key 5 is pressed; must be
lowercase
Any string
jkl5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-87
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
Element
Description
Range of Values
Default Value
Key6
SMS character string representing
one or more indexed characters
when key 6 is pressed; must be
lowercase
Any string
mno6
Key7
SMS character string representing
one or more indexed characters
when key 7 is pressed; must be
lowercase
Any string
pqrs7
Key8
SMS character string representing
one or more indexed characters
when key 8 is pressed; must be
lowercase
Any string
tuv8
Key9
SMS character string representing
one or more indexed characters
when key 9 is pressed; must be
lowercase
Any string
wxyz9
SMSEntryDelay
Defines the delay in milliseconds
between a key being pressed and
the SMS character being processed
as input.
2000—5000
2000
SMSKeypressBeep
Defines whether a beep is sounded
when a key press occurs
NoKeypressBeep
KeypressBeep1
KeypressBeep1
SMSNextCharBeep
Defines whether a beep is sounded
when a series of keystrokes is
converted into an SMS character
and accepted as input
NoNextCharBeep
NextCharBeep1
NextCharBeep2
NextCharBeep3
NextCharBeep4
NextCharBeep1
For details of the SMS Data Collector worker, see “Self-Service
Core” on page B-16, and refer to the Self-Service Core Worker Class
Help in the APTRA Author.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-88
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
.NET Supervisor Task
5
You can extend the functionality of Advance NDC by integrating an
existing .NET Supervisor task or developing a new .NET Supervisor
task.
Developing a New .NET Supervisor Task
5
To be valid a new .NET Supervisor task must conform to the SPL
guidelines for a Supervisor function and implement the
ISupervisorTask interface. For information about SPL guidelines,
refer to the following:


Software Engineering Institute web site
SPL Development Rules and Conventions (NCR intranet users
only)
The .NET Supervisor task inherits from
NCR.APTRA.SupervisorTaskCore.StandardTask class which is
located in the NCR.APTRA.SupervisorTaskCore.dll.
Integrating New or Existing .NET Supervisor Tasks
5
Advance NDC executes a .NET Supervisor task through either the
Supervisor Exit Executor worker or the Supervisor Task Executor
worker. The configuration required for the .NET Supervisor task
must be added to AdvanceNDC.accfg file so that the Supervisor Task
Executor and the Supervisor Exit Executor can refer to the task from
the authored flow.
If printing to journal or receipt printer is required, each .NET
Supervisor task must identify the Journal Service and Receipt
Service, as shown in the following example from the
AdvanceNDC.accfg file showing the StartInvestigation and
DeleteInvestigation class definitions:
<Class ID="StartInvestigation"
Name="NCR.APTRA.PDCSupportTasks.StartInvestigation"
Assembly="NCR.APTRA.PDCSupportTasks.dll">
<Interface>
<Property Name="UserActivityTimeout" Value="0"/>
<Property Name="DisplayTimeout" Value="0"/>
<Property Name="JournalService"
Value="FormattedJournalService"/>
</Interface>
</Class>
<Class ID="DeleteInvestigation"
Name="NCR.APTRA.PDCSupportTasks.DeleteInvestigation"
Assembly="NCR.APTRA.PDCSupportTasks.dll" >
<Interface>
<Property Name="UserActivityTimeout" Value="0"/>
<Property Name="DisplayTimeout" Value="0"/>
<Property Name="JournalService"
Value="FormattedJournalService"/>
</Interface>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-89
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
</Class>
The default settings for the FormattedJournalService class are also
provided in AdvanceNDC.accfg.
The SupervisorTaskWrapper class is defined in AdvanceNDC.accfg
as follows:
<Class ID="SupervisorTaskWrapper"
Name="NCR.APTRA.NDC.SupvTaskWrapper.SupervisorTaskWrapper"
Assembly="NCR.APTRA.NDC.SupvTaskWrapper.dll">
<Interface>
<Property Name="CIFRenderer"
Value="ConsumerGUIRenderer" IsLink="true"/>
<Property Name="TTURenderer"
Value="OperatorTextRenderer" IsLink="true"/>
</Interface>
</Class>
Table 5-25
Property
Description
CIFRenderer
The consumer interface renderer to be used if on the
front interface
TTURenderer
The renderer for the text terminal unit (TTU) to be
used if on the rear interface
SupervisorTaskWrapper Properties
The properties defined by the SupervisorTaskWrapper class are
used to configure all .NET Supervisor tasks that are subsequently
executed by any Supervisor Task Executor or Supervisor Exit
Executor.
The configuration of the .NET Supervisor task to be executed will
vary for each Supervisor task. For more information, refer to the
.NET Supervisor Tasks On-line Documentation.
Supervisor Exit Executor This worker allows Activate .NET
Supervisor tasks to be configured and executed in the same way as a
Supervisor Exit, without any additional authoring updates.
However, like the execution of Supervisor Exits, only the top two
levels of the Supervisor menus can be configured to execute a .NET
Supervisor task.
Supervisor Task Executor This worker requires additional
authoring in the Supervisor project to implement the required
functionality, but the .NET Supervisor task can be executed
anywhere in the application flow.
For information about configuring SUPCTR to enable the
Supervisor Exit Executor to execute .NET Supervisor tasks, refer to
to the publication APTRA Advance NDC, Extending the Product,
chapter 8, “Developing Exits for Supervisor Functions”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-90
APTRA Advance NDC, Developer’s Guide
5
5
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
For information about the Supervisor Exit Executor and Supervisor
Task Executor, refer to the on-line help in the APTRA Author.
.NET Software Updates
5
Advance NDC uses the .NET Software Update Tasks component to
install or update software and configuration files (without the need
to use a PC keyboard) on an SST from a removable medium such as
a diskette, CD-ROM or USB stick.
As the .NET Software Update Service is installed and run as a
Windows service by default, the .NET Software Update Tasks
component uses it to install or update software on an SST without
requiring Advance NDC to run with administrator privileges.
For details of configuring the .NET Software Update Service, see
“.NET Software Update Service” on page 5-93.
For more information about the functionality of the .NET
components, refer to the following:


.NET Software Update Tasks On-line Documentation
.NET Software Update Service On-line Documentation.
In Advance NDC, the software update functionality is disabled by
default. If enabled, access to it from the Misc Funcs menu in
Supervisor, requires secure authentication (user ID and password).
Any text terminal unit (TTU) screen definitions associated with
running files or copying files must be present in the
NCR.APTRA.SoftwareUpdateTasks.frmttu file in the C:\Program
Files\NCR APTRA\Printing\TTU\Forms folder.
Configuring the Installation Script
5
By default, selecting the Run Executable File option in Supervisor
runs install.bat if it is found on the removable medium. To run a
different file, edit the InstallScript property in
AdvanceNDC.accfg.
The default entry is as follows:
<Class ID="RunExecutableFile"
Name="NCR.APTRA.SoftwareUpdateTasks.SoftwareUpdateTasks"
Assembly="NCR.APTRA.SoftwareUpdateTasks.dll">
<Interface>
...
<Property Name="InstallScript" Value="install.bat"/>
</Interface>
</Class>
Enabling the Software Update Function To enable the function,
update the SoftwareUpdateEnabled property in
AdvanceNDC.accfg to False, as follows:
5
<!-- Software Update Tasks - Run Executable File -->
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-91
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
<Class ID="RunExecutableFile"
Name="NCR.APTRA.SoftwareUpdateTasks.SoftwareUpdateTasks"
Assembly="NCR.APTRA.SoftwareUpdateTasks.dll">
<Interface>
<Property Name="SoftwareUpdateService"
Value="SWUpdateService"/>
<Property Name="SoftwareUpdateEnabled" Value="True"/>
<Property Name="InstallScript" Value="install.bat"/>
<Property Name="InstallationRootDirectory" Value=""/>
<Property Name="UserActivityTimeout" Value="0"/>
<Property Name="VerifySignature" Value="True" />
</Interface>
</Class>
Configuring the Copy File Directory
5
By default, the .NET Software Update Tasks component copies files
to the following:
C:\Program Files\NCR APTRA\Advance NDC\UpdateSoftware.
To change the destination folder, edit the
InstallationRootDirectory property in AdvanceNDC.accfg.
The default entry is as follows:
<Class ID="Copy Files"
Name="NCR.APTRA.SoftwareUpdateTasks.SoftwareUpdateTasks"
Assembly="NCR.APTRA.SoftwareUpdateTasks.dll">
<Interface>
...
<Property Name="InstallationRootDirectory"
Value="C:\program Files\NCR APTRA\Advance
NDC\UpdateSoftware "/>
</Interface>
</Class>
Enabling File Copy To enable file copying, update the
SoftwareUpdateEnabled property in AdvanceNDC.accfg to True,
as follows:
<!--Software Update Tasks - Copy File -->
<Class ID="CopyFiles"
Name="NCR.APTRA.SoftwareUpdateTasks.SoftwareUpdateTasks"
Assembly="NCR.APTRA.SoftwareUpdateTasks.dll">
<Interface>
<Property Name="SoftwareUpdateService"
Value="SWUpdateService"/>
<Property Name="SoftwareUpdateEnabled" Value="True"/>
<Property Name="InstallScript" Value=""/>
<Property Name="InstallationRootDirectory"
Value="C:\program Files\NCR APTRA\Advance
NDC\UpdateSofware"/>
<Property Name="UserActivityTimeout" Value="0"/>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-92
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
<Property Name="VerifySignature" Value="True" />
</Interface>
</Class>
For details of the Software Update menu functions in Supervisor,
refer to the APTRA Advance NDC Supervisor’s Guide.
.NET Software Update Service
5
If the .NET Software Update Service is not installed, updates can be
performed but with the same access restrictions as Advance NDC. If
the user account that Advance NDC runs under has sufficient
privileges, the .NET Software Update Service does not need to be
installed.
Configuring .NET Software Update Service The .NET Software
Update Service is configured through the property, UseService,
which specifies whether it must be used or not. By default, the
UseService property has a value of False, as follows:
5
<!-- Software Update service -->
<Class ID="SWUpdateService"
Name="NCR.APTRA.SWUpdateSrv.SWUpdate"
Assembly="NCR.APTRA.SWUpdateSrv.dll">
<Interface>
<Property Name="UseService" Value="False"/>
</Interface>
</Class>
This means that the update will be performed under the user
account that Advance NDC runs under and with the same
restrictions.
If UseService is set to True, the .NET Software Update Service will
always be used to perform the update and any installation will be
run with the full system privileges available under the Local System
user account. If the .NET Software Update Service is not installed,
registered and running, the update will fail.
For Advance NDC to be PCI compliant, the Signature Verification
Service must be used as described in the following section. For
further information, refer to the APTRA Advance NDC, Payment
Application Data Security Standard Implementation Guide.
Security Considerations
5
It is acceptable for file copying to be performed under the Local
System user account as the directory is specified by the task, but
install script updates can be used to run any commands. Security is
maintained by the VerifySignature property under the
RunExecutableFile and CopyFiles class IDs. By default, the
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-93
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
VerifySignature property has a value of True, meaning that
signature verification is required, as follows:
<Property Name="VerifySignature" Value="True" />
Signature Verification Service The NCR Signature Verification
Service component verifies the signature on signed files to ensure
that they have not been maliciously altered or accidentally
corrupted since the time of signing.
5
Software developed by NCR is not signed, and will fail verification
by the Signature Verification Service component unless signed
before verification. It is the responsibility of the financial institution
to ensure files are signed before installation. For further
information, refer to the NCR Signature Verification Service On-line
Documentation.
The Signature Verification Service component requires signed files
to be one of the following types:



.cab
.exe
.msi
Compatibility with Other Products The .NET Software Update
Tasks component is compatible with SolidCore for APTRA and
Security for APTRA. The .NET Software Update Tasks component
does not perform any security validation of the installation medium
before installing or copying files.
5
The .NET Software Update Service has no means of validating batch
files or executables, which will run with system-wide privileges and
are able to perform any action. It is the client application's
responsibility to validate the batch file or executable if required.
Software signing works and integrates with Security for APTRA
and Solidcore for APTRA.
Promote/Copyfile
5
The Promote/Copyfile option on the Supervisor Access menu uses a
.NET Supervisor task to interact with APTRA Promote. This option
is configured using the AdvanceNDC.accfg file.
Configuring the Export File Path
The details of the APTRA Promote screens played and coupons
printed are stored in the presentation log. The presentation log is
exported to a filename of the following format:
<MachineNumber>_Summary_<StartDate>_<EndDate>.arulog
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-94
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
The format for a presentation log for the 28th June 2011 created on
machine number WINAC185092-ZNV, for example, would be as
follows:
WINAC185092-ZNV_Summary_26-06-2011_28-06-2011.arulog
When the Extract Presentation Log option is selected, the
presentation log is exported to the path defined in the
ConfigurableExportFilePath property of the
PromoteOrCopyFile class. By default, this is set as follows:
<PropertyName="ConfigurableExportFilePath"
Value="C:\Program Files\NCR APTRA\Advance NDC\Data\
PresentationLog"/>
To set a different path, edit this entry in the AdvanceNDC.accfg file.
Relate Supervisor Option
5
The Relate option on the Supervisor Access menu uses a .NET
Supervisor task to enable or disable APTRA Relate. This option is
configured using the AdvanceNDC.accfg file.
By default, APTRA Relate is disabled. If you need to enable APTRA
Relate and cannot use the Supervisor menu, update the value of the
ServiceEnabled property under the
NCR.APTRA.TMSCustomerPowerTMSrv class as follows:
<PropertyName="ServiceEnabled" Value="true"/>
Configuring Multiple
Destination Screens to
Display Fixed Drives
5
Advance NDC can be configured to show or hide fixed drives. By
default, fixed drives are displayed but this can be changed to avoid
files being saved by mistake to a fixed drive. To change the display
of fixed drives, use the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\HideFixedDrives
Valid values are as follows:


0 = Display the fixed drives on the SST (default)
1 = Do not display the fixed drives on the SST.
Changing this setting affects the following Supervisor menus:
Configuring the Default
Location for Note
Signatures
5

INIT EJRNL (Initialise electronic journal) on Replenish Menu

RCOPY EJRNL (Recopy Electronic Journal) on Replenish menu

COPY ON/OFF on the Dialup Configuration menu

COPY LOGS on Silent Debug menu

RECONFIGURE on Silent Debug menu.
The Create Signatures option in Supervisor prompts the operator to
select a destination for the signatures. One option is the
pre-configured location on a fixed drive, which is displayed as
‘DEFAULT LOCATION’ in the Supervisor task.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-95
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality
Advance NDC is installed with a default location of C:\Program
Files\NCR APTRA\Advance NDC\Data\Signatures. This can be
changed by editing the CreateSignaturesPath property in
CashInCustom.accfg, as follows:
<Class ID="CreateSignatures"
Name="NCR.APTRA.ECB6SupervisorTasks.CreateSignatures"
Assembly="NCR.APTRA.ECB6SupervisorTasks.dll">
<Interface>
<Property Name="CreateSignaturesPath" Value=" C:\Program
Files\NCR APTRA\Advance NDC\Data\Signatures "/>
<!-- Property Name="AutoSelectSignaturePath"
Value="false"/-->
</Interface>
</Class>
To automatically select the destination defined in the
CreateSignaturePath property during execution of the Create
Signatures Supervisor option, complete the following:
Configuring the Location
and Format of Extracted
Signatures
1
Uncomment the AutoSelectSignaturesPath property
2
Update the value to true.
The Extract Signatures option in Supervisor copies signatures
recorded to a database during transactions to a selected destination.
5
Advance NDC is installed with a default location of C:\Program
Files\NCR APTRA\Advance NDC\Data\Signatures. This can be
changed by editing the ExtractSigsOutputPath property in
CashInCustom.accfg, as follows:
<Class ID="ExtractSignatures"
Name="NCR.APTRA.ECB6SupervisorTasks.CreateSignatures"
Assembly="NCR.APTRA.ECB6SupervisorTasks.dll">
<Interface>
<Property Name="ExtractSigsOutputPath"
Value=" C:\Program Files\NCR APTRA\
Advance NDC\Data\Signatures "/>
<!--Property Name="CompressToCab" Value="true"/-->
<!--Property Name="OutputFileName"
Value="ECBExt.xml"/-->
</Interface>
</Class>
Two properties are commented out in the above extract. These can
be used by uncommenting and configuring them as follows:

The CompressToCab property defines whether the extracted
signature file is to be saved as a zipped file. By default, the file
will not be saved as a zipped file
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-96
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Supervisor Functionality

Configuring Supervisor
Entry/Exit Message
5
The OutputFileName property defines the name of the saved
file. By default, the filename is ECBExt.xml. You can change the
filename if required.
A simulated Supervisor Entry/Exit message is sent to the host
during automatic error recovery for a device. If the device is not
recovered, no simulated Supervisor Entry/Exit message is sent.
A simulated Supervisor Entry/Exit message is also sent when a
24-volt reset is initiated or when an mStatus of 35 is generated.
To distinguish between an unsolicited sensors status message sent
to Central when a Supervisor mode change occurs and a simulated
Supervisor Entry/Exit, an extra field can be configured using the
following DWORD registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\
EnableAERFlagDuringSimSupervisor
Valid values are as follows:


0 = Send P21 and P20 messages for both Supervisor mode
changes and simulated Supervisor Entry/Exit (default)
1 = Send P21 and P20 messages for Supervisor mode changes
and P211 and P201 messages for simulated Supervisor
Entry/Exit.
If an invalid value is specified or the key does not exist, the default
value is used. This key has no impact on the Supervisor Entry/Exit
message during Supervisor mode change.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-97
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Configuring Cardholder
Functionality
This section describes configuration details for cardholder
functionality.
Where configuration is done using the class configurator file,
default configuration settings are included in the AdvanceNDC.accfg
file installed with Advance NDC. For information on the
AdvanceNDC.accfg file see “.NET Class Configurator Files” on
page 5-37.
Configuring Input Type,
Buffer and Display Format
5
The format of cardholder input that is echoed on the screen is
defined using table entry 9 of the Information Entry state table. The
format defined in this state table can be overridden using the
DisplayDataFormat.xml file which can be updated locally or through
XML Configuration Download message from the host. To use the
values defined in table entry 9, the the DisplayDataFormat.xml must
match the state table or contain invalid XML.
For details of the XML envelope that must be used with this
configuration file, see “XML Configuration Files” on page 5-34. For
details of the XML Configuration Download, refer to the APTRA
Advance NDC, Reference Manual.
If the DisplayDataFormat.xml file is invalid, the values defined in
table entry 9 of the Information Entry state are used. For details of
the Information Entry state, refer to Chapter 2, “State Tables” in the
APTRA Advance NDC, Reference Manual.
The DisplayDataFormat.xml file is stored in the following location:
C:\Program Files\NCR APTRA\Advance NDC\Config
The schema, DisplayDataFormat.xsd, defines the structure of the
configuration data for the keyboard. The defaults stated in the
following table are the settings provided in the file installed with
Advance NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-98
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Table 5-26
Display Data Format XML Schema
Element
Description
DisplayData
The whole file is embedded within DisplayData tags.
This is the root element
Nested elements:

StateNumber
StateNumber
Defines the state number to which the formatting applies.
The format is defined using the following attributes:

InputFormat. Mandatory. Defines the format of the display of cardholder
input. The characters entered by the cardholder are represented by asterisks
(*). The maximum length of data is defined by the number of asterisks and
the number of asterisks cannot exceed 32. If this attribute is not defined or
the number of asterisks exceeds 32, the XML is considered to be invalid.

EntryType. Optional. Defines whether the entered information is numeric
or alphanumeric. Valid values are as follows:
Numeric
Alphanumberic.

DataBuffer. Optional. Defines the data buffer to use to store the
cardholder input. Valid values are as follows:
B
C.

ReplaceChar. Optional. Defines the character to use when masking the
cardholder input. If this attribute is set to blank (“”), no masking is applied.
Cardholder Alphanumeric
Data Entry
Various options are available for consumer data entry, as follows:

5


SMS-style data entry
PC keyboard
Touch-screen keyboard
SMS-style data entry using the numeric keypad is supported
through entry 9 of the Information Entry (‘H’) state table or the
DisplayDataFormat.xml file described in “Configuring Input Type,
Buffer and Display Format” on page 5-98.
Data entry using a PC keyboard is also supported through entry 9 of
the Information Entry state table or the DisplayDataFormat.xml file.
For a touch-screen keyboard, the Information Entry screen must be
updated or defined as a new screen. For details, see “Touch-screen
Keyboards for Alphanumeric Data Entry” on page 5-124.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-99
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Configuring SMS-style Data Entry or PC Keyboard
SMS-style data entry and PC keyboard configuration are defined in
the NDCKeyboard.xml file, which can be updated locally or through
XML Configuration Download message from the host.
For details of the XML envelope that must be used with this
configuration file, see “XML Configuration Files” on page 5-34. For
details of the XML Configuration Download, refer to the APTRA
Advance NDC, Reference Manual.
The NDCKeyboard.xml file is stored in the following location:
C:\Program Files\NCR APTRA\Advance NDC\Config
The keyboard schema, NDCKeyboard.xsd, defines the structure of the
configuration data for the keyboard.
Table 5-27
NDC Keyboard XML Schema
Element
Description
NDCKeyboard
The whole file is embedded within NDCKeyboard tags.
This is the root element
Nested elements:



AlphanumericEntryStyle
AlphanumericEntryStyle
PCKeyboardConfiguration
SMSKeyboardConfiguration
Defines the type of alphanumeric entry.
Valid values are as follows:
SMS - Enter information using SMS-style alphanumeric input (default)
PCKeyboard - Enter information using a PC keyboard
PCKeyboardConfiguration
Contains the PC keyboard configuration information.
Nested elements:


MakeUppercase
MakeUppercase
JournalEntry
Defines whether to display all input in upper case.
Valid values are as follows:
true - Display alpha characters in uppercase irrespective of the position of the
Caps Lock or Shift key (default)
false - Display alpha characters in upper and lower case, as normal using a PC
keyboard
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-100
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Element
Description
JournalEntry
Defines whether to journal the message.
Valid values are as follows:
true - Journal the message
false - Do not journal the message (default)
SMSKeyboardConfiguration
Contains the SMS-style keyboard configuration information.
Nested elements:

SMSKeyboardLayout

EntryDelay

Timer0Multiplier

Cursor

JournalEntry
SMSKeyboardLayout
Contains the mapping of the keys.
Nested elements:

Key0

Key1

Key2

Key3

Key4

Key5

Key6

Key7

Key8

Key9
Key0
Defines the characters displayed when Key 0 is pressed.
By default, this is 0.
Key1
Defines the characters displayed when Key 1 is pressed.
By default, this is 1QZ.
Key2
Defines the characters displayed when Key 2 is pressed.
By default, this is 2ABC.
Key3
Defines the characters displayed when Key 3 is pressed.
By default, this is 3DEF.
Key4
Defines the characters displayed when Key 4 is pressed.
By default, this is 4GHI.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-101
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Element
Description
Key5
Defines the characters displayed when Key 5 is pressed.
By default, this is 5JKL.
Key6
Defines the characters displayed when Key 6 is pressed.
By default, this is 6MNO.
Key7
Defines the characters displayed when Key 7 is pressed.
By default, this is 7PRS.
Key8
Defines the characters displayed when Key 8 is pressed.
By default, this is 8TUV.
Key9
Defines the characters displayed when Key 9 is pressed.
By default, this is 9WXY.
EntryDelay
Defines the delay in milliseconds between key presses before the cursor is
displayed at the next character location.
The default delay is 2000 milliseconds. The minimum delay that can be defined
is 500 milliseconds and the maximum is 5000 milliseconds.
Timer0Multiplier
Defines the multiplier used to extend Timer 00 when using this timer as an
overall timeout for the character entry.
The default multiplier is 2.0.
For more information on Timer 00, refer to the APTRA Advance NDC,
Reference Manual.
Cursor
Defines the symbol to use as the cursor. The cursor is displayed in the position
to be used when the next character is entered.
Any single character can be used. By default, the asterisk (*) character is used.
JournalEntry
Defines whether to journal the message.
Valid values are as follows:
true - Journal the message
false - Do not journal the message (default)
Cardholder Verification
State in STCONT
5
The entry in STCONT for the Cardholder Verification state allows
cardholder verification by Central for transactions such as web
transactions to be processed on another host. This reduces the
burden of authorisation and identification on the other host.
This state can be managed through local customisation, described in
“Specifying Local Customisation Data” on page 5-21, without the
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-102
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
host downloading any additional data. It can be used in conjunction
with the Web Exit state, described in “Cardholder Alphanumeric
Data Entry” on page 5-99, to process web-based transactions. A
typical local customisation might be to add a sequence of states
(Pre-Set Operation Code -> Cardholder Verification ->Web Exit) to a
selection in the main cardholder menu.
Cardholder verification state type 1 is defined in STCONT as
follows:
1NState Cardholder Authorised
VerificationApplicationLink0ZZZ0099900ZZZ00ZZZ00ZZZ000000
0000000000
To change this state to state type O, change the number ‘1’ in
‘1NState’ to the letter ‘O’.
The name of the application DLL built for this state is
StateCardholderAuthorisedVerification.dll.
For further information on the Cardholder Verification state, see
Appendix G, “User-Configurable States”.
Confirmation Screens
During Cash Deposit
The following two screens are configured for use with the Cash
Accept state:
5


Confirmation screen
ECB 6 screen.
The properties described in the following sections are configured
using the CashInCustom.accfg file.
For details of the Cash Accept state, refer to Chapter 2, “State
Tables”, in the APTRA Advance NDC, Reference Manual. For details
of the timers used during the execution of this state, refer to Chapter
7, “Configuration Parameters”, in the APTRA Advance NDC,
Reference Manual.
Cash Accept Screen Formatter Classes
5
The ConfirmationScreenDialog class delegates the formatting of
the dynamic screen data to the ConfirmationScreenFormatter
and CounterfeitNotesRetainedScreenFormatter classes.
The following table describes the properties of the
ConfirmationScreenFormatter and
CounterfeitNotesRetainedScreenFormatter classes.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-103
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Table 5-28
Cash Accept Screens Formatting
Properties
Property
Description
IncludeAllAcceptableDenominations
Used by the ConfirmationScreenFormatter class
Defines whether denominations that are not stored in the
escrow are listed on the screen
Return type: bool
Default: false
TemplateForReportLine
Used by the ConfirmationScreenFormatter class
Defines the string template used when the screen is formatted
for each denomination
Composite formatting rules are used
See Table Note 1 for information on composite formatting rules
Return type: string
Default: "{0,3} {1,3} X {2,3} = {3,5}"
The object list contains the following items:

0 - denomination

1 - currency ID

2 - number of notes

3 - total value of denomination
The default formats the display of denominations as follows:
10 PLN X
1 =
10
This display is derived from the default as follows:

10 is the three-character denomination defined by {0,3}

PLN is the three-character currency ID defined by {1,3}

The three-character note count defined by {2,3} is
" 1"

The five-character total value of the currency defined by
{3,5} is "
10"
TemplateForTotalLine
Used by the ConfirmationScreenFormatter class
Defines the template to use for the value of the currency
Composite formatting rules are used
See Table Note 1 for information on composite formatting rules
Return type: string
Default: "TOTAL = {1,5} {0,3}"
The object list contains the following items:

0 - currency ID

1 - total value of currency

2 - total number of notes of this currency
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-104
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Property
Description
TemplateForSummaryLine
Used by the ConfirmationScreenFormatter class
Defines the string template used when the screen is formatted
for each currency
Composite formatting rules are used
See Table Note 1 for information on composite formatting rules
Return type: string
Default: "{0,3} = {1,5}"
The object list contains the following items:

0 - currency ID

1 - total value of this currency

2 - total number of notes of this currency
TemplateForTotalRetainedLine
Used by both the ConfirmationScreenFormatter and the
CounterfeitNotesRetainedScreenFormatter classes
Defines the string template used to report retained notes when
the ECB 6 regulations are applied
Composite formatting rules are used
See Table Note 1 for information on composite formatting rules
Return type: string
Default: "NOTES RETAINED = {0,3}"
The object list contains the following items:

0 - total number of retained counterfeit and suspect notes

1 - number of retained counterfeit notes

2 - number of retained suspect notes
TemplateForRemainingAmountLine
Used by the ConfirmationScreenFormatter class
Defines the string template used to report the difference
between the Amount buffer and the amount that has been
depsosited so far in a direct deposit transaction
This is evaluated only when the Amount buffer is not zero and
the current operation is a single currency direct deposit
Composite formatting rules are used
See Table Note 1 for information on composite formatting rules
Return type: string
Default: empty string
The object list contains the following items:

0 - currency ID

1 - Amount buffer (decimal)

2 - amount deposited (decimal)

3 - remaining amount (decimal)
ReportHeader
Used by both the ConfirmationScreenFormatter and the
CounterfeitNotesRetainedScreenFormatter classes
Defines the string used as the heading of the screen
Return type: string
Default: empty string
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-105
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Property
Description
ReportFooter
Used by both the ConfirmationScreenFormatter and the
CounterfeitNotesRetainedScreenFormatter classes
Defines the string used as the footer of the screen
Return type: string
Default: empty string
FormatterID
Used by the ConfirmationScreenFormatter class
Defines a unique identifier for the formatter used to map the
screen offset for the chosen language
NumberOfAvailableLines
Used by the ConfirmationScreenFormatter class
Defines the number of lines available on the screen for the
confirmation screen data.
This is used when the formatter switches between detailed and
summary mode. When the number of inserted denominations
plus one line exceeds this number, the display switches to
display items by currency. If UseSummaryOnly is set, this is
ignored
Caution: This property must be set only after careful analysis
of the screen data sent by the host and the number of accepted
denominations and currencies. If this is set incorrectly, screen
corruption can occur and the data on the confirmation screen
may be displaced or not visible.
Return type: integer
Default: 8
Culture
Used by both the ConfirmationScreenFormatter and the
CounterfeitNotesRetainedScreenFormatter classes
Defines the formatter used for number formatting.
Return type: string
Default: empty string
The culture code is a combination of an ISO 639 two-letter
lowercase culture code associated with a language and an ISO
3166 two-letter uppercase sub-culture code associated with a
country or region. For example "es-AR" configures number
formatting for Argentina.
Translator
Used by both the ConfirmationScreenFormatter and the
CounterfeitNotesRetainedScreenFormatter classes
The component used for the translation and formatting of
dynamic data after all other formatting is applied. The
translator object implements the IFormatProvider and
ICustomFormatter interfaces
Return type: IFormatProvider
Default:
NCR.APTRA.NDC.CashInFlows.NDCScreenDataTranslator
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-106
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Property
Description
IncludeNotesRetainedCount
Used by the ConfirmationScreenFormatter class
Defines whether to list the number of retained notes on the
screen.
Return type: bool
Default: true
UseOnlySummary
Used by the ConfirmationScreenFormatter class
Defines whether switching to reporting per denomination is
permitted.
Return type: bool
Default: true
NoReturnableNotesMessage
Used by the ConfirmationScreenFormatter class
Defines the message displayed when only counterfeit notes are
accepted and the accepted notes report is empty.
Return type: string
Default: " "
ShowOnlyWhenCounterfeit
Used by the
CounterfeitNotesRetainedScreenFormatter class
Defines whether the ECB 6 screen is displayed only when
counterfeit notes are detected, or when counterfeit and/or
suspect notes are detected
Return type: bool
Default: false
Table Note 1: Composite formatting uses strings and object lists.
For full details on composite formatting, refer to
http://msdn.microsoft.com/en-us/library/txafckwd.aspx. There can be
any number of fixed-text strings with one or more format items.
Each format item corresponds to an object or boxed structure
defined in the object list. The composite formatting returns a new
result string where each format item is replaced by the string
representation of the corresponding object or structure in the object
list.
Table Note 2: The settings in the Regional and Language Options
folder of the Windows Control Panel can influence the formatting
results. It is the responsibility of the financial institution to ensure
that the regional settings for cultures used by formatters are
correctly installed and configured.
Screen Control Characters As XML does not permit ASCII
characters lower than 0x20, you must provide any screen control
characters as a character sequence. The character sequence is
converted to ASCII before being set to the screen displayer. The
character sequences that can be used and the ASCII equivalent are
given in Table 5-50, “Screen Control Character Sequences”.
5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-107
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Table 5-29
Screen Control Character Sequences
Character Sequence
ASCII Equivalent
Description
|HT|
0x09
Displays the name encoded on Track
1 of the card
|VT|
0x0b
Displays the next character from the
seconday character set
|FF|
0x0c
Clears the screen and positions the
cursor at the top left corner of the
screen
|SO|
0x0e
Inserts the screen called by the next
3, 5 or 8 characters
|CR|
0x0d
Moves the cursor to the following
line and positions it at the left-hand
margin
|SI|
0x0f
Positions the cursor on the row and
column specified by the next two
characters
|ESC|
0x1b
Control character introducing
supplementary control codes for
extra features
For example, to set a white foreground on the summary screen and
position the string and value for the totals at row H, column A, set
the TemplateForSummaryLine property as follows:
"|SI|HA|ESC|[27m{2,13} = {1,5} {0,3}"
Data Translator The data translator is used to replace the
character sequences with the equivalent screen controls in ASCII
characters. The data translator can also be used to configure an
array of strings to place on the confirmation screen using the
UserDictionary property in the CashInCustom.accfg file.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-108
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
The following example shows the format that must be used if
creating data translators:
<Class ID="ConfirmationScreenDialog"
Name="NCR.APTRA.NDC.CashInFlows.ConfirmationScreenDialog"
Assembly="NCR.APTRA.NDC.CashInFlows.dll" Transient="true">
<Interface>
<Property Name="DataFormatters" Value="ConfirmationScreenDataFormatters" />
</Interface>
</Class>
<Class ID="StringTranslator"
Name="NCR.APTRA.NDC.CashInFlows.NDCScreenDataTranslator"
Assembly="NCR.APTRA.NDC.CashInFlows.dll" Transient="true">
<Interface>
<Property Name="CustomTranslationDictionary" Value="CurrencyNamesMapping"/>
</Interface>
</Class>
<Class ID="DefaultConfirmationScreenDataFormatter"
Name="NCR.APTRA.NDC.CashInFlows.ConfirmationScreenDataFormatter"
Assembly="NCR.APTRA.NDC.CashInFlows.dll" Transient="true">
<Interface>
<Property Name="FormatterID" Value="0"/>
<Property Name="TotalString" Value="SUMA"/>
<Property Name="Translator" Value="StringTranslator"/>
</Interface>
</Class>
<Array ID="ConfirmationScreenDataFormatters">
<Element Value="DefaultConfirmationScreenDataFormatter"/>
</Array>
<Array ID="CurrencyNamesMapping">
<!-- The equals sign is used as the separator -->
<Element Value="EUR=EURO" />
<Element Value="USD=$"/>
</Array>
Screen Formatter You can create a component that implements
the interface for the data formats used in the confirmation screen
and replaces the provided formatter. To use a different formatter,
implement the System.IFormatProvider and
System.ICustomFormatter interfaces.
5
The following extract shows how the configuration file is updated
to use the MyFormatter class, which has been created using
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-109
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
VB.NET. The MyFormatter class implements the confirmation
screen data formatter interface and is compiled to MyFormatter.dll.
<Class ID="DefaultConfirmationScreenDataFormatter"
Name="MyFormatter"
Assembly="MyFormatter.dll">
<Interface>
<Property Name="FormatterID" Value="200"/>
</Interface>
</Class>
The following extract shows how the configuration file has to be
updated to use the MyScreenDataTranslator class, which has been
created in C#. The MyScreenDataTranslator class implements the
format provider and custom formatter interfaces and is compiled to
MyScreenDataTranslator.dll.
<Class ID="MyTranslator"
Name="MyScreenDataTranslator"
Assembly="MyScreenDataTranslator.dll">
</Class>
<Class ID="PolishFormatter"
Name="NCR.APTRA.NDC.CashInFlows.ConfirmationScreenDataFormatter"
Assembly="NCR.APTRA.NDC.CashInFlows.dll">
<Interface>
<Property Name="FormatterID" Value="200"/>
<Property Name="Formatter" Value="MyTranslator" />
<Property Name="ReportHeader" Value ="|SI|CFmNAGLoWEK|SI|EA" />
<Property Name="TotalString" Value ="SUMA" />
</Interface>
</Class>
Using Multiple Languages If you are using multiple languages in
an interface, you must define formatters for each language. States Y
and A set the screen offset value depending on the language
selection and this offset value is used to select the apropriate
formatter. The ConfirmationScreenFormatters array is searched
for a FormatterId with a matching offset value and this formatter
is used to generate the screen.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-110
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
To correctly display three languages, three instances of formatters
must be defined and the ConfirmationScreenFormatters array
must be updated as shown in the following extract:
<Class ID="EnglishFormatter" Name="NCR.APTRA.NDC.CashInFlows.ConfirmationScreenDataFormatter"
Assembly="NCR.APTRA.NDC.CashInFlows.dll">
<Interface>
<Property Name="FormatterID" Value="0"/>
<Property Name="ReportHeader" Value="|SI|CF|ESC|[27mHEADER|SI|EA|ESC|[B0m" />
<Property Name="TemplateForReportLine" Value="|ESC|[B3m{0,3} {1,3} X {2,3} =
|ESC|[23m{3,8}" />
<Property Name="TotalString" Value="TOTAL" />
</Interface>
</Class>
<Class ID="PolishFormatter" Name="NCR.APTRA.NDC.CashInFlows.ConfirmationScreenDataFormatter"
Assembly="NCR.APTRA.NDC.CashInFlows.dll">
<Interface>
<Property Name="FormatterID" Value="200"/>
<Property Name="ReportHeader" Value ="|SI|CFmNAGLoWEK|SI|EA" />
<Property Name="TotalString" Value ="SUMA" />
</Interface>
</Class>
<Class ID="SpanishFormatter" Name="NCR.APTRA.NDC.CashInFlows.ConfirmationScreenDataFormatter"
Assembly="NCR.APTRA.NDC.CashInFlows.dll">
<Interface>
<Property Name="FormatterID" Value="400"/>
<Property Name="ReportHeader" Value ="|SI|CBENCABEZAMIENTO|SI|EA" />
<Property Name="TotalString" Value ="SUM" />
</Interface>
</Class>
<!-- CashIn Confirmation Screen formatters -->
<Array ID="ConfirmationScreenFormatters">
<Element Value="EnglishFormatter"/>
<Element Value="PolishFormatter"/>
<Element Value="SpanishFormatter"/>
</Array>
ECB 6 Dialog Class
5
The ECB6Dialog class defines how to display the number of
counterfeit notes retained for verification during the cash deposit.
The ECB 6 screen is only displayed if notes are to be retained in a
transaction.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-111
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Configuring Amount
Entry
You can configure the Amount Entry Length and Whole Amount
Entry using an XML file.
5
Note: If Display Manager is used, the screen download is
mandatory. If the screen download is missing and the
AppendBuffer.xml file is used, the amount may not be displayed on
the HTML screen.
Configuring Amount Entry Length
5
This feature allows the cardholder to enter an amount length up to
12 digits. Once the number of entered digits reaches the maximum
value, further input is prevented.
The Amount Entry Length is defined in the AppendBuffer.xml file.
For the details of the attributes, AmountEntryLength and
AllowUpToMaxLength, and their description, see “Amount Entry
XML Schema” on page 5-113.
Configuring Whole Amount Entry
Whole Amount Entry can be configured for the following states:




F (Amount Entry)
R (Enhanced Amount Entry)
X (FDK Information Entry)
z017 (Note Mix Selection).
This automatically adds extra zeros after the decimal point to the
data to conform to the format expected by the host.
Whole amount entry configuration is defined in the
AppendBuffer.xml file. This file can be updated through software
distribution, local modification or the XML Configuration
Download message from the host. For details of the XML envelope
that must be used with this configuration file, see “XML
Configuration Files” on page 5-34. For details of the XML
Configuration Download refer to the APTRA Advance NDC,
Reference Manual.
The Append Buffer schema, AppendBuffer.xsd, defines the structure
of the configuration data for whole amount entry.
The AppendBuffer.xml and AppendBuffer.xsd files are stored in
C:\Program Files\NCR APTRA\Advance NDC\Config.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-112
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Table 5-30
Amount Entry XML Schema
Element
Description
AppendBuffer
This is the root element.
Nested element: AppendStates
AppendStates
Defines the states that can have extra zeros appended after the decimal point.
Nested element: StateNumber
StateNumber
The state number. Any number of states can be defined.
The state number must be an Amount Entry, Enhanced Amount Entry, or FDK
Information state or the StateNumber element is ignored.
This element includes attributes called NoOfZeros, AmountEntryLength
and AllowUpToMaxLength.
NoOfZeros = “0”.
This attribute holds a positive integer value defining the number of zeros to be
appended after the decimal point. The maximum number of zeros that can be
defined is 4, and the minimum is 0.
NoOfZeros
The NoOfZeros attribute value should be set to zero if no additional zeros are
required when limiting the Amount Entry maximum length or disabling/
enabling the clearing on reaching the max length.
AmountEntryLength
This attribute defines the Amount entry length. If this attribute is not present,
the Amount entry length set to 8 or 12 based on Enhanced configuration
parameter option 01.
AllowUpToMaxLength
AllowUpToMaxLength = “YES”. Limits the number of digits to the configured
amount entry length, which has a value of 8 or 12 in the attribute
AmountEntryLength.
AllowUpToMaxLength = “NO”. If the entered digits exceed the configured
amount entry length of 8 or 12 or the AmountEntryLength configured value,
then reset the amount entered to be 0 and restart the entry from the beginning.
If this attribute is not present or is invalid, “NO” is the default.
If the total length of the entered and appended amount buffer
exceeds the configured length in Enhanced Configuration
Parameter option 01, the Cancel Next State Number is taken.
Validating Buffer Data
5
The Buffer Validation state (z009) is used to validate data entered by
the cardholder and held in Buffer A, Buffer B or the Amount Buffer.
For details of the Buffer Validation state, refer to Chapter 2, “State
Tables” in the APTRA Advance NDC, Reference Manual.
The Buffer Validation state allows validation of the content of Buffer
B, Buffer C or the Amount Buffer against the rules provided in the
ValidationRuleSet.xml configuration file. This file can be updated
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-113
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
through software distribution, local modification or the XML
Configuration Download message. For details of the XML
Configuration Download message, refer to the APTRA Advance
NDC, Reference Manual.
The configuration file uses the ValidationRuleSet.xsd schema. The
XML elements must match those defined in the schema and are
case-sensitive. The default Close state is executed if any of the
following are true:




Invalid data is identified in either the schema or the
configuration file.
The schema is not present.
The configuration file is not present.
The boundary values for elements or their attributes in the
configuration file exceed the limits defined in the schema.
The ValidationRuleSet.xml and ValidationRuleSet.xsd files are stored in
C:\Program Files\NCR APTRA\Advance NDC\Config.
Table 5-31
Buffer Validation XML Schema
Element
Description
ValidationRulesSet
Mandatory.
The whole file is embedded within ValidationRuleSet tags.
This is the root element
Nested element: RuleSet
RuleSet
Mandatory.
Appears once or more times.
Identifies the rule to use in validating the buffer data. The required ID attribute
identifies the rule being configured and is used to match the validation
requested from the Buffer Validation state. The ID attribute value must be 3
characters in length. If duplicate ID attributes are found, the last entry is used
for validation.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-114
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Element
Description
Rule
Mandatory.
Appears at least once.
Defines the rule to use in validating the buffer data. The required Pattern
attribute defines the rule being configured. The Pattern attribute value is
defined using regular expressions.
For more information on regular expressions, refer to the following:
http://msdn.microsoft.com/en-us/library/2k3te2cs(VS.80).aspx
Configuring Beep for
Cardholder Transactions
5
When the cardholder’s card is ejected or cash is presented, a beep is
sounded. This beep can be configured to use one of several sounds
using the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\Alerts\Cardholder
If this registry entry is missing or invalid, the default value is used
to sound the beep.
Valid values and the associated sound are described in Table 5-32.
For descriptions of the beeps, refer to the APTRA online
documentation under Programmer’s Reference | XFS SIU Service
Provider | Configurable Parameters | BEEP DATA.
Table 5-32
Configurable Alert Sounds
Registry Value
Description
2
Sounds the key press beep (default)
4
Sounds an exclamation beep
8
Sounds a warning beep
16
Sounds an error beep
32
Sounds a critical error beep
PC Beep
5
The PC beep is used as default.
If the PC beep is not working or is not configured, no beep is
sounded unless the SIU SP Audio is configured by setting the
following registry entry to 1:
HKLM\SOFTWARE\NCR\Advance NDC\Alerts\CardHolder Use SIU
AUDIO
Cardless Transactions
5
Instead of using a card, consumer transactions can be started using
FDKs, FDK emulation, or PINpad key entry. If an active FDK or a
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-115
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
PINpad key is pressed with no card inserted, the transaction
proceeds as configured in the registry. If a card is inserted and a key
pressed simultaneously, the card takes priority.
Entries under the following registry key are used to configure
cardless transactions:
HKLM\SOFTWARE\NCR\Advance NDC\Extensions\
Cardless Transaction
By default, cardless transactions are not enabled. Cardless
transactions can be enabled through Supervisor or by modifying the
registry. Enabling cardless transactions requires a valid next state
number. The next state number can be set through Supervisor, by
modifying the registry, or by the host using Enhanced
Configuration option 77.
Note: When cardless transactions are disabled using the
Supervisor menu option, the next state number is stored and is used
when cardless transactions are re-enabled.
Supervisor Configuration of Cardless Transactions
5
Option 93 Cardless Transactions on the Configure menu in
Supervisor both enables or disables cardless transactions and allows
the next state number to be set at the local level. Access to this
function is password controlled to ensure only authorised personnel
can make these changes.
Enabling cardless transactions requires a valid next state number. If
it is not available, the operator must first set the next state number.
If this option is taken, a test teller transaction is required to check
that the state flow goes to the expected state.
Changes made through Supervisor updates the Next State
Number registry entry, described in Table 5-13, “Cardless
Transaction Registry Entries” on page 5-117.
For details of the Supervisor function, refer to the APTRA Advance
NDC Supervisor’s Guide.
Registry Configuration of Cardless Transactions
To configure cardless transactions, modify the following registry
entries:

Active FDK Mask or/and Active PIN Pad Key Mask

Next State Number.
Table 5-33, “Cardless Transaction Registry Entries” describes the
registry entries used to define the processing of cardless
transactions. For details of the key mask settings, see “Key Mask
Definition” on page 5-120.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-116
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
PAN Data The consumer who initiates the cardless transaction
cannot be identified using Track 2 or PAN data. The registry entries
allow static generic data to be used. Host applications have to
recognise that this data is not specific to a consumer and therefore
be able to restrict the transactions available, for example, offer
balance enquiries but not cash dispense transactions.
5
You can modify the PAN Data registry entry if CRM applications
(APTRA Promote or APTRA Relate) are used. APTRA Promote or
APTRA Relate applications can use the PAN data to provide a
generic flow for the consumer using the SST. As the data supplied is
not real consumer PAN data, it does not affect PA-DSS compliance.
Alternatively, you can use dummy PAN data or a dummy PIN if
SkipFITSearch is set to 1.
Other Registry Entries Other values can be modified to suit the
requirements of the financial institution.
5
Table 5-33
Cardless Transaction Registry Entries
Registry Entry
Description
Active FDK Mask
FDK mask value for cardless transactions in the range 0—255.
Default is 0, no FDK keys are defined.
If this is not present or is invalid, the default is used.
Active PIN Pad Key Mask
Numeric mask value for cardless transactions in the range 0—2047.
Default is 0, no PIN keys are defined.
If this is not present or is invalid, the default is used.
Next State Number
The next state number following a cardless transaction initiation.
See Table Note 3
If this entry contains an empty string (default value), 0 or 255 (invalid
values), cardless transactions are disabled. If this entry contains any valid
value, cardless transactions are enabled.
NCR recommends that the next state number is configured using Enhanced
Configuration Parameters option 77 or Supervisor.
PAN Data
The PAN data to be stored in the PAN field (CDI 2077) for cardless
transactions where a FIT search is not carried out (SkipFITSearch is set to
1).
Default is an empty string
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-117
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Registry Entry
Description
SkipFitSearch
Defines whether a FIT search is carried out or not. If set to 1, the FIT match
processing is not carried out.
See Table Note 3
Default is 0, FIT search is carried out.
Track 2 Data
Track 2 data for cardless transactions.
See Table Note 3
If this is not present, no FIT search is carried out, no PIN prompt is displayed
and the cardless next state number is taken.
Table Note 3: The cardless next state is taken if either of the
following is true:


FIT search is to be skipped (SkipFITSearch = 1)
FIT search is to be performed (SkipFITSearch = 0) but
Track 2 Data is not set.
For further information see Figure 5-4 “Cardless Transaction Flow”
on page 5-119. The Good FIT Match and No FIT Match next state
exits are taken from the Card Read state.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-118
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Figure 5-4
Cardless Transaction Flow
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-119
Configuring Advance NDC and Associated Components
Configuring Cardholder Functionality
Key Mask Definition
5
The Active FDK Mask and Active PIN Pad Key Mask registry
entries define the FDK and PIN pad keys to activate.
These masks are binary-coded values. To activate an FDK, PIN pad
key or touch area, set the associated bit, as shown in Table 5-34. To
activate more than one FDK or PIN pad key, XOR the codes.
Table 5-34
Key Mask Settings
Set Bit
Associated FDK
Associated PIN Pad Key
0
A
0
1
B
1
2
C
2
3
D
3
4
F
4
5
G
5
6
H
6
7
I
7
8
8
9
9
10
ENTER
For example, if you want to set the ENTER, 8, 5, and 2 PIN pad keys,
enter 1316 in the Active PIN Pad Key Mask registry value. This is
calculated as shown in the following table:
Table 5-35
Binary to Decimal Conversion Example
Key
ENTER
9
8
7
6
5
4
3
2
1
0
Binary
1
0
1
0
0
1
0
0
1
0
0
Decimal
1024
512
256
128
64
32
16
8
4
2
1
Active
1024
Total
1316
256
32
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-120
APTRA Advance NDC, Developer’s Guide
4
Configuring Advance NDC and Associated Components
Configuring Keyboards
Configuring Keyboards
5
This section describes the how the front keyboard and operator
keyboard can be configured. It also covers enabling a beep when an
emulated FDK is selected from a touch screen.
Front Keyboard
5
The front keyboard or the PIN SP must be configured so that, as
well as all numeric keys (0-9), the Enter, Clear and Cancel keys are set
up. Default key configurations are provided; however, NCR
recommends the Clear key be configured to clear the full input
buffer, not just one character. To support this, the Clear key must
return the WFS_PIN_FK_CLEAR value to the application.
To do this for NCR SSTs, complete the following instructions using
the Aggregate Builder Tool:
1
To create a new archive on the development PC, select a new
empty directory
2
Import the APTRA XFS Platform Aggregate from the
distribution media.
3
Open the APTRA Self Service Support Aggregate, select the
version and click Contents.
4
Scroll to the Keyboards component and select the current
revision, for example 04.00.03. In the Configuration Sets
window at the bottom, it will show the Default (NCR) set.
5
Select the Default (NCR) set with right mouse and perform
Duplicate.
6
Rename the newly created set, for example, to Advance NDC.
7
Right click the new set and select open, then click Change. This
brings up the Change Wizard with the default keyboard
selected.
8
Select Copy to display a Custom Keyboard Information dialog.
Pick a Custom keyboard feature number from the dropdown
menu.
9
Enter a description in the Custom keyboard description dialog,
for example, “APTRA NDC Keyboard”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-121
Configuring Advance NDC and Associated Components
Configuring Keyboards
10 Select Keyboard to configure the Custom keyboard for the Front
Keyboard.
11 Find the Backspace key and double click it to display the Set Key
Configuration dialog.
12 In the list of Virtual key names, find Delete (= Clear) and select
it. Click OK twice to close both dialogs.
13 Select Next to proceed to Step 2 of the wizard detailed below
under “Operator Keyboard”.
The function display keys (FDKs), if present, must be set up with
the following layout:
Table 5-36
Front Keyboard Layout
WFS_PIN_FK_FDK01
WFS_PIN_FK_FDK05
WFS_PIN_FK_FDK02
front
WFS_PIN_FK_FDK06
WFS_PIN_FK_FDK03
display
WFS_PIN_FK_FDK07
WFS_PIN_FK_FDK04
WFS_PIN_FK_FDK08
Audible Alert on Emulated FDK Selection
To enable Advance NDC to sound a beep whenever an FDK is
selected, set the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\CardholderKeyboard\
UseXFSBeepWithFDKs=1
By default, this is set to 0.
In voice-guided sessions, a single beep is always sounded on FDK
selection regardless of the setting of this registry entry.
Operator Keyboard
5
The operator panel keyboard or the TTU SP is configured by
default, to support FDKs as individual keys. However, NCR
recommends the Clear key be configured to clear the full input
buffer, not just one character. For further information on
configuring the key and updating the registry for this, refer to the
APTRA on-line documentation under APTRA XFS | Text Terminal
Device Class | User Guide | CEN XFS | Frequently Asked
Question.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-122
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Keyboards
To configure this for an NCR SST follow these instructions as “Step
2 of 2" of the Change Wizard as introduced in section “Front
Keyboard”:
1
Click Copy to bring up a Custom Keyboard Information dialog.
Pick a Custom keyboard feature number from the dropdown
menu.
2
Enter a description in the Custom keyboard description dialog,
for example, “APTRA NDC Rear Keyboard”.
3
Click Keyboard to configure the Custom keyboard for the Rear
Keyboard.
4
Find the Backspace key and double click it to bring up the Set
Key Configuration dialog.
5
In the list of Virtual key names find Delete (= Clear) and select it.
Click OK to close the dialog.
6
Click Finish to close the wizard. Click OK to close the
Configuration Property sheet.
7
Click Profiles under the APTRA Self-Service Support aggregate
to create a new profile. Name the new profile for example,
SSSProfile.
8
Select the profile and scroll to the Keyboards component. Under
the Installation Instruction dropdown select the configuration
set AdvanceNDC that has been created.
9
Click Profiles under the APTRA XFS aggregate to create a new
profile. Name the new profile for example, XFSProfile.
10 Select the profile and scroll to the APTRA Self-Service Support
aggregate. Under the Installation Instruction dropdown select
the profile SSSProfile that has been created.
11 Export the APTRA XFS Platform Aggregate by selecting the
aggregate version, right-clicking and selecting Export from the
context menu.
12 Close the Aggregate Builder tool.
The customised aggregate with a custom keyboard configuration
can now be deployed to the SST network.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-123
Configuring Advance NDC and Associated Components
Configuring Keyboards
Touch-screen Keyboards
for Alphanumeric Data
Entry
A touch-screen keyboard can be supported for consumer data entry
in the Information Entry state (‘H’). When a touch-screen keyboard
is used, the numeric keypad is also available.
5
Keyboard Definitions
5
Keyboard definitions are defined in offline screen definition files
<keyboardname>.ndcacsdf. The keyboard board definition file is
referenced from the Information Entry screen in a nested screen and
overlaid on the NDC screen display.
Each touch button on the keyboard can be defined to return the
appropriate ASCII code to be placed in the input buffer.
As the scaling and layout change when the resolution changes,
example keyboard definitions are provided for a few of the
commonly used resolutions, as follows:


Simple.acsdf
ExampleAlphaKeyboard.ndcacsdf
For both keyboard definitions, the characters and layout are for an
English language keyboard. The following figure illustrates the
keyboard provided in Simple.acsdf:
Figure 5-5
Touch-screen Keyboard
Defining the Screen
5
The following points apply:



The Information Entry screen (‘H’) must be updated or defined
as a new screen.
The Information Entry screen that is displayed must reference
the configured keyboard overlay.
Any FDK touch areas defined for the screen must not interfere
with the keyboard touch areas.
Keyboard Definition


The following points apply:
The valid range for the touch key codes is 20h—EFh.
Advance NDC reserves F0h—FFh for use as the FDK, CLEAR,
CANCEL and ENTER key codes.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-124
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Keyboards



A Windows font is required that is capable of echoing any
special character to be displayed, for example, É or Å.
The ASCII code must match the code specified in the keyboard
definition. This is usually the same code used by the active
country code page.
Only languages that have code pages can be displayed.
Customising a Keyboard Definition
5
You can customise a touch-screen keyboard by editing the required
keyboard definition file. This XML file has various fields that can be
updated for the required data entry
The example keyboard definitions and associated button images
supplied with Advance NDC are located in the following folders:


Keyboard definitions
C:\Program Files\NCR APTRA\Advance NDC\Forms
Button images
C:\Program Files\NCR APTRA\Advance NDC\Forms\Media.
NCR recommends you take a backup of the keyboard definition file
before modifying it.
Copy or rename the file you want to use to the required nested
screen number in the ‘u’ screen group. For example, a screen with
nested screen number 012 requires screen definition u0012.ndcacsdf
to be preset in the Forms directory.
Key Codes For each touch key, a TouchButton element contains
the Key attribute, which can be updated (in the range 20h—EFh) to
return the ASCII hexadecimal code for the required key press. The
Text attribute is the character to display on the keyboard button, as
shown in the following extract:
5
<TouchButton … X="97" Y="186" Key="51" Enabled…">
<Label Name="" …Text="Q" … />
This will allow all characters for a particular code page to be
displayed and entered.
Note: The coordinates must be within the visible screen area.
Touch Area Position The position of the touch area is specified by
the X and Y attributes for each TouchButton definition.
5
<TouchButton … X="97" Y="186" Key="51" Enabled…">
<Label Name="" …Text="Q" … />
To move the keyboard up or down, a search and replace can be
performed for each Y coordinate in each of the keyboard rows.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-125
Configuring Advance NDC and Associated Components
Configuring Keyboards
Touch-screen Keyboard Display
The following are required for the touch-screen keyboard to be
displayed:



For language offsets, the appropriately named files must be
copied and available.
The correct display must be active in the Information Entry state
screen before it is displayed.
The cursor must be placed at the appropriate position to echo
the data.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-126
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Configuring Screen Displays
5
This section describes how aspects of screen display can be
configured.
Secure Key Entry
5
In DAPI 7 mode, the keyboard layout is dynamically remapped by
the XFS PIN service provider, to enable the relevant data to be
entered through the encryptor keyboard.
The application queries the XFS PIN service provider regarding the
dynamic keyboard layout, and then uses the secure keyboard,
however, the application uses a static screen I30 in the resrvd.def file
to show the secure key entry mapping to the cardholder.
Note: Different layouts are supported for secure key entry. If the
configured layout is different from the default layout, update screen
I30 in resrvd.def to match the keyboard layout in use. For details of
how the keyboard is mapped for secure key entry, refer to the
APTRA on-line documentation under APTRA XFS | Programmer’s
Reference | XFS Service Providers |
Display Manager for
HTML Screens
5
For details of configuring Display Manager for the display of HTML
screens, refer to the APTRA Advance NDC, User Guide for Display
Manager, which describes how to install and configure Display
Manager on your development PC and SST.
Note: This component is separate from the display manager used
to handle NDC screens in .NET.
Hide Taskbar
5
If the System Application is started on the rear operator panel, the
Windows Taskbar may be shown on the front screen. By default the
taskbar is always hidden with the following registry setting added
during installation:
HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVer
sion\
Policies\Explorer
"NoDriveTypeAutoRun"=dword:00000091
"Clearrecentdocsonexit"=dword:00000001
"NoSMBalloonTip"=dword:00000000
"NoSimpleStartMenu"=dword:00000001
If required, the settings can be edited to display the taskbar.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-127
Configuring Advance NDC and Associated Components
Configuring Screen Displays
AVI System Limit
5
There is an operating system imposed system limit on the number
of distinct AVI windows open within a process. This means that you
cannot use more than 24 AVI files.
If you need to play more than 24 AVI files, use partial AVI files. A
partial AVI is not a full screen display, but is superimposed on a
JPEG background. The JPEG can provide a static picture over which
the partial AVI files can provide the moving part of the display. This
separation of the static and moving parts helps to reduce the
number of AVI files required.
Note: The 24-file limit also applies to partial AVI files.
Advance NDC Display
Components
5
Advance NDC display components are configured using XML
configuration files. These files can be updated through software
distribution, local modification or the XML Configuration
Download message. For details of the XML Configuration
Download refer to Chapter 9, “Terminal to Central Messages”, of
the APTRA Advance NDC, Reference Manual.
Details of the components and their associated schemas are given in
the following sections.
The .NET Class Configurator configures any properties that are set
at runtime using the AdvanceNDC.accfg file. For details of the
properties set by the .NET Class Configurator see “Advance NDC
Display Runtime Settings” on page 5-148. For details of the .NET
Class Configurator, refer to the APTRA online documentation
under .NET Class Configurator.
Note: The C:\Program Files\NCR APTRA\Advance NDC\Screens
folder is used internally by Advance NDC to hold screens for
display.
Offline Keyboard Layouts
As an alternative to downloading keyboard layouts from the host,
you can use one or more XML configuration files to define
keyboards and associated keyboards.
You can use either of the following approaches:


Create a single XML file containing all keyboards and associated
keyboards
Create multiple XML files each containing one or more
keyboards and associated keyboards.
The keyboard configuration file is stored in the location defined in
the ScreenRetrievers property as described in “Offline Screens”
on page 5-148.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-128
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Screen Displays
The keyboard schema defines the structure of the configuration data
for the keyboards and associated keyboards as described in
Table 5-37 on page 5-129.
Table 5-37
Offline Keyboard XML Elements
Element
Description
keyboardDefinition
Mandatory.
This is the root element.
The whole file is enclosed within keyboardDefinition tags.
Nested elements:

keyboard

associations
keyboard
Mandatory.
Appears at least once.
Identifies the keyboard definition. The required number attribute identifies the
keyboard being configured and is 3 alphanumeric characters long in the range 000
to ZZZ.
Nested elements:

physical

touch
physical
Optional.
Appears only once in each keyboard element.
Defines the physical SST.
Nested elements:
pinKeys

functionKeys

Mappings

pinKeys
Optional.
Appears only once in each physical element.
Defines the PINPad keys to enable in the keyboard.
Nested elements:
key

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-129
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
key
Optional.
Appears up to 16 times in each pinKeys element.
Defines a PINPad key to enable on the keyboard. The key can only be enabled if a
matching key is configured at the Service Provider level.
The required value attribute identifies the key to enable. Valid values are as
follows:

WFS_PIN_FK_0

WFS_PIN_FK_1

WFS_PIN_FK_2

WFS_PIN_FK_3

WFS_PIN_FK_4

WFS_PIN_FK_5

WFS_PIN_FK_6

WFS_PIN_FK_7

WFS_PIN_FK_8

WFS_PIN_FK_9

WFS_PIN_FK_ENTER

WFS_PIN_FK_CANCEL

WFS_PIN_FK_CLEAR

WFS_PIN_FK_BACKSPACE

WFS_PIN_FK_DECPOINT

WFS_PIN_FK_00

WFS_PIN_FK_000
functionKeys
Optional.
Appears only once in each physical element.
Defines the FDKs to enable in the keyboard.
Nested elements:

fdk
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-130
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
fdk
Optional.
Appears up to eight times in each functionKeys element.
Defines an FDK to enable on the keyboard. The FDK can only be enabled if a
matching FDK is configured at the Service Provider level. If physical FDKs are not
present, a corresponding button is enabled on the touch screen.
The required value attribute identifies the key to enable. Valid values are as
follows:

WFS_PIN_FK_FDK01

WFS_PIN_FK_FDK02

WFS_PIN_FK_FDK03

WFS_PIN_FK_FDK04

WFS_PIN_FK_FDK05

WFS_PIN_FK_FDK06

WFS_PIN_FK_FDK07

WFS_PIN_FK_FDK08
Mappings
Optional.
Appears only once in each physical element.
Defines any remapping o FDK values to alternative NDC values.
Nested elements:
mapping

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-131
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
mapping
Optional.
Appears up to eight times in each Mappings element.
Defines the mapping of an FDK position to an alternative NDC value code. For
details of the mapping layout, refer to Chapter 4, “Keyboard Data and Layouts”
in the APTRA Advance NDC, Reference Manual.
The required position attribute identifies the FDK to be mapped. Valid values
are as follows:

17

18

19

20

21

22

23

24
The required code attribute defines the new NDC value code that the FDK is to
be mapped to. Valid values are as follows:

F3

F4

F5

F6

F7

F8

F9

FA
Note: Advance NDC does not support the remapping of PINPad key
values.
touch
Optional.
Appears only once in each keyboard element.
Defines the touch screen keyboard for an SST.
Nested elements:

area
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-132
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
area
Mandatory.
Appears up to 200 times in each touch element.
Defines an on-screen touch button area.
The required returnCode attribute defines the key code of the touch button and is
2 alphanumeric characters long. The characters are each in the range 0 to F.
Nested elements:

topLeft

bottomRight
topLeft
Mandatory.
Appears only once in each area element.
Defines the co-ordinate of the top left corner of the touch button area.
The required x attribute defines the x-axis co-ordinate and is 8 numeric characters
long in the range 0-9.
bottomRight
Mandatory.
Appears only once in each area element.
Defines the co-ordinate of the top left corner of the touch button area.
The required y attribute defines the y-axis co-ordinate and is 8 numeric characters
long in the range 0-9.
associations
Optional.
Appears only once in each keyboardDefinition element.
Defines the screen associated with a keyboard.
Nested elements:
association

association
Mandatory.
Appears at least once in each associations element.
The required keyboardNumber attribute identifies the keyboard to associate
with the screen and is 3 alphanumeric characters long.
Nested elements:

Screen
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-133
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
Screen
Mandatory.
Appears at least once in each associations element.
The required number attribute identifies the screen to associate with the
keyboard and is 5 alphanumeric characters long.
Advance NDC Display Configuration File
The Advance NDC display configuration file,
DisplayManagerConfig.xml, is located in C:\Program Files\NCR
APTRA\Advance NDC\Config. The file must conform to the
structure defined in the related schema. Invalid XML is written to
the PD log but processing continues. Advance NDC does not
always ensure that the content is valid and cannot provide detailed
information for use in troubleshooting for all entries. It is the
responsibility of the XML author to ensure that the content is valid.
The file defines the following configuration settings:





Colour configuration. Sixty-four colour control codes are
supported. The colour value assigned to each control code is
fully configurable using either an alpha, red, green, blue (ARGB)
or red, green, blue (RGB) format. For details of the control codes,
refer to Chapter 3, “Screen Data” in the APTRA Advance NDC,
Reference Manual. For details of the colour configuration XML
elements, see colourDefinitions on page 5-135
Font configuration. The fonts are specified using unique font
designators and associated parameters to control how the font is
displayed. For further details of fonts and their use in Advance
NDC, see Appendix D, “Font Definition”. For details of the font
configuration XML elements, see fontDefinitions on
page 5-139
Language configuration. Language offsets are mapped to
language strings. For details, see languageDefinitions on
page 5-141
Grid configuration. The grid settings allow a fine granularity of
control over the positioning of display elements. For details, see
gridConfig on page 5-142
Hook configuration. The hooks specify the expression index and
assembly for dynamic screen content. For details, see
hookConfig on page 5-142. An example of defining a dynamic
screen is provided in “Example Definition of Dynamic Screen
Content” on page 5-145
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-134
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Screen Displays

Configuration of cheque image display. Two Boolean
parameters can be used to control the image scale and aspect
ratio of cheques of different sizes. The cheque images can be
displayed in either of the following ways:
— According to the height and width of the cheque image
— According to the height and width of the screen.
By default, this functionality is disabled for backwards
compatibility. For details, see chequeDisplayConfig on
page 5-143 and “Resizing the Cheque Image for Display” on
page 5-146.

Miscellaneous configuration. Miscellaneous settings include
whether Display Manager operates in full screen mode, the
display of an out of service screen and whether nested screens
can perform keyboard updates. For details, see miscConfig on
page 5-144.
The Advance NDC display schema defines the structure of the
configuration data for these settings as described in “Advance NDC
Display XML Elements” on page 5-135.
Table 5-38
Advance NDC Display XML Elements
Element
Description
displayManager
Mandatory.
This is the root element.
The whole file is enclosed within displayManager tags.
Nested elements:

colourDefinitions

associations
colourDefinitions
Mandatory.
Appears only once.
Defines the colours to use in screen foreground and background.
Nested elements:
foreground

background

defaultForeground

defaultBackground

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-135
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
foreground
Mandatory.
Appears only once in each colourDefinitions element.
Defines the colours used in the screen foreground.
Nested elements:

foregroundColour
foregroundColour
Mandatory.
Appears 16 times in each foregroundColour element.
The required control attribute defines the control code to map to the colour.
Valid values are as follows:
















20 – low intensity black
B0 – high intensity black
21 – low intensity red
B1 – high intensity red
B2 – low intensity green
22 – high intensity green
B3 – low intensity yellow
23 – high intensity yellow
24 – low intensity blue
B4 – high intensity blue
25 – low intensity magenta
B5 – high intensity magenta
26 – low intensity cyan
B6 – high intensity cyan
B7 – low intensity white
27 – high intensity white
The required colour attribute defines the colour value of the control code. This is
either 6 or 8 characters in length. If 6 characters are specified, it is interpreted as an
RGB value. If 8 characters are specified, it is interpreted as an ARGB value.
background
Mandatory.
Appears only once in each colourDefinitions element.
Defines the colours used in the screen background.
Nested elements:
backgroundColour

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-136
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
backgroundColour
Mandatory.
Appears 16 times in each backgroundColour element.
The required control attribute defines the control code to map to the colour.
Valid values are as follows:

30 – low intensity black

C0 – high intensity black

31 – low intensity red

C1 – high intensity red

C2 – low intensity green

32 – high intensity green

C3 – low intensity yellow

33 – high intensity yellow

34 – low intensity blue

C4 – high intensity blue

35 – low intensity magenta

C5 – high intensity magenta

36 – low intensity cyan

C6 – high intensity cyan

C7 – low intensity white

37 – high intensity white
The required colour attribute defines the colour value of the control code. This is
either 6 or 8 characters in length. If 6 characters are specified, the control code is
interpreted as an RGB value. If 8 characters are specified, it is interpreted as an
ARGB value.
defaultForeground
Mandatory.
Appears only once in each colourDefinitions element.
Defines the default foreground colours.
Nested elements:
defaultForegroundColour

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-137
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
defaultForegroundColour
Mandatory.
Appears 16 times in each defaultForeground element.
The required control attribute defines the control code to map to the colour.
Valid values are as follows:
















60 – low intensity black
F0 – high intensity black
61 – low intensity red
F1 – high intensity red
F2 – low intensity green
62 – high intensity green
F3 – low intensity yellow
63 – high intensity yellow
64 – low intensity blue
F4 – high intensity blue
65 – low intensity magenta
F5 – high intensity magenta
66 – low intensity cyan
F6 – high intensity cyan
F7 – low intensity white
67 – high intensity white
The required colour attribute defines the colour value of the control code. This is
either 6 or 8 characters in length. If 6 characters are specified, it is interpreted as an
RGB value. If 8 characters are specified, it is interpreted as an ARGB value.
defaultBackground
Mandatory.
Appears only once in each colourDefinitions element.
Defines the default background colours.
Nested elements:
defaultBackgroundColour

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-138
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
defaultBackgroundColour
Mandatory.
Appears 16 times in each defaultBackground element.
The required control attribute defines the control code to map to the colour.
Valid values are as follows:
















70 – low intensity black
G0 – high intensity black
71 – low intensity red
G1 – high intensity red
G2 – low intensity green
72 – high intensity green
G3 – low intensity yellow
73 – high intensity yellow
74 – low intensity blue
G4 – high intensity blue
75 – low intensity magenta
G5 – high intensity magenta
76 – low intensity cyan
G6 – high intensity cyan
G7 – low intensity white
77 – high intensity white
The required colour attribute defines the colour value of the control code. This is
either 6 or 8 characters in length. If 6 characters are specified, it is interpreted as an
RGB value. If 8 characters are specified, it is interpreted as an ARGB value.
fontDefinitions
Mandatory.
Appears only once.
Defines the fonts to use in the screen.
Nested elements:
font

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-139
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
font
Mandatory.
Appears up to 95 times.
Defines the font used to display information on the screen.
The required id attribute identifies the font and is one character in the visible
ASCII range (0x21 - 0x7E). The id must be unique. If duplicate ids exist, the first
definition encountered in the XML file is used.
The required face attribute identifies the name of the font and is the name of an
installed font.
The optional charset attribute identifies the character set to use. Valid values
are as follows:

ANSI_CHARSET (default)

DEFAULT_CHARSET

SYMBOL_CHARSET

SHIFTJIS_CHARSET

HANGEUL_CHARSET

HANGUL_CHARSET

GB2312_CHARSET

CHINESEBIG5_CHARSET

OEM_CHARSET

JOHAB_CHARSET

HEBREW_CHARSET

ARABIC_CHARSET

GREEK_CHARSET

TURKISH_CHARSET

VIETNAMESE_CHARSET

THAI_CHARSET

EASTEUROPE_CHARSET

RUSIAN_CHARSET

MAC_CHARSET

BALTIC_CHARSET
The optional height attribute specifies the height of the font in logical units and
is an integer. The default is 100.
The optional size attribute specifies the size of the font. Valid values are as
follows:

Single (default)

Double
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-140
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
font (cont.)
The optional fixedSpacing attribute specifies whether to use fixed spacing.
Valid values are as follows:

True – use fixed spacing (default)

False – do not use fixed spacing.
The optional xOffset attribute specifies the initial horizontal position of the text
relative to the default initial horizontal position. A positive integer offsets the text
to the right, a negative integer offsets the text to the left. The default is 0 (no
offset).
The optional yOffset attribute specifies the initial vertical position of the text
relative to the default initial vertical position. A positive integer offsets the text
upward, a negative integer offsets the text downward. The default is 0 (no offset)
The optional weight attribute specifies whether to use a weighted font or not.
Valid values are as follows:

FW_BOLD – use bold font

FW_NORMAL – do not use bold font (default).
The optional italic attribute specifies whether to use an italic font or not. Valid
values are as follows:

True – use italic font

False – do not use italic font (default).
The optional underline attribute specifies whether to use an underlined font or
not. Valid values are as follows:

True – use underlined font

False – do not use underlined font (default).
The optional strikeout attribute specifies whether to use a strikeout font or not.
Value values are as follows:
languageDefinitions

True – use a strikeout font

False – do not use a strikeout font (default).
Mandatory.
Appears only once.
Defines the language to use.
Nested elements:

language
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-141
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
language
Mandatory.
Appears at least once.
Defines the mapping between a language string and a language offset.
The required lang attribute specifies the language string to be mapped to the
offset and is 3 characters in length in the range A-Z or a-z.
The required offset attribute specifies the offset to be mapped to the language
string and is an integer.
gridConfig
Mandatory.
Appears only once.
Defines the grid used for positioning of display elements on the screen.
Nested elements:

xGrid

yGrid
xGrid
Mandatory.
Appears only once.
Defines the position of the display elements on the x-axis of the grid.
The required coord attribute specifies the coordinate string to use when
positioning elements.
yGrid
Mandatory.
Appears only once.
Defines the position of the display elements on the y-axis of the grid.
The required coord attribute specifies the coordinate string to use when
positioning elements.
hookConfig
Mandatory.
Appears only once.
Defines hook configuration information.
Nested elements:

dynamicContentHooks
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-142
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
dynamicContentHooks
Mandatory.
Appears only once.
Defines the hooks used in defining dynamic screen content.
Nested elements:

contentHook
contentHook
Mandatory.
Appears at least once.
Identifies the expression index and assembly used to match dynamic screen
content.
The type attribute identifies the implementation of the hook. Valid types are as
follows:

native – a C function

managed – a managed class
The id attribute provides the index to match with the expression given in the
screen control sequence
The assembly attribute identifies the DLL.
The name attribute identifies the function name if the type attribute is native or
the class name used to evaluate the expression if the type attribute is managed.
chequeDisplayConfig
Mandatory.
Appears only once.
Enables re-interpretation of the Lift Cheque Image Control escape sequence to
scale a cheque image using the following Boolean attributes:

scaleToScreenSize

maintainAspectRatio
The default value for each attribute is false for backwards compatibility.
The first attribute is set to true to scale the image to the width and height of the
available screen display area.
Both are set to true to maintain the aspect ratio in one dimension while scaling
the other proportionally. See “Resizing the Cheque Image for Display” on
page 5-146.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-143
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
miscConfig
Mandatory.
Appears only once.
Defines general configuration information.
Nested elements:

windowMode

defaultOutOfService

nestedScreens
windowMode
Mandatory.
Appears only once.
Defines whether the Advance NDC display window runs in window mode or full
screen mode.
The required mode attribute specifies the screen mode. Valid values are as
follows:

Windowed

FullScreen
The optional width attribute specifies the width of the window if the screen mode
is set to Windowed and is an integer. The default window width is 640 pixels.
The optional height attribute specifies the height of the window if the screen
mode is set to Windowed and is an integer. The default window width is 480
pixels.
The optional topMost attribute specifies whether the Advance NDC display
window is always on top. Valid values are as follows:

True – The NDC Display Window is always on top. (Runtime installation
default)

False – The NDC Display Window is not always on top. (Development PC
installation default)
Note: If another window requires focus and the Advance NDC display is
set to always be on top, the Advance NDC display window is minimised.
When the next screen is to be displayed, the Advance NDC display
window is automatically maximised and, if configured, will become the
top window again.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-144
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Element
Description
defaultOutOfService
Optional.
Appears only once.
Defines whether a default screen is displayed immediately after initialisation
completes.
The required useDefault attribute specifies whether a default screen is used.
Valid values are as follows:

True – Use a default screen following initialisation. (default)

False – Do not use a default screen following initialisation
The required screenNumber attribute identifies the screen to display if the
useDefault attribute is set to True. The screen number is 3, 5, or 6 digits in
length and the default is C02.
nestedScreens
Optional.
Appears only once.
Defines whether nested screens can be used to perform keyboard updates.
The required allowkeyboardUpdates attribute specifies whether keyboard
updates are allowed. Valid values are as follows:

True – keyboard updates are allowed (default)

False – keyboard updates are not allowed.
Example Definition of Dynamic Screen Content Dynamic screen
content can be defined using conditional expressions in either the
Dynamic Button or Dynamic Text control sequence.These control
sequences call the methods in the content hooks. If the expression is
true, the dynamic content is displayed.
5
The following examples show the following:


The Dynamic Button control sequence used in the screen to
determine whether to display a button in Figure 5-6.
An example hookConfig entry from the
DisplayManagerConfig.xml file containing hook configuration
information in Figure 5-7
Figure 5-6
Example Dynamic Button Control
Sequence
<ESC>P b F2;Quick
Cash;CashIcon.png;004;(E002|E003&E004)<ESC>\
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-145
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Figure 5-7
Example hookConfig Extract
<hookConfig>
<dynamicContentHooks>
<contentHook type="native" id="001" assembly"NativeDynamicContentHook.dll"
name= "DeviceDynamicMenuHook"
<contentHook type="managed" id="002" assembly"ManagedDynamicContentHook.dll"
name= "ManagedDynamicContentHook.DeviceConditionTwo"
<contentHook type="managed" id="003" assembly"ManagedDynamicContentHook.dll"
name= "ManagedDynamicContentHook.AvailabilityConditionThree"
<contentHook type="managed" id="004" assembly"ManagedDynamicContentHook.dll"
name= "ManagedDynamicContentHook.DynamicConditionFour"
</dynamicContentHooks>
</hookConfig>
In the above examples, the control sequence defines the position of
the FDK (F2), the button text (“Quick Cash”), the button image
(CashIcon.png) and the conditional expression.
Note: The button image can be specified, but the default
WinRenderer style is always used.
The conditional expression states that either E002 or E003 and E004
must be true for the button to be displayed on the screen. This
expression is passed to the hook function at index 004, evaluated
and, if true, the button is displayed on screen.
For details of these control sequences and building conditional
expressions, refer to Chapter 3, “Screen Data” in the APTRA
Advance NDC, Reference Manual.
For information on key code mapping see Chapter 4, “Keyboard
Data and Layouts” in the APTRA Advance NDC, Reference Manual.
Resizing the Cheque Image for Display Configuration in
DisplayManagerConfig.xml can be used to re-interpret the Lift
Cheque Image Control escape sequence and handle how cheque
images of varying sizes are displayed on screen.
Two Boolean attributes are provided in DisplayManagerConfig.xml to
configure how a cheque is scaled for the screen display area, as
follows:

scaleToScreenSize
This attribute determines the way the cheque image scaling
factor is interpreted, as follows:
false
Cheque images are scaled according to the height and
width of the cheque image. For backwards compatibility,
this is the default value
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-146
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Screen Displays
true

Cheque images are scaled according to the height and
width of the available screen display area
maintainAspectRatio
This attribute determines whether the aspect ratio of the cheque
images is maintained during scaling and it applies only when
the scaleToScreenSize attribute is set to true.
false
Cheque images are scaled according to the x and y
co-ordinates. This is the default value
true
Cheque images are scaled in one dimension and
proportionally in the other, so that the scaled image fits
into the area defined by the x and y co-ordinates
The Lift Cheque Image Control escape sequence is as follows:
<ESC>PS(x,y)ImagePath/FileName<ESC>\
The (x,y) values are numbers in the range 1 to 100 inclusive and
represent the scaling factor to fit the image into the area defined by
the x and y coordinates in the Lift Cheque Image control
With the following control sequence as an example
<ESC>PS(90,40)C:\Graphics/image.bmp<ESC>\
the impact of setting these attributes is as follows:


Scaling to screen size (true) without aspect ratio (false)
The image will occupy 90% of the horizontal display size and
40% of the vertical display size.
Scaling to screen size (true) with aspect ratio (true)
The image will not be distorted but scaled in one of the
following ways to ensure it fits into the area defined by the x
and y co-ordinates:
— The image will occupy 90% of the horizontal display size
and up to 40% of the vertical display size
— The image will occupy 40% of the vertical display size and
up to 90% of the horizontal display size
The following XML extract shows the configuration to maintain the
aspect ratio when the cheque image is scaled for display in the
available screen area.
Figure 5-8 L
Maintaining the Aspect Ratio of Displayed
Cheque Images
<chequeDisplayConfig scaleToScreenSize="true" maintainAspectRatio="true"/>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-147
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Note: This configuration also applies to the Bunch Cheque Display
Image Control.
For details of the cheque image controls, refer to chapter 3, “Screen
Data” of the APTRA Advance NDC Reference Manual.
Advance NDC Display
Runtime Settings
5
The .NET Class Configurator is used to configure any screen
properties that are set at runtime using the AdvanceNDC.accfg file.
Details of the configuration settings are given in the following
sections. For details of the class configurator, refer to the APTRA
online documentation under .NET Class Configurator. For details
of the AdvanceNDC.accfg file, see “.NET Class Configurator Files” on
page 5-37.
Advance NDC display components are configured using XML files.
For details of the XML files, see “Advance NDC Display
Components” on page 5-128.
If you want to extend or customise these settings, contact NCR
Dundee Product Management for implementation details and
advice.
Offline Screens
5
Offline screen and keyboard files are loaded by screen retrievers.
The screen retriever uses the following properties to set the location
of the files:
Table 5-39
Offline Screen Properties
Property
Type
Description
FormsPath
String
Specifies the path to the offline screen directory
KeyboardsPath
String
Specifies the path to the offline keyboard directory
Reserved Screens
Reserved screen files contain screens defined in ASCII format for
display on the operator interface. If there are multiple reserved
screen files, the following rules apply:


All reserved screen files must be of the same format as resrvd.def
If there are multiple definitions of the same screen identifier, the
definition in the last file to be loaded is used as the previous
definition is overwritten.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-148
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Screen Displays
The paths to these screens are configured using the following
property:
Table 5-40
Reserved Screen Property
Property
Type
Description
ReservedScreenFiles
String
Specifies the paths to files containing reserved screens
Paths can be defined in the following ways:

Absolute path

File name. If the file name is used, the PATH environment variable
is used to determine the full path. The first file found on the path is
loaded
The files are loaded in the order listed in this property. Any
multi-vendor screen files must be specified after the NCR screen files to
ensure that the vendor-specific screens are not overwritten
Screen Manager Class
5
The screen manager class configures the screen retrievers and
reserved screen collections using the following properties:
Table 5-41
Screen Manager Properties
Property
Type
Description
RawScreenCollections
String
Specifies the reserved screen collection to use when loading raw
reserved screen definitions
ScreenRetrievers
String
Specifies the offline screen retrievers to use when loading offline
screen files and keyboard definitions
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-149
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Display Manager Class
5
The display manager class configures the display of screens and the
conversion of any content to a suitable display format using the
following properties:
Table 5-42
Display Manager Properties
Property
Type
Description
Renderer
NCR.APTRA.IRenderer
Specifies the renderer to use when
displaying content on screen
Note: Advance NDC only supports
the .NET WinRenderer component
Converter
NCR.APTRA.NDC.IScrnFrmt.IScreenFormatter
Specifies the screen data converter to
use when converting the NDC screen
data to a format recognised by the
renderer
Note: Advance NDC only supports
the NDC Activate screen definition
format (NDCACSDF) format for use
with the .NET WinRenderer
component
Hide Mouse Pointer
Whether the mouse pointer is hidden or shown is configured using
the following property of the renderer:
Table 5-43
Hide Mouse Pointer Property
Property
Type
Description
HideCursor
Boolean
Specifies whether the mouse pointer is hidden or not
The default is True, the mouse pointer is hidden
The following example shows the mouse cursor:
<Class ID="StdRenderer"
Name="NCR.APTRA.ChnApp.WinRenderer.StdRenderer"
Assembly="NCR.APTRA.ChnApp.WinRenderer.dll">
<Interface>
<Property Name="HideCursor" Value="False" />
</Interface>
</Class>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-150
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Screen Displays
Customer Relationship Management
5
The targeted messaging service is configured using the following
NDCCRMService property:
Table 5-44
CRM Property
Property
Type
Description
TargetedMessaging
NCR.APTRA.ITargetedMessagingService
Specifies the targeted messaging
service to use when providing
customer relationship management
(CRM) content to the CRM service
Enabling Extended Screen
Groups
5
Multi-language consumer screens are identified for display by
applying a language offset to the screen number defined in the state
tables or host message. The language offset is defined in the
language selection state tables.
A group of screens is defined for each language (screen group). The
screen group is chosen using the Language Select from Card (‘V’)
state. For example, if each language has a group of 2500 screens and
four languages are available, the screen groups are as follows:




Language 1 uses screen numbers 0000 to 2499
Language 2 uses screen numbers 2500 to 4999
Language 3 uses screen numbers 5000 to 7499
Language 4 uses screen numbers 7500 to 9999.
The first screen in each group is defined by the screen base. The
screen base is defined using either the Eight FDK Selection Function
(‘Y’) or PIN and Language Select (‘m’) state. In the example above,
the screen base for each language would be as follows:




Language 1 has a screen base of 0000
Language 2 has a screen base of 2500
Language 3 has a screen base of 5000
Language 4 has a screen base of 7500.
The following formatting is applied:



If the screen group in table entry 9 of the Language Select from
Card state is set to 001, it is multiplied by 1000
If any screen base field in extension table 2 of the Eight FDK
Selection Function state is in the range 001 to 009, it is multiplied
by 1000
If any screen base field in extension table 3 of the PIN and
Language Select state is in the range 001 to 009, it is multiplied
by 1000.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-151
Configuring Advance NDC and Associated Components
Configuring Screen Displays
If extended screen groups are enabled, the following formatting is
also applied:



If the screen group in table entry 9 of the Language Select from
Card state is in the range 010 to 050, it is multiplied by 100
If any screen base field in extension table 2 of the Eight FDK
Selection Function state is in the range 010 to 099, it is multiplied
by 100
If any screen base field in extension table 3 of the PIN and
Language Select state is in the range 010 to 099, it is multiplied
by 100.
By default, extended screen groups are disabled. To enable them, set
the following registry entry to 1:
HKLM\SOFTWARE\NCR\Advance NDC\Extensions\Screens\
ExtendedScreenGroupSize
Note: Before enabling extended screen groups, ensure that existing
language selection states do not include ranges of 010 to 050 or 010
to 099, as appropriate.
For details of the states and how they are affected by enabling
extended screen groups, refer to Chapter 2, “State Tables” in the
APTRA Advance NDC, Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-152
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring the Electronic Journal
Configuring the Electronic Journal
5
This section describes the configuration of various options for the
electronic journal (EJ).
EJ Compression
5
Advance NDC can be configured to compress the EJ file on
performing an initialisation option on the Configure menu in
Supervisor.
This sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\
EJCompression
Valid values are as follows:


EJ Privacy
5
0 = disabled (default)
1 = enabled.
EJ privacy compresses and applies password protection to the EJ
file. If the password is forgotten, the EJ files can no longer be
accessed. To allow access to future EJ files, you must de-install
Advance NDC, delete the UCDIPers.dat file, and re-install Advance
NDC.
The UCDIPers.dat file is located in the C:\Program Files\NCR
APTRA\Advance NDC\Data directory.
Maximum EJ File Size
5
The size of the EJ file can be configured using the EJ Options option
on the Configure menu in Supervisor to set the following registry
entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\EJFileSize
In Supervisor, the value is entered in kilobytes (KB). The default is
1411000 bytes, or 1378 KB, for backwards compatibility. The
minimum value is 1 KB. The maximum value is calculated as
follows:
available disk space / (maximum number of backups + 4)
EJ Checksum
5
A checksum is added to the EJ file by default. This cannot be
changed through Supervisor. However, if required, the checksum
can be disabled by adding the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\EJChecksum
Valid values are as follows:

0 to disable the checksum
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-153
Configuring Advance NDC and Associated Components
Configuring the Electronic Journal

1 to enable the checksum
The checksum is added when no registry value is present.
Automatic Initialisation
Options
5
The initialisation of the EJ can be run in a number of ways without
having to manually select the INIT EJRNL Supervisor function. The
backup of the EJ log file is created in the following directory:
c:\program files\advance ndc\data\EJBackups
A copy of the automatic initialisation file can also be saved to a
specified destination. The name of this file can be configured as
described in “EJ Backup Filenames” on page 5-158.
For details of all options set in Supervisor mode, refer to the APTRA
Advance NDC, Supervisor’s Guide.
Note: Multiple destinations must be enabled to use any of the
automatic initialisation features.
Cutover
5
Advance NDC can be configured to run automatic initialisation
whenever the EJ file reaches 90% of the specified maximum size
using the EJ Options option on Configure menu in Supervisor
mode.
The cutover option sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\EJCutover
Valid values for this entry are as follows:


0 = disabled (default)
1 = enabled.
If Cutover is not used, an unsolicited status message is sent when
the EJ file reaches 90% of the specified maximum size. This message
is suppressed when Cutover is used. Also, when Cutover is used,
the EJ file never reaches 100% of the specified maximum size, so the
fatal message will never be seen.
For details of the unsolicited message, refer to the APTRA Advance
NDC, Reference Manual.
Scheduled
5
Advance NDC can be configured to run the automatic initialisation
at a specified time and day or date using the EJ Options option on
the Configure menu in Supervisor mode.
The scheduled option sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\RecurrenceOptions\
EJRecurrence
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-154
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring the Electronic Journal
Valid values for this entry are as follows:


0 = disabled (default)
1 = enabled.
The scheduled initialisation pattern option allows the setting of the
interval at which to run the Scheduled automatic initialisation.
The recurrence pattern sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance
NDC\EJOptions\RecurrenceOptions\
EJRecurrencePattern
Valid values for this entry are as follows:



1 = daily (default)
2 = weekly
3 = monthly.
The recurrence pattern selected determines the other options that
must be set, as follows:



Daily—set time
Weekly—set day of the week and time
Monthly—set day of the month and time.
The time sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance
NDC\EJOptions\RecurrenceOptions\
Time
Valid values for this entry are any four digit number between 0000
and 2359 inclusive. This represents the 24 hour clock, and is based
on the local time.
The day of the week sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance
NDC\EJOptions\RecurrenceOptions\
DOW
Valid values are as follows:







0 = Sunday (default)
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-155
Configuring Advance NDC and Associated Components
Configuring the Electronic Journal
The day of the month sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance
NDC\EJOptions\RecurrenceOptions\
DOM
Valid values for this entry are in the range 1 to 31 inclusive. The
default is 1 (the first day of the month). If the value is greater than
the days in the current month, the automatic initialisation will run
on the last day of the month.
Agent
5
Advance NDC can be configured to run the automatic initialisation
when called by third-party software or a batch file. This is
configured using the Configure menu in Supervisor mode.
This sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\EJAgent
Valid values are as follows:


0 = disabled (default)
1 = enabled.
To run automatic initialisation successfully requires the following:



The third-party software or batch file must be installed in the
appropriate directory. For SST installations, this is C:\Program
Files\NCR APTRA\Advance NDC. For development
installations, the default is <drive>:\ntglobal.
The agent automatic initialisation must be enabled
Advance NDC must be running.
Once these prerequisites are met, the agent can run an automatic
initialisation using third-party software or a batch file.
Third-Party Software
Third party software must call InitEJ.dll:
5
extern ‘C’ IMP_OR_EXP BOOL EJAgentInit()
which is declared in InitEH.h.
Batch File If using a batch file, you have to use InitEJ.exe to call
InitEJ.dll.
The batch file can be called by remote third-party software or run
from the command line at the SST. Any error codes are returned to
the batch file.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-156
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring the Electronic Journal
The following is an example of a batch file used to perform an
automatic initialisation:
Figure 5-9
Example Batch File
@echo off
::InitEJ.exe
InitEJ.exe
if errorlevel 1 goto errhand
echo EJ Initialised
goto end
:errhand
echo EJ failed to initialise
:end
Automatic Initialisation Copy Drive
5
Advance NDC can be configured to make a copy of the automatic
initialisation EJ file using the EJ Options option on the Configure
menu in Supervisor mode.
This sets the following in the registry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\SecondaryBKP
This entry stores the drive letter of the selected destination. The
destination drive must be writable and it cannot be the diskette
drive.
The following registry key can be used to configure a folder path
within the drive specified for the secondary backup:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\FolderPath
This is not configurable through the EJ Options Supervisor option
and must be configured directly in the registry.
Example: If the EJ backup location is configured as
D:\EJFiles\Backups, the EJOptions registry entries need to be set as
follows:
SecondaryBkp = "D:\"
FolderPath = "EJFiles\Backups"
Note: If either the C drive or a CD drive is specified as the
secondary backup drive, the FolderPath registry entry is ignored
and the secondary backup destination is the root of the drive.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-157
Configuring Advance NDC and Associated Components
Configuring the Electronic Journal
Initialisation After Settlement
5
Advance NDC can be configured to initialise the EJ after a
settlement transaction using the Configure menu in Supervisor
mode.
This sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance
NDC\EJOptions\EjinitAfterSettlement (DWORD)
Valid values are as follows:


0 = disabled (default)
1 = enabled.
If this function is enabled, EJ initialisation is performed after the
settlement transaction and then the SST is put into service. If this
function is disabled, the SST is directly put into service, after the
settlement transaction. Since initialisation of EJ is a part of automatic
initialisation, there will not be any user prompt to indicate its
success or failure.
Delaying Initialisation
During Transactions
5
Advance NDC can be configured to prevent a transaction entry
being split over multiple EJ files by delaying EJ initialisation until
any in-progress transaction completes. This delay does not affect the
next scheduled EJ initialisation.
This is configured using the following(DWORD)registry entry:
HKLM\SOFTWARE\NCR\AdvanceNDC\EJOptions\
EJScheduledInitOnlyOnIdle
Valid values for this entry are as follows:


EJ Backup Filenames
5
0 to perform a scheduled EJ initialisation operation at the time it
is due (default). This is used if the entry is missing or an invalid
value is specified.
1 to perform a scheduled EJ initialisation operation at the time it
is due only if a transaction is not in progress, otherwise delay
initialisation until the transaction is complete.
You can configure Advance NDC to allow alternative EJ backup
filenames by using the entries described below which are under the
following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions
EJFileDateFormat
This entry allows you to specify a date format to be included in the
filename of the EJ backup file. If this value is present, and the value
of this entry is one of the supported date formats, then an EJ backup
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-158
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring the Electronic Journal
file is created with the specified date format included in its name.
For example, if the value is ‘ddmmyy’, the EJ filename generated is
EJNNNNNNddmmyy.xxx where ‘NNNNNN’ is the machine number
and ‘xxx’ is the sequence number.
Valid values for this entry are:
ddmmyy
ddyymm
mmddyy
mmyydd
yyddmm
yymmdd
ddmmyyyy
ddyyyymm
mmddyyyy
mmyyyydd
yyyymmdd
yyyyddmm
Note: Each day, month and year part of the value must be entered
in the same case. For example, ddMMyy is a valid entry, but
ddMmyy is invalid.
If this entry is not present or blank, this feature is disabled and the
filename is EJNNNNNN.xxx or EJ.xxx, depending on whether the
EJShortFilename registry entry is configured. If the date format is
not one of the supported date formats, the ddmmyyyy is used.
EJShortFilename
5
This entry allows you to specify EJ backup files with a short
filename. This option is only available when a machine number is
not configured for the terminal.
Using this option, the EJ filename can be as short as EJ.xxx.
However, if the EJFileDateFormat registry entry is also
configured, the shortest filename possible is EJddmmyy.xxx.
Valid values for this registry entry are as follows:


Multiple Destinations for
EJ Backup
5
1 to indicate that the machine number is not configured,
allowing an EJ backup file to have a short filename such as
EJ.xxx, where ‘xxx’ is the sequence number.
0 to indicate that this feature is disabled. This is the default
value.
Advance NDC can be configured to prompt for a drive each time
the EJ is backed up or copied using the Configure menu in
Supervisor mode.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-159
Configuring Advance NDC and Associated Components
Configuring the Electronic Journal
This sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\
MultipleDestination
Valid values for this entry are as follows:


0 for single EJ backup destination. This is the default.
1 for multiple EJ backup destinations.
By default, if the CDRW is selected as the destination drive, the CD
is ejected after the backup is taken. This can be controlled by the
following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\
EjectCD
Valid values for this entry are as follows:


Enhanced EJ Backup
5
0 to keep the CD in the drive following a backup.
1 to eject the CD following a backup. This is the default.
Advance NDC provides the ability to create multiple EJ backup
files. Multiple EJ backup allows up to 1000 EJ files to be stored
depending on disk space. Standard EJ backup is the default,
allowing only a single EJ backup file to be retained.
EJ backup can be changed either through option 36 of the Enhanced
Configuration Parameters Download, or through Supervisor.
Note: There is an option in Supervisor to prevent the host from
changing this setting. For more details, see “Disable Host Control of
Enhanced EJ Backup” on page 5-161.
Each method updates the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\
EJMode
Valid values for this entry are as follows:


0 for standard EJ backup. This is the default
1 for multiple EJ backup.
If standard EJ backup is enabled, files are backed up to C:\Program
Files\Advance NDC\data.
If multiple EJ back up is enabled, files are backed up to C:\Program
Files\Advance NDC\data\ejbackups.
Maximum Number of Backups
With multiple EJ backup set, the maximum number of backups can
be set using the Configure menu in Supervisor mode.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-160
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring the Electronic Journal
This updates the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\
NoOfBackups
Valid values for this entry are 2 to 1000, provided there is enough
space on disk. The default is 10.
If the requested number of backups exceeds the available disk
space, the following message is displayed:
INVALID; MAX POSSIBLE VALUE = <var>
Disable Host Control of Enhanced EJ Backup
5
The EJ backup mode can be changed either through option 36 of the
Enhanced Configuration Parameters Download, or through
Supervisor. Sometimes local control is required and the host control
can be disabled using the Configure menu in Supervisor mode.
This sets the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\EJOptions\
EJBackupECP
Valid values are as follows:


EJ Level
5
0 to prevent the host from changing the EJ backup mode
1 to allow the host to change the EJ backup mode (the default).
The information that is journaled for a transaction to the EJ can be
configured using the EJ Options option on the Configure menu in
Supervisor. The EJ level can be different from the level configured
for the journal printer. The following registry entry (DWORD)
specifies what is journaled for the EJ:
HKLM\SOFTWARE\NCR\Advance NDC\EJLevel
Valid values for this entry are 0, 1, 2 or 3. For a full description of the
values, refer to the APTRA Advance NDC, Supervisor’s Guide.
Journal Page Workers
5
To provide an additional level of control over the data to be
journaled (EJ or journal printer), the Journal Page workers in the
authored application can be modified to restrict what is printed in
conjunction with the journal levels configured through the
Supervisor (option 35 on the Configure menu).
The attribute Journal Level Trigger Value is provided to restrict the
data to be journaled. Data will be journaled according to the value
specified by this attribute. The default value places no restriction on
the data. For more information about modifying the attribute value,
see “Level 1 Modification Example” on page 8-10.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-161
Configuring Advance NDC and Associated Components
Configuring Printers
Configuring Printers
Reconfiguration of the default settings provided by Advance NDC
may be required for particular printers.
When Advance NDC is installed, printers are configured with
default registry settings. If you require a different configuration
setting for your printer, you must edit and run the ANDCSST.xml
file, as described in “Automatic Configuration at Start-up” on
page 5-2.


To configure forms-based printing for an Open Document
Printer on a PersonaS SST, the settings must be as described in
“Form-Based Printing” on page 5-169
To configure USB printers, the setting must be as described in
“USB Statement Printer” on page 5-169
Note: NCR recommends using form-based printing on USB
printers; however, raw data printing is supported. For more
information on configuring a USB printer for raw data printing,
see “USB Receipt and USB Journal Printers” on page 5-174. For
details of creating graphics for USB printers, see “Creating
Graphics Files” on page 5-175. To extend the available fonts,
create a Windows font as described under “Creating Fonts” on
page D-2

If using Promote coupons with a dot matrix printer, see
“Promote Coupons” on page 5-165.
Specific registry entries for journal, receipt and statement printers
can be found under the following keys:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\<printer>
The variable <printer> is one of the following:
Journal Printer Status
5

Journal or Journal Forms

Receipt or Receipt Forms

Statement or Statement Forms.
The following registry entry allows you to configure whether to
report that the journal printer is configured:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Journal\
JournalMissingUnsol
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-162
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Printers
Valid values are as follows:
Table 5-45
Journal Printer Registry Value
Name
Data Value
Description
JournalMissingUnsol
0
Do not generate unsolicited
message to report device not
configured (default value).
1
Generate unsolicited message to
report device not configured.
Journal Printer Level
5
The information that is journaled for a transaction on the journal
printer can be configured using the Configure menu in Supervisor.
The following registry entry specifies what is journaled:
HKLM\SOFTWARE\NCR\Advance NDC\
JournalLevel (DWORD)
Valid values for this entry are 0, 1, 2 or 3. For a full description of the
values, refer to the APTRA Advance NDC, Supervisor’s Guide.
Cash Count Reporting By default, cash counts are journaled after
notes have been presented when the journal level is set to 3.
Journaling of cash counts can be disabled or modified by editing the
relevant screen in resevd.def. To disable the journaling of a cash
count, remove the text from the appropriate screen. If a screen is
blank, no journaling occurs and no blank line is printed.
5
The screens are described in Table 5-46, “Cash Count Journal
Screens”. For details of the screens in resrvd.def, refer to Appendix A,
“Reserved Screens”, in the APTRA Advance NDC, Reference Manual.
Table 5-46
Cash Count Journal Screens
Screen Number
Description
j0027
Heading line for NDC cassette types 1 to 4
j0028
Heading line for NDC cassette types 5 to 7
j0029
Heading line for the currency value of the notes in
the cassette type identified in screen j0027 or j0028
The currency symbol is not included
The cassette type must be configured
For details of configuring the cassette types, see
“Configuring Cash Handlers” on page 5-186
j0030
Cash counts for dispensed notes
j0031
Cash counts for rejected notes
j0032
Cash counts for remaining notes
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-163
Configuring Advance NDC and Associated Components
Configuring Printers
Journal Page Workers To provide an additional level of control
over the data to be journaled (journal printer or EJ), the Journal Page
workers in the authored application can be modified to restrict what
is printed in conjunction with the journal levels configured through
the Supervisor (option 35 on the Configure menu).
5
The attribute Journal Level Trigger Value is provided to restrict the
data to be journaled. Data will be journaled according to the value
specified by this attribute. The default value places no restriction on
the data. For more information about modifying the attribute value,
see “Level 1 Modification Example” on page 8-10.
Receipt Printer
5
The default configuration for the receipt printer service provider is
the following:



Thermal printer
Variable length receipt
‘Black Mark’ disabled, to prevent the printer automatically
ejecting receipts that exceed the printer’s standard receipt
length.
Receipt Handling
5
Any receipts that are not removed will be retracted, if the hardware
has the capability, as follows:



At Start of Day
In the Close state
On execution of INIT RECEIPT (Initialise Receipt function in
Supervisor).
Receipt Retract By default, receipts are retracted. To disable
retract for receipts, change the following registry entry:
5
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\RECEIPT\
DisableCaptureIfPageNotTaken
Valid values are as follows:
0 = Enable receipt retract (default value)
1 = Disable receipt retract.
For any other value or if the value is not present, the default value is
used.
Long Receipt Retract When retract receipt is enabled
(DisableCaptureIfPageNotTaken is 0), and Supervisor Message
Mode option 6B (max 49 lines printed before cut) is set, a further
registry entry controls whether long receipts are retracted, as
follows:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\RECEIPT\
RetractLongReceipt
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-164
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Printers
Valid values are as follows:
0 = Disable retract for long receipts (default value)
1 = Enable retract for long receipts.
For any other value or if the value is not present, the default value is
used.
If the last receipt of multiple receipts is a long receipt, it is retracted
if RetractLongReceipt is enabled and the retract bin is not full.
Note: Long receipts will not be retracted unless the two registry
entries described above are set to enable receipts and long receipts
to be retracted.
Reporting Capture Bin Full When the capture bin is full, receipts
continue to be printed but are no longer retracted if not taken by the
consumer. After the capture bin has been emptied, receipts will be
retracted if not taken. The capture bin can be reported as full in
messages to the host and on the fault display.
5
On NCR SSTs, an unsolicited message can be sent when the capture
bin is full to report a fatal condition for the receipt printer. The
following registry entry controls whether a fatal condition is
reported for the receipt printer when the capture bin is full:
HKLM\SOFTWARE\NCR\APTRA Self-Service Support (NCR
Features)\Usb80mmThermalPrinters\
Operations Parameters\RPNT-01-UsbThermal\CONFIG
Valid values are as follows:
0 = Do not report receipt printer as fatal when capture bin is full
(default).
1 = Report receipt printer as fatal when capture bin is full.
For any other value or if the value is not present, the default value is
used.
Promote Coupons
5
The format to use when printing Promote coupons has to be
configured for the specific receipt printer in use.
To permit Promote coupon printing, a string value must exist under
the following:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\RECEIPT\
PROMOTE_COUPON_FORMAT
Valid data values are as follows, running ANDCSST.xml sets these
as defaults:

RCPT:PFM-LOWRES for NCR 40 column thermal printers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-165
Configuring Advance NDC and Associated Components
Configuring Printers

RCPT:PFM-HIGHRES for NCR 60mm thermal printers

RCPT:BMP-HIGHRES for NCR USB printers

RCPT:BMP-LOWRES for non-NCR printers
Printing Promote Coupons Promote coupons can be printed on
the back of the transaction receipt if the following are true:


5
The receipt printer is a two-sided USB thermal printer
Promote returns the delivery type as Back.
Where the receipt is printed when the delivery type Back is
specified depends on the capabilities of the printer and the type of
paper loaded, as described in Table 5-47.
Table 5-47
Promote Coupon Printing
2ST printer?
2ST paper?
Delivery Type Used:
Receipt Requested/Required?
Host Data on Back?
Coupon Printed on:
Yes
No
Attached
Yes
-
Front
Attached to
receipt
No
-
Attached
Yes
-
Front
Attached to
receipt
Yes
Yes
Back
No
-
Back
Yes
No
Standalone
Yes
-
Front
Separate from
receipt
No
-
Standalone
No
-
Front
Separate from
receipt
Yes
Yes
Back
Yes
-
Back
On transaction
receipt
Yes
Yes
Attached
Yes
Yes
Front
Attached to
receipt
Printing Promote Coupons During Transaction Reply
Functions You can choose to print Promote coupons only when a
receipt is successfully printed. The coupon can be printed during
the following Transaction Reply functions:



Dispense and Print
Next State and Print
Fast Cash
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-166
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Printers







Card Before Cash
Card Before Dispense and Print
Print Statement and Next State
Envelope Deposit and Print
BNA Encash and Set Next State
BNA Encash and Wait
BNA Refund and Set Next State
This feature is enabled through the following DWORD registry
entry:
HKLM\SOFTWARE\NCR\Advance NDC\Promote\
Print Coupon Only After Successful Receipt Print
Valid values are as follows:


0 = Print a Promote coupon even when no receipt is printed
(default)
1 = Print a Promote coupon only when a receipt is printed.
If an invalid value is specified or the registry entry does not exist,
the default value is used.
Dot-Matrix Receipt Printers When using a dot-matrix receipt
printer that supports multi-vendor coupon printing, the following
must be set to “ ” (empty string):
5
5
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\RECEIPT\
PROMOTE_COUPON_FORMAT
This stops any attempt to print a coupon.
If you use APTRA Promote SST RTL 02.07.01, which does not
support multi-vendor coupon printing, this must be set to RECEIPT.
Top Margin of Receipts
5
The receipt top margin can be configured through reserved screen
K01 for raw data printing or, for forms-based printers, the following
registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Receipt Forms\
Print Data\Form Alignment
In addition, the receipt top margin can be configured through
Supervisor (option 92, RECEIPT TOP MARGIN on the Configure
menu) and the values are stored in the following registry entries:

Raw data printing (personaS printers)
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\RECEIPT\
ReceiptTopMargin
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-167
Configuring Advance NDC and Associated Components
Configuring Printers

Forms-based printing (USB printers on SelfServ SSTs)
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Receipt Forms\
ReceiptTopMargin
By default, the registry value for each is NULL (undefined). Valid
values are 0 to 24 and NULL. If a valid value is entered in Supervisor,
the registry entries are updated with the new value.
The receipt top margin can also be configured remotely through the
ReceiptTopMargin entry in UniversalPrinters.reg and
PersonasPrinters.reg.
Priority of Values
as follows:
The order of priority in processing the values is
1
The value entered through Supervisor
2
The value defined in the K01 screen
3
The value set in the Form Alignment registry entry
The first two options apply to both raw-data printing and
forms-based printing. The third option applies only to forms-based
printing.
If an invalid value is entered in Supervisor, the previous valid value
entered in Supervisor takes priority over the value in screen K01.
If the ReceiptTopMargin registry entry is updated manually and an
invalid value is entered, the value in screen K01 screen takes
priority.
For raw-data printing, if the ReceiptTopMargin registry value is
NULL (the default value), the value in screen K01 is used.
For forms-based printing, if the ReceiptTopMargin registry entry is
NULL (the default value), the value provided in screen K01 is used.
If the top margin value in screen K01 is also defined as 0, the value
in the Form Alignment registry entry is used.
For details of screen K01, refer to Chapter 3, “Screen Data”, of the
APTRA Advance NDC Reference Manual.
For more information about option 92 RECEIPT TOP MARGIN,
refer to Chapter 4, “Configure Menu” of the APTRA Advance NDC
Supervisor’s Guide.
Statement Printer
5
You can set a maximum statement length, which sets the maximum
number of lines to be printed before a cut. This ensures that the
statement will be cut when the black mark is not used. The
maximum number of lines is set using the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Statement\Length
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-168
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Printers
The default value is 20. The valid range is 12 to 92.
If you are using forms-based printing with the statement printer
and require a font, for example for a specific language, you must
create the font. For details of creating fonts, see “Creating Fonts” on
page D-2. You cannot use a mapping file to translate an unknown
character as this only applies to raw data printing. For more
information on mapping files, refer to Appendix B, “Character Sets”
in the APTRA Advance NDC, Reference Manual.
USB Statement Printer
5
For a USB statement printer, edit ANDCSST.xml and change the
value of the Document Printer alias from
“Document Printer”=”OpenDocumentPrinter1”
to
“Document Printer”=”USBStatementPrinter1”
Form-Based Printing
5
Forms can be dynamically generated for each print operation for
statement, receipt or journal printers. The form generation process
can be customised using the registry entries described in Table 5-48.
The <printer type> variable in the registry keys represents the
printer type as follows:
—
—
—
STATEMENT
RECEIPT
JOURNAL
Registry Entries for Configuring Forms
5
The settings to configure the forms generation process are provided
under the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\
<printer type> Forms
Table 5-48
Registry Entries for Configuring Forms
Registry Entry
Values
Description
Dynamic Forms
See Table Note 4
Can be either of the following:

0 to prevent form-based printing

Any non-zero number to allow
form-based printing (default is 1)
Specifies whether forms can be
used.
In the following format:
Convert <printer type> Forms.
Specifies the function name to use
for field conversion during form
generation.
FUNCTIONNAME

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-169
Configuring Advance NDC and Associated Components
Configuring Printers
Registry Entry
Values
Description
SCALING
Valid values are as follows:

0 to scale the graphic to fit the
boundaries of the graphic field, the
aspect ratio may be lost (default)

1 to scale the graphic to fit within the
boundaries of the graphic field,
maintaining the aspect ratio

2 to print the graphic at normal size. This
prints only the part of the graphic that
fits within the boundaries of the graphic
field. The part of the graphic that is
printed depends on the horizontal and
vertical positioning of the field
Specifies the scaling to apply to
graphics when printing using the
Print Graphic control sequence.
Default values for USB printers are as
follows:

Journal printer: Journal1

Receipt printer: Receipt1

Statement printer: Statement80
Default value for the Open Document printer
is Statement80.
Specifies the media definition
name to use when printing forms.
Print Data\Form Units
The only valid value is the default, as
follows:

ROWCOLUMN, 1, 1.
Specifies the units of measurement
used in forms generation.
Print Data\Form
Alignment
Valid values are vendor dependent, but will
be one of the following:

TOPLEFT, 1, 1. This is the default.

TOPLEFT, 0, 0
Specifies the starting coordinates
for the form using ROWCOLUMN
format.
Print Data\Forms
Extension
The value is found in the key values for your
printer. By default, it is as follows:

.DEF.
Specifies the file extension for the
generated form.
Media Definition
For details of the Print Graphic
control sequence, refer to Chapter
5, “Printer Data” in the APTRA
Advance NDC, Reference Manual.
If the SST Configuration
Component identifies the UPTR
service provider, it sets this to an
empty string (“”). Otherwise, a
media definition file must be
present and contain the definition
matching the name used in this
registry entry.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-170
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Printers
Registry Entry
Values
Description
SCALING
Valid values are as follows:

0 to scale the graphic to fit the
boundaries of the graphic field, the
aspect ratio may be lost (default)

1 to scale the graphic to fit within the
boundaries of the graphic field,
maintaining the aspect ratio

2 to print the graphic at normal size. This
prints only the part of the graphic that
fits within the boundaries of the graphic
field. The part of the graphic that is
printed depends on the horizontal and
vertical positioning of the field
Specifies the scaling to apply to
graphics when printing using the
Print Graphic control sequence.
Default values for USB printers are as
follows:

Journal printer: Journal1

Receipt printer: Receipt1

Statement printer: Statement80
Default value for the Open Document printer
is Statement80.
Specifies the media definition
name to use when printing forms.
Print Data\Form Units
The only valid value is the default, as
follows:

ROWCOLUMN, 1, 1.
Specifies the units of measurement
used in forms generation.
Print Data\Form
Alignment
Valid values are vendor dependent, but will
be one of the following:

TOPLEFT, 1, 1. This is the default.

TOPLEFT, 0, 0
Specifies the starting coordinates
for the form using ROWCOLUMN
format.
Print Data\Forms
Extension
The value is found in the key values for your
printer. By default, it is as follows:

.DEF.
Specifies the file extension for the
generated form.
Media Definition
For details of the Print Graphic
control sequence, refer to Chapter
5, “Printer Data” in the APTRA
Advance NDC, Reference Manual.
If the SST Configuration
Component identifies the UPTR
service provider, it sets this to an
empty string (“”). Otherwise, a
media definition file must be
present and contain the definition
matching the name used in this
registry entry.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-171
Configuring Advance NDC and Associated Components
Configuring Printers
Registry Entry
Values
Description
SCALING
Valid values are as follows:

0 to scale the graphic to fit the
boundaries of the graphic field, the
aspect ratio may be lost (default)

1 to scale the graphic to fit within the
boundaries of the graphic field,
maintaining the aspect ratio

2 to print the graphic at normal size. This
prints only the part of the graphic that
fits within the boundaries of the graphic
field. The part of the graphic that is
printed depends on the horizontal and
vertical positioning of the field
Specifies the scaling to apply to
graphics when printing using the
Print Graphic control sequence.
Default values for USB printers are as
follows:

Journal printer: Journal1

Receipt printer: Receipt1

Statement printer: Statement80
Default value for the Open Document printer
is Statement80.
Specifies the media definition
name to use when printing forms.
Print Data\Form Units
The only valid value is the default, as
follows:

ROWCOLUMN, 1, 1.
Specifies the units of measurement
used in forms generation.
Print Data\Form
Alignment
Valid values are vendor dependent, but will
be one of the following:

TOPLEFT, 1, 1. This is the default.

TOPLEFT, 0, 0
Specifies the starting coordinates
for the form using ROWCOLUMN
format.
Print Data\Forms
Extension
The value is found in the key values for your
printer. By default, it is as follows:

.DEF.
Specifies the file extension for the
generated form.
Media Definition
For details of the Print Graphic
control sequence, refer to Chapter
5, “Printer Data” in the APTRA
Advance NDC, Reference Manual.
If the SST Configuration
Component identifies the UPTR
service provider, it sets this to an
empty string (“”). Otherwise, a
media definition file must be
present and contain the definition
matching the name used in this
registry entry.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-172
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Printers
Registry Entry
Values
Description
Print Data\Forms Name
The value is found in the key values for your
printer.
Used to generate a unique form
name, and provide the filename of
the generated form.
Print Data\Forms Path
The default paths are as follows:
Specifies the directory in which to
generate the form.


C:\Program Files\NCR
APTRA\Advance NDC\
Printing\<printer type>\Forms
C:\Program Files\NCR
APTRA\Advance NDC\
Printing\<printer type>\Media
Some service providers need the
form to be stored in a specific
directory, or the form will not load
at run time. Refer to the
appropriate vendor publications
for the value required for this
entry.
Table Note 4: If configuring an Open Document Printer on a
Personas SST, you must update this entry as follows:
— Update the Dynamic Forms entry in the ANDCSST.xml file
from 0 to 1
— Update the Aliases entry in the ANDCSST.xml file from
“Document Printer”=”StatementPrinter1” to “Document
Printer”=”OpenDocumentPrinter1”.
Registry Entries for Configuring Fonts
5
The <var> part of the registry entries for configuring fonts
represents a font identifier. Any ASCII character can be used as the
font identifier, but only those present in the print stream are
actioned.
The settings to configure the font identifiers are provided under the
following registry key.
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\<printer type>
FORMS\Print Data\Font Identifiers\<var>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-173
Configuring Advance NDC and Associated Components
Configuring Printers
Table 5-49
Registry Entries for Configuring Fonts
Registry Entry
Values
Description
Font Name
This is vendor-dependent. Refer to the
appropriate vendor publications for the
values accepted for this entry.
The name of the font, used in the font field
of the form.
By default this entry is blank, which means
that the default font will be used.
CPI
The value is vendor-dependent. Refer to the
appropriate vendor publications for the
values accepted for this entry.
For NCR printers, the default is 12 CPI.
Font Size
Valid values are as follows:

1 for single size

2 for double size

3 for condensed size
The characters per inch setting, used in the
CPI field of the form for the following font
identifiers:

F

G

H

O

P
Specifies the font size in characters.
Registry Entry for Configuring LPI
Entries to configure the number of lines per inch (LPI) are provided
under the following registry key:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\<printer type>
FORMS\Print Data\LPI Index
Table 5-50
Registry Entry for configuring LPI
Registry Entry
Values
Description
<var>
The LPI indexes, 0 to 7 inclusive
The lines per inch setting, used in the LPI
field of the form. A missing index indicates
that it is to be ignored and no LPI setting is
added to the XFSFIELD definition.
USB Receipt and USB
Journal Printers
5
Although the supported LPI setting is the same across all printer
types, other features may require specific configuration on
particular printers.
For details of the differences in registry entries for the USB Receipt
and Journal printers, refer to the APTRA Advance NDC, Reference
Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-174
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Printers
For details of the printer SP, refer to the APTRA online
documentation.
For raw data on a USB printer, the following registry entries are
used:
Table 5-51
USB Receipt and Journal Registry Entries
for Raw Data
Registry Entry
Description
CHAR_MAP_FILENAME
Stores the character map filename,
which translates the code page
used by the USB Receipt and
Journal printer into the
corresponding Arabic and
International characters.
CHAR_MAP_DESIGNATOR
Stores the designator used to
identify the user-specified font in
the mapping file.
For details of the mapping file and associated registry entries, refer
to the APTRA Advance NDC, Reference Manual.
Registry Entry for Receipt Retract
5
Disabling or enabling receipt retract is the same as for non-USB
printers. For details of the registry settings, see “Receipt Handling”
on page 5-164.
Creating Graphics Files
5
Note: The .prn files for SDC printers will not print on USB printers.
For forms-based printing, you must create a .bmp file with the same
name as the .prn file. Advance NDC automatically uses the .bmp file
during forms-based printing.
For raw data printing on USB printers, you must create a usable .prn
file. To create .prn files for use with USB Receipt and USB journal
printers, do the following:
1
Locate the NCR80RDR.INF file on your PC and note the path.
This file is installed as part of an APTRA XFS development
installation.
2
Select Start from the Windows Taskbar, then Printers and Faxes
| Add Printer. The Add Printer Wizard opens.
3
Select the Next button.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-175
Configuring Advance NDC and Associated Components
Configuring Printers
4
Select the Local printer attached to this computer radio button
and deselect the Automatically detect and install my Plug and
Play printer check box. Select the Next button.
5
Select the Use the following port radio button, and select File
(Print to File) from the associated drop-down menu. Select the
Next button.
6
Select the Have Disk button. The Install from Disk dialog box
appears, select the Browse button and browse to the
NCR80RDR.INF file in the location you identified in step 1.
Select the NCR80RDR.INF file from the file list, and select the
Open button. You are returned to the Install from Disk dialog
box, select the OK button to return to the Add Printer Wizard.
7
Select “NCR USB 80mm Renderer” from the Manufacturer list
box, and then select the Next button.
8
Choose the default printer by selecting one of the following
radio buttons:
— If you have a different printer that you want to use as the
default, select the No radio button
— If you want to use the NCR USB 80mm Renderer as the
default, select the Yes radio button.
Select the Next button.
9
Select the Do not share this printer radio button, then select the
Next button.
10 As this is printing to a file, you do not need to print a test page,
so select the No radio button, then select the Next button.
11 Select the Finish button.
As the NCR USB 80mm Renderer driver is not signed, you might be
prompted before installation. Choose to continue with the
installation. A message will appear notifying you of a successful
installation.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-176
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Printers
To print a logo with forms-based printing on USB printers, ensure
that an equivalent .bmp file is available.
For raw data printing on USB printers, the logo may need to be
resized. To print a correctly sized logo file, ensure that the paper
size is set to match the receipt paper size as follows:
1
Select Start from the Windows Taskbar, then Printers and Faxes
| NCR USB 80mm Renderer |Open | Printer | Printing
Preferences | Advanced | Paper Size.
2
Update the paper size to match the receipt paper size. By default
the paper size is set to NCR 80x500mm. For normal size receipt
paper, this should be changed to NCR 80x25mm.
To produce a .prn file, open the graphic you require and select Print
to File.
Non-Thermal Printers
5
Reconfiguration is required for journal, receipt and statement
printers that do not support the printer control codes set as default
in Advance NDC, such as ESC G for graphics. If an unsupported
control code is sent for printing, a square bracket ( [ ) is printed.
The configuration can be made either through the host or through
the registry settings on the SST. The registry entries for printers are
under:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING
The following subkeys may need to be reconfigured for your
particular printer:







BARCODE
GRAPHICS
HZ_HGHT_BARCODE
POS_HRI_CHAR
SW_ON
SW_OFF
WIDTH_BARCODE
For information about supported control codes, refer to the
documentation for your particular printer.
Passbook Printer
5
If you develop an authored flow using the Passbook Printer worker
classes provided in the APTRA Author, the following registry key is
available to control page mark or line number processing:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Passbook
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-177
Configuring Advance NDC and Associated Components
Configuring Printers
You can set the values so the Passbook Reader worker does not read
the page mark for the page number or scan the passbook for the
next line number. Valid values are as follows:
Table 5-52
Passbook Printer Registry Values
Name
Data Value
Description
BypassPageMark
0
The page mark is read and the
resulting value stored in the Page
Number Store (default)
1
The page is not read and a value of 0
(zero) is stored Page Number Store
If this is set, the page mark scan still
occurs when the first READ_FORM
command is issued, but the Passbook
Reader worker does not read the scan
0
The page is scanned for the next
available line and the result is stored
in the Line Number Store (default)
1
The page is not scanned and a value of
0 (zero) is stored in the Line Number
Store
BypassLineScan
As the Passbook Definition and Passbook Definer worker classes
use form and media definitions to interface with XFS, the following
registry entries are included in ANDCSST.xml file, giving the
default location where these definitions will be dynamically created
by the workers:
HKLM\SOFTWARE\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDERS\
PPTR\GENERAL_CONFIGS
FormsDir = C:\Program Files\NCR APTRA\Printing\
Passbook\Forms
MediaDir = C:\Program Files\NCR APTRA\Printing\
Passbook\Media
For more information, refer to the Passbook Printer worker class
help in the Author.
Implementation
The following steps illustrate how these settings affect the
implementation.
1
The Passbook Acceptor worker issues a READ_FORM command to
enable the device. When media is inserted, this worker signals
2
An attempt is made to read the magnetic stripe on the passbook
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-178
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Printers
3
If this is the first transaction following a reboot of the SST, the
line scan is performed. This occurs whatever the value of the
ByPassLineScan registry setting
4
Depending on the registry settings, one of the following occurs:
— If both ByPassPageMark and ByPassLineScan are set to 1
no further READ_FORM commands are issued. Typically,
information from the magnetic stripe is used by the
application instead of that in the Page Number and Line
Number stores
— If both ByPassPageMark and ByPassLineScan are set to 0, a
second and third READ_FORM command is issued to read the
page mark and look for empty lines
— If ByPassPageMark is set to 1 and ByPassLineScan is set to
0, Advance NDC does not attempt to read the page mark,
and a second READ_FORM is issued to look for empty lines
— If ByPassPageMark is set to 0 and ByPassLineScan is set to
1, a second READ_FORM is issued to read the page mark, but
no attempt is made to look for empty lines.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-179
Configuring Advance NDC and Associated Components
Configuring Readers
Configuring Readers
This section describes configuration of the following functionality
for reader devices:



Accepting Smart Cards in
Motorised Card Readers
Accepting Smart Cards in Motorised Card Readers
Additional DASH Reader Fatal/Suspend Handling
Barcode Reader Filter Configuration
Advance NDC can be configured to allow smart (non-magnetic)
cards to be accepted by setting the following in the registry:
5
HKLM\SOFTWARE\NCR\APTRA Self-Service Support (NCR
Features)\<var>\Operational Parameters\
NON MAGNETIC ACCEPT
where <var> represents the specific card reader, for example,
SdcMotorisedCardReader. An entry is created for each card reader
attached to the SST during the service provider configuration.
Valid values are as follows:


0 = non-magnetic cards are not accepted
1 = non-magnetic cards are accepted
You must also create the following registry key and DWORD entry:
HKLM\SOFTWARE\NCR\Advance NDC\Extensions\
Option39\AcceptMagCardsOnly = 0
Additional DASH Reader
Fatal/Suspend Handling
5
When using a DASH reader with Card Read State A, or Card Read
State T with no chip connect bit set, the reader acts as a standard
DIP reader and does not enter a suspend state.
To use the additional fatal/suspend handling the following registry
entry must be set to '1':
HKLM\Software\NCR\Advance NDC\DASH\EnableSeverity
By default, this option is not enabled.
When enabled, the following additional fatal/suspend handling
occurs:


If a card is entered in a DASH reader and not removed before
Timer 72 expires, a suspend message is sent and the DASH
reader enters a suspend timeout.
If the card is still detected in the DASH reader after the suspend
timeout expires, the reader reports a fatal status and goes out of
service. The card entry screen is displayed, but no cards can be
accepted.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-180
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Readers
Note: Because the suspend and fatal states are initiated by the
application, they are not reflected in the fault display information.
Barcode Reader Filter
Configuration
5
The barcode reader configuration is defined within the
NDCBarcodeReader.xml file. This file can be updated through
software distribution, local modification or the XML Configuration
Download message. For details of the XML envelope that must be
used with this configuration file, see “XML Configuration Files” on
page 5-34. For details of the XML Configuration Download refer to
the APTRA Advance NDC, Reference Manual.
The NDCBarcodeReader.xml file is stored in the following location:
C:\Program Files\NCR APTRA\Advance NDC\Config
The Barcode Filter schema, NDCBarcodeReader.xsd, defines the
structure of the configuration data for the barcode reader.
Table 5-53
Barcode Filter Structure Definition
Element
Description
BarcodeReaderClass
The whole file is embedded within BarcodeReaderClass tags.
This is the root element.
Nested elements:

BarcodeReaderDevice
BarcodeReaderDevice
The identification number of the barcode reader device.
Nested elements:

Name

Instance

BarcodeFilter
Name
A free format name assigned to the device. This name is for information only.
Instance
The barcode reader device that the configuration applies to. There is only one
barcode reader available for the barcode reader device class.
BarcodeFilter
A list of barcode filters that are used for comparison within the Barcode Read
state. These filters ensure that the barcode conforms to an application template
and allow the state flow to branch, based on the barcode presented.
Nested elements:
Index

Offset

Filter

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-181
Configuring Advance NDC and Associated Components
Configuring Readers
Element
Description
Index
This value is used as an index for the Barcode Read state parameters and is used
to select an exit. Index is in the range 0 to 48. See “&-Barcode Reader State” in
Chapter 2, “State Tables” of the APTRA Advance NDC, Reference Manual.
Note: The values should be kept as low as possible to minimize the number of
extension states required. The most common filters are assigned lower range
index identifier values.
Offset
Within the barcode, the position of the character at which the comparison is to
start.
Filter
Specifies a character filter, which ensures that only barcodes of the correct format
are accepted by the application.
Filter can contain any ASCII hex character from 0x20 to 0x7E. The following
characters have a special meaning within the filter process:

@ = numeric character 0-9

% = any character from 0x20 to 0x7E
For example, ‘abc@@@@%%%def’ would be used to select a string within the
barcode that begins at the index specified by the Offset and exactly matches the
following sequence:
1
The characters ‘abc’
2
Any four numeric characters in the range 0-9
3
Any three characters from 0x20 to 0x7E
4
The characters ‘def’.
Example Barcode Filter Configuration File
<?xml version="1.0" encoding="UTF-8"?>
<BarcodeReaderClass
xmlns="http://www.ncr.com/APTRA/NDC/BarcodeReader"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.ncr.com/APTRA/NDC/
BarcodeReader NDCBarcodeReader.xsd">
<BarcodeReaderDevice DeviceID="f">
<Name>Barcode1</Name>
<Instance>1</Instance>
<BarcodeFilter>
<Index>0</Index>
<Offset>0</Offset>
<Filter>1234@@45</Filter>
</BarcodeFilter>
<BarcodeFilter>
<Index>1</Index>
<Offset>0</Offset>
<Filter>Bill%%12345@@</Filter>
</BarcodeFilter>
</BarcodeReaderDevice>
</BarcodeReaderClass>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-182
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Coin Dispensers
Configuring Coin Dispensers
5
A coin mapping table held in the registry of the SST is used to map
the cash units to the Advance NDC coin hopper types. On NCR
SSTs, the mappings between the physical hoppers, the cash units
and the Advance NDC hopper types are automatically set up.
Therefore, no additional operator configuration is needed after the
initial installation of Advance NDC, nor any reconfiguration after
replenishment. Advance NDC applies a one-to-one mapping of
hopper type to cash unit.
Note: If either the CDM SP or the coin mapping table is changed
from the default, errors will occur or incorrect coins will be
dispensed. This will be obvious from testing, or the errors
generated.
The coin dispenser does not maintain a record of the number of
coins dispensed. This means that if a power failure occurs during a
coin dispense, the counts will be incorrect.
Registry Keys for the Coin
Dispenser
Registry entries for coins are held under the following eight registry
keys:
5
HKLM\SOFTWARE\NCR\Advance NDC\CoinTable\NDCHopperType<x>
The variable <x> in NDCHopperType<x> is a number from 1 to 8 to
identify the hopper type.
Setting the Currency
5
The currency dispensed by a hopper is set using the CurrencyID
registry entry. The default setting for the currency is USD for
American dollars.
Note: The CurrencyID value must be a valid ISO currency code as
defined by ISO 4217.
Setting the Coin Value
Table 5-54
Default Hopper Values
5
The value of the coins dispensed by a hopper is set using the Value
registry entry: Advance NDC provides eight entries, one for each
hopper type, set by default as follows:
Type
Default Coin Value
Default Value in the Default Currency
1
10
10 cents
2
20
20 cents
3
50
50 cents
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-183
Configuring Advance NDC and Associated Components
Configuring Coin Dispensers
Setting the Low Threshold
5
Caution:
Supplies and Severity
Information
Type
Default Coin Value
Default Value in the Default Currency
4
100
1 dollar
5
10
10 cents
6
20
20 cents
7
50
50 cents
8
100
1 dollar
You can set low thresholds for the number of coins in a hopper. The
registry entry LowCoinsThreshold defines the threshold for coins
remaining in a hopper before they are reported as low. Advance
NDC provides eight entries, one for each hopper type, set by default
to 30.
Allowing the coin dispenser to become too low can cause jams as
the coins are dispensed using gravity only.
Supplies and severity information is updated to reflect the known
state of the coin dispenser as described in the following table:
5
Table 5-55
Supplies and Severity
Point at which update occurs...
Cassette Status
Severity Reported As...
Supplies Reported As...
Start of Day
Good
Good
Sufficient Coins
Low
Good
Coins Low
Empty
Good
Coins Low
Missing
Good
No new state
Good
Good
Sufficient Coins
Low
Good
Coins Low
Empty
Good
Coins Low
Missing
Good
No new state
Good
Good
Sufficient Coins
Low
Good
Coins Low
Empty
Fatal
Out of Coins
Missing
Good
No new state
Supervisor Exit
Following a CHECK COIN
operation
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-184
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Coin Dispensers
Point at which update occurs...
Cassette Status
Severity Reported As...
Supplies Reported As...
Following a coin dispensing
transaction, status information
is updated only for hoppers
used in the transaction
Good
Good
Sufficient Coins
Low
Good
Coins Low
Empty
Fatal
Out of Coins
Missing
Fatal
Out of Coins
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-185
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
Configuring Cash Handlers
A currency cassette mapping table held in the registry of the SST is
used to map the XFS logical cassette units to the Advance NDC
cassette types. On NCR SSTs, the mappings between the physical
cassette units, the XFS logical cassette units and the Advance NDC
cassette types are automatically set up. Therefore, no additional
operator configuration is needed after the initial installation of
Advance NDC, nor any reconfiguration after replenishment, unless
you are using one of the following:



A recycling unit in any capacity, including as part of a dual cash
handler setup. If a recycling unit is used, all settings used must
conform to the stricter requirements of a recycling unit
A cash handler with a fifth physical cassette. If a fifth physical
cassette is used, you must update the registry entry for this
cassette as described in “Cash Handler with a Fifth Physical
Cassette” on page 5-190. Only four logical cassettes are
supported, so you must also configure at least two physical
cassettes as the same cassette type
Gasper. For information on requirements required for Gasper,
refer to the Gasper documentation.
Note: If either the CDM SP or the currency cassette mapping table
is changed from the default, errors will occur or incorrect notes will
be dispensed unless both are changed to matching valid values.
Any inconsistencies will be obvious from testing, or the errors
generated. The default values are stored in AdvanceNDC.reg in the
DLL directory and theANDCSST.xml file in the Config directory.
The cash handler can also be configured using the Extended Add
Cash option in Supervisor. This option is offered, in particular, for
mixed NCR and other vendor networks. For details of configuring
the Extended Add Cash option, see “Extended Add Cash Option”
on page 5-84.
Setting the Currency
5
The currency used by each cassette type is set using the following
registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCTypex\
CurrencyID
Each cassette type must be defined using the x in NDCTypex to
identify the cassette type.
The value is the Currency ID using ISO 4217 alphabetic currency
codes, for example EUR for euro or GBP for sterling.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-186
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
Setting the Media Type
The kind of cassette in use is set using the following registry entry:
5
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCTypex\
MediaType
Each cassette type must be defined using the x in NDCTypex to
identify the cassette type.
The content of this setting is the CEN-XFS media type. For a
recycling unit, this must be set to one of the following:


3 (WFS_CDM_TYPEBILLCASSETTE)
12 (WFS_CDM_TYPERECYCLING).
For details of the media types, refer to the APTRA on-line
documentation for usType, under APTRA XFS | Programmers
Reference | XFS Service Providers.
Setting the Denomination
5
The value of the notes used by each cassette is set using the
following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCTypex\
Value
Each cassette type must be defined using the x in NDCTypex to
identify the cassette type.
Setting the Cassette
Identifier
5
Each cassette can optionally be uniquely identified to allow a
denomination to be mapped to multiple cassettes. The identifier is
set using the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCTypex\
UnitID
Each UnitID must be a unique string. For example, on NCR SSTs
the cassettes are identified using numbers in the range 1 to 7.
Setting the Cash Unit
Identifiers for Supervisor
5
The position of each cassette can be defined using options on the
Extended Add Cash menu, as described in Chapter 3, “Configure
Menu” of the APTRA Advance NDC, Supervisor’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-187
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
The screens used to set the cassette mapping are as follows:
Table 5-56
Cash Unit Identifiers in Supervisor Screens
Screen
Description
Update SP Cash Unit ID
This is displayed during the sequence of screens for the Configure Cash
Units option
The SP cash unit identifiers are mapped to the physical cassette identifiers
defined in the CEN-XFS cUnitID field
For further information on the cUnitID field, refer to the APTRA online
documentation under APTRA XFS | Programmer’s Reference | XFS
Service Providers | XFS GBRU-GBNA Service Provider | Application
Guidelines
Update Cash Unit ID
This is displayed during the sequence of screens for the Update Note
Types option
The cash unit identifier s are mapped to the NDC cassette type defined in
the UnitID registry entry
For further information on the UnitID registry entry, see “Setting the
Cassette Identifier” on page 5-187
The cash unit identifiers used in these screens are defined using the
following registry entries:
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\CashUnitIDs\1
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\CashUnitIDs\2
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\CashUnitIDs\3
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\CashUnitIDs\4
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\CashUnitIDs\5
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\CashUnitIDs\6
HKLM\SOFTWARE\NCR\Advance NDC\Supervisor\CashUnitIDs\7
Each cassette type must be defined to identify the cassette type
displayed on the Supervisor screens. By default, the cassettes are
identified using numbers in the range 1 to 7.
Setting Multiple
Currencies
5
Multiple currencies are defined by setting up all present cassette
types in the currency cassette mapping table as described in “Setting
the Currency”, “Setting the Media Type”, and “Setting the
Denomination”as mentioned above. Cash handlers can then
provide alternate currencies using the defined cassette types, as
illustrated in the following examples:

Set cassette types 1 and 2 up for euro (EUR) denominations
while cassette types 3 and 4 are set up for sterling (GBP)
denominations.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-188
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Handlers


Disabling Retract after
Suspend
On dual cash handlers, if Option 76 supports up to four cassette
types, cassette types 1 and 2 in the primary cash handler can be
set up for EUR denominations while cassette types 3 and 4 are
set up in the secondary cash handler for GBP denominations.
On dual cash handlers, if Option 76 supports up to seven
cassette types, cassette types 1, 2, 3 and 4 can be set up for EUR
denominations while cassette types 5, 6 and 7 can be set up for
GBP denominations. The cassette types can be in either cash
handler as required.
On NCR SSTs, retract can be disabled to prevent retract from
occurring, even after a suspend condition.
5
Note: This configuration is not required for GBXX devices as they
can validate retracted notes.
To disable retract, complete the following steps:
1
In the Suspend Mode application link in the Customisation
Layer, remove the Cash Handler Resource ID worker
(4|1094y20) from the following:

Terminal Suspend worker (189n4798dc128)

Short Terminal Suspend worker (7s689g213)
2
Update the service provider suspend timeout settings as
follows:
HKLM\Software\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDERS\
CDM\GENERAL_CONFIGS\CDM\SuspendTimeout = "0"
HKLM\Software\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDERS\
CDM\GENERAL_CONFIGS\CDM2\SuspendTimeout = "0"
For details of the suspend timeout, see “Configuring Suspend
Timeout” on page 5-82.
3
Update the following registry entry as shown to disable the
clearing of the cash handler at Start of Day:
HKLM\Software\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDERS\
CDM\GENERAL_CONFIGS\CDM\ClearTransportOnStartup = "0"
4
Disable the following in the DeviceRecovery.xml file:

24-volt reset for all devices

XFS reset for the Cash Dispenser

XFS reset for the Cash Dispenser Second
For details of disabling 24-volt reset, see “Resetting USB
Devices” on page 5-78
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-189
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
Reporting Pick Failure
Errors
5
On an NCR single cash handler with four cassette types, the
reporting of error conditions following consecutive pick failures in
one transaction or over several transactions can be configured as
follows:


Report no error for the first and second pick failure and report a
fatal error for the third pick failure. This is the default
Report a routine error for the first pick failure, a warning for the
second pick failure and a fatal error for the third pick failure.
The level of error reporting is configured using the following
registry setting:
HKLM\Software\NCR\Advance NDC\CashHandler\
EnableErrorSeverity
Valid values are as follows:
0 to report no error for the first and second pick failure (default)
1 to report a warning for the first and second pick failure.
Cash Handler with a Fifth
Physical Cassette
5
If the cash handler has a fifth cassette, this can be reported on the
Fault Display and the Test Cash option in Supervisor and as part of
tamper indication journaling. To configure a fifth cassette, you must
enter the physical name of the fifth position in the following
registry, which is blank by default:
HKLM\Software\NCR\Advance NDC\PhysicalCassettes\Fifth
Enabling Support for
Seven Cassette Types
To configure support for seven cassette types, you must do the
following:
5
1
Ensure that the Advance NDC currency cassette mapping table
is correctly set up for seven cassette types, as described in
“Setting the Currency”, “Setting the Media Type”, and “Setting
the Denomination” above.
2
Enable extended cassettes for the service provider by setting the
following registry entry to 1:
HKLM\SOFTWARE\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDER
S\
CDM\GENERAL_CONFIGS\EnableExtendedCassettes
Note: For dual cash handlers, you must also set the following
registry entry:
HKLM\SOFTWARE\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDER
S\
CDM2\GENERAL_CONFIGS\EnableExtendedCassettes
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-190
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
3
Define a currency and value for cassette types 5 to 7. For
example, to enable support for 10 GBP in cassette type 5 add the
following keys:
HKLM\SOFTWARE\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDER
S\
CDM\GENERAL_CONFIGS\CurrencyIDType5="GBP"
HKLM\SOFTWARE\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDER
S\
CDM\GENERAL_CONFIGS\ValuesType5="10"
Note: This can be done using the ANDCSST.xml file, which
includes keys for cassette types five to seven commented out by
default.
Setting Note Thresholds
5
4
Set Enhanced Configuration option 76 to 001 to use extended
messages for seven cassette types. For details of option 76, refer
to the APTRA Advance NDC, Reference Manual.
5
At the SST, use the System Application to set up the note
configuration for cassette types 5 to 7. For details of the System
Application, refer to the Self-Service Support, System Application
User Guide. You can access this PDF from the on-line APTRA
Documentation: select APTRA XFS | Runtime Maintenance |
System Application.
You can set low and maximum thresholds for the number of notes
in a cash handler.
Note: The maximum number of notes that can be dispensed is set
by the hardware capabilities. For bunch dispensers, the MaxBills
registry entry can be set to either 40 or 50 in the configurable
parameters for the CDM SP (NCR only). For spray dispensers, the
MaxBills registry entry must not exceed 70 in the configurable
parameters for the CDM SP. For details, refer to the APTRA on-line
documentation, under APTRA XFS | Programmers Reference |
XFS Service Providers.
Low Threshold
5
The threshold for notes remaining in a cassette before reporting as
low is set using the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\NDCTypex\
LowBillsThreshold
Each cassette type must be defined using the x in NDCTypex to
identify the cassette type.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-191
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
The default is '0' and uses the hardware sensors. For details, refer to
the APTRA on-line documentation for ulMinimum, under APTRA
XFS | Programmers Reference | XFS Service Providers.
Maximum Threshold
The threshold for notes deposited into the reject bin to trigger a
device status of high is set using the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\CurrencyTable\RejectBin\
MaxBillsThreshold
The default is '0', which switches off the counter thresholds. For
details, refer to the APTRA on-line documentation for ulMaximum,
under APTRA XFS | Programmers Reference | XFS Service
Providers.
Configuring the MEI for a
Spray Dispenser
The MEI can be enabled and configured for use on a spray dispenser
using registry entries under the following key:
5
HKLM\SOFTWARE\NCR\AdvanceNDC\CashHandler\SprayDispenser
Table 5-57 “MEI Spray Dispenser Registry Entries” on page 5-193
describes the DWORD registry entries used to enable the MEI and to
configure when flashing is turned on and off during a dispense
operation. The default values are used if an entry is missing or
invalid. At installation, Advance NDC sets values as described in
the table.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-192
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
Table 5-57
MEI Spray Dispenser Registry Entries
Registry Entry
Description
MEI Enabled
Enables and disables the MEI flashing on a spray
dispenser
Valid values are as follows:

0 = disabled (default)

1 = enabled (installed value)
MEI Start Delay
Defines the delay, in seconds, between the
dispense command being sent and the MEI being
turned on
This delay can be used to ensure that the MEI
starts flashing before the first note is presented
Valid values are in the range 0 to 5
The default setting is 0, Advance NDC sets the
value to 1 at installation
The dispense operation may complete before the
delay time elapses if a value greater than 3
seconds is set. In this situation, the MEI does not
flash
MEI End Delay
Defines the delay, in seconds, between the last
note being dispensed and the MEI being turned
off
This delay can be used to ensure that the MEI
stops flashing after the final note is presented
Valid values are in the range 0 to 5
The default setting is 0, Advance NDC sets the
value to 3 at installation
Note: Depending on the performance of the cash
dispenser, there could be a delay of up to 3
seconds between the dispensing of the last note
and the sending of the command to turn off the
MEI. Adjust the MEI End Delay if you need to
compensate for this situation
Supplies and Severity
Information
5
By default, supplies and severity information is updated to reflect
the known state of the cash handler, as described in the following
table:
Table 5-58
Supplies and Severity
Update Point
Cassette Status
Severity Reported As...
Supplies Reported As...
Start of Day
Good
Good
Sufficient Notes
Low
Good
Notes Low
Empty
Fatal
Out of Notes
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-193
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
Update Point
Supervisor Exit
Following a TEST CASH
operation
Following a
note-dispensing transaction
status information is
updated only for cassettes
used in the transaction
All points above,
the status reported for the
Reject bin
Cassette Status
Severity Reported As...
Supplies Reported As...
Missing
Good
No new state
Good
Good
Sufficient Notes
Low
Good
Notes Low
Empty
Fatal
Out of Notes
Missing
Good
No new state
Good
Good
Sufficient Notes
Low
Good
Notes Low
Empty
Fatal
Out of Notes
Missing
Good
No new state
Good
Good
Sufficient Notes
Low
Good
Notes Low
Empty
Fatal
Out of Notes
Missing
Fatal
Out of Notes
Good
Good
No overfill
Overfilled
Fatal
Overfill
Missing
Fatal
No overfill
Replenishment Status of Cassettes
The default configuration of Advance NDC can be changed to
report the actual replenishment status of all cassettes after a
note-dispensing transaction, not just the status of cassettes used in
the transaction. The following registry entry shows the default
value:
HKLM\SOFTWARE\NCR\Advance NDC\ActualSupplies = 0
To report the actual status of all cassettes, change the value of
ActualSupplies to 1.
Dual Cash Handler
Configuration
5
A second cash handler (known as the secondary cash handler) can
be added to create one logical cash handler, which emulates a single
cash handler for the host.
Note: As increased cash-handler capacity has been implemented
without host impact, the host cannot select the cash dispenser to be
used for dispensing cash.
A dual cash handler configuration can include a recycling unit. If a
recycling unit is used, the stricter cassette mappings required for
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-194
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
recycling unit configuration must be used for all cash handlers in
the dual cash handler.
Note: In messages the cash handlers are identified using 0 and 1; in
Advance NDC screens they are identified using 1 and 2.
The registry entry for dual cash handler settings is:
HKLM\SOFTWARE\NCR\Advance NDC\DualCashHandler
The secondary cash handler has the following alias:
HKLM\SOFTWARE\NCR\Advance NDC\Aliases\
Cash Dispenser Second
Setting the Cash Handler Priority
5
The cash handler that is given priority is checked first and used to
dispense whenever possible. If a recycling unit is used, it must be
set as the priority cash handler.
Note: If there is no primary cash handler attached to the SST, the
secondary cash handler will never be available, even if it is set as the
priority cash handler.
The following registry entry contains the setting for cash handler
priority:
HKLM\SOFTWARE\NCR\Advance NDC\DualCashHandler\Priority
Valid values for this entry are as follows:
0 to give priority to the primary cash handler (default)
Note: If a recycling unit is used, it must be both the primary
cash handler and the priority cash handler.
1 to give priority to the secondary cash handler.
Setting the Counter Entry Mode
5
The counters for a dual cash handler can be set as combined or
separated. If combined counters are used, the total count for both
cash handlers is entered, displayed and printed in Supervisor mode.
If separated counters are used, the counts for each cash handler are
entered, displayed and printed in Supervisor mode.
The following registry entry contains the setting for combined or
separated counts:
HKLM\SOFTWARE\NCR\AdvanceNDC\DualCashHandler\
CountersEntryMode
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-195
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
Valid values for this entry are as follows:
0 to use combined counters (default)
1 to use separated counters.
Setting the Counter Clearing Mode
5
If separated counters are used, the counters for each cash handler in
a dual cash handler can be cleared separately or together. If cleared
separately, the cash handler must be selected in the Clear Cash and
Standard Cash functions on the Supervisor Replenish menu. If
cleared together, the Clear Cash and Standard Cash functions do
not prompt for selection of a cash handler.
The following registry entry contains the setting for the counter
clearing mode:
HKLM\SOFTWARE\NCR\AdvanceNDC\DualCashHandler\
CountersClearMode
Valid values for this entry are as follows:
0 to clear the cash handler counters for both cash handlers
together (default)
1 to enable the selection of the cash handler in the Supervisor
functions.
Status Reporting
5
As each cash handler has a separate dispenser, each transaction uses
one cash handler.
The status of dual cash handlers is reported as a single logical cash
handler as follows:


The severity is reported for the cash handler with the best status.
The fitness is reported for the cash handler with the best status
or a suspend status. A suspend status is always reported
whatever the fitness of the other cash handler.
Cash Handler Status Message
The following registry entry defines whether to report a combined
(best overall) or suspend status when the specified note mix cannot
be dispensed by one cash handler:
HKLM\SOFTWARE\NCR\Advance NDC\DualCashHandler\
CassSuspendedValue
Valid values for this entry are as follows:
0 = report a combined status (default)
3 = report a suspend status.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-196
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
The following scenario illustrates the effect of this registry setting:
If only one of the cash handlers can dispense the requested note
mix, the following occurs:
— The cash handler that can dispense the note mix is used.
— A solicited status message is sent if a cassette type runs out
of notes during the dispense operation.
In this situation, neither cash handler can now provide the note
mix required, and the status message reports a combined status
by default. This reports the best overall status, which states that
sufficient notes are available for the dispense. The host therefore
continues to request a note mix that cannot be dispensed. If
configured to report a suspend status, the host can continue
requesting the cassette type as it is still available in one of the
cash handlers, but will not request the note mix.
If both cash handlers could have dispensed the note mix, the
priority cash handler is used. If the priority cash handler runs
out of notes during the dispense operation, using the suspend
setting means that the transaction can be re-attempted.
The following example illustrates this situation:



Each cash handler contains cassette types 1 and 2
Cassette type 1 is already fatal in the priority cash handler
Cassette type 2 runs out of notes during a dispense using the
second cash handler.
This situation means that a mix of cassette types 1 and 2 cannot
be dispensed from either cash handler. However, reporting a
combined status means that the supplies appear to be good
because cassette type 2 is available in the priority cash handler.
Reporting a suspend status allows the host to continue
requesting cassette type 2 as it is still available in the priority
cash handler, but not in a mix with cassette type 1.
The following registry entry defines whether a message is sent to
the host reporting that the cash handler has recovered from a fatal
status:
HKLM\SOFTWARE\NCR\Advance NDC\DualCashHandler\
CU_ReturnedToGood_Severity
Valid values for this entry are as follows:
0 = do not report recovery from a fatal status (default)
1 = report recovery from a fatal status.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-197
Configuring Advance NDC and Associated Components
Configuring Cash Handlers
Interlock Handling
5
Dual cash handlers may each have a safe door interlock or there can
be a single interlock that disables power to both cash handlers. If
there are two interlocks on dual cash handlers that emulate a single
cash handler, the interlock open M-Status can be reported with a
non-fatal severity. To avoid this, interlock handling is defined by
Enhanced Configuration option 76 as follows:


If option 76 is set to 000, an open interlock is always reported as
fatal
If option 76 is set to 001, the best overall status is reported. The
individual status is reported using DIGs ‘d’ and ‘e’ in response
to a Send Configuration command. For information on this
command, refer to the APTRA Advance NDC, Reference Manual.
Tamper Indication
As both cash handlers are reported to the host as a single logical
cash handler, some messages to the host can seem to be duplicated.
This may imply that tampering has occurred. If this is the case check
the journal trace, which includes information on the cash handler.
For example, if all cassettes are removed from CH0 and then all
cassettes are removed from CH1, the host message will suggest that
cassettes have been removed twice. However, the journal trace
prefixes this information with Cx., where x indicates the individual
cash handler.
For further information on tamper indication, refer to the APTRA
Advance NDC, Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-198
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Configuring Cash Acceptors
5
This section describes the configuration options for cash acceptor
and recycling devices when used for the following types of
transaction:



Cash deposit
Cash deposit/dispense
Recycling.
Cash acceptors (also referred to as BNA and GBNA) and recycling
units (also referred to as GBRU) are configured both by updating
registry keys and by editing the CashInCustom.accfg. Where
configuration is done using the class configurator file, default
configuration settings are included in the CashInCustom.accfg file
installed with Advance NDC. For information on the
CashInCustom.accfg file see “.NET Class Configurator Files” on
page 5-37.
Note: Any references to GBXX mean that the information can apply
to both recycling unit and cash acceptors with configurable
cassettes.
Cash Acceptor Installation
Settings
The following registry entries are set during installation and must
not be changed:
5
HKLM\SOFTWARE\NCR\Aptra Self-Service Support (NCR
Features)\RS232BunchNoteAcceptor\Operational Parameters\
Disable Automatic Resets
HKLM\SOFTWARE\NCR\XFS CIM Service
Provider\XFS-DeviceControl\CIM\GENERAL_CONFIGS\
ResetActionOnInitialise
HKLM\SOFTWARE\NCR\XFS CIM Service Provider\XFS-Device
Control\CIM\Interoperability\
ExpandCIMRetractNoteList
HKLM\SOFTWARE\NCR\XFS CIM Service Provider\XFS-Device
Control\CIM\Interoperability\
IgnoreCashUnitNumberOnReset
HKLM\SOFTWARE\NCR\XFS CIM Service Provider\XFS-Device
Control\CIM\Interoperability\
ReportSeparateCashUnits
HKLM\SOFTWARE\NCR\GBRU-GBNA Service
Provider\XFS-DeviceControl\ GBRU-GBNA\Interoperability\
ChangeSoftwareErrorCIM
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-199
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Scalable Deposit Module
A cash acceptor that can accept either cash or cheques but not both
in a single transaction can be used as a scalable deposit module
(SDM). An SDM is an NCR device that can accept both notes and
cheques.
The following table describes the registry entries and the values that
are set to allow cash deposits:
Table 5-59
SDM Registry Entries
Registry Entry
Value
Description
CashInModule1
Allows cash deposit transactions on SDMs
HKLM\SOFTWARE\ActiveXFS\
CashInModule1
HKLM\SOFTWARE\NCR\XFS SDM Service Provider\XFS-DeviceControl\SDM\Interoperability\
ExpandCIMRetractNoteList
1
Retracted note counts for deposit transactions are
journaled
If set to 0, notes retracted during a deposit
transaction are not journaled
AlwaysAllowCapabilities
1
If no device is present, the Capabilities command
is successful
If set to 0, the Capabilities command is
unsuccessful when no device is present
For more information on the Capabilities
command, refer to the APTRA online
documentation under APTRA XFS |
Programmer’s Reference | XFS Service
Providers | XFS GBRU-GBNA Service Provider
| CIM Class Capabilities
DepositMode
0
Accept only cash or cheques in a single
transaction
The depositing of both cash and cheques in a
single transaction (a value of 1) is not supported
HKLM\SOFTWARE\NDC\XFS SDM Service Provier\XFS-DeviceControl\SDM\Operations\
SuspendTimeout
900
Defines the time in seconds for which the device
is suspended when tampering by the consumer is
suspected
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-200
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Positioning the Reason for
Note Refusal
In the Cash Accept state, you can use a dynamic text dictionary
control sequence to define the reasons for refusing notes.
5
The RefuseReasonMask property of the CashInCustom.accfg file is
used to position the text on the screen as follows:
<Property Name="RefuseReasonMask"
Value="Display Text {0:000}">
Defining the Please Wait
screen
5
To use a screen other than the default Please Wait screen (reserved
screen C20) during a cash deposit transaction, update the value of
the Wait Screen property of the Cash In Close Flow Config
class.
The default entry is as follows:
<Property Name="WaitScreen" Value="C20" />
Setting the Volume
5
The audio volume during a cash deposit transaction can be set using
the AudioVolume property of the NDCCashAcceptService class.
The range is from 1 to 1000, inclusive and the default entry is as
follows:
<Property Name="AudioVolume" Value="750" />
Combined Cash Handler
5
If a cash acceptor is part of a combined cash handler, you can set the
following property of the CashInStatusHandler class to associate
the cash acceptor with a dispenser for tamper indication reporting:
<Property Name="CombinedDispenserNumber" Value="1" />
Valid values are 1 for the primary cash handler and 2 for the
secondary cash handler.
Setting the Insertion Limit
for Bunches of Notes
5
The number of bunches of notes that can be accepted in a single
transaction is limited only by the maximum note limits of the
escrow or cassettes.
The number of bunches of notes can also be limited by setting an
explicit value in the AcceptedBunchLimit property of the
CashAcceptStateFlowConfig class. The default value means that
the limit is defined by the capabilities of the device as follows:
<Property Name="AcceptedBunchLimit" Value="0" />
If the insertion limit is reached, the option to add more notes is
disabled on the confirmation screen.
To apply a specific limit, update the value to the number of bunch
insertions to allow. For example, a value of ‘5’ allows up to five
bunches of notes to be inserted in a single transaction.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-201
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
The screen used to journal that the retry limit has been reached is
defined using the CashInJournalRecordMapping array, as
described in “Reserved Screen Mapping” on page 5-234.
Setting the Retry Limit for
Note Insertion
5
If all notes in a bunch are rejected, the consumer can repeat the
attempt to insert the bunch until the configured limit of retries is
reached.
Note: The retry limit applies to all failed attempts to insert bunches
of notes during a single transaction. This means that the limit can be
reached even if the failed attempts are not consecutive.
If repeated attempts to insert bunches of rejected notes fail and the
retry limit is reached, the notes are rejected and a prompt to remove
the notes is displayed. If the notes are removed, an unsolicited
message reports a consumer cancellation and the reason (the retry
limit was reached) is journaled. If the notes are not removed, the
notes are either retracted or left at the exit depending on the
behaviour defined by Enhanced Configuration option 45.
If the retry limit is reached and some notes have already been
accepted in previous bunches, the option to add more notes is
disabled on the confirmation screen in the following situations:



The ECB 6 regulations are not being applied
The ECB 6 regulations are being applied and notes identified as
counterfeit, suspect, or unrecognised have already been
inserted. If counterfeit notes are to be retained, the notes
retained screen is displayed before the confirmation screen
Direct deposit is enabled.
The retry limit is configured using the RejectedBunchLimit
property of the CashAcceptStateFlowConfig class as follows:
<Property Name="RejectedBunchLimit" Value="0" />
The default value of ‘0’ means that no limit is applied to the
number of attempts that can be made to re-insert bunches of notes.
To apply a limit, update the value to the number of attempts to
allow. For example, a value of ‘5’ permits five attempts to insert a
bunch of rejected notes.
The screen used to journal that the retry limit has been reached is
defined using the CashInJournalRecordMapping array, as
described in “Reserved Screen Mapping” on page 5-234.
Transaction Request
Cumulative Counts
5
By default, the running total of all deposit transactions since the last
Clear BNA was performed (cumulative counts) are not reported in
Transaction Request messages.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-202
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
To enable the reporting of cumulative counts, set the
ReportTRequestCumulativeCounts property of the
CashInStatusHandler class as follows:
<Property Name="ReportTRequestCumulativeCounts"
Value="true" />
Configuring Note Retract
to Escrow
The retract configuration is defined using the CashInCustom.accfg
configuration file as follows:
5

The RetractConfiguration property of the
ECB6CashAcceptService class defines the configuration to use.
The configuration is defined in the class with the same name as
the defined value. By default this is set to
RetractToStackerConfig


The CounterName property of the RetractToStackerConfig
class defines the name of the counter used to persistently store
the number of retract operations that have been completed
The NumberOfRetractCounts property of the
RetractToStackerConfig class defines the number of retracts
allowed.
The following extract shows the default entries for these properties
in the CashInCustom.accfg file:
<Class ID="ECB6CashAcceptService"
Name="NCR.APTRA.NDC.CashAcceptService.
ECB6CashAceptServiceCusomized"
Assembly="NCR.APTRA.NDC.CashAcceptService.dll">
<Interface>
<Property Name="RetractConfiguration"
Value="RetractToStackerConfig"/>
</Interface>
</Class>
<Class ID="RetractToStackerConfig"
Name="NCR.APTRA.CashAcceptService.
StdRetractConfiguration"
Assembly="NCR.APTRA.CashAcceptService.dll">
<Interface>
<Property Name="CounterName" Value="RetractCount"
/>
<--!Property Name="NumberOfRetractCounts" Value="2"
/-->
</Interface>
</Class>
Enabling Retract to the Escrow
5
By default, the NumberOfRetractCounts property is commented
out in the CashInCustom.accfg file. This means that the default value
of 0 is used, giving infinite retract operations.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-203
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Uncommenting the NumberOfRetractCounts property enables
retract to the escrow (also known as the stacker). The value of 2
means that the first time notes are retracted, they are sent to the
retract area configured in “Error Recovery Modes” on page 5-223.
The second time notes are retracted, they are sent to the escrow.
Setting the value to 1 means that the first time notes are retracted,
they are sent to the escrow.
If notes are retracted to the escrow, the cash acceptor is reported as
fatal until the notes are removed and either the Initialise BNA or the
Clear BNA Supervisor option has been performed. The notes
remain in the escrow whatever the setting of table entry 8 (BNA
Notes Return/Retain/Leave Flag) of extension state 1 in the Close
state.
Automatic Error Recovery
5
Automatic error recovery must be configured to leave notes in the
escrow (stacker). For further information, see “Error Recovery
Modes” on page 5-223.
Note: If BNA variants are used, automatic error recovery must be
disabled as it will fail unless notes are manually removed from the
escrow.
Journaling
The destination of the retracted notes is journaled as specified in
“Reporting the Retract Destination” on page 5-234
Enabling Direct Deposit
5
In a direct deposit operation, the notes are deposited to the cassettes
without being stored in the escrow. The Cash Accept State defines
whether the cash acceptor accepts direct deposits. For details of the
Cash Accept state, refer to Chapter 2, “State Tables” in the APTRA
Advance NDC, Reference Manual.
Note: To ensure that the notes can be successfully reported, bit 1 of
Enhanced Configuration Parameter option 45 must be set to 1 so
that the number of notes that can be accepted is more than 90.
Recycling units, cash acceptors with configurable cassettes (referred
to jointly as GBXX) and single-note acceptors (SNA) are capable of
direct deposits with the appropriate configuration described below
in Table 5-60, “Enabling Direct Deposit” added to the registry.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-204
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Table 5-60
Enabling Direct Deposit
Hardware
Registry Entry
Description
GBXX
HKLM\SOFTWARE\NCR\
GBRU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\
Interoperability\DepositMode
Specifies the deposit mode.
Valid values are as follows:

1 - Move the notes to the escrow
(default)

2 - Move the notes to the cassettes.
If set to 1, you can change the deposit
mode from 1 to 2 dynamically.
Single note
acceptor
HKLM\SOFTWARE\NCR\
XFS SCIM Service Provider\
XFS-DeviceControl\SCIM\Interoperab
ility\DepositMode
Specifies the deposit mode for the
device.
Valid values are as follows:

1 - Move items to the escrow
(default)

2 - Move items to the cassettes
(direct deposit).
This must be set to 2 to enable direct
deposit.
The CashInAutoEnabled property of the
CashAcceptStateFlowConfig class determines whether deposits
are automatically enabled while the Confirmation screens are
displayed, as follows:
<Property Name="CashInAutoEnabled" Value="false" />
Valid values are as follows:
false - The Add More FDK must be selected to deposit more
notes
true - Notes can be deposited while the Confirmation screen is
displayed and the Add More FDK must be configured to
000.
For more information on the Confirmation screen, see
“Confirmation Screens During Cash Deposit” on page 5-103.
Setting the Direct Deposit Limit
5
The number of notes accepted in a direct deposit transaction can be
defined in the following ways:

Using the Direct Deposit Limit in the Cash Accept state
(extension 4, table entry 6). For details of the Cash Accept state,
refer to Chapter 2, “State Tables” in the APTRA Advance NDC,
Reference Manual
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-205
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors

Using the CashInCustom.accfg configuration file. This is used
only if the Direct Deposit Limit in the Cash Accept state uses the
default value of 000 (accept the maximum number of notes for
the hardware).
When the direct deposit limit is reached no further bunches are
accepted, however, the current bunch will be processed.
The value of the Direct Deposit Limit must prevent the number of
notes from exceeding both the message limit and the setting of
Enhanced Configuration Parameter option 45.
If the configuration is incorrect or the number of notes exceeds the
message limits the counts are reported as follows:


The journal will be correct
Messages to the host report the maximum supported by the
field. In this situation, reserved screen U0152 is journaled to
record that the number of deposited notes exceeds the message
field size.
Using the Configuration File The DefaultDirectDepositLimit
property of the CashAcceptStateFlowConfig class in
CashInCustom.accfg specifies the value as follows:
<Property Name="DefaultDirectDepositLimit" Value="700" />
This value means that the direct deposit limit is reached after 699
notes have been deposited in a transaction. As cash deposit is still
enabled, another bunch of up to 200 notes can be inserted.
Therefore, a maximum of 899 notes can be deposited in a single
transaction.
Off-line Cash Deposit
Handling
5
The Cash Deposit Handling state allows off-line cash deposits to be
handled in a similar way to the Deposit Media and Refund Media
transaction reply functions used to complete a transaction where
notes have been accepted during the Cash Accept State.
In the CashInCustom.accfg file, the SuppressMessages property of
the CashInStatusHandling class determines whether unsolicited
cash-in status message (DIG ‘w’) are sent to the host, as follows:
<Property Name="SuppressMessages" Value="false" />
Valid values are as follows:
false
Send all status messages
true
Suppress unsolicited status messages, either all
unsolicited messages or as defined in the Off-line States
array
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-206
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
The ReceiptService property of the
CashDepositHandlingStateFlow class defines the service provider
for the receipt printer. The default entry is as follows:
<Property Name="ReceiptService" Value="NDCReceiptService"
IsLink="true" />
Off-line States Array
5
This array in CashInCustom.accfg has an ID of OfflineStates and
specifies which NDC states are not to send unsolicited cash-in status
messages (DIG 'w'). It is used in conjunction with the
SuppressMessages property on the CashInStatusHandler. This
and the Cash Deposit Handling state allow cash deposits to be
handled without host control. Consequently, there may be a
requirement to suppress the sending of status messages. It also
allows other States such as the Cash Accept state to have their
messages suppressed. This may be required when other states are
used in conjunction with the offline Cash Deposit Handling state.
The array defines a list of state types which are to be considered
off-line and therefore do not send unsolicited cash-in status
messages (DIG 'w'). The state types are entered in the form of
strings. The array accepts single-character state types or extended
state types, that is, 'z' followed by a three-digit number, for example,
"z014".
For example, the following string values can be used to suppress
unsolicited messages for the respective states:
Table 5-61
Examples of Strings for the Off-Line States
Array
String Value
State
">"
Cash Accept state
"I"
Transaction Request state
"J"
Close state
"z014"
Cash Deposit Handling state
If the specified state value is not recognised, it is ignored.
If all unsolicited cash-in messages are to be suppressed, keep the
array empty, and set the SuppressMessages property in the
CashInStatusHandler to true.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-207
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Example of the Off-line States Array
5
The following example suppresses unsolicited cash-in status
messages for the Cash Accept and Cash Deposit Handling states:
<Array ID="OfflineStates" >
<Element Value="z014" />
<Element Value=">" />
</Array>
Note: This does not affect solicited cash-in status messages.
Reading and Journaling
Serial Numbers of Good
Notes
Due to the size of the signature data, the serial numbers of good
(category 4) notes can only be journaled to the EJ if it is enabled. By
default, the serial number is not journaled.
5
Reading the Serial Numbers of Good Notes
5
To read serial numbers, the SST must have either a GBXX with a
dual-camera bill validator or a BNA with an HBV (Revision H Bill
Validator) installed.
Advance NDC uses the SignatureParser class in the
CashInCustom.accfg configuration file to read serial numbers. The
SignatureParser class is configurable for supported hardware
variants. By default, it is configured to use the GBXX signature
parser as follows:
<Class ID="SignatureParser"
Name="NCR.APTRA.NDC.CashAcceptService.GBxxSignatureParser"
Assembly="NCR.APTRA.NDC.CashAcceptService.dll"/>
For a BNA with an HBV, update the Name entry of the
SignatureParser class as follows:
Name="NCR.APTRA.NDC.CashAcceptService.BNAHBVSignatureParser
Journaling the Serial Numbers of Good Notes to the EJ
For a GBXX with a dual camera note validator, set the following
DWORD registry entry to 1:
HKLM\SOFTWARE\NCR\XFS GRBU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\Interoperability\
ReportCat4Signatures
For a BNA with an HBV installed, set the following DWORD
registry entry to 1:
HKLM\Software\Classes\WOSA/XFS_ROOT\SERVICE_PROVIDERS\CIM
\ReportCat4Signatures
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-208
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Reconciliation List
Customisation
5
The reconciliation list is produced by selecting either 48 DSP BNA
RCNL or 49 PRN BNA RCNL on the Replenish menu in Supervisor.
The information to be displayed or printed is created dynamically
using a Variable Operator Text worker.
You can use the entries under the following registry key to localise
the screen and print row headings:
HKLM\SOFTWARE\NCR\Advance NDC\BNA\Reconciliation
In the reconciliation list, the following conventions are used to
position counters and values:



The counters column heading (CNTRS) occupies columns 18 to
22
The values column heading (VALUE) occupies columns 25 to 31
Data is right-aligned, as follows:
— A 1-digit counter starts at column 22
— A 3-digit counter starts at column 20
— A 1-digit value starts at column 31
— A 3-digit value starts at column 29
Note: If localising the reconciliation list, you must make sure that
the changes do not impinge on the positioning of the counters.
The default settings for the entries are as follows:
Table 5-62
Default Settings for Reconciliation List
Printing BNA Totals
5
Registry Entry
Default Setting
RecListRetractedString
RETRACT
RecListRetainedString
RETAIN
RecListNotesString
NOTES
RecListHeaderString
BNA RECONCILIATION LIST
RecListDepositedString
DEPOSIT
MultipleCurrencyReconSupp
0
Not supported
RecListTotalString
TOTAL
Option 60 PRN BNA TTLS on the Supervisor Replenish menu prints
note counts by denomination and the total number of notes for
different note counts. The totals can be printed on any receipt
printer, journal printer or both depending on the selection made
using the SET PRINT option on the Configure menu in Supervisor.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-209
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
The following forms are used to print the counts and display status
messages and prompts on the screen:
Table 5-63
Forms Used for BNA Note Counts
Form
Destination
Form Location
CashInPrintTotalsRPTR.DEF
Receipt printer
C:\Program Files\NCR APTRA\Printing\Receipt\Forms
CashInPrintTotalsJPTR.DEF
Journal printer
C:\Program Files\NCR APTRA\Printing\Journal\Forms
CashInPrintTotalsTTU.frmttu
Screen display
C:\Program Files\NCR APTRA\Printing\TTU\Forms
Currency Names Mapping Array
5
In the CashInCustom.accfg file, a mapping array is used to specify the
currency names to be used when printing Supervisor counts, as
follows:
<Array ID="CurrencyNamesMappingArray" >
<!-- The equals sign is used as the separator -->
<Element Value="USD=USD" />
<!-- Element Value="USD=$"/ -->
</Array>
The element values have the ISO currency code on the left of the =
separator and the output value on the right.
The element value with the ISO currency code and the currency
symbol is commented out by default.
Counts Configuration Array
This mapping array in the CashInCustom.accfg file is used to specify
the counts to be used for the print operation. The default settings
provided with Advance NDC for option 60 PRN BNA TTLS on the
Supervisor Replenish menu are as follows:
<!-- CashIn Counters Configuration Array for the BNA Totals
Supervisor Task-->
<Array ID="CountsConfigurationArray">
<Element Value="DepositCounts"/>
<Element Value="RejectedDuringDepositCounts"/>
<Element Value="RetractCounts"/>
<Element Value="TotalDeposit"/>
<Element Value="TotalRejectedDuringDeposit"/>
<Element Value="TotalRetract"/>
<Element Value="TotalEscrow"/>
<Element Value="TotalRefund"/>
<Element Value="TotalReject"/>
<!--Element Value="CashInCassetteDepositCounts"/-->
<!--Element Value="RecycleCassetteDepositCounts"/-->
<!--Element Value="SuspectsNotAuthorisedDepositCounts"/-->
<!--Element Value="OfflineDepositCounts"/-->
<!--Element Value="RetractRecycleCounts"/-->
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-210
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
<!--Element Value="RetractNonRecycleCounts"/-->
<!--Element Value="CounterfeitCounts"/-->
<!--Element Value="SuspectCounts"/-->
<!--Element Value="TotalCashInCassetteDeposit"/-->
<!--Element Value="TotalRecycleCassetteDeposit"/-->
<!--Element Value="TotalSuspectsNotAuthorisedDeposit"/-->
<!--Element Value="TotalOfflineDeposit"/-->
<!--Element Value="TotalRetractRecycle"/-->
<!--Element Value="TotalRetractNonRecycle"/-->
<!--Element Value="TotalCounterfeit"/-->
<!--Element Value="TotalSuspect"/-->
</Array>
The counts in bold are printed by default. The other counts can be
added to the report by uncommenting the entries in the array and
the counts for those note groups will be printed as individual counts
as well as in the main group to which they belong.The print order of
the counts follows the order of elements in the array.
The counts include notes not authorised by the host, that is, notes
that have been processed locally at the SST using the Cash Deposit
Handling state. For details, refer to Chapter 2, “State Tables” of the
APTRA Advance NDC Reference Manual.
Details of what each count contains are described in Table 5-64,
“Counts for Note Groups” on page 5-212.
Available Counts
5
What is printed for the Print BNA Totals option depends on the
configuration of the Counts Configuration Array. The main groups
are deposit and retract. Counterfeit notes are always reported
separately. The other counts are subsets of deposit and retract.
Deposit Counts DEPOSIT COUNTS gives the number of notes
deposited since the counts were last cleared, and the sum of their
value, for each denomination, as follows:





5
Notes deposited in or recovered to the cash-in cassettes
Notes deposited in the recycle cassettes
Notes that are in the escrow before user confirmation and are
moved to the reject bin after deposit as the second validation
resulted in a misrecognition
Notes jammed in the transport on their way to the cassettes after
deposit or for direct deposits, notes jammed in the transport after
insertion
Notes retained in the Close state when the Close state option is
set to retain the notes
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-211
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors

Notes identified as suspect (category 3) under the ECB 6
regulations and are one of the following:
— In the cash-in cassettes
— Not encash authorised, that is, not authorised by the host
because the SST is configured to retain such notes on
insertion
If ECB 6 regulations are not enabled, suspect notes are returned
to the consumer as invalid and included in the rejected totals

Notes that cannot be accepted to the correct cassette type because,
for example, the cassette for that denomination is full, and are
redirected to the reject bin after an encash operation. Such notes
are also known as excess notes.
Some counts appear in more than one group, which is indicated in
the table.
Retract Counts RETRACT COUNTS gives the number of notes
retracted since the counts were last cleared, and the sum of their
value, for each denomination, as follows:



Notes in the recycle cassette
Notes in the retract bin
Notes retracted to the cash-in cassette
CDI Stores CDI store IDs are also given for those counts that have
CDI stores. Some counts do not have CDI stores because the
information is obtained from internal data.
Table 5-64
Counts for Note Groups
Count
DEPOSIT
COUNTS
Description
(CDI stores 3164 to 3213)
The number of notes of each denomination in the groups shown above with the sum of their
value, including the following subsets of counts:
CASH-IN CASSETTE
DEPOSIT COUNTS
For each denomination, the number of notes deposited in or
recovered to the cash-in cassettes
(CDI store 5034)
RECYCLE CASSETTE
DEPOSIT COUNTS
For each denomination, the number of notes authorised by the
host and then encashed or recovered to the recycle cassette
SUSPECTS NOT
AUTHORISED DEPOSIT
COUNTS
For each denomination, the number of notes identified as
suspect (category 3) under ECB 6 regulations and retained
without authorisation from the host.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-212
5
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Count
Description
For each denomination, the number of rejected notes as follows:
REJECTED DURING
DEPOSIT COUNTS

Notes in the escrow before user confirmation and moved to
the reject bin after deposit

Excess notes redirected to the reject bin after an encash
operation
(CDI store 5051)
RETRACT
COUNTS
OFFLINE DEPOSIT
COUNTS
For each denomination, the number of notes in the escrow and
later authorised off-line
(CDI store 5053)
SUSPECT COUNTS
For each denomination, the number of notes identified as
suspect (category 3) under ECB 6 regulations and deposited in
any cash-in or retract bin
(CDI store 5043)
For each denomination, the number of retracted notes. This includes notes moved to the
retract bin, the cash-in cassettes or the recycle cassettes depending on Enhanced
Configuration Parameters option 74 (“Destination for Cash Deposit Retract”, described in
Chapter 7, “Configuration Parameters” of the APTRA Advance NDC Reference Manual)
(CDI stores 3292 - 3341). This count includes the following subsets of counts:
For each denomination, the number of notes retracted or
recovered to the recycle cassette
(CDI store 5052)
RETRACT RECYCLE
COUNTS
RETRACT
NON-RECYCLE COUNTS
COUNTERFEIT
COUNTS
For each denomination, the number of notes:

Recovered or retracted to the retract bin

Retracted to the cash-in cassette
For each denomination, the number of notes identified as counterfeit (category 2) notes
under ECB 6 regulations; if ECB 6 regulations are not enabled, such note are rejected as
invalid and included in the rejected totals
(CDI store 5042)
Totals Counts The following table gives the total counts for the
different groups of notes.



5
The TOTAL DEPOSIT count gives the cumulative figures for the
same note groups moved to the cash-in cassettes (Table 5-64,
“Counts for Note Groups” on page 5-212).
The TOTAL RETRACT count gives the cumulative figures for
notes retracted to the recycle bin and the retract bin
Other totals described in the table are as follows:
— If ECB 6 regulations are enabled, the total of counterfeit
notes
— The total of notes passing through escrow
— The total of all rejected notes
— The total of all notes refunded to the consumer
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-213
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Table 5-65
Counts for Note Totals
Count
TOTAL DEPOSIT
Description
The total number of notes, including the following subsets of total counts
(CDI store 3214)
TOTAL CASHIN
CASSETTE DEPOSIT
The total number of notes deposited in or recovered to the
cash-in cassettes
TOTAL RECYCLE
CASSETTE DEPOSIT
The total number of notes deposited in or recovered to the
recycle cassettes
TOTAL SUSPECTS NOT
AUTHORISED DEPOSIT
The total number of notes retained in the cassettes but not
authorised.
TOTAL REJECTED
DURING DEPOSIT
The total number of notes containing:

Notes that were in the escrow and were moved to the reject
bin after being vaulted

Excess notes redirected to the reject bin after being vaulted
(CDI store 3347)
TOTAL RETRACT
TOTAL OFFLINE
DEPOSIT
The total number of notes that were in the escrow and later
authorised off-line
(CDI store 3776)
TOTAL SUSPECT
The total number of notes identified as suspect (category 3
under ECB 6 regulations) and moved to any cash-in cassette
or retract bin
The total number of notes moved to the retract bin or the cash-in cassettes depending on
Enhanced Configuration Parameter option 74, described in Chapter 7, “Configuration
Parameters”, of the APTRA Advance NDC Reference Manual. This count includes the
following subsets of totals:
(CDI store 3765)
TOTAL RETRACT
RECYCLE
The total number of notes retracted to or recovered to the
recycle cassette
TOTAL RETRACT
NON-RECYCLE
The total number of notes retracted to or recovered to the
cash-in cassettes or the retract bin
TOTAL
COUNTERFEIT
The total number of notes identified as counterfeit (category 2) notes under ECB 6
regulations; if ECB 6 regulations are not enabled, such note are rejected as invalid and
included in the total for rejected notes
TOTAL ESCROW
The total number of notes accepted into the escrow
(CDI store 3216)
TOTAL REFUND
The total number of notes returned to the refund slot from the escrow
(CDI store 3215)
TOTAL REJECT
The number of notes returned during the Cash Accept state. A note is rejected when it
cannot be validated and is returned to the consumer.
(CDI store 3217)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-214
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Enhanced Cash-in Formatter
5
Use this to format the output for the BNA counts
Name
NCR.APTRA.NDC.CashInFormattingCore.EnhancedCashInFormatter
Assembly
NCR.APTRA.NDC.CashInFormattingCore.dll
Table 5-66
Enhanced Cash-In Formatter Properties
Property Name
Type
Description
Possible values
Default Value
TotalString
String
The string to use when outputting
the Total amount
Any string
"TOTAL"
TemplateFor
TotalLine
String
The string template for the
Total line. The object list
contains the following:
0—Currency name
1—Total string (from the
TotalString property)
2—Total value of the currency
3—Total number of notes for
the currency
Any string
adhering to
the .NET
"{0} {1} = {2,8}"
The string template for the
report line used when the
report is formatted for each
denomination. The object list
contains the following:
0 - Currency name
1 - Currency value
2 - Number of notes
3 - Total value of the currency
(the currency value times the
number of notes)
Any string
adhering to
the .NET
"{0, 3} {1, 6} X {2, 3}
= {3,8}"
Framework
Composite
Formatting
For example, one note of 10
USD will be output as:
rules
USD
TemplateFor
ReportLine
String
Framework
Composite
Formatting
For example, one note of 20
USD will be output as:
USD TOTAL =
20
rules
1 X
1 =
1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-215
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Property Name
Type
Description
Possible values
Default Value
Include
GroupDigit
Boolean
Indicates whether to use a
comma as a digit group
separator (for example, 1,000)
while journaling any total
amount
false
Comma will
not be used.
false
true
Comma will
be used.
CurrencyNames
Array
Specifies the strings to be used
for the localised currency
names
The string values have the
following comma-delimited
format:
currencyName=
localisedCurrencyName,
for example:
{ "USD=$", "EUR=€" }
Any string
equivalent
representing
the currency
name
CurrencyNamesMapping
Array
Print Cash-in Totals
5
Use this to configure the following:




Which counts are to be printed
Duration of the error time-out
Whether zero counts are to be reported
The formatter to be used
Name
NCR.APTRA.NDC.CashInSupervisorTasks.PrintCashInTotals
Assembly
NCR.APTRA.NDC.CashInSupervisorTasks.dll
Table 5-67
Print Cash-in Totals Properties
Property Name
Type
Description
Possible values
Default Value
ConfigureCounts
TobePrinted
Array
By default, the elements
shown in “Counts
Configuration Array” on
page 5-210 will be printed.
All other count elements are
commented out. To change
the default output, edit the file
to add or remove the comment
characters from the required
elements in the array
Any string
referring to an
array mapper
CountsConfiguration
Array
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-216
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Property Name
Type
Description
Possible values
Default Value
ErrorTimeout
Int
A general time-out used to
specify the amount of time an
error screen will be displayed
Any unsigned
integer value. If a
time-out is
required, set the
value to greater
than 0, for example,
5000 for 5 seconds.
0
Specifies whether counts
with zero values are to be
included in the print report
False
False
ReportZero
Counts
Boolean
(The screen waits
indefinitely and never
times out)
Counts with zero
values will not be
included.
True
Counts with zero
values will be
included.
Counters
Formatter
ICounters
Formatter
Reason for Refusing a
Deposit
A cash-in counters
formatter.
Any concrete class
that implements
ICounters
Formatter
EnhancedCashIn
Formatter
The reason for refusing a deposit is journaled. The text can be
localised using the CashInCustom.accfg file.
5
The default reasons are given in the extract of CashInCustom.accfg in
Figure 5-10. These entries can be edited to localise the journaled text.
Figure 5-10
Default Input Rejected Reasons
<Array ID="MoneyRejectReasons">
<Element Value="CashUnitFull=CASH UNIT FULL" />
<Element Value="InvalidMedia=INVALID MEDIA" />
<Element Value="NoItems=NO ITEMS" />
<Element Value="DepositFailure=DEPOSIT FAILURE" />
<Element Value="ComponentFailure=COMPONENT FAILURE" />
<Element Value="EscrowFull=ESCROW FULL" />
<Element Value="ForeignItemsDetected=FOREIGN ITEMS DETECTED" />
<Element Value="BunchInvalid=BUNCH INVALID" />
<Element Value="CounterfeitItemsDetected=COUNTERFEIT ITEMS DETECTED" />
<Element Value="Jam=JAM" />
<Element Value="HardwareError=HARDWARE ERROR" />
</Array>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-217
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Localising Tamper
Indication Journaling
When a cassette is inserted or removed, this is journaled using
reserved screens U0143 and U0144 respectively.
5
The cassette names can be localised using the CashInCustom.accfg
file.
The default cassette names are given in the extract of
CashInCustom.accfg in Figure 5-11. These entries can be edited to
localise the journaled text.
Figure 5-11
Default Cassette Names
<Array ID="CassetteNamesArray">
<Element Value="Cassette1=CASSETTE 1" />
<Element Value="Cassette2=CASSETTE 2" />
<Element Value="Cassette3=CASSETTE 3" />
<Element Value="Cassette4=CASSETTE 4" />
<Element Value="Retract=RETRACT BIN" />
<Element Value="Reject=REJECT BIN" />
<Element Value="Counterfeit=COUNTERFEIT BIN" />
<Element Value="UnknownCassette=UNKNOWN CASSETTE" />
</Array>
Note Type Mapping
5
By default, NDC note types are mapped automatically to the
corresponding XFS note type. XFS note types are also mapped to the
corresponding NDC note types. This does not need to be changed
unless you want to change the way in which the mapping is done. A
sample file, CashInNoteMapping.XML, is created by the automatic
mapping and saved to C:\Program Files\NCR APTRA\Advance
NDC\Config\Samples. This file can be edited and is used if the
mapping method is changed to use the XML file.
Note: If the notes template is changed and automatic mapping is
used, clear all counts using the Supervisor options and restart the
SST.
The mapping method is configured using the CashInCustom.accfg
file.
The NoteTypesMapping property under the
NDCCashAcceptService class defines the method of mapping to
use, as follows:
<Property Name="NoteTypesMapping"
Value="AutomaticByNoteID" />
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-218
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Valid values are as follows:



AutomaticByNoteID. This automatically maps NDC note types
to XFS note types (default). The first NDC note type is associated
with the lowest XFS note type, the second NDC note type with
the second lowest XFS note type and so on until a maximum of
50 note types have been mapped. If any XFS note types are not
mapped to an NDC note type, they are inactive
AutomaticByDenom. This automatically maps note types by
grouping XFS note types of the same currency and
denomination. The first NDC note type is associated with the
lowest denomination grouping, the second NDC note type with
the second lowest denomination grouping and so on until a
maximum of 50 note types have been mapped. If any XFS note
types are not mapped to an NDC note type, they are inactive.
This method allows more than 50 note types to be used.
XMLFile. This uses the XML file described in “Using the Note
Type Mapping XML File” below. This method allows a
one-to-one or one-to-many mapping of NDC note types to XFS
note types and the XFS note types can also be put into a specific
order in the host messages.
Using the Note Type Mapping XML File
5
If you have configured the mapping as XMLFile, you can edit the
CashInNoteMapping.XML file created by the automatic mapping and
save it to C:\Program Files\NCR APTRA\Advance NDC\Config. The
XML configuration file download is not used to install this file.
If this file is not present, it is not created by Advance NDC and a
fatal condition is reported to the host for the cash acceptor.
The file must conform to the structure given in Table 5-68.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-219
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Table 5-68
Note Mapping XML Structure
Element
Description
NDCCashDepositItemMapping
The whole file is embedded within NDCCashDepositItemMapping
tags.
This is the root element.
Nested elements:
CashItem

Optional
CashItem
Maps an NDC note type to a XFS note type.
The XFSIdentifier attribute is the numeric identifier for the XFS note
type being mapped.
The NDCType attribute is the numeric identifier for the NDC note type
being mapped.
Example Note Mapping The XML example in Figure 5-12, “Note
Mapping XML Extract” maps the note types as described in
Table 5-69, “Example Note Mapping”.
Table 5-69
Example Note Mapping
Figure 5-12
Note Mapping XML Extract
XFS Note ID
NDC Note Type
1, 2 and 3
1
4
2
5
<NDCCashDepositItemMapping>
<CashItem XFSIdentifier="1" NDCType="1"/>
<CashItem XFSIdentifier="2" NDCType="1"/>
<CashItem XFSIdentifier="3" NDCType="1"/>
<CashItem XFSIdentifier="4" NDCType="2"/>
</NDCCashDepositItemMapping>
Journaling Note
Configuration Failures
5
If the configuration of the note types fails, reserved screen t34 is
used to journal the failure. The reason for the failure can be localised
using the NoteConfigFailedReasonsArray in the
CashInCustom.accfg file.
The default reasons, which can be edited as required, are as follows:
<Array ID="NoteConfigFailedReasonsArray">
<Element Value="000=EXCHANGE MODE" />
<Element Value="100=TIME_OUT" />
<Element Value="101=HARDWARE_ERROR" />
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-220
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
<Element Value="102=DEVICE_LOCKED" />
<Element Value="103=UNSUPPORTED METHOD" />
<Element Value="104=CANCELLED" />
<Element Value="105=UNSUPPORTED CATEGORY" />
<Element Value="106=CONNECTION_LOST" />
<Element Value="107=DEVICE NOT READY" />
<Element Value="108=UNSUPPORTED DATA" />
<Element Value="109=EXCEPTION OCCURRED" />
<Element Value="110=INVALID DATA" />
<Element Value="111=USER ERROR" />
<Element Value="999=SOFTWARE ERROR" />
<Element Value="Unknown=UNKNOWN ERROR" />
</Array>
Journaling Note Validation
Errors
5
If the validation of deposited notes fails, reserved screen t20 is used
to journal the failure. The reason for the failure can be localised
using the NoteErrorReasonsArray in the CashInCustom.accfg file.
The default reasons, which can be edited as required, are as follows:
<Array ID="NoteErrorReasonsArray">
<Element Value="0=DOUBLE NOTES HAVE BEEN DETECTED" />
<Element Value="1=LONG NOTES HAVE BEEN DETECTED" />
<Element Value="2=SKEWED NOTE HAS BEEN DETECTED" />
<Element Value="3=ITEM COUNTING ERROR HAS OCCURRED" />
<Element Value="4=NOTES HAVE BEEN DETECTED AS
TOO CLOSE" />
<Element Value="Unknown=UNKNOWN ERROR" />
</Array>
Device M-Status Reporting
5
Reporting of M-Status values differs for different devices. By
default, the device type is detected and reported accordingly. The
reporting of M-Status values can be specifically configured to use
reporting used by BNA or GBXX devices. For example, to report
other vendors’ devices correctly. In general, other vendors’ devices
use the same reporting as BNA devices. Compound devices use the
same reporting as GBXX devices. The NCR SDM uses the same
reporting as BNA devices.
The M-Status reporting is defined using the MStatusType property
on the IMStatusMapper class, the default entry in the
CashInCustom.accfg file is as follows:
<Property Name="MStatusType" Value="Default" />
Valid values are as follows:

Default - use the reporting for the device detected in the SST

BNA - use the same reporting as BNA devices

GBXX - use the same reporting as GBXX devices.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-221
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Suspend Handling
5
You can choose whether to handle a Suspend condition as a fatal
condition or a Suspend condition. This is configured using the
CashInCustom.accfg file.
How to handle a Suspend condition on a cash acceptor is set using
the HandleSuspendAsFatal property under the
CashInStatusHandler class, as follows:
<Property Name="HandleSuspendAsFatal" Value="false" />
Valid values are as follows:


true. This treats the cash acceptor as if it were in a fatal
condition. Automatic error recovery is run as normal.
false (default). This treats the cash acceptor as if it were in
Suspend mode. For more information on the Suspend condition,
see “Configuring Suspend Timeout” on page 5-82.
Note: Suspend condition handling is carried out before
automatic error recovery starts.
When an attempt is made to clear the Suspend condition, reserved
screen U0140 is journaled.
Error Recovery
5
Error recovery attempts to clear cash acceptor device errors that
have occurred following cash deposits at the following points:




Start of Day
After the device is reported fatal at the end of the Close state
Initialise BNA option on the Supervisor Replenish menu
Exiting Supervisor.
Automatic error recovery is configured using the
CashInCustom.accfg file.
The points listed above are configured using different classes, as
shown in Table 5-70 “Error Recovery Configuration Classes” on
page 5-222.
Table 5-70
Error Recovery Configuration Classes
Point
Class
Start of day
NCR.APTRA.NDC.CashInErrorRecovery.AutoRecoveryFlow
Close State
NCR.APTRA.NDC.CashInErrorRecovery.AutoRecoveryFlow
INIT BNA
NCR.APTRA.NDC.CashInErrorRecovery.SupervisorRecoveryFlow
Exiting Supervisor
NCR.APTRA.NDC.CashInErrorRecovery.SupervisorRecoveryFlow
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-222
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Error Recovery Modes
5
The error recovery mode is set using the RecoverMode property of
the AutoRecoveryFlow class, as follows:
<Property Name="RecoveryMode" Value="FullRecovery" />
Valid values are as follows:



RecoveryDisabled
Automatic error recovery is off. No automatic error recovery is
performed. An operator must clear the device, for example by
running INIT BNA
FullRecovery (default)
Automatic error recovery is performed. Any notes in the device,
including any at the throat, are retained in the destination
configured in the RecoveryDestination property as described
in “Recovery Destination” below
LeaveNotesAtExitSlot
If notes are left at the throat, automatic error recovery starts only
after notes are removed or an operator clears the device

LeaveNotesInStacker
If notes are left in the escrow for a reason other than a jam, a
retract operation or notes left in the Close state, automatic error
recovery starts only after notes are removed and an operator
clears the device

LeaveNotesAtExitSlotOrInStacker
If notes are left at the throat or in the escrow for a reason other
than a jam, a retract operation or notes left in the Close state,
automatic error recovery starts only after notes are removed and
an operator clears the device.
Recovery Destination
5
The destination used when recovering notes is set using the
RecoveryDestination property of the AutoRecoveryFlow class, as
follows:
<Property Name="RecoveryDestination" Value="Automatic" />
Valid values are as follows:

Cassette
Notes are moved to the cassettes


Retract
Notes are moved to the retract bin
Automatic (default)
The destination is automatically selected based on money
ownership. Notes are moved to the cassettes if the money
belongs to the bank or to the retract bin if the money belongs to
the cardholder.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-223
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Reason for Failed Recovery
5
The reason given in reserved screen U0118 for a failed recovery
attempt can be described using the RecoveryFailedReasonsArray
in the CashInCustom.accfg file.
The default reasons are as follows:
<Array ID="RecoveryFailedReasonsArray">
<Element Value="Success=NO ERROR" />
<Element Value="Jammed=DEVICE JAMMED" />
<Element Value="RetractMissing=RETRACT BIN MISSING" />
<Element Value="CassettesMissing=CASSETTES REMOVED" />
<Element Value="CassettesFull=CASSETTES FULL" />
<Element Value="CombinedDeviceError=CASH OUT ERROR" />
<Element Value="HardwareError=HARDWARE ERROR" />
<Element Value="DeviceOffline=DEVICE OFFLINE" />
<Element Value="StartEndExchangeFailed=EXCHANGE FAILED" />
</Array>
ECB 6 Considerations
5
Article 6 of the Council Regulation (EC) No 1338/2001 of 28 June
2001 lays down measures for protecting the euro against
counterfeiting. The Governing Council is part of the European
Central Bank (ECB), and these measures are collectively known as
ECB 6.
For more information about the ECB 6 regulations, see the European
Central Bank web site at www.ecb.int.
ECB 6 Note Categories
Four note categories are defined by ECB 6, as described in the
following table.
Table 5-71
ECB 6 Note Categories
Category
Description
1
Either not a note or not recognised as a note. Category 1
notes are returned to the cardholder as unrecognised.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-224
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Category
Description
2
Counterfeit note. Counterfeit notes must be captured and
cannot be returned to the cardholder even if the
transaction is cancelled. The Supervisor option CREATE
SIGS asks the operator to insert a note in four directions
and captures the signatures onto removable media. The
Supervisor option EXTRACT SIGS asks for a start and
end date for the data to be extracted from the ECB 6
journal and a destination to copy the data to. Counterfeit
notes cannot be credited to the cardholder’s account but
the details are journaled.
Note: Information from these options must be removed
from the SST and compared to the journal to match a
cardholder to a transaction. The financial institution
must use information from Central to identify a
cardholder as the information in the ECB 6 journal is
masked
3
Suspect note. Suspect notes can be captured or returned
to the cardholder as unrecognised depending on the
financial institution. If captured, data can be extracted
from the ECB 6 journal, as described for counterfeit notes
above. Suspect notes may be credited to the cardholder’s
account; this decision is made by the financial institution.
Details of suspect notes are journaled.
4
Authenticated note. Authenticated notes have been
classified as genuine.
Note:
Within ECB 6, authenticated notes can be further
categorised into fit and unfit notes. A fit note is
one that is suitable for circulation. Unfit notes are
damaged in such a way that they are unsuitable
for circulation. This categorisation only affects
devices used for recycling.
Counterfeit and Suspect Notes
5
When a deposited note is identified as a counterfeit (category 2)
note, it must be captured, even if the cardholder subsequently
cancels the deposit.
When a deposited note is identified as a suspect (category 3) note
and ECB 6 mode 1 is configured, the note is either captured or
returned to the cardholder. For NCR SSTs, the action taken depends
on the setting of the Cat3rollback entry in the GBXX configuration
file. For details of the Cat3rollback entry, see “GBXX Cassette
Configuration” on page 5-241. For other vendors, this is set using
the platform. If ECB 6 mode 2 is configured, the suspect note is
always returned to the cardholder as unrecognised. For details of
the ECB 6 modes, see “ECB 6 Modes” on page 5-227.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-225
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Logging Counterfeit and Suspect Notes The note signatures for
counterfeit and suspect notes are logged to the ECB 6 database
through the RecordCat3Signatures property of the
ECB6CashAcceptServiceCustomised class. This property is set to
true in the CashInCore.accfg file. The RecordCat2Signatures
property in the code is also set to true. This ensures that the
signatures retrieved for counterfeit and suspect notes are always
logged to the ECB 6 database regardless of the ECB 6 settings.
5
Note: If you require to stop this logging to the ECB 6 database of
signatures for counterfeit and suspect notes, you will have to edit
CashInCore.accfg as follows:
1
Set the RecordCat3Signatures property of the
ECB6CashAcceptServiceCustomised class to false.
2
Add a similar entry for the RecordCat2Signatures property,
also setting it to false.
If the reading of the note signature fails for suspect or counterfeit
notes, this is journaled using reserved screens U0124 and U0125.
Capturing Counterfeit and Suspect Notes When a note is
captured, the SST does the following:
1
Takes a single-orientation note signature.
This is added to the ECB 6 database along with other details
such as the note type, ECB 6 note category, currency and time
stamp.
2
Captures the note.
Counterfeit notes are stored in the counterfeit bin. Suspect notes
are stored as specified in the Cat3StoragePolicy entry of the
GBXX configuration file or configured on the platform
depending on the SST. For details of the GBXX configuration
file, see “GBXX Cassette Configuration” on page 5-241.
3
Journals the number of captured notes.
The operator must then use the following options on the Configure
menu in Supervisor:
1
Option 55 - CREATE SIGS to take four orientations of a note and
copy the signatures to removable media. The operator must
remove the note and re-insert it in each of the orientations.
2
Option 56 - EXTRACT SIGS to take an extract from the ECB 6
database and copy it to a selected destination.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-226
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Note counts for suspect notes are included in the ‘ca3’ field of the
Transaction Request message. Note counts for counterfeit notes are
not included in the Transaction Request message.
Note counts for counterfeit notes are shown as totals and suspect
notes are included in the individual note type counts along with
good notes and shown as totals in following situations:
— When a confirmation screen is displayed, as described in
Chapter 5, “Application Programming Interfaces” of the
APTRA Advance NDC, Extending the Product publication
— When the following options are used on the Supervisor
Replenish menu:
3 DSP CNTS
4 PRNT CNTRS
53 CLR BNA
58 DSP BNA CNTS
59 PRN BNA CNTS.
Whether to report any detected counterfeit or suspect notes in an
unsolicited status message is configured using the
P6DetectedUnsol property of the CashInStatusHandler class.
Valid values are as follows:
DoNotSend — Do not send an unsolicited message (default)
SendWithoutCardData — Send an unsolicited message, but do
not include any card data
SendWithCardData — Send an unsolicited message, and
include card data. If the card data is unavailable, the card
data fields are empty.
If the property is set to SendWithoutCardData or
SendWithCardData, a status message reporting counterfeit notes
begins with w? and a status message reporting suspect notes begins
with w@.
Note 1: For a PA-DSS compliant solution, the message must be sent
securely, for example, by using SSL to encrypt the message, if value
is set to SendWithCardData.
Note 2: If ECB 6 support is enabled, Enhanced Configuration
Parameter option 45 should be set to allow more than 90 notes.
ECB 6 Modes
5
The ECB 6 mode defines how notes are identified using the ECB 6
note categories. ECB 6 modes are defined using the CatMode
element of the GBXX Configuration file, as described in “GBXX
Cassette Configuration” on page 5-241.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-227
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
If the CatMode element of the GBXX configuration file is set to 2, the
CatMode property of the ECB6CashAcceptServiceCustomised
class in the CashInCustom.accfg file must also be set to 2 to guarantee
the suspect note count.
If the CatMode element of the GBXX configuration file is set to 0, the
CatMode property of the ECB6CashAcceptServiceCustomised in
the CashInCustom.accfg file must also be set to 0.
The following sub-sections describe the other registry values that
must be set according to your hardware and the CatMode value set
in the GBXX configuration file.
For further information on these registry entries, refer to the APTRA
on-line documentation, under Self-Service Support |
Programmer’s Reference | XFS Service Providers | XFS
GBNA-GBRU Service Provider | Configurable Parameters.
Registry Entry for BNA Using ECB 6 Mode 1 If you are using a
BNA device and want to enable ECB 6 mode 1, you must set the
following registry entry to 1:
5
HKLM\SOFTWARE\Classes\WOSA/XFS_ROOT\
SERVICE_PROVIDERS\CIM\GENERAL_CONFIGS
Registry Entry for GBXX Using ECB 6 Modes 0 and 2 If you are
using ECB 6 mode 0 or 2 with a GBXX device, you must define the
destination for unfit authenticated notes by adding the following
registry entry:
5
HKLM\SOFTWARE\NCR\XFS GRBU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\Interoperability\
NonECBUnfitDest
Valid values are as follows:

1 - unfit authenticated notes are deposited in cassette position 1

2 - deposit fit and unfit authenticated notes together.
ECB 6 Database Support Utility
The ECB 6 database support utility is a component in the Advance
NDC aggregate. It is included so that the ECB 6 journal can store
signatures for the counterfeit and suspect notes.
Note: On BNA devices, the Glory Database Generator must be
used. This is not supplied with Advance NDC, but can be obtained
from NCR Deposit Product Management.
For further information on the ECB 6 database support utility,
including the format of the file, refer to the APTRA on-line
documentation under APTRA ECB6 Database Support.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-228
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
ECB 6 Journal Format The ECB 6 journal is an XML file called
ECB6LOG.SDF. This file is located in the C:\Program Files\NCR
APTRA\Advance NDC\PersistedData\ECB6Log folder. It cannot be
viewed, unless the Extract Signature option on the Supervisor
Configure menu is used to copy an extract to removable media.
ECB 6 Journal Contents The ECB 6 journal contains the masked
card number, the time of the transaction, note ID, denomination,
whether the note was a counterfeit or suspect, and the orientation
and signature of the note. No information on counterfeit or suspect
notes is sent to the host in the Transaction Request message, but
note counts are included in the ca3 field. Unsolicited status
messages contain information on counterfeit and suspect notes.
5
5
Note: The card number is masked in the database. If the card
number consists of only four digits, all are masked. If more than
four digits are included, all are masked except the last four. To track
a specific note or transaction to a cardholder, include reporting of
counterfeit and suspect notes in the status messages to allow the
host data to be used for tracking purposes.
For details of including counterfeit and suspect notes in the status
messages, see “Counterfeit and Suspect Notes” on page 5-225. For
information on using a PCI PA-DSS compliant solution, see
Appendix E, “PCI DSS & PA-DSS Compliance in Advance NDC.”.
Duration of Stored Information According to ECB 6 regulations,
the maximum age of the stored information must be a minimum of
four weeks. Advance NDC will store information for 60 days. Any
records over the maximum age are automatically deleted from the
database.
Media Entry Indicator for a
BNA
5
The media entry indicator (MEI) on a BNA is used as defined in the
following registry entry:
5
HKLM\SOFTWARE\NCR\XFS CIM Service Provider\
XFS-DeviceControl\CIM\Interoperability\
MiscIfMEI
For details of this registry entry, refer to the APTRA on-line
documentation under APTRA XFS | Programmer’s Reference |
XFS Service Providers | XFS CIM Service Provider | Configurable
Parameters.
Encash, Print and Set Next
State
5
To improve performance, the transaction reply printer data can be
sent to the printer at the same time as the encash operation is carried
out. This results in a parallel print and encash. The printing occurs
only if the encash operation is successful.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-229
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
To enable parallel print and encash, the following registry entry
must be set to 1:
HKLM\SOFTWARE\NCR\Advance NDC\BNA\DoParallelEncashPrint
Valid values for this entry are as follows:


Cash Deposit Exception
Reporting
5
0 to disable parallel print and encash (default).
1 to enable parallel print and encash.
An XML file is used to log exceptions, retract operations and host
timeouts occurring during deposit transactions. Exception reporting
is enabled and configured using properties in the
CashInCustom.accfg file as described in the following sections.
The log can be printed and cleared using options on the Supervisor
Replenish menu. The file can be archived and retrieved using
options on the Supervisor Configure menu. For details of the menu
options, refer to Chapter 3, “Replenish Menu” and Chapter 4,
“Configure Menu” in the APTRA Advance NDC, Supervisor’s Guide.
Enabling Exception Reporting for Cash Acceptors
5
The following shared property is used to enable exception reporting
for cash acceptors:
<SharedProperty Name="EnableExceptionReporting"
Value="false"/>
By default, exception reporting is disabled. To enable exception
reporting, update the value to "true".
Configuring the Report Format
5
The formatter to use is set using the following property on the
PrintCashInExceptionReport class:
<Property Name="CountersFormatter"
Value="BasicCashInFormatter"/>
By default, the basic formatter is used. To use the enhanced
formatter, update the value to EnhancedCashInFormatter.
Basic Formatter When using the basic formatter, the number of
accepted notes for each denomination is reported as illustrated in
the following example:
DENOM:
EUR5-001,EUR20-017,
EUR50-018,EUR100-019
The number of columns to use when wrapping dynamic data can be
configured, as described in “Number of Columns” on page 5-232.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-230
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Enhanced Formatter When using the enhanced formatter, the
number of accepted notes for each denomination is reported as
illustrated in the following example:
5
DENOM:
EUR
5 x
1 =
5
EUR
20 x 17 =
340
EUR
50 x 18 =
900
EUR
100 x 19 =
1900
EUR TOTAL =
3145
A separator can be configured to format numbers when the number
reaches a thousand as described in “Using a Separator” on
page 5-233.
The test used for the total heading can be configured as described in
“Text Used for Total Heading” on page 5-233.
Error Screen Display Timer
5
The time that an error screen is displayed on the operator interface if
the printer is not available can be configured using the following
property on the PrintCashInExceptionReport class:
<Property Name="ErrorTimeout" Value="5000"/>
The value can be set to any unsigned integer. A value of 0 means
that the error screen is continuously displayed. The default value, as
shown in the above extract, is 5000 milliseconds (5 seconds).
Configuring the Receipt Service
5
Several properties in the CashInXFSReceiptSrv class can be used
to configure media and language for the receipt service, as
described in the following sections.
Media Definition The path and filename for the receipt definition
file can be configured using the following property:
5
<Property Name="ReceiptDefinitionFileName"
Value="Config\SupervisorReceiptConfig.xml"/>
The CEN-XFS media definition defining the dimensions of the
paper used for printing is set using the following property:
<Property Name="Media" Value="Receipt1"/>
The value can be updated to reference any valid media definition
file.
Translation and Language The data translator associated with the
receipt service can be set using the following property:
5
<Property Name="Translator" Value="DataTranslator"/>
If the value is set to an empty string, no translation is carried out.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-231
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
If a value is specified, the data records are translated to the language
specified in the Language property. The Language property defines
the two-letter abbreviation that identifies the language to translate
the data records into as follows:
<Property Name="Language" Value="en"/>
The value must be the abbreviation for the desired language as
defined in ISO standard 639.
Journal Formats
5
The format for cash acceptor journal entries can be configured using
the CashInCustom.accfg file and screens in resrvd.def.
Example journal entries are described in Chapter 7, “Error Recovery
and Reporting” in the APTRA Advance NDC, Supervisor’s Guide.
Class Configurator Configuration
5
The following sections describe the parts of the journal that can be
configured using the CashInCustom.accfg file. The examples from the
file provide the default settings. To change a setting, edit the value.
You can define whether to use the basic or enhanced formatter
using the DeviceStatusFormatter property of the CashInJrnlSrv
class, as follows:
<Property Name="DeviceStatusFormatter"
Value="BasicDeviceStatusFormatter" />
<Property Name="UnknownText" Value="UNKNOWN" />
To use the enhanced formatter, update the value to
EnhancedDeviceStatusFormatter. Table 5-72, “BNA Journal Format
Properties”, shows which formatting properties use basic
formatting and which properties use enhanced formatting.
Table 5-72
BNA Journal Format Properties
Property
Basic
Number of Columns
X
Enhanced
Text Used for Total Heading
X
Using a Separator
X
Denomination Names
Currency Names
X
X
Number of Columns The number of columns is set using the
NumberOfColumns property, under the BasicStatusFormatter
class, as follows:
<Property Name="NumberOfColumns" Value="22" />
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-232
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
If the number of columns is set to a value less than or equal to 20,
the default value (22) is used.
Text Used for Total Heading The text to use as the heading for
totals is set using the TotalString property, under the
EnhancedStatusFormatter class, as follows:
5
<Property Name="TotalString" Value="TOTAL" />
Text Used for Counterfeit Notes Heading The heading used for
the counterfeit note count is set using the CAT2H property, under the
CashInJrnlSrv class, as follows:
5
<Property Name="CAT2H" Value="CAT2:" />
Text Used for Suspect Notes Heading The heading used for the
suspect note count is set using the CAT3H property, under the
CashInJrnlSrv class, as follows:
5
<Property Name="CAT3H" Value="CAT3:" />
Using a Separator
Whether to use a separator is set using the
5
JournalGroupDigit property, under the
EnhancedStatusFormatter class, as follows:
<Property Name="JournalGroupDigit" Value="false" />
Valid values are as follows:

true Use a separator

false Do not use a separator.
The separator is used to format numbers, in the journaled totals the
separator is used when the number reaches a thousand. You must
change the value to true if you want to use a separator. For
example, to use 1,000 instead of 1000.
Reporting Zero Counts This is set using the ReportZeroCounts
property, under the CashInJrnlSrv class, as follows:
5
<Property Name="ReportZeroCounts" Value="true" />
Valid values are as follows:

true Report counts with a value of zero

false Do not report counts with a value of zero.
These are set using the
DenominationNamesMapping array, as follows:
Denomination Names
5
<Array ID="DenominationNamesMapping">
<Element Value="USD5=$5-" />
</Array>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-233
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Currency Names These are set using the CurrencyNamesMapping
array described in "Currency Names Mapping Array", on page
5-210.
Reporting the Retract Destination The destination of retracted
notes is journaled using the text defined in the RetractAreasArray
array, as follows:
5
5
<Array ID="RetractAreasArray">
<Element Value="CIM_TO_RETRACT=RETRACT BIN" />
<Element Value="CIM_TO_STACKER=STACKER" />
<Element Value="CIM_TO_CASSETTE=CASSETTES" />
<Element Value="CIM_TO_TRANSPORT=TRANSPORT"/>
</Array>
Reporting the Recovery Destination The destination for
recovered notes is journaled using the text defined in the
RecoveryDestinationsArray array, as follows:
5
<Array ID="RecoveryDestinationsArray">
<Element Value="RETRACT BIN" />
<Element Value="CASSETTES" />
</Array>
Reserved Screen Mapping The reserved screens used to journal
information for cash acceptors are mapped using the
CashInJournalRecordMapping array as follows:
5
<Array ID="CashInJournalRecordMapping">
<Element Value="CAS_CASH_IN_START_OK=j4018" />
<Element Value="CAS_SHUTTER_OPEN=j4019" />
<Element Value="CAS_NOTES_INSERTED=j4020" />
<Element Value="CAS_MONEY_REJECTED=j4021" />
<Element Value="CAS_NOTES_PRESENTED=j4022" />
<Element Value="CAS_NOTES_TAKEN=j4023" />
:
:
</Array>
Journaling a Customer Timeout The text used to journal that the
consumer has not responded within the allowed time limit is set
using the TCode1Timeout property, which is included under both
the BasicStatusFormatter and EnhancedStatusFormatter
classes, as follows:
5
<Property Name="TCode1Timeout" Value="CUSTOMER TIMEOUT" />
Transaction Code Mapping The messages used to journal
information for transaction codes are mapped using the
CashInJrnlTCodes array as follows:
<Array ID="CashInJrnlTCodes">
<Element Value="0=OPERATION OK" />
<Element Value="1=CUSTOMER CANCEL" />
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-234
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
<Element Value="2=CASHIN CASSETTE FULL" />
<Element Value="3=DEVICE ERROR" />
<Element Value="4=BILLS AT EXIT" />
:
:
</Array>
If you use customised transaction error codes, this array must be
configured to match the new codes. For details of customised
transaction error codes, see “Legacy Software Transaction Error
Codes”, below.
Legacy Software Transaction Error Codes For regions that have
had to customise the transaction error codes, the
CashInStatusHandler component can be configured to use the
customised transaction error codes. This allows those regions to
maintain on-going support on their host networks for the
customised status messages.
5
The TransactionErrorCodes property on the
CashInStatusHandler class is used to specify the transaction error
codes. This property is present in the CashInCustom.accfg file with an
example set of alternative error codes, but it is commented out by
default. When the TransactionErrorCodes property is used, the
CashInJrnITCodes array must also be configured to match the new
error codes.
Note: This setting is for legacy purposes only and must not be used
for future extensions. If you need to report different transaction
error codes, please contact NCR Dundee Product Management.
Reserved Screen Configuration
5
The following sections describe the parts of the journal that can be
configured using the resrvd.def file.
If you do not require a journal entry for any of the following
situations, you can either remove all data from the appropriate
reserved screen, or remove the mention of the screen from the
JournalRecordMapping array in the CashInCustom.accfg file.
Inaccurate Counts If there is a device or platform limitation where
counts cannot be reported but notes have been detected during an
error recovery operation, the cash acceptor note counts may be
inaccurate at the following points:

5
Whenever any of the following Supervisor functions are
selected:
— DISP CNTRS
— PRNT CNTRS
— DISP BNA RCVL
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-235
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors

— PRN BNA RCNL
— DISP BNA CNTS
— PRN BNA CNTS
— PRN BNA TTLS.
Following automatic error recovery.
That note counts may be inaccurate at any of the above points is
journaled using reserved screen U0116 and displayed on the Fault
Display using reserved screen U0151. The error (inaccurate counts)
can be cleared by running the Clear BNA Supervisor option.
Note: The journaling of inaccurate counts applies only when no
note counts are updated by the platform. If good notes (category 4)
are reported as unrecognised (category 1) under the ECB 6
regulations, details of retracted or recovered note types are not
reported. In this situation, only the retract totals will be updated but
note counts are not journaled as inaccurate.
Signatures of Good Notes If the recording of serial numbers is
configured under the ECB 6 regulations and the signature of good
notes is successfully read, it is journaled only on the EJ using
reserved screen U0119. If the EJ is not configured, no note signatures
are journaled.
5
For information on configuring the recording of serial numbers, see
“Reading and Journaling Serial Numbers of Good Notes” on
page 5-208.
Failed Signature Read If the recording of serial numbers is
configured under the ECB 6 regulations, the number of good note
signatures that cannot be read in the current bunch is journaled
using reserved screen U0120.
5
For information on configuring the recording of serial numbers, see
“Reading and Journaling Serial Numbers of Good Notes” on
page 5-208.
If the signature of some notes identified as counterfeit or suspect
under the ECB 6 regulations cannot be read, one of the following
reserved screens are used to journal it:


For counterfeit notes, reserved screen U0124
For suspect notes, reserved screen U0125
The number of notes for which the reading of the signature failed is
also journaled.
Reporting Account Numbers The masked account number is
supplied dynamically using the account number field of reserved
screen U0127. For information on the masking of the account
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-236
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
number, refer to Chapter 7, “Error and Exception Reporting and
Recovery” in the APTRA Advance NDC, Supervisor’s Guide.
Configuration properties are also provided as follows:


The JournalCustomerData property of the
CashInStatusHandler class to determine whether to print
customer data
The UnknownText property of the CashInJrnlSrv class
provides a method of customising the text used when the card
number is not available, for example in a cardless transaction.
This is set by default to UNKNOWN, but you can change this if
required.
Supplies and Severity Reporting By default, extended supplies
are always reported using reserved screen U0127.
5
You can configure reserved screen U0127 to always report extended
severity as well as supplies, or you can include supplies and
severity based on the setting of bit 3 of Enhanced Configuration
Parameter option 45.
To always report extended severity, add the SeverityEx% field to
the definition of screen U0127 in resrvd.def, as shown in the
following example:
’U0127’ ’*<TSN%>*<MessageClass%>*(Iw(1*<Transcode%>,
M-<DiagnosticData%>, R-<SuppliesEx%>’
’S-<SeverityEx%>’
’A/C<AccountNo%>’
To report supplies and severity based on the setting of bit 3 of
Enhanced Configuration Parameter option 45, add the Supplies%
and Severity% fields to the definition of screen U0127 in resrvd.def,
as shown in the following example:
’U0127’ ’*<TSN%>*<MessageClass%>*(Iw(1*<Transcode%>,
M-<DiagnosticData%>, R-<Supplies%>’
’S-<Severity%>’
’A/C<AccountNo%>’
Reporting Diagnostic Data The M-Status diagnostic data is
supplied dynamically using the DiagnosticData field of reserved
screen U0127.
5
To exclude diagnostic data from the journal, edit the screen to
remove the field.
Text Used for Escrow Heading The heading used for the escrow
note count is defined using reserved screen U0127.
5
By default, this is ESC:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-237
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Text Used for Rejected Notes Heading The heading used for the
rejected note count is defined using reserved screen U0127.
5
By default, this is REJECTS:
Text Used for Returned Notes Heading The heading used for the
returned note count is defined using reserved screen U0127.
5
By default, this is REF:
Text Used for Vaulted Notes Heading The heading used for the
vaulted note count is defined using reserved screen U0127.
5
By default, this is VAL:
Reporting Notes at Exit During AER If notes are detected at the
exit during automatic error recovery, this is journaled using
reserved screen U0135.
Journaling Retract Counts
Retract counts are journaled after a retract operation. The format of
the journal entries are described in the APTRA Advance NDC,
Supervisor’s Guide.
On a GBXX, to display the list of note types, by default listed under
RECOGNIZED ITEMS, the SP must be configured to report the note
list on the retract bin by setting the following registry entry:
HKLM\SOFTWARE\NCR\XFS GBRU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\Interoperability\
ExpandCIMRetractNoteList
To ensure that the retract serial number is correctly updated, the SP
must be configured to report retract operations by setting the
following registry entry:
HKLM\SOFTWARE\NCR\XFS GBRU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\Interoperability\
ReportRetractOperations
GBXX Money Insertion
Time Limit
5
When a cash deposit is selected on a GBXX, the shutter opens to
accept notes and the consumer is prompted by the display, flashing
MEI and audible beeping to insert notes.
The delay between the GBXX shutter opening and the prompts to
insert notes can be configured using the InsertMoneyTimeLimit
property of the NDCCashAcceptService class.
By default, the delay is set to 3 seconds.
To change the delay, edit the following property in the
CashInCustom.accfg file:
<Class ID="NDCCashAcceptService"
Name="NCR.APTRA.NDC.CashAcceptService.NDCCashAcceptService"
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-238
APTRA Advance NDC, Developer’s Guide
5
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Assembly="NCR.APTRA.NDC.CashAcceptService.dll">
<Interface>
<Property Name="InsertMoneyTimeLimit" Value="3" />
</Interface>
</Class>
GBXX Dynamic Note
Sorting
5
Advance NDC can be configured to allow dynamic note sorting in
GBXX devices when a cassette becomes nearly full (a high cassette
event). This effectively increases the capacity of the device, as notes
can continue to be accepted.
After a high cassette event, a new cassette must be reconfigured to
accept the note types previously accepted by the nearly full cassette.
Advance NDC reconfigures the cassette during the Close state.
Following this reconfiguration, once the cassette becomes nearly
full, notes are automatically sorted to the newly reconfigured
cassette. The priority sequence is defined by the
CashInCassetteReconfigurePriority property of the
DynamicOverspill class. This property defines an array of the XFS
logical cassette IDs that can be reconfigured to accept other note
types. The order of the array defines the sequence in which the
cassettes are to be reconfigured.
To enable dynamic note sorting, the property in the
CashInCustom.accfg file must be as follows and the array must be
updated to list the cassettes to reconfigure:
<Class ID="DynamicOverspill"
Name="NCR.APTRA.NDC.CashInStatusHandling.DynamicOverspill
" Assembly="NCR.APTRA.NDC.CashInStatusHandling.dll">
<Interface>
<Property Name="CashInCassetteReconfigurePriority"
Value="CashInCassetteReconfigurePriorityArray"
IsArray="true" />
</Interface>
</Class>
To disable dynamic note sorting, the property in the
CashInCustom.accfg file must be commented out, as follows:
<Class ID="DynamicOverspill"
Name="NCR.APTRA.NDC.CashInStatusHandling.DynamicOverspill
" Assembly="NCR.APTRA.NDC.CashInStatusHandling.dll">
<Interface>
<!--Property Name="CashInCassetteReconfigurePriority"
Value="CashInCassetteReconfigurePriorityArray"
IsArray="true" />
</Interface>
</Class>
Note: In order to disable dynamic note sorting after it has been
enabled on the SST, use the Clear BNA option on the Supervisor
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-239
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Config to reset the list of cassettes. If the list of cassettes is not reset,
dynamic note sorting remains enabled.
The following scenarios illustrate how the dynamic note sorting
occurs.
Note: As the reconfiguration occurs during the Close state, there
are some scenarios where the reconfiguration cannot take place. For
example, reconfiguration cannot take place if a cassette becomes
nearly full during a series of transactions.
In all of these scenarios, the desired priority is Cassette 1, Cassette 2,
Cassette 3, and Cassette 4, and the array is defined as follows:
<Array ID="CashInCassetteReconfigurePriorityArray">
<Element Value="CI1" />
<Element Value="CI2" />
<Element Value="CI3" />
<Element Value="CI4" />
</Array>
Scenario 1: No All-in Cassette Configured
5
The cassettes are configured as follows:
— Cassette 1 (CI1) accepts ten-euro notes
— Cassette 2 (CI2) accepts twenty-euro notes
— Cassette 3 (CI3) accepts fifty-euro notes
— Cassette 4 (CI4) accepts one hundred-euro notes
If Cassette 1 becomes nearly full, Cassette 2 will be dynamically
configured to accept ten-euro notes. Cassette 2 is reconfigured as it
is the next cassette in the priority list.
If Cassette 1 is not high but Cassette 2 becomes nearly full, Cassette
1 will be dynamically configured to accept twenty-euro notes. In
this case, Cassette 1 is reconfigured as it has the highest priority.
Scenario 2: All-in Cassette Configured
All cassettes are configured as follows:
— Cassette 1 (CI1) accepts ten-euro notes
— Cassette 2 (CI2) accepts twenty-euro notes
— Cassette 3 (CI3) accepts fifty-euro notes
— Cassette 4 (CI4) accepts all notes (this is the all-in cassette)
If Cassette 1 becomes nearly full, notes will be sorted to Cassette 4
with no reconfiguration.
If Cassette 4 also becomes nearly full, Cassette 2 will be dynamically
configured to accept ten-euro notes.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-240
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
GBXX Cassette
Configuration
This section describes the configuration options for cassettes in cash
acceptors and recyclers as follows:
5






“Cassette Configuration Using Supervisor” describes how to
configure cassettes using Supervisor menu options
“XML Schema” on page 5-243 describes the schema used for the
GBXX configuration file on NCR SSTs
“GBXX Configuration File” on page 5-249 describes the GBXX
configuration file used for NCR SSTs
“Registry Entries for Recycling Units” on page 5-251 describes
the registry settings needed for recycling
“Fixed Cassette Mapping for Recycling” on page 5-254 describes
configuring a fixed mapping to report recycling cassettes
“Maximum Accepted Notes” on page 5-256 describes
configuring the maximum threshold for accepted notes.
Cassette Configuration Using Supervisor
5
The following options on the Supervisor Configure menu that allow
cassettes to be configured:


39 GBXX CONFIG
82 BNA CASS CFG
Note: These configuration options can be used only with GBXX
devices, and are not applicable to BNA devices.
For details of these options, refer to Chapter 4, “Configure Menu” in
the APTRA Advance NDC, Supervisor’s Guide. The configuration for
these options is detailed below.
39 GBXX CONFIG Option This option is used to configure
cassettes for NCR GBXX devices only. Configuration will fail if the
configuration file does not exist, or does not conform to the
guidelines provided here.
5
To configure the cassettes for a GBRU or GBNA, you must use an
XML configuration file and associated XML schema as described in
“GBXX Configuration File” on page 5-249 and “XML Schema” on
page 5-243. The displays associated with this option are controlled
by forms in the CIMConfigTasksTTU.frmttu file. This file is located in
C:\Program Files\NCR APTRA\Printing\TTU\forms.
An example configuration file is given in “GBXX Configuration
File” on page 5-249. The file can be created and edited in any text
editor. No template or sample file is supplied with Advance NDC.
Once created, the GBRUConfig.xml configuration file must be
installed to C:\Program Files\NCR APTRA\Advance NDC\Config
using your preferred method.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-241
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
If no cassettes are configured as all-in cassettes, or the all-in
cassettes become full, good notes may be rejected. This occurs when
an individual bin becomes full but the GBXX is still in service. To
avoid this situation, either ensure that any all-in cassettes are
replenished immediately, or use dynamic note sorting if no all-in
cassettes are configured. For details of dynamic note sorting, see
“GBXX Dynamic Note Sorting” on page 5-239.
You must create the configuration file, and include the following
information:



Currency
Denomination
Initial counts
Note: The initial counts in the NoteCount element must be set
to 0. The counts are updated by the ADD CASH replenishment
option in Supervisor mode. Recycle cassettes must not contain
more than one denomination.




Number of notes to accept before reporting the high threshold
List of notes that can be deposited in particular cassettes
Settings for the GBRUMode registry entry
Settings for the ValidationMode registry entry.
If you use Enhanced Configuration Parameter option 45 to specify
when to report a full cassette, the cassettes must be configured as
follows:


If option 45 is set to report when the first cassette is full, the
cassettes must be configured as individual cassettes. With this
setting, Central is informed when at least one Note Type can no
longer be accepted
If option 45 is set to report when one retract bin or all cash-in
cassettes are full, the cassettes must be configured as all-in
cassettes. With this setting, Central is only informed when all
cassettes are full.
For further information on option 45, refer to Chapter 7,
“Configuration Parameters” of the APTRA Advance NDC, Reference
Manual.
82 BNA CASS CFG Option This option can be used to configure
all vendors’ SSTs with the following limitations:


Only one cash acceptor can be configured for an SST
Multiple currencies can only be configured to a single cassette if
the cassettes are configured using note IDs.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-242
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors

Further vendor-specific configuration may be required. The
GBRU and validation mode settings on NCR SSTs require
further configuration, for example, which can be achieved using
option 39 GBXX CONFIG or the XML configuration file.
XML Schema
5
The following schema must be referenced, as shown in “GBXX
Configuration File” on page 5-249:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3org/2001/XMLSchema">
<xs:complexType name="NoteIDSType">
<xs:sequence>
<xs:element name="NoteID" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="CassetteType">
<xs:sequence>
<xs:element name="CassetteID" type="xs:string"
minOccurs="1" maxOccurs="1"/>
<xs:element name="CurrencyType" type="xs:string
minOccurs="1" maxOccurs="1""/>
<xs:element name="CurrencyValue" type="xs:string"
minOccurs="1" maxOccurs="1"/>
<xs:element name="NoteCount" type="xs:string"
minOccurs="1" maxOccurs="1"/>
<xs:element name="NoteIDS" type="NoteIDSType"
minOccurs="1" maxOccurs="1"/>
<xs:element name="MaxCashInItems" type="xs:string"
minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ConfigDetailsType">
<xs:sequence>
<xs:element name="Cassette" type="CassetteType"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="ConfigID" type="xs:string"
use="required"/>
</xs:complexType>
<xs:complexType name="ActiveConfigType">
<xs:sequence>
<xs:element name="ActiveConfigID" type="xs:string"/>
<xs:element name="GBRUMode" type="xs:string"/>
<xs:element name="ValidationMode" type="xs:string"/>
<xs:element name="CatMode" type="xs:string"/>
<xs:element name="Cat3RollBack" type="xs:string"/>
<xs:element name="Cat3StoragePolicy" type="xs:string"/>
<xs:element name="SuspectCassetteID" type="xs:string"/>
</xs:sequence>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-243
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
</xs:complexType>
<xs:element name="GBRUConfig">
<xs:complexType>
<xs:sequence>
<xs:element name="ActiveConfig" type="ActiveConfigType"/>
<xs:element name="ConfigDetails" type="ConfigDetailsType"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Schema Elements
following table.
The schema elements are described in the
Table 5-73
XML Schema Elements
Element Name
Description
GBRUConfig
The whole file is embedded within GBRUConfig tags.
This is the root element.
Nested elements:
ActiveConfig

ConfigDetails

ActiveConfig
Mandatory.
Appears once only.
Defines the mode of operation and validation for a device. Defines the configuration to
use for the current device.
The mandatory GBRUNumber attribute identifies the device that is to be configured.
Nested elements:
ActiveConfigID

GBRUMode

ValidationMode

ActiveConfigID
Mandatory.
Identifies the configuration set to use when configuring the current device.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-244
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Element Name
Description
GBRUMode
Mandatory for a GBRU.
Ignored for a GBNA.
Identifies the mode in which a GBRU works.
Valid values are as follows:
0 - Recycling mode. Cash can be deposited to and dispensed from the same recycling
cassette.
1 - Cash Dispense mode. Cash can only be dispensed from a cash-out cassette
2 - Cash Deposit mode. Cash can only be deposited to cash-in cassettes
3 - Non-recycling mode. Cash can be deposited to a cash-in cassette, and dispensed from a
cash-out cassette, but these must be separate cassettes
Note: If using the GBRU as a cash-in/cash-out device, this must be set to 3
ValidationMode
Mandatory.
Identifies the currency validation mode of the device.
Valid values are as follows:
0 - Actual notes
1 - Test notes
CatMode
See Table Note 5
Mandatory.
Defines the ECB 6 mode. For more information on ECB 6 modes and related settings, see
“ECB 6 Modes” on page 5-227.
Valid values are as follows:
0 - ECB 6 mode is disabled. All notes are identified as either category 1 or category 4
1 - Full ECB 6 support. Provides standard ECB 6 note categorisation, as described in “ECB
6 Note Categories” on page 5-224.
2 - Notes are identified as unrecognised, counterfeit, or authenticated. Suspect notes are
treated as unrecognised.
3 - Suspect and authenticated notes can be stored together.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-245
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Element Name
Description
Cat3RollBack
Only used when CatMode is set to 1.
Defines whether suspect notes are retained or returned to the cardholder.
Valid values are:
0 - store suspect notes according to the Cat3StoragePolicy value (default).
1 - return suspect notes to the cardholder if the transaction is cancelled or notes are
refunded.
Cat3StoragePolicy
Only used when Cat3RollBack is set to 0.
Sets the destination for suspect notes.
Valid values are:
0 - store suspect notes in an all-in cassette (default).
1 - store suspect notes only in position 1, as defined by the SuspectCassetteID
value.
SuspectCassetteID
Only used if Cat3StoragePolicy is set to 1.
Identifies the cassette used for suspect notes.
Valid values are:
CIxx - where xx is the magnetic setting on the designated cassette
ConfigDetails
Mandatory.
Appears at least once.
Defines a complete set of configuration parameters to use when configuring a device.
Each ConfigDetails sub-element is identified by a ConfigID attribute. This
ConfigID attribute is used by the ActiveConfig sub-element to determine the
configuration to use.
The optional GBRUNumber attribute identifies the device that is to be configured.
Nested elements:

Cassette

ConfigID
ConfigID
Mandatory.
Identifies a configuration set to be used for configuring the device.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-246
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Element Name
Description
Cassette
Mandatory.
Defines the configuration parameters for each cassette that is to be configured.
Nested elements:
CassetteID

CurrencyType

CurrencyValue

NoteCount

MaxCashInItems

NoteIDS

CassetteID
Mandatory.
Identifies the cassette; for example CI15, RC10, or BC5.
Cassettes that are present in the SST and have corresponding entries in the XML file are
configured. No changes are made to the configuration of any cassette that is present in the
SST but does not have a corresponding entry in the XML file.
NCR recommends that entries are included for all cassettes currently present in the SST to
avoid possible conflicts when changing the configuration.
Entries can be included for cassettes not currently present in the SST to avoid reworking
the XML file in the future.
Note: If a recycling cassette is identified and the mode is changed such that recycling is
not supported, the CassetteID should be updated to identify a bill cassette. For example,
RC1 would be updated to BC1. All other configuration settings can remain the same.
CurrencyType
Mandatory.
Identifies the currency to be accepted or dispensed by the cassette.
If CurrencyType is empty and NoteID is specified, the cassette is configured to accept
the specified note.
If CurrencyType is empty and NoteID is empty, the cassette is configured to accept all
notes listed within the NoteIDS element.
CurrencyType uses the ISO-4217 format.
Settings must not conflict with the Advance NDC cash dispenser mapping registry
entries.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-247
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Element Name
Description
CurrencyValue
Mandatory.
Identifies the value of the currency to be accepted or dispensed by the cassette.
If CurrencyValue is empty and CassetteID points to a cash-in cassette, the cassette is
configured to accept all valid notes specified by CurrencyType.
CurrencyValue should be left empty to configure a cash-in cassette that accepts all
notes listed within the NoteIDS element.
NoteCount
Mandatory.
Specifies the number of notes available in the cassette.
This value must initially be set to zero (0). Running ADD CASH in Supervisor mode
populates the counts.
NoteIDS
Mandatory
Defines one or more note identifiers for the currency and value specified in
CurrencyType and CurrencyValue.
If multiple note identifiers are specified, the CurrencyType and CurrencyValue are
ignored.
Nested elements:

NoteID
NoteID
Optional.
Identifies a note ID for the currency and value specified in CurrencyType and
CurrencyValue.
Note ID values are vendor-specific.
MaxCashInItems
Optional.
Specifies the maximum number of notes that can be accepted before the SP reports a
cassette high threshold. If the MaxCashInItems element is present but empty, the
current setting is retained.
If the cassette is a bill cassette (type BC or CI), and the MaxCashInItems element is not
present, the default of 2000 is used
If the cassette is a retract, reject, or counterfeit bin, the following apply:

When running the GBXX configuration file, only the MaxCashInItems element is
used

If the MaxCashInItems element is not present, the default of 200 is used
Table Note 5: If the CatMode value is set to 1 or 2, the ECB 6
database support utility must be installed. See “ECB 6 Database
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-248
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Support Utility” on page 5-228.
GBXX Configuration File
5
The following example of a GBXX configuration file defines the
following:





The recycling unit can deposit cash to cash-in cassettes and
dispense from cash-out cassettes, but these must be separate
cassettes
The GBXX is in the Test notes validation mode
ECB 6 is fully supported, with suspect notes stored in cash-in
cassette 1
Configuration 1 is not used. This would configure cash-in
cassettes 1 and 2 for any currency and denomination, cash-in
cassette 3 for five-euro notes (EUR), and cash-in cassette 15 for
ten-euro notes
Configuration 2 is set as active and configures bill cassette 1 for
fifty-euro notes, bill cassette 2 for one hundred-euro notes, and
cash-in cassette 3 is configured as an all-in cassette.
The cassettes must contain the configured denominations.
<?xml version="1.0" encoding="utf-8"?>
<GBRUConfig
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="GBRUConfig.xsd">
<ActiveConfig>
<ActiveConfigID>2</ActiveConfigID>
<GBRUMode>3</GBRUMode>
<ValidationMode>1</ValidationMode>
<CatMode>1</CatMode>
<Cat3RollBack>1</Cat3RollBack>
<Cat3StoragePolicy>1</Cat3StoragePolicy>
<SuspectCassetteID>CI1</SuspectCassetteID>
</ActiveConfig>
<ConfigDetails ConfigID="1">
<Cassette>
<CassetteID>CI1</CassetteID>
<CurrencyType></CurrencyType>
<CurrencyValue></CurrencyValue>
<NoteCount>0</NoteCount>
<NoteIDS/>
</Cassette>
<Cassette>
<CassetteID>CI15</CassetteID>
<CurrencyType>EUR</CurrencyType>
<CurrencyValue>10</CurrencyValue>
<NoteCount>0</NoteCount>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-249
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
<NoteIDS>
<NoteID>260</NoteID>
</NoteIDS>
</Cassette>
<Cassette>
<CassetteID>CI3</CassetteID>
<CurrencyType>EUR</CurrencyType>
<CurrencyValue>5</CurrencyValue>
<NoteCount>0</NoteCount>
<NoteIDS>
<NoteID>259</NoteID>
</NoteIDS>
</Cassette>
<Cassette>
<CassetteID>CI2</CassetteID>
<CurrencyType></CurrencyType>
<CurrencyValue></CurrencyValue>
<NoteCount>0</NoteCount>
<NoteIDS></NoteIDS>
</Cassette>
</ConfigDetails>
<ConfigDetails ConfigID="2">
<Cassette>
<CassetteID>BC1</CassetteID>
<CurrencyType>EUR</CurrencyType>
<CurrencyValue>50</CurrencyValue>
<NoteCount>0</NoteCount>
<NoteIDS>
<NoteID>260</NoteID>
</NoteIDS>
</Cassette>
<Cassette>
<CassetteID>BC2</CassetteID>
<CurrencyType>EUR</CassetteType>
<CurrencyValue>100</CurrencyValue>
<NoteCount>0</NoteCount>
<NoteIDS>
<NoteID>261</NoteID>
</NoteIDS>
</Cassette>
<Cassette>
<CassetteID>CI3</CassetteID>
<CurrencyType></CurrencyType>
<CurrencyValue></CurrencyValue>
<NoteCount>0</NoteCount>
<NoteIDS></NoteIDS>
</Cassette>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-250
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
</ConfigDetails>
</GBRUConfig>
Registry Entries for Recycling Units
5
The following registry configuration is needed to support separate
cash-in and cash-out functions or full recycling functionality on a
recycling unit.
Note: To enable recycling, GBRUMode must be set to 0 using the
GBXX configuration file. For details, see “GBXX Cassette
Configuration” on page 5-241. Recycling must also be enabled using
Enhanced Configuration option 45 as described in chapter 7 of the
APTRA Advance NDC, Reference Manual.
Table 5-74, “Recycling Unit Registry Entries Set by Advance NDC”,
shows the entries set by Advance NDC, and Table 5-75, “Recycling
Unit Registry Entries to be Updated by User”, shows the entries that
you must update to complete the configuration.
Table 5-74
Recycling Unit Registry Entries Set by
Advance NDC
Registry Entry
Description
Value
HKLM\Software\NCR\
XFS GBRU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\Operations\
GBRUMode
Set at installation to set the recycling unit mode.
For details of the recycling unit modes see
Table 5-73 on page 5-244.
3
HKLM\Software\NCR\
XFS GBRU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\Operations\
SuspendTimeout
Set at installation to set the recycling unit suspend
timeout.
Advance NDC uses the maximum value to ensure
that it has control over the recycling unit timeouts.
900
HKLM\Software\NCR\XFS GBRU-GBNA
Service Provider\
XFS-DeviceControl\GBRU-GBNA\
Interoperability\AllowResetDuringSuspend
Set at installation to allow a reset command to be
sent when the recycling unit is in suspend mode.
1
HKLM\Software\NCR\
XFS GBRU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\
Interoperability\SuppressManipStatus
Set at installation to ensure that the MANIP state
is not reported when a cassette is inserted. The
state is only reported for a short time and is
automatically cleared.
1
HKLM\Software\
NCR\XFS GBRU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\
Interoperability\NotRejectOnDispense
Set at installation to prevent notes found in the
stacker when WFS_CMD_CDM_DISPENSE is
called from being automatically sent to the reject
area.
1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-251
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Registry Entry
Description
Value
HKLM\Software\NCR\
XFS GBRU-GBNA Service Provider\
XFS-DeviceControl\GBRU-GBNA\
Interoperability\RejectOnCashInStart
Set at installation to prevent notes found in the
stacker when WFS_CMD_CIM_CASH_IN_START
is called from being automatically sent to the reject
area.
0
HKLM\Software\NCR\
APTRA Self-Service Support (NCR Features)\
GBRU\Operational Parameters\
DisableAutoResetErrorRecovery
Set at installation to prevent automatic error
recovery when a hardware error occurs.
1
HKLM\Software\NCR\
APTRA Self-Service Support (NCR Features)\
GBRU\Operational Parameters\
ClearTransportOnStartUp
Set at installation to ensure that notes are not
cleared from the transport at startup.
0
HKLM\Software\NCR\Advance NDC\
CashRecycler\BillDispenser
Set at runtime if the device is a recycling unit.
1
HKLM\Software\NCR\Advance NDC\
CashRecycler\CashRecyclerMapping
Set at runtime depending on the setting of
Enhanced Configuration option 78.
HKLM\Software\NCR\Advance NDC\
CashRecycler\ResetRequired
HKLM\Software\NCR\Advance NDC\
CashRecycler\TransactionType
This is to avoid the device performing automatic
error recovery in the middle of a cardholder
session, which would delay the transaction.
If option 78 is 000
0
If option 78 is 001
1
Set at runtime to identify whether an error has
occurred, and whether any error was on a cash-in
or a cash-out transaction.
If there was no error
0
If there was an error during a cash-out transaction
1
If there was an error during a cash-in transaction
2
Set at runtime to identify whether the last
transaction was a cash-in or a cash-out transaction.
If the last transaction was a cash-out transaction
0
If the last transaction was a cash-in transaction
1
The entries defined in Table 5-75 must be updated to use the stated
values to complete the configuration. All entries are under the
following registry key:
HKLM\Software\NCR\Advance NDC\
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-252
APTRA Advance NDC, Developer’s Guide
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Table 5-75
Recycling Unit Registry Entries to be
Updated by User
Registry Entry
Description
Update Value To..
Aliases\Cash Dispenser
Specifies that the cash handler is a recycling
unit
The alias for whichever <Cash
Dispenser> is being used as a recycling
unit must be updated. Only one recycling
unit is supported on an SST.
BillDispenser1
CashRecycler\PhysicalCassettes\Top
Defines the name of the physical cassette in
the top position
Cassette 1
CashRecycler\PhysicalCassettes\Second
Defines the name of the physical cassette in
the second position
Cassette 2
CashRecycler\PhysicalCassettes\Third
Defines the name of the physical cassette in
the third position
Cassette 3
CashRecycler\PhysicalCassettes\Fourth
Defines the name of the physical cassette in
the fourth position
Cassette 4
CashRecycler\PhysicalCassettes\Reject
Defines the name of the physical cassette in
the reject bin position
Reject bin
supervisor\ClearCashHandlerCmd
Ensures that the recycling unit is cleared
using a reset rather than a reject command
after the following:

Suspend

Exit from Supervisor

Test Cash operation

STD Cash operation
0x141
CurrencyTable
Defines the Advance NDC Currency Types.
Must match the
contents of the
Aliases\Cash Dispenser Second
GBRUConfig.xml
file.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-253
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
Registry Entry
Description
Update Value To..
CashRecycler\DispenseDisableThreshold
Used when the recycling unit is in recycling
mode.
Defines the number of notes remaining in a
recycling cassette when the cassette is to be
reported as out of notes
The default value is 0. If the value is missing
or is greater than the
DispenseEnableThreshold value, the
default is used
Update as
required
CashRecycler\DispenseEnableThreshold
Used when the recycling unit is in recycling
mode.
Defines the number of notes remaining in a
recycling cassette when the cassette is to be
reported as good having previously been
reported as being out of notes
The default value is 1. If the value is missing
or is less than the
DispenseDisableThreshold value, the
default is used
Update as
required
CashRecycler\ReportCDMRetractCounts
Used to enable the storing, printing and
displaying of counts for notes retracted in
dispense operations when a recycling unit is
present and Enhanced Configuration option
45 has bits 3 and 6 set
Valid values are as follows:

0 - do not report retract note counts for
dispense operations

1 - report retract note counts for
dispense operations
The default value is 0, retract note counts for
dispense operations will not be reported. If
the value is missing or is any value other
than 0 and 1, the default is used
If retract note
counts for
dispense
operations are
required, set to 1
A cassette can be configured for deposit, recycling or dispense
transactions. To use cash-in/cash-out functionality on a recycling
unit, at least one physical cassette must be configured for depositing
notes and at least one must be configured for dispensing notes. The
reject bin contains three partitions, as follows:



Reject area
Retract area
Counterfeit area.
Fixed Cassette Mapping for Recycling
By default, the NDC cassette type is mapped to the XFS logical cash
unit automatically. Defining a fixed cassette mapping means that
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-254
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
you can match the deposit cassette IDs with the dispense cassette
IDs.
A fixed mapping must be used when recycling is enabled and you
want to report fixed cassette types in a Ready ‘B’ or other status
message.
To configure fixed mapping, the following tasks must be completed:


The CassetteFixedMappings property must be uncommented
in the CashInCustom.accfg file
The CassetteFixedMappings array must be populated
Note: The GBRUMode registry entry must be present as described in
“Registry Entries for Recycling Units” on page 5-251.
Uncommenting the Property The following section of the
CashInCustom.accfg file must be uncommented as shown below:
5
<Class ID="CassetteMapper"
Name="NCR.APTRA.NDC.CashAcceptService.GBxxCassetteMapper"
Assembly="NCR.APTRA.NDC.CashAcceptService.dll">
<Interface>
<Property Name="CassetteFixedMappings"
Value="CassetteFixedMappings" IsArray="true"/>
</Interface>
</Class>
Populating the Array The array must be populated with the
required mapping pairs using the following fomat:
5
Element Value ="<CassetteID>=<XFS logical cash unit>"
The following example array maps two recycling cassettes and one
cash-in cassette:
<Array ID="CassetteFixedMappings">
<Element Value="RC1=1"/>
<Element Value="RC2=2"/>
<Element Value="CI15=3"/>
</Array>
The cassettes are reported using three digits, therefore, the cassette
defined in the first line of the above example would be reported as
‘001’.
For further information on the CassetteID element, see “GBXX
Cassette Configuration” on page 5-241.
Valid values for the XFS logical cash unit are between 0 and 255. For
restrictions to this range, see “Reporting Missing or Invalid
Mappings” below.
Single to Multiple Mapping A single NDC cassette type must not
be mapped to more than one XFS logical cash unit unless the
5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-255
Configuring Advance NDC and Associated Components
Configuring Cash Acceptors
network contains both GBNA and GBRU devices with recycling
enabled. In this situation, you can set up a single to multiple
mapping, but you must not insert the cassettes at the same time.
This allows a single CashInCustom.accfg file to be used on different
SSTs across the network. If the cassettes are inserted at the same
time and recycling is enabled, the recycling cassette is given
precedence over the cash-in cassette. If this situation occurs,
Advance NDC adds 100 to the value reported by the service
provider. To avoid this situation, NCR recommends that the XFS
logical cash unit identifier is not duplicated.
Reporting Missing or Invalid Mappings If a mapping is not
found for a cassette or the mapping value is invalid, the cassettes are
reported as follows:


5
For cash-in cassettes Advance NDC adds 100 to the value
reported by the service provider
For recycling cassettes Advance NDC adds 200 to the value
reported by the service provider.
Due to these adjustments, NCR recommends that no cassettes are
mapped to values in the following ranges:


100 to 115
200 to 215.
Maximum Accepted Notes
If Enhanced Configuration option 45 is used to limit the number of
accepted notes to 90 (default setting) and you also use any GBXX
units, you must reduce the number of notes accepted by the cash-in
devices to 90.
To limit the number of accepted notes, update the
usmaxAcceptednote parameter in the GBRU_DP2_initial.ini file.
This parameter is set by default to 200.
The file is located in C:\Program Files\NCR APTRA\PcGBRU and
can be edited using a text editor.
Deposit Cassette
Maximum Threshold
A device status of High is triggered when the service provider
reports a high status.
5
For details of the service provider maximum settings, refer to the
APTRA on-line documentation for ulMaximum under APTRA XFS
| Programmers Reference | XFS Service Providers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-256
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
Configuring Cheque Processors
5
This section describes the functionality that can be configured for
the Cheque Processors.
Accessing Cheque Data
5
The SharedChequeDetail class in the AdvanceNDC.accfg file allows
customisations to access cheque data. To avoid problems with data
access, you must not change the following text in the
AdvanceNDC.accfg file:
<Class ID="SharedChequeDetail"
Name="NCR.APTRA.NDC.Customisation.ChequeDetails.
SharedChequeDetail"
Assembly="NCR.APTRA.NDC.Customisation.ChequeDetails.dll"
Remoted="Any">
<Constructor>
<Argument Name="chequeAcceptServiceName"
Value="_IChequeAcceptService" />
</Constructor>
</Class>
Cheque Processing
Module
The location of an image lifted by the cheque processing module
(CPM) is set using the following registry key:
5
HKLM\SOFTWARE\NCR\Advance NDC\CPM
The default path is C:\Program Files\NCR APTRA\Advance
NDC\Data.
Note: If your solution is to be PA-DSS compliant, see “Cheque
Processing Solutions” on page E-10, in Appendix E, “PCI DSS &
PA-DSS Compliance in Advance NDC”.
If your printer can use the Epson Graphics format, you can print the
lifted image. The following registry entries provide the escape
sequence to allow printing of Epson Graphics:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Receipt\CHEQUE
Note: USB receipt printers print cheque images regardless of
the value set here.
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Journal\CHEQUE
If the value is empty, the escape sequence to print a cheque image is
ignored. For details of escape codes, refer to the APTRA Advance
NDC, Reference Manual or your printer’s documentation.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-257
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
To rotate the lifted image anti-clockwise by 90 degrees, set the
following registry entry to 1:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Receipt\
RotateChequeImage
The following entry is used to calculate the area used to mask the
codeline:
HKLM\SOFTWARE\NCR\Advance NDC\CPM\CodeLineHeight
The minimum value is 1 and the maximum is 40. The default is 40.
This value must be less than that defined by the
ChequeSizeRotated registry entry described in “Resizing the
Image” on page 5-258.
If you are using a Branch Assist 18 SST, change the value of the
following registry entry from ChequeProcessor1 to
DocumentProcessor1:
HKLM\SOFTWARE\NCR\Advance NDC\Aliases\Cheque Processor
Cheque Images on Two-Sided Thermal Printers
5
On two-sided thermal printers, the following registry key allows
local configuration when printing cheque images on receipts:
HKLM\SOFTWARE\NCR\Advance NDC\CPM
The following entry controls whether the cheque image is printed
on the front or back:
AlwaysPrintChequesOnBack
By default, this entry is set to 0. This prints the cheque image as
specified in the escape sequence used in the message from Central.
If the entry is set to 1, the cheque image is always printed on the
back irrespective of the escape sequence in the message from
Central.
Resizing the Image
The cheque image can be resized by an amount specified in
millimetres; the DPI registry entry is used to convert the millimetre
setting for printing. The default DPI registry entry is 0, which is 150
DPI. To resize the lifted image, use the appropriate registry entry as
follows:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Receipt\
ChequeSizeNormal
Use this entry when the RotateChequeImage registry entry is
set to 0 (default). The default value is 75, the minimum value is
10 and the maximum value is 75.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-258
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\Receipt\
ChequeSizeRotated
Use this entry when the RotateChequeImage registry entry is
set to 1. The default value is 75, the minimum value is 10 and the
maximum value is 90.
Raw Data Printing For raw data printing, no additional lines are
inserted when a lifted image is printed. Also, the receipt length
defined by message mode option digit 6 is ignored to allow the
increased receipt length. You have to ensure that the total receipt
length for both text and image is not likely to result in a cardholder
trying to remove the receipt before printing has completed.
5
For details of the message mode option digits, refer to the APTRA
Advance NDC Supervisor’s Guide.
Form and Media Definitions
5
Default forms and media definitions are provided for cheque
endorsement, as described in Table 5-76. These forms can be
modified to match the capabilities of the CPM. The default
installation locations are as follows:


Table 5-76
Cheque Endorsement Form & Media
Definitions
Forms
C:\Program Files\NCR APTRA\Printing\CPM\Forms
Media definitions
C:\Program Files\NCR APTRA\Printing\CPM\Media.
File
Description
LocalEndorse.def
Used when a cheque is captured locally. The data
used to endorse the cheque is based on reserved
screen U0057. For details of this screen, refer to
the APTRA Advance NDC, Reference Manual
Endorse.def
Used when the single-line endorsement data sent
from the host does not start with the ‘?’ character
SpecialEndorse.def
Used when the endorsement data sent from the
host starts with the ‘?’ character
CPMMedia.def
Common media definition for all endorsing
operations
Reserved screen U0057 contains the locally customisable string used
for endorsing a cheque. The default endorsement data is as follows:
<Machine Number> <Track 2 Data> CAPTURED <Date> <Time>
If the machine number is not defined, the endorsement data starts
with the track 2 data. The track 2 data is masked for security
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-259
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
reasons. The date format is dd/mm/yy. The time format is
hh:mm:ss.
For example, the default endorsement data could appear as follows:
012345 ;XXXXXXXXXXXXXXXXX0507 CAPTURED 24/09/10 14:05:20
Magnetic Ink Character Recognition (MICR) Option
5
By default, Advance NDC includes MICR reading when processing
cheques. To disable MICR reading, change the registry entry from 1
to 0 as in the following example:
HKLM\SOFTWARE\NCR\Advance NDC\CPM
"EnableMICR"=dword:00000000F
Bunch Cheque Acceptor
You can configure a bunch cheque acceptor as follows:
5






To configure the codeline for different fonts
To suppress status messages in off-line cheque deposit
transactions
To accept cheques in a single orientation only
To support a cheque validation service
To retrieve the cheque image path
To retrieve the setting of bit 4 of Enhanced Configuration
Parameter option 83.
Configuring the Codeline
5
As bunch cheque acceptors can support both the CMC7 MICR
barcode font and the E13B MICR font for automatic cheque
processing, the Bunch Cheque Accept Service has to be configured
for the required format through the Class Configurator.
To configure the required font, add a line for the CodeLineFormat
property in the AdvanceNDC.accfg file and include the font value,
CMC7 or E13B, as shown in the following example for the CMC7
font:
<Class ID="IChequeAcceptService"
Name="NCR.APTRA.BunchChqAccptSrv.XFSBunchChequeAcceptServ
ice" Assembly="NCR.APTRA.BunchChqAccptSrv.dll">
<Property Name="MICRFormat" Value="NCRFormat"/>
</Class>
<Property Name="CodeLineFormat" Value="CMC7"/>
Suppressing Status Messages
In offline bunch cheque deposit transactions, the following registry
entry controls whether status messages are suppressed for the
bunch cheque acceptor:
HKLM\SOFTWARE\NCR\Advance NDC\CPM\
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-260
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
SuppressSCPMStatusMessages
Valid settings are as follows:
0 - Send status messages (default)
1 - Do not send status messages.
Note: The information is still journaled when this registry entry is
set to 1.
Accepting Cheques in a Single Orientation
5
You can accept cheques in one orientation only; you must disable
optical character recognition (OCR) on the PTR SP.
To disable OCR, set the following registry setting to 0:
%ULYBASEKEY%/USB Scalable Cheque Processing Module/
Operational Parameters/EnableOCR
Note: If your solution is to be PA-DSS compliant, see “Cheque
Processing Solutions” on page E-10, in Appendix E, “PCI DSS &
PA-DSS Compliance in Advance NDC”.
Returning Invalid Cheques When the validation centre identifies
a cheque as invalid, the cheque is marked for return and returned
later in the transaction. For off-line transactions, the cheques are
returned in Bunch Cheque Handling State. For host driven
transactions the cheques are either returned or moved to deposit
bin. This happens in line with cheque destination settings in the
transaction reply. This is a default setting which can be changed
through an XML configuration file available in C:\Program
Files\NCR APTRA\Advance NDC\Config.
5
To change the default behaviour, update the value of
"RefuseNonValidCheques" in AdvanceNDC.accfg file as shown
below:
<Class ID="IChequeAcceptService"
Name="NCR.APTRA.BunchChqAccptSrv.XFSBunchChequeAcceptServ
ice" Assembly="NCR.APTRA.BunchChqAccptSrv.dll">
<Interface>
<Property Name="RefuseNonValidCheques" Value="TRUE"/>
</Interface>
</Class>
Caution
For SCPM support, any modifications to functionality or operation
must be done through Advance NDC state processing and off-line
processing. The on-line documentation for the .NET Bunch Cheque
Acceptance Service is provided for information on configuring and
using the data provided through this interface. Programming
directly to the API is not supported.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-261
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
Supporting a Cheque Validation Service
5
The following extract shows an entry in AdvanceNDC.accfg to
support a cheque validation service, which involves no NDC
configuration and can only be set using this file. If this were edited
by changing the LogInvalidCheques property to “True”, invalid
cheques would be logged.
<Class ID="IChequeValidation"
Name="NCR.APTRA.CodeLineValSrv.CodelineVerify"
Assembly="NCR.APTRA.CodeLineValSrv.dll">
<Interface>
<Property Name="ValidationService"
Value="IConfigurableChequeValidator"/>
<!--Property Name="JournalService"
Value="IJournalService"/-->
<Property Name="TerminalService"
Value="ITerminalService"/>
<Property Name="TestDefinitionFile" Value="C:\Program
Files\NCR APTRA\Advance NDC\Config\NCRCVSCONFIG.XML"/>
<Property Name="LogInvalidCheques" Value="False"/>
<!--Property Name="InvalidChequesLogLocation"
Value="Logs"/-->
</Interface>
</Class>
Retrieving the Cheque Image Path
5
The following extract shows an entry in AdvanceNDC.accfg to
retrieve the path used for cheque images from the registry, if the
path changes, this property must be updated.
<Property Name=”ImageCreationDir” Value=”C:\Program
Files\NCR APTRA\Advance NDC\ChequeImages”
DataDictionary=”AANDC Configuration”
DictionaryRecordType=”HKEY_LOCAL_MACHINE\SOFTWARE\NCR\
Advance NDC\CPM” DictionaryFieldName=”ImagePath”/>
Retrieving the Scan After Endorsement Setting
5
The following extract shows an entry in AdvanceNDC.accfg to
retrieve the setting of bit 4 of Enhanced Configuration Parameters
option 83 (scan after endorsing the cheque):
<Property Name=”ScanAfterEndorse” Value=”true”
DataDictionary=”NDC Configuration”
DictionaryRecordType=”Boolean”
DictionaryFieldName=”idOption83:2”/>
For details of the Enhanced Configuration Parameters, refer to
Chapter 7, “Configuration Parameters”, of the APTRA Advance
NDC, Reference Manual.
Endorsing Cheques Returned by the Host
If the cheque processor supports the endorsement of returned
cheques, any cheques returned by the host can be endorsed. If an
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-262
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
NCR bunch cheque acceptor is used, the XFS SCPM service
provider must be changed from IPM to PTR to configure the device
as a single cheque acceptor.
For details of configuring the bunch cheque acceptor for single
cheque acceptance, refer to the USB SCPM component release
bulletin.
Cheque Amount
Recognition
5
Courtesy amount recognition (CAR) and legal amount recognition
(LAR) can be implemented for cheque processing. To implement
amount recognition, you must do the following:



ImageMark Passport ATM
Image Agent
5
Contact NCR Dundee for implementation details and advice
Purchase and configure a third-party cheque validation engine,
such as those offered by A2iA or Parascript
Implement and integrate the CAR/LAR support in Advance
NDC.
The ImageMark Passport ATM Image Agent, available from NCR,
assists in the reconciliation of deposits. For details, contact your
local Payment and Imaging team representative.
By default, support for the ImageMark Passport ATM Image Agent
is disabled in Advance NDC. To use this feature, change the value
of the following registry entry to 1 or 3:
HKLM\SOFTWARE\NCR\Advance NDC\CPM\ImageMark
Valid values for this entry are as follows:
0 to disable ImageMark Passport ATM Image Agent
1 to enable ImageMark Passport ATM Image Agent for
successful cheque deposits only
3 to enable ImageMark Passport ATM Image Agent for
successful cheque deposits and for the CLR DEPOS and CLR
BINS Replenish menu options in Supervisor.
The SST machine number is set using the Supervisor configuration
menu. The SST machine number is used to identify the source of the
transaction (see SourceId in “Transaction Data File: XML
Elements” on page 5-267) and in the back-office processing of the
cheques.
If cardless transactions are enabled, a method of identifying the
correct account must be provided. This allows the back-end system
to determine the account number to post the deposit to and generate
any adjustments, such as an incorrectly entered cheque amount,
against. For further information, please contact your local Payment
and Imaging team representative.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-263
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
The ImageMark Passport ATM Image Agent does the following:

Defines the location of the upload directory. The path is
specified in the following registry entry:
HKLM\SOFTWARE\NCR\Advance NDC\CPM\Path
If this registry entry does not exist, or does not contain a value,
or the specified path is invalid, the following path is assumed by
default:
C:\Program Files\NCR APTRA\Passport
Note: If your solution is to be PA-DSS compliant, see “Cheque
Processing Solutions” on page E-10, in Appendix E, “PCI DSS &
PA-DSS Compliance in Advance NDC”.

For each successful cheque deposit, the ImageMark Passport
ATM Image Agent completes the following steps:
1
Copies images lifted during cheque processing to the
specified path
2
Creates a temporary data file
3

Renames the temporary file when all the data has been
written to the temporary data file, as required by the
Passport Agent. For details of the file see “Example
Transaction Data File” on page 5-266.
Creates an XML file when the CLR DEPOS or CLR BINS option
is selected from the Replenish menu in Supervisor. For details of
the file, see “Example Clear Option File” on page 5-268.
Note: When the CLR BINS option is selected, the XML file is
created for each cleared bin on a CPM. On a bunch cheque acceptor,
an XML file is created only when the first bin with a non-zero count
is cleared.
ImageMark Passport ATM Image Agent Filenames
the following filename format:
All files use
<identifier><yyyymmdd>-<hhmmss>+<machine number>#<transaction
number><front/back><image number>.<extension>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-264
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
The variables in the filename are described in the following table.
Table 5-77
Cheque Deposit Filename Variables
Variable
Description
<identifier>
Identifies whether the file was created for a
cheque deposit or clear option.
If a cheque deposit, this is TXN
If a clear option, this is BIN
<yyyymmdd>
The date of the transaction in numeric year,
month, day format (yyyymmdd)
<hhmmss>
The time of the transaction in numeric hour,
minute, second format (hhmmss)
<machine number>
The machine number of the SST used for the
transaction
<transaction
number>
The number of the transaction
<front/back>
Only used for front image or rear image files.
Identifies whether the image is of the front or
back of the cheque.
If the front, this is f
If the back, this is r
<image_number>
Only used for front image or rear image files.
Identifies the number of the image and
matches the associated ItemId tag described in
Table 5-78 on page 5-265
For a CPM, this is always 01
<extension>
The file extension.
If an image file, this is bmp
If a temporary file, this is tmp
If an XML file, this is xml
The following table provides example of filenames created
following successful cheque deposit and the selection of a CLR
DEPOS or CLR BINS option in Supervisor.
Table 5-78
Example Cheque Deposit Files
Description
Filename
Front image
TXN20071207-091459+123456#1785f01.bmp
Rear image
TXN20071207-091459+123456#1785r01.bmp
Temporary data
TXN20071207-091459+123456#1785.tmp
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-265
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
Description
Filename
Transaction data
(renamed temporary
data file)
TXN20071207-091459+123456#1785.xml
CLR DEPOS or CLR
BINS options
BIN20071207-163459+12345#1945.xml
Example Transaction Data File The transaction data file and front
and rear image files are created on a successful cheque deposit. The
cheque is considered to be successfully deposited when the
Transaction Reply message contains the Process Cheque function
identifier. If the cheque is ejected, or captured because the
cardholder has not taken the ejected cheque, the cheque is not
successfully deposited and no files are created. For details of the
Transaction Reply message, refer to the APTRA Advance NDC,
Reference Manual.
The transaction data file is an XML file with two sections:
transaction details and item details. For example, the
TXN20071207-091459+123456#1785.xml file from the example above
would be as follows:
<Tran>
<Version>2</Version>
<SourceId>123456</SourceId>
<TransactionId>1785</TransactionId>
<TranDate>20071207</TranDate>
<TranTime>091459</TranTime>
<PAN>5505123456789012</PAN>
<TansactionSource>ATM</TransactionSource>
<NumberOfItems>01</NumberOfItems>
<DepositAmount>10</DepositAmount>
<Item>
<ItemId>01</ItemId>
<ItemType>03</ItemType>
<MICR>:000067894: 87654321<2214</MICR>
<ItemAmount>10</ItemAmount>
</Item>
</Tran>
The file is populated by Advance NDC using the elements
described in Table 5-79. For bunch cheque acceptors, the
information is provided by the ImageMark Deposit Recorder
component.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-266
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
Table 5-79
Transaction Data File: XML Elements
XML Tag
Description
Populated With
Version
The version of
XML used
2
SourceId
The SST used for
the transaction
The machine number
TransactionId
Identifies the
transaction
The NDC transaction
sequence number
TranDate
The date of the
transaction
The date that the transaction
occurred in yyyymmdd
format
TranTime
The time of the
transaction
The time that the transaction
occurred in hhmmss format
PAN
The primary
account number
of the card used in
the transaction
The PAN read from the card
inserted for the transaction
TransactionSource
The type of device
used for the
transaction
ATM
Source Location
Describes the
location of the
source
Source location identifier
with a maximum of 20
alphanumeric characters
Not supported for CPMs
NumberOfItems
A count of the
number of <Item>
tags included in
the transaction
The number of cheques
deposited in this transaction.
For CPMs, this is always 1
DepositAmount
The amount being
deposited
The total amount deposited
Maximum of 30 numeric
characters
For CPMs, this is read from
the NDC Amount buffer
For bunch cheque acceptors,
the Cheque Detail Display
state allows the cardholder
to enter the amount. The
decimal point is not
exported, so any user of this
XML file, such as the
consolidation server, must
know how many decimal
points are used
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-267
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
XML Tag
Description
Populated With
ItemId
Identifies the item
in the transaction
that the .bmp files
are associated
with
Two digit count of the item.
For the CPM, this is always
01
ItemType
Identifies the type
of deposit
03
MICR
The codeline from
the cheque being
deposited
The codeline read from the
cheque.
If the codeline validation
service is used and the
codeline cannot be read, this
tag is empty
If the codeline validation
service is not used, this tag
contains the codeline as it
has been read with question
marks (?) in the place of
characters that could not be
read
Codeline validation can only
be used on bunch cheque
acceptors
ItemAmount
The amount of the
deposit
The amount is calculated as
described for the
DepositAmount element
Example Clear Option File The clear option file is an XML file
that records the clearing of the cheque bins. For example, the
BIN20071207-163459+12345#1945.xml file from the example above
would be as follows:
<Tran>
<SourceId>123456</SourceId>
<TransactionId>1945</TransactionId>
<TranDate>20071207</TranDate>
<TranTime>163459</TranTime>
<LocalAmountTotal>00</LocalAmountTotal>
<LocalTotalCount>1</LocalTotalCount>
</Tran>
Note: The clear option file is not created if the counts are zero
before the cheque bins are cleared, even if the ImageMark Passport
ATM Image Agent is enabled.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-268
APTRA Advance NDC, Developer’s Guide
5
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
The file is populated by Advance NDC using the elements
described in the following table:
Table 5-80
Check Bin Empty XML Tags
Envelope Dispenser
5
XML Tag
Description
Populated With
SourceId
The machine used
for the transaction
The SST machine
number
TransactionId
Identifies the
transaction
The NDC transaction
sequence number
TranDate
The date of the
transaction
The SST system date
when the transaction
occurred
TranTime
The time of the
transaction
The SST system time
when the transaction
occurred
LocalAmountTotal
Total of the amount
deposited
00
LocalCountTotal
Total number of
cheques deposited in
the bins cleared by
the CLR DEPOS or
CLR BINS option
The number of cheques
that have been
removed from the bin
If the CLR BINS option
is selected, only the
selected bin is cleared.
On a bunch cheque
acceptor, if the selected
bin has a zero count,
nothing is exported
If you want your application to emulate NDC+ behaviour for
envelope dispensing, you need to configure the following registry
setting:
HKLM\SOFTWARE\NCR\Advance NDC\
EmulateNDCPlusEnvDisp
The settings for this key are:

DWORD value 0 or the key does not exist:
An envelope is dispensed during the Deposit and Print function
if the NDC State C (Envelope Dispenser State) has not been used
(current ANDC behaviour).

DWORD value 1:
No envelope is dispensed during the Deposit and Print function.
(NDC+ behaviour).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
5-269
Configuring Advance NDC and Associated Components
Configuring Cheque Processors
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-270
APTRA Advance NDC, Developer’s Guide
Table of Contents
Configuring Voice Guidance
Chapter 6
Configuring Voice Guidance
Overview
6-1
Introducing Voice Guidance
Voice Guidance During a Transaction
Standard Audio Capabilities
Enhanced Audio Capabilities
6-2
6-2
6-4
6-4
Configuring Voice Guidance
Prompting for a Language
Automatic Language Selection
Enabling Voice Guidance Without Host Updates
Configuring Third-Party TTS Software
Specifying the Character Encoding
Audio elements required in the XML Configuration File
Other XML Files used in Voice Guidance
Local XML Configuration File
Voice Guidance Unavailable
6-5
6-5
6-6
6-6
6-6
6-7
6-7
6-8
6-8
6-9
Advance NDC Voice Guidance and Other Applications
Using Advance NDC Voice Guidance with Promote
Using Advance NDC Voice Guidance with
Display Manager
6-10
6-10
XML Schema
Schema Elements
Encoding Formats for Voice Guidance
6-12
6-20
6-38
Example XML Configuration File
6-39
Voice-Guided Sessions without Host Update
No Host Update XML Elements
Transaction Reply
Screen Display Update Field
6-44
6-44
6-53
6-53
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-11
Table of Contents
Configuring Voice Guidance
Printer Data Field
Interactive Transaction Response
ITR Screen Data Fields
ITR Screen Timer Field
ITR Display Flag Field
ITR Active Keys/Touch Areas Field
Transaction Request General Purpose Buffer B field
Example ITR Message Conversion
Send Configuration Information
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-55
6-57
6-58
6-58
6-58
6-59
6-59
6-59
6-61
Configuring Voice Guidance
Overview
F
Overview
6
This chapter describes how to configure Advance NDC to use voice
guidance.
Voice guidance in Advance NDC is controlled by an XML
configuration file, as described under the following headings:




“Introducing Voice Guidance”
“Advance NDC Voice Guidance and Other Applications”
“XML Schema”
“Example XML Configuration File”
If you have the Americas implementation, this is still supported
without change. Refer to the US documentation provided with the
implementation for information on the formats used.
Note: For voice-guided transactions, NCR recommends you use
version 11 of Windows Media Player to ensure efficient memory
handling.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-1
Configuring Voice Guidance
Introducing Voice Guidance
Introducing Voice Guidance
Voice guidance provides audio assistance to guide a
visually-impaired cardholder through a transaction.
To support voice guidance, two methods of providing audio
messages are supported in Advance NDC as follows:


Voice recordings, which are provided in any file format that is
supported by Advance NDC. These files are referenced from the
XML configuration file for voice guidance
Text messages voiced by any third-party text-to-speech (TTS)
software for Windows XP, for example, RealSpeak Solo
Text-to-Speech from Nuance. The TTS software must be
obtained separately and installed. The TTS software transforms
the text included in the XML file to speech.
Note: Windows XP is supplied with Windows Media Player and
basic TTS software.
These methods can be used in any combination in the order defined
in the voice guidance XML configuration file.
To enable voice guidance on an SST, the following are required:




A valid AudioGuidanceData.xml file must exist in C:\Program
Files\NCR APTRA\Advance NDC\Config
The TTS software must be installed on the SST
If used, audio files must be present on the SST
Message mode option digit 1 must be set to enable voice
guidance. For details of Option Digit 1, refer to the APTRA
Advance NDC, Supervisor’s Guide.
If you want to use different voices for multiple languages, you can
edit the AdvanceNDC.accfg file to configure the TTS software. For
details, see “Configuring Third-Party TTS Software” on page 6-6.
If you want to use voice-guided sessions without updating the host,
the NHCVGAudio.xml file must also be installed to C:\Program
Files\NCR APTRA\Advance NDC\Config using your preferred
method. This file defines the rules for parsing the Interactive
Transaction Response and the Transaction Reply messages and
includes the text for the data normally supplied by these messages.
Voice Guidance During a
Transaction
6
During the idle loop, voice guidance is initiated in one of two ways
depending on the SST audio capability, as described in “Standard
Audio Capabilities” on page 6-4 and “Enhanced Audio
Capabilities” on page 6-4.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-2
APTRA Advance NDC, Developer’s Guide
6
Configuring Voice Guidance
Introducing Voice Guidance
Note: If no AudioGuidanceData.xml file is present in the expected
location, the NoAudio.xml file defines a message to play when voice
guidance is unavailable. For more information, see “Voice Guidance
Unavailable” on page 6-9.
Figure 6-1 illustrates voice guidance during a transaction.
Figure 6-1
Voice Guidance During a Transaction
The cardholder is then prompted as defined in the XML file as
follows:
1
To adjust the volume: the volume is increased or decreased by
10% each time the relevant key is pressed
Note: The volume can be adjusted by 25% at any time if the 00
key is configured for the platform.
2
To set the session preferences: the following session preferences
can be defined:

Whether to hide the screen during the cardholder session.
This selection applies throughout the cardholder session. If
the cardholder chooses to hide the screen, a screen defined
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-3
Configuring Voice Guidance
Introducing Voice Guidance


3
in the XML file is displayed. The screen typically contains
text identifying the current session as a private audio session
with an option to cancel the session.
Whether to include advertisements during the cardholder
session. This selection is stored for use throughout the
cardholder session.
Whether to play the orientation script. If selected, the
orientation script will be played. The cardholder can choose
to replay or stop the playback during the orientation script.
To initiate the transaction.
Standard Audio Capabilities
6
A voice-guided session can be initiated by the selection of a defined
key or language on an SST that cannot detect the insertion of a
headset (Standard Audio capabilities). An audio message
identifying the required selection plays in a continuous loop until
the required selection is made to activate the session. If a key press
is used to trigger voice guidance, the cardholder may then be
prompted to select a language for the remainder of the transaction.
Enhanced Audio Capabilities
A voice-guided session can be initiated by the insertion of a headset
on an SST that can detect the insertion of a headset (Enhanced
Audio capabilities). If language options are available, the
cardholder is then prompted to select a language for the remainder
of the transaction.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-4
APTRA Advance NDC, Developer’s Guide
6
Configuring Voice Guidance
Configuring Voice Guidance
Configuring Voice Guidance
6
Voice guidance is configured using the registry and an XML file.
A registry entry can be used to prevent the consumer being
prompted for language selection more than once during a
voice-guided session, as described in “Prompting for a Language”
below.
The XML file is called AudioGuidanceData.xml and is downloaded
from Central using the XML Configuration Download message. For
details of this message, refer to the APTRA Advance NDC, Reference
Manual.
The XML file defines the following:



Configuration parameters
Keyboard layouts
Audio messages.
The XML configuration file must conform to and reference the XML
schema described in “XML Schema” on page 6-12. An example
configuration file is given in “Example XML Configuration File” on
page 6-39, but is not provided with Advance NDC. The file can be
created and edited in any text editor, and downloaded from Central.
Note: If the AudioGuidanceData.xml file is invalid, it is not deleted
whether downloaded or copied locally and a message defined in the
NoAudio.xml file is played to inform the cardholder that a
voice-guided session is unavailable.
Prompting for a Language
6
The following registry entry defines whether the consumer is
prompted for a language selection once or more than once during a
voice guidance session:
HKLM\SOFTWARE\NCR\Advance NDC\VoiceGuidance\
SingleLanguageSelection
The default value is 1, meaning that the consumer is prompted for a
language selection only once in the session. This has the following
implications when a language is selected during a voice-guided
initialisation sequence:

Language selection is skipped in the Eight FDK Selection
Function (‘Y’) and PIN and Language Select (‘m’) states. The
screen offset taken from the screenOffset element in the XML
file must match the offset specified in the state tables
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-5
Configuring Voice Guidance
Configuring Voice Guidance

The language selected by the consumer for the voice-guided
session takes precedence over the language selected in the
Language Select from Card (‘V’) state.
If the registry value is 0, the screen offset is reset when the
voice-guided initialisation sequence has completed.
Automatic Language
Selection
Enabling Voice Guidance
Without Host Updates
6
If only a single language is supported on the SST and useLang is set
to false (do not use a language selection to trigger a voice-guided
session), the language specified in LangOption is automatically
selected. For information on using these elements, see “XML
Schema” on page 6-12.
6
If you want to use voice guidance without updating the host, you
must configure the NHCVGAudio.xml file. This functionality can be
enabled or disabled through option 89 - NO HOST CHG VG on the
Configure menu in Supervisor or by setting the following registry
entry:
HKLM\SOFTWARE\NCR\Advance NDC\NoHostChangeVG\Enable NHC VG
Valid values are as follows:
0 to disable voice guidance without updating the host
1 to enable voice guidance without updating the host.
For details of the Supervisor option, refer to the APTRA Advance
NDC, Supervisor Guide.
You must also create a NHCVGAudio.xml file that conforms to the
structure defined in the schema described in “Voice-Guided
Sessions without Host Update” on page 6-44. You must ensure that
the voice guidance configuration file, AudioGuidanceData.xml, is
present otherwise voice guidance will not be recognised.
Configuring Third-Party
TTS Software
To configure your TTS software, take the following steps:
6
1
Install the TTS software
2
Ensure that the correct Text To Speech settings for your TTS
software are selected in the Speech Properties dialog box. This
dialog box is displayed using the Speech category in the
Windows Control Panel
3
If required, uncomment the DefaultVoices property in the
AdvanceNDC.accfg file (see Figure 6-2, “Configuring Multiple
Voices”) and complete the VoiceGuidanceVoices array with
the languages and voices you require (see Figure 6-3,
“VoiceGuidanceVoices Array”). By default on Windows XP,
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-6
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Configuring Voice Guidance
English is the only available language and Microsoft Sam is the
only available voice. By default on Windows 7, Microsoft Anna
is the only available voice. If this is all you require you do not
need to change the default configuration.
Figure 6-2
Configuring Multiple Voices
<Class ID=”NDCVoiceGuidance” Name=”NCR.APTRA.NDC.VoiceGuidance.NDCVoiceGuidance”
Assembly=”NCR.APTRA.NDC.VoiceGuidance.dll”
<Interface>
<!--Property Name=”DefaultVoices” Value=”VoiceGuidanceVoices” IsArray=”true” /-->
</Interface>
</Class>
Figure 6-3
VoiceGuidanceVoices Array
<Array ID=”VoiceGuidanceVoices”>
<Element Value=”en=Microsoft Sam”/>
<Element Value=”<languagecode>=<voiceName>”/>
</Array>
Note: If the VoiceGuidanceVoices array is not defined, a voice
matching the transaction language is automatically selected. If
no voice is available for the transaction language, no audio is
played.
Specifying the Character
Encoding
6
To support languages with accented or special characters,
AudioGuidanceData.xml specifies the character encoding to apply.
Any dynamic voice data is interpreted as using the same encoding
as that specified in the XML preamble.
The following XML preamble specifies the use of Unicode
Transformation Format–8-bit (utf-8) character encoding:
<?xml version="1.0" encoding="utf-8"?>
Audio elements required
in the XML Configuration
File
6
In a voice-guided session, the cardholder is directed at various
points by messages defined by Audio elements (seeTable 6-1,
“XML Schema Elements” on page 6-20) associated with screens in
the XML file, as follows:


If the SST has Standard Audio capability, run continuously
when the SST is In Service but not in a cardholder session. This
message provides instructions on starting a voice-guided
session
When a voice-guided session is initiated, allow the cardholder to
do the following:
— Select a language for the session
— Adjust the volume
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-7
Configuring Voice Guidance
Configuring Voice Guidance







Other XML Files used in
Voice Guidance
— Hide or display the screen
Once the session preferences are set, ask the cardholder to enter
a card
Allow the cardholder to select transaction options, such as
whether to withdraw cash or obtain a balance statement
Inform the cardholder of the outcome of the transaction, such as
to ask the cardholder to take their cash, or to tell them their
balance
Ask the cardholder to wait while the transaction processes
Ask the cardholder if they require more time. This must be
defined with an audioID sub-element of “0000”
Define whether keyboard selections are to be echoed to the
cardholder using the keyText sub-elements
Inform the cardholder that the SST is out of service.
The following XML files can also be used in voice guidance, as
follows:
6

A local file is supported for the Americas implementation and
can be used in the following situations:
— When Central does not support the download of an XML file
— When the SST uses a different configuration to that
downloaded from Central.
For details of the local file, see “Local XML Configuration File”.

When no valid AudioGuidanceData.xml file is present with audio
data, the NoAudio.xml file defines the message used to inform
the cardholder that a voice-guided session is unavailable. For
details of this XML file, see “Voice Guidance Unavailable”.
Local XML Configuration File
6
The local XML configuration file must conform to and reference the
XML schema described in “XML Schema” on page 6-12. An
example configuration file is given in “Example XML Configuration
File” on page 6-39. The file can be created and edited in any text
editor. No local XML configuration file is provided with Advance
NDC.
The configuration file must be named AudioGuidanceDataLocal.xml,
and installed to C:\Program Files\NCR APTRA\Advance
NDC\Config using your preferred method.
The SST must be rebooted after a local configuration file is installed.
If this file is present, it is used instead of the AudioGuidanceData.xml
file when a voice-guided session is requested.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-8
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Configuring Voice Guidance
Invalid Local XML File If AudioGuidanceDataLocal.xml is invalid,
no files are deleted and a message is played to indicate that voice
guidance is unavailable.
Voice Guidance Unavailable
6
6
The NoAudio.xml file is provided with Advance NDC and installed
to the following location on the SST:
C:\Program Files\NCR APTRA\Advance NDC\Config
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-9
Configuring Voice Guidance
Advance NDC Voice Guidance and Other Applications
Advance NDC Voice Guidance and
Other Applications
If using APTRA Promote and/or Display Manager on the SST with
Advance NDC, there may be restrictions or other considerations for
voice-guided sessions. These are outlined in the following sections.
If using EMV Exits, refer to the EMV Integrated Circuit Card (ICC)
Reference Manual.
Using Advance NDC
Voice Guidance with
Promote
When a voice-guided session is enabled on an SST with APTRA
Promote, the following restrictions apply:

6




The Promote campaign must not have audio messages
associated with any flow-point. Any audio messages in the
Promote campaign will be played at the same time as the
Advance NDC voice guidance audio messages. In a cardholder
session that is not an Advance NDC voice-guided session, the
audio messages in the Promote campaign may be played
through the audio jack and not the speaker, and therefore not be
audible
If the Promote campaign includes a screen displayed for a
defined period in the “Approving Transaction” flow point, the
previous audio message continues to play until the transaction
request is sent, “please wait” is then played while awaiting the
transaction reply
If the Promote campaign has an “Attract” flow point, but no
“Card Inserted” flow point, the screen for the “Attract” flow
point is displayed briefly after the card is inserted before the
next Advance NDC screen is displayed
If the cardholder has chosen to hide screens in a voice-guided
session, the Promote screens are unaffected and are displayed as
usual.
The following flow points must not be used:
— Card Inserted - The “Please insert your card” message
continues playing after the card is inserted and while the
APTRA Promote screen is displayed
— PIN Acquired - The “Please enter your PIN message
continues playing after the PIN is entered and while the
APTRA Promote screen is displayed
— Deposit (print receipt) - The “Please insert your envelope”
message continues playing after the envelope is inserted and
while the APTRA Promote screen is displayed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-10
APTRA Advance NDC, Developer’s Guide
6
Configuring Voice Guidance
Advance NDC Voice Guidance and Other Applications
— Deposit (complete) - The “Please insert your envelope”
message continues playing until after the envelope is
inserted and while the APTRA Promote screen is displayed
— Dispense (print receipt) - The “Please take your cash”
message continues to play until after the cash is taken and
while the APTRA Promote screen is displayed
— Dispense (complete) - The “Please take your cash” message
continues to play until after the cash is taken and while the
APTRA Promote screen is displayed.
The audio message associated with the previous screen can be
set to play continuously to avoid silence during the display of
the Promote screen.
Using Advance NDC
Voice Guidance with
Display Manager
6
Advance NDC calls the Display Manager and continues displaying
HTML screens and playing the associated audio messages based on
the value returned. For information, refer to the APTRA Advance
NDC User Guide for Display Manager.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-11
Configuring Voice Guidance
XML Schema
XML Schema
A schema, called ABMAudioGuidanceSchema.xsd, is provided with
Advance NDC and installed to C:\Program Files\NCR
APTRA\Advance NDC\Config. This schema must be referenced, as
shown in “Example XML Configuration File” on page 6-39.
Figure 6-4 provides a sample ABMAudioGuidanceSchema.xsd
schema.
Figure 6-4
Sample Voice Guidance XML Schema
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="urn:xsdNCRAudioGuidance"
xmlns:vt="urn:xsdNCRAudioGuidance">
<xsd:element name="NCRAudioGuidance">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Config" type="vt:ConfigTemplate"/>
<xsd:element name="Keyboard" type="vt:KeyboardTemplate"
minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Audio" type="vt:AudioTemplate"
minOccurs="1" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<!-********* This is used by the host validation
********* groupID is not used on the SST
<xsd:unique name="UniqueConfigID">
<xsd:selector xpath="Config"/>
<xsd:field xpath="@groupID"/>
</xsd:unique>
<xsd:unique name="UniqueKeyboardID">
<xsd:selector xpath="Keyboard"/>
<xsd:field xpath"@keyboardID"/>
<xsd:field xpath="@groupID/>
</xsd:unique>
<xsd:unique name="UniqueAudioID">
<xsd:selector xpath="Audio"/>
<xsd:field xpath="@audioID"/>
<xsd:field xpath="@groupID"/>
</xsd:unique>
<xsd:keyref name="AudioMustExist"
refer="vt:UniqueAudioID">
<xsd:selector xpath=".//Link"/>
<xsd:field xpath="@audioID"/>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-12
APTRA Advance NDC, Developer’s Guide
6
Configuring Voice Guidance
XML Schema
<xsd:field xpath="@groupID"/>
</xsd:keyref>
-->
<xsd:unique name="UniqueKeyboardID">
<xsd:selector xpath="Keyboard"/>
<xsd:field xpath="@keyboardID"/>
</xsd:unique>
<xsd:unique name="UniqueAudioID">
<xsd:selector xpath="Audio"/>
<xsd:field xpath="@audioID"/>
</xsd:unique>
<xsd:keyref name="AudioMustExist"
refer="vt:UniqueAudioID">
<xsd:selector xpath=".//Link"/>
<xsd:field xpath="@audioID"/>
</xsd:keyref>
</xsd:element>
<xsd:annotation><xsd:documentation xml:lang="en">
=================================================
Audio Template declaration
=================================================
</xsd:documentation></xsd:annotation>
<xsd:complexType name="AudioTemplate">
<xsd:choice minOccurs="1" maxOccurs="unbounded">
<xsd:element name="Text" type="vt:TextCommand"/>
<xsd:element name="Recording" type="xsd:RecordingType"/>
<xsd:element name="Stream" type="vt:StreamCommand"/>
<xsd:element name="Loop" type="vt:LoopCommand"/>
</xsd:choice>
<xsd:attribute name="audioID" type="xsd:string"
use="required"/>
<xsd:attribute name="groupID" type="xsd:string"
use="optional"/>
<xsd:attribute name="keyboardID" type="xsd:string"
use="optional"/>
<xsd:attribute name="ad" type="xsd:boolean"
default="false"/>
<xsd:attribute name="repetitions" type="vt:LoopCount"
default="1"/>
<xsd:attribute name="ParamSourceID" type="xsd:string"
use="optional"/>
<xsd:attribute name="keyText" type="xsd:string"
use="optional"/>
</xsd:complexType>
<xsd:annotation><xsd:documentation xml:lang="en">
===================================================
Loop Command declaration
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-13
Configuring Voice Guidance
XML Schema
a LoopCount of 0 means infinite loop
===================================================
</xsd:documentation></xsd:annotation>
<xsd:complexType name="LoopCommand">
<xsd:choice minOccurs="1" maxOccurs="unbounded">
<xsd:element name="Text" type="vt:StreamCommand"/>
<xsd:element name="Stream" type="vt:TextCommand"/>
</xsd:choice>
<xsd:attribute name="count" type="vt:LoopCount"
use="required"/>
</xsd:complexType>
<xsd:annotation><xsd:documentation xml:lang="en">
====================================================
Play Text Command declaration
====================================================
</xsd:documentation></xsd:annotation>
<xsd:complexType name="TextCommand" mixed="true">
<xsd:group ref="vt:TextElements" minOccurs="0"
maxOccurs="unbounded"/>
<xsd: attribute name="lang" type="xsd:language"
default="en"/>
<xsd:attribute name="state" type="vt:AudioState"
default="private"/>
</xsd:complexType>
<xsd:group name="TextElements">
<xsd:choice>
<xsd:element name="Link" type="vt:LinkCommand"/>
<xsd:element name="Pause" type="vt:PauseCommand"/>
<xsd:element name="PlaceHolder" type="xsd:string"/>
<xsd:element name="Spell" type="xsd:string"/>
<xsd:element name="Pron" type="xsd:string"/>
</xsd:choice>
</xsd:group>
<xsd:annotation><xsd:documentation xml:lang="en">
===================================================
Play Stream Command declaration
===================================================
</xsd:documentation></xsd:annotation>
<xsd:complexType name="StreamCommand">
<xsd:group ref="vt:StreamElements" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:attribute name="state" type="vt:AudioState"
use="required"/>
<xsd:attribute name="lang" type="xsd:language"
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-14
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
default="en"/>
</xsd:complexType>
<xsd:group name="StreamElements">
<xsd:choice>
<xsd:element name="Link" type="vt:LinkCommand"/>
<xsd:element name="Pause" type="vt:PauseCommand"/>
<xsd:element name="StreamURI" type="xsd:anyURI"/>
<xsd:element name="PlaceHolder" type="xsd:string"/>
</xsd:choice>
</xsd:group>
<xsd:annotation><xsd:documentation xml:lang="en">
===================================================
Pause Command declaration
PauseDuration unit is one tenth of a second
===================================================
</xsd:documentation></xsd:annotation>
<xsd:complexType name="PauseCommand">
<xsd:attribute name="duration" type="vt:PauseDuration"
use="required"/>
</xsd:complexType>
<xsd:annotation><xsd:documentation xml:lang="en">
===================================================
Configuration Related declaration
===================================================
</xsd:documentation></xsd:annotation>
<xsd:complexType name="ConfigTemplate">
<xsd:sequence>
<xsd:element name="afaTrigger" type="vt:AFATriggerDef"
minOccurs="1" maxOccurs="1"/>
<xsd:element name="afaLang" type="vt:AFALangDef"
minOccurs="1" maxOccurs="1"/>
<xsd:element name="audioVolume" type="vt:audioVolumeDef"
minOccurs="0" maxOccurs="1"/>
<xsd:element name="afaOption" type="vt:AFAOptionDef"
minOccurs="1" maxOccurs="4"/>
</xsd:sequence>
<xsd:attribute name="groupID" type="xsd:string"
use="optional"/>
<xsd:attribute name="restartKeyPos" type="vt:keyPosRange"
use="required"/>
<xsd:attribute name="repeatDelay" type="xsd:integer"
default="30"/>
<xsd:attribute name="configRetryCount" type="xsd:integer"
default="1"/>
<xsd:attribute name="timersAdjust" type="xsd:integer"
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-15
Configuring Voice Guidance
XML Schema
use="optional"/>
<xsd:attribute name="blankScreenID" type="xsd:integer"
use="required"/>
<xsd:attribute name="cardPromptScreen" type="xsd:integer"
use="required"/>
<xsd:attribute name="defaultVolume" type="xsd:integer"
default="50"/>
</xsd:complexType>
<xsd:complexType name="AFAOptionDef">
<xsd:attribute name="name" type="vt:AFAOptionNames"
use="required"/>
<xsd:attribute name="screen" type="xsd:integer"
use="required"/>
<xsd:attribute name="yesKeyPos" type="vt:keyPosRange"
use="required"/>
<xsd:attribute name="yesAudioID" type="xsd:string"
use="required"/>
<xsd:attribute name="noKeyPos" type="vt:keyPosRange"
use="required"/>
xsd:attribute name="noAudioID" type="xsd:string"
use="required"/>
xsd:attribute name="defaultResponse" type="xsd:boolean"
default="false"/>
</xsd:complexType>
<xsd:simpleType name="AFAOptionNames">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="blankScreen"/>
<xsd:enumeration value="ads"/>
<xsd:enumeration value="OrientationSkip"/>
<xsd:enumeration value="OrientationScript"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="audioVolumeDef">
<xsd:attribute name="screen" type="xsd:integer"
use="required"/>
<xsd:attribute name="plusKeyPos" type="vt:keyPosRange"
use="required"/>
<xsd:attribute name="minusKeyPos" type="vt:keyPosRange"
use="required"/>
<xsd:attribute name="doneKeyPos" type="vt:keyPosRange"
use="required"/>
</xsd:complexType>
<xsd:complexType name="AFATriggerDef">
<xsd:attribute name="useLang" type="xsd:boolean"
default="false"/>
<xsd:attribute name="triggerKeyPos" type="vt:keyPosRange"
use="required"/>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-16
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
<xsd:attribute name="triggerKeyPos2" type="vt:keyPosRange"
use="optional"/>
<xsd:attribute name="confirmationKeyPos"
type="vt:keyPosRange" use="optional"/>
<xsd:attribute name="confirmationAudioID"
type="xsd:string" use="optional"/>
<xsd:attribute name="timeoutAudioID" type="xsd:string"
use="optional"/>
</xsd:complexType>
<xsd:complexType name="AFALangDef">
<xsd:sequence>
<xsd:element name="LangOption" type="vt:AFALangOptions"
minOccurs="1" maxOccurs="8"/>
</xsd:sequence>
<xsd:attribute name="screen" type="xsd:integer"
use="required"/>
<xsd:attribute name="opCodePos" type="vt:opCodePosRange"
use="optional"/>
</xsd:complexType>
<xsd:complexType name="AFALangOptions">
<xsd:attribute name="lang" type="xsd:language"
use="required"/>
<xsd:attribute name=keyPos" type="vt:keyPosRange"
use="required"/>
<xsd:attribute name="opCode" type="vt:opCodeRange"
use="optional"/>
<xsd:attribute name="opCodeNoALT" type="vt:opCodeRange"
use="optional"/>
<xsd:attribute name="screenOffset" type="xsd:integer"
default="0"/>
<xsd:attribute name="treqFieldID" type="xsd:string"
use="optional"/>
<xsd:attribute name="treqFieldLangData" type="xsd:string"
use="optional"/
</xsd:complexType>
<xsd:simpleType name="opCodeRange">
<xsd:restriction base="xsd:string">
<xsd:pattern value="[1-9A-Za-z]"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="opCodePosRange">
<xsd:restriction base="xsd:integer">
<xsd:minInclusive value="0"/>
<xsd:maxInclusive value="7"/>
</xsd:restriction>
</xsd:simpleType>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-17
Configuring Voice Guidance
XML Schema
<xsd:annotation><xsd:documentation xml:lang="en">
===================================================
Keyboard Related declaration
===================================================
</xsd:documentation></xsd:annotation>
<xsd:complexType name="KeyboardTemplate">
<xsd:sequence>
<xsd:element name="Key" type="vt:KeyDef" minOccurs="1"
maxOccurs="24"/>
</xsd:sequence>
<xsd:attribute name="keyboardID" type="vt:KeyboardNumber"
use="optional"/>
<xsd:attribute name:"groupID" type="xsd:string"
use="optional"/>
</xsd:complexType>
<xsd:complexType name="KeyDef">
<xsd:attribute name="pos" type="vt:keyPosRange"
use="required"/>
<xsd:attribute name="code" type="vt:keyCodeRange"
use="required"/>
</xsd:complexType>
<xsd:simpleType name="KeyboardNumber">
<xsd:restriction base="xsd:integer">
<xsd:minInclusive value="000"/>
<xsd:maxInclusive value="999"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="keyPosRange">
<xsd:restriction base="xsd:integer">
<xsd:minInclusive value="1"/>
<xsd:maxInclusive value="24"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="keyCodeRange">
<xsd:restriction base="xsd:string">
<xsd:pattern value="(3\d)|([fF][1-9aAfF])"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:annotation><xsd:documentation xml:lang="en">
===================================================
Misc Declaration
===================================================
</xsd:documentation></xsd:annotation>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-18
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
<xsd:simpleType name="LoopCount">
<xsd:restriction base="xsd:integer">
<xsd:minInclusive value="0"/>
<xsd:maxInclusive value="9"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="PauseDuration">
<xsd:restriction base="xsd:integer">
<xsd:minInclusive value="1"/>
<xsd:maxInclusive value="999"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="AudioState">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="private"/>
<xsd:enumeration value="public"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="LinkCommand">
<xsd:attribute name="audioID" type="xsd:string"
use="required"/>
<xsd:attribute name="groupID" type="xsd:string"
use="required"/>
</xsd:complexType>
<xsd:complexType name="RecordingType
<xsd:attribute name="lang" type="xsd:language"/>
<xsd:attribute name="file" type="xsd:string"
use="required"/>
<xsd:attribute name="state" type="vt:AudioState"
default="private"/>
</xsd:complexType>
">
</xsd:schema>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-19
Configuring Voice Guidance
XML Schema
The schema elements are described in the following table.
Schema Elements
6
Table 6-1
XML Schema Elements
Element Name
Description
Config
Mandatory.
Appears once only.
Defines the parameters required to initialise a voice-guided session.
Nested elements:
groupID

restartKeyPos

repeatDelay

configRetryCount

timersAdjust

blankScreenID

cardPromptScreen

defaultVolume

groupID
Optional.
Ignored by the SST.
Can be used by the host to categorise the Config sub-elements for different
downloads.
restartKeyPos
Mandatory.
Defines the key used to initiate a voice-guided session.
This sub-element must be present in the configuration file or the XML validation will
fail. However, it is ignored by voice guidance in Advance NDC.
repeatDelay
Optional.
Defines the pause in tenths of a second between repeated messages. By default, this is
set to 30, giving a pause of 3 seconds.
configRetryCount
Optional.
Defines the number of times a cardholder is prompted to select voice guidance options
before the voice-guided session is cancelled.
If this sub-element is not present, or is set to zero, the voice-guided session is cancelled
after the first prompt if the cardholder does not respond within the time allowed by
the adjusted timer. See timersAdjust for more information on the adjusted timers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-20
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
Element Name
Description
timersAdjust
Optional.
Defines the time added to field ‘i’ of the Interactive Transaction Response message and
the following Advance NDC timers:

Timer 00

Timer 01

Timer 04

Timer 05

Timer 07

Timer 08

Timer 09

Timer 61

Timer 77

Timer 78

Timer 87

Timer 94

Timer 95

Timer 96

Screen Timer defined in field ‘i’ of the Interactive Transaction Response message.
The integers values represent a count of 800 millisecond ticks. No adjusted timer can
exceed 255 ticks. If the adjustment results in a timer exceeding this limit, only 255 ticks
are used.
For details of the Interactive Transaction Response message and Advance NDC timers,
refer to the APTRA Advance NDC, Reference Manual.
blankScreenID
Mandatory.
Defines the screen displayed during a voice-guided session if the cardholder selects
the option to hide the screen for privacy.
If multiple languages are supported, a screen should be defined for each supported
language. Language screens must be numbered as defined in the ScreenOffset
sub-element.
Ensure that no audio elements are defined for screens used in this situation.
cardPromptScreen
Mandatory.
Defines the screen displayed when the cardholder is prompted to insert their card.
If multiple languages are supported, a screen should be defined for each supported
language. Language screens must be numbered as defined in the ScreenOffset
sub-element.
Ensure that no audio elements are defined for screens used in a voice-guided session
with hidden screens used for privacy.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-21
Configuring Voice Guidance
XML Schema
Element Name
Description
defaultVolume
Optional.
Defines the default volume set at the start of each voice-guided session.
If this sub-element is not present, the default volume is set to 50. Valid values are
between 0, for the lowest volume setting, and 100, for the highest volume setting.
afaTrigger
Mandatory.
Defines how a voice-guided session is triggered.
On SSTs with Standard Audio capabilities, this element is used when is In Service and
not in a cardholder session.
On SSTs with Enhanced Audio capabilities, this element is used when a headset
remains inserted after a cardholder session has concluded.
Nested elements:

useLang

triggerKeyPos

triggerKeyPos2

confirmationKeyPos

confirmationAudioID

timeoutAudioID
useLang
Optional.
Defines whether language selection is used to trigger a voice-guided session.
Valid values are as follows:
true – Use language selection to trigger a voice-guided session
false – Do not use language selection to trigger a voice-guided session
If this sub-element is not present, language is not used to trigger a voice-guided
session.
If this sub-element is set to false or not present, the number of languages configured in
the XML is checked. If only a single language is present, the consumer is not asked to
select a language.
If set to true, the keys defined by the keyPos sub-element are activated while the SST
is In Service and not in a cardholder session. Pressing an active key triggers a
voice-guided session and selects the associated language. The triggerKeyPos and
triggerKeyPos2 sub-elements are ignored.
If not present or set to false, the keys defined by the triggerKeyPos and
triggerKeyPos2 sub-elements are used to trigger a voice-guided session.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-22
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
Element Name
Description
triggerKeyPos
Mandatory.
Defines the key that triggers a voice-guided session by its position. For details of the
key positions, see Table Note 1. If the triggerKeyPos2 sub-element is defined, both
defined keys must be pressed to trigger a voice-guided session.
This sub-element must be present in the configuration file or the XML validation will
fail. However, it is ignored if the useLang sub-element is set to true.
triggerKeyPos2
Optional.
Defines the key that triggers a voice-guided session by its position. For details of the
key positions, see Table Note 1.
If this sub-element is present, the cardholder must press two keys to trigger the
voice-guided session. If the key defined by this sub-element is not pressed within two
seconds of the key defined by the triggerKeyPos sub-element, the voice-guided
session is cancelled.
This sub-element is ignored if the useLang sub-element is set to true.
confirmationKeyPos
Optional.
Defines the key used to confirm that a voice-guided session is required. For details of
the key positions, see Table Note 1.
If set, the cardholder must press the key to confirm the voice-guided session before
Timer 00 expires. If the cardholder does not press the defined key in this time, the
voice-guided session is cancelled.
This sub-element is ignored if the confirmationAudioID sub-element is not set.
confirmationAudioID
Optional.
Defines the audio to be played to request that the cardholder confirms that they
require a voice-guided session.
This sub-element is ignored if the confirmationKeyPos sub-element is not set.
timeoutAudioID
Optional.
Defines the audio to be played to inform the cardholder that a selection has not been
made within the allowed time.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-23
Configuring Voice Guidance
XML Schema
Element Name
Description
afaLang
Mandatory.
Defines the language and keys used in selecting a supported language.
Nested elements:

screen

opCodePos

LangOption
screen
Mandatory.
Defines the screen displayed when the cardholder is prompted to select the language
for a voice-guided session.
An Audio element must be associated with the screen defined by this sub-element.
This sub-element is ignored if the useLang sub-element is set to true.
opCodePos
Optional.
Defines the language code position in field ‘j’ of the Transaction Request message.
See Table Note 2.
If this sub-element is present, the opCode sub-element is placed in the defined
position of field ‘j’ of the Transaction Request message for a voice-guided session.
For details of the Transaction Request message, refer to the APTRA Advance NDC,
Reference Manual.
If using voice guidance with no host update, this sub-element must not be present as
the field ‘j’in the Transaction Request message is not used.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-24
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
Element Name
Description
LangOption
Mandatory.
Defines the following:

Language

Key position for selecting the language

Optionally, the value defining the language in the Transaction Request message

The screen offset for the voice guidance configuration screens.
At least one LangOption sub-element must be defined in an afaLang element. A
maximum of eight LangOption sub-elements can be defined in an afaLang
element.
Nested elements:
lang

keyPos

opCode

opCodeNoALT

ScreenOffset

treqFieldID

treqFieldLangData

lang
Mandatory.
Defines the language used for the voice-guided session.
Uses the ISO 639-1 specification, which uses a two-character code to represent each
language. See Table Note 2.
If TTS software is used and it does not support the defined language, this sub-element
is ignored.
If the Text element contains messages in multiple languages, only the message in the
defined language is played. If the defined language does not match any languages
defined in the Text element, the message is played in all languages that are defined.
Before a voice-guided session is triggered, the instructions are played in all defined
languages.
keyPos
Mandatory.
Defines the key used to select a language. For details of the key positions, see Table
Note 1.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-25
Configuring Voice Guidance
XML Schema
Element Name
Description
opCode
Optional.
Defines the language using an alphanumeric character. The character is placed in the
position defined by the opCodePos sub-element and used in the Transaction Request
message.
If using voice guidance with no host update, this sub-element must not be present as
the field in the Transaction Request message is not used.
opCodeNoALT
Optional.
Defines the language using an alphanumeric character. The character is placed in the
position defined by the opCodePos sub-element and used in the Transaction Request
message.
Advance NDC does not support this sub-element and it is ignored if present.
If using voice guidance with no host update, this sub-element must not be present as
the field in the Transaction Request message is not used.
ScreenOffset
Mandatory.
Defines which screen to display after a language is selected. The specified offset is
added to the screen number of the following screens:

blankScreenID

cardPromptScreen

audioVolume

blankScreen

Ads

OrientationSkip

OrientationScript.
For example, if English is assigned an offset of 0 and Spanish an offset of 5, and the
cardholder selects Spanish, then 5 is added to the screen numbers and those screens
are displayed. Alternatively, you can use the same screen regardless of the selected
language by defining an offset of 0 for both English and Spanish. In this case, the
audioID sub-element associated with each screen must contain both languages.
See Table Note 4 and Table Note 5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-26
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
Element Name
Description
treqFieldID
Optional.
Defines an additional field to include in the Transaction Request message to identify
the session as a voice-guided session. The field identifier should be defined as ‘<’. As
this is a character with meaning within an XML file, it must be coded appropriately as
follows:
treqFieldID="&#60;"
This sub-element can be used in addition to, or instead of the opCodePos and
opCode sub-elements.
For details of the Transaction Request message, refer to the APTRA Advance NDC,
Reference Manual.
If using voice-guided sessions with no host update, this sub-element must not be
present as the field in the Transaction Request message is not used.
treqFieldLangData
Optional.
Defines the language to be included in the voice guidance buffer.
If this sub-element is defined, the treqFieldID sub-element must also be defined. The
language data is added to the transaction request message following the additional
field defined in the treqFieldID sub-element.
For details of the Transaction Request message, refer to the APTRA Advance NDC,
Reference Manual.
audioVolume
Optional.
Defines the keys used to adjust the audio volume and the screen displayed for the
volume adjustment option.
Nested elements:

screen

plusKeyPos

minusKeyPos

doneKeyPos
screen
Mandatory.
Defines the screen to display during volume adjustment. If multiple languages are
supported, you can define a screen for each language. Screens should be numbered as
defined in the ScreenOffset sub-element. Each screen must have an Audio
element defined.
plusKeyPos
Mandatory.
Defines the key used to increase the volume. For details of the key positions, see Table
Note 1.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-27
Configuring Voice Guidance
XML Schema
Element Name
Description
minusKeyPos
Mandatory.
Defines the key used to decrease the volume. For details of the key positions, see Table
Note 1.
doneKeyPos
Mandatory.
Defines the key used to finish adjusting the volume. For details of the key positions,
see Table Note 1.
afaOption
Mandatory.
Defines at least one and up to four cardholder options. Each option requires a choice of
two options (usually yes and no). If an option is not defined, the default is used.
Nested elements:

name

screen

yesKeyPos

yesAudioID

noKeyPos

noAudioID

defaultResponse
name
Mandatory.
Defines the cardholder option being defined in the afaOption element for a screen
with an Audio element as follows:

blankScreen - Asks whether the cardholder wants the screen to be hidden
during the voice-guided session. Default is to hide the screen.

Ads - Asks whether the cardholder wants to hear advertisements during the
voice-guided session. Default is to play advertisements.

OrientationSkip - Asks whether the cardholder wants to skip the orientation
information. This option must precede the OrientationScript option. If the
OrientationScript option is not defined, this option is ignored. Default is to play
the orientation information.

OrientationScript - Plays the orientation information. The cardholder can use
defined keys to play the information again or to skip the rest of the message. If the
cardholder inserts their card during the orientation information, the information
stops playing. If this element is not present, no orientation information is played.
screen
Mandatory.
Defines the screen to display. If multiple languages are supported, you can define a
screen for each language. Screens should be numbered as defined in the
ScreenOffset sub-element. Each screen must have an Audio element defined.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-28
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
Element Name
Description
yesKeyPos
Mandatory.
Defines the key used to accept the option. For details of the key positions, see Table
Note 1.
yesAudioID
Mandatory.
Defines the Audio element played to confirm acceptance of the option.
noKeyPos
Mandatory.
Defines the key used to refuse the option. For details of the key positions, see Table
Note 1.
noAudioID
Mandatory.
Defines the Audio element played to confirm refusal of the option.
defaultResponse
Optional.
Defines the default selection for occasions where the options are skipped, for example
by the cardholder inserting their card.
Valid values are as follows:
true - accept the option
false - refuse the option
If this sub-element is not present, the options are refused by default.
Keyboard
Mandatory.
Defines the layout of the numeric keyboard on the SST.
Nested elements:

keyboardID

groupID

Key
keyboardID
Mandatory.
Defines the Keyboard element. This can be used as a reference by any Audio
element.
Valid values are any unique integer between 100 and 999, inclusive.
groupID
Optional.
Ignored by the SST.
Can be used by the host to categorise the Keyboard sub-elements for different
downloads.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-29
Configuring Voice Guidance
XML Schema
Element Name
Description
Key
Mandatory.
Defines the keypad position and the code generated by that position.
At least one and up to 16 Key sub-elements can be defined.
Only the numeric keys not in use by the state being executed can be defined. If any
keys already defined in the state table are defined in the XML file, the XML definition
is ignored
Nested elements:

pos

code
pos
Mandatory.
Defines the key being defined in this Key sub-element. For details of the key
positions, see Table Note 1.
code
Mandatory.
Defines the code generated when the defined key is pressed. If the keyboard is not
referenced by an Audio element, the default keyboard layout us used. For details of
the default keyboard layout, refer to the APTRA Advance NDC, Reference Manual.
See Table Note 6
Audio
Mandatory.
Defines a complete audio message.
Audio messages using Text elements are voiced by TTS software, and Recording
sub-elements by recorded voice, for example .wav files. If both Text and Recording
sub-elements are present, only the Recording sub-element is used; the Text
element is ignored.
Nested elements:
audioID

groupID

keyboardID

ad

repetitions

ParamSourceID

keyText

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-30
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
Element Name
Description
audioID
Mandatory.
Defines the Audio element. Can be any alphanumeric data unless it is associated
with a screen when it must match the screen number.
This sub-element is case-sensitive. If the identifier contains alphabetic characters, the
same case must be used in any reference to the identifier or the reference will be
unsuccessful.
groupID
Optional.
Ignored by the SST.
Can be used by the host to categorise the Audio sub-elements for different
downloads.
keyboardID
Optional.
References a Keyboard element. The value must match an existing keyboardID
sub-element of the Keyboard element.
This sub-element can be included in either base or nested screens, but not both.
ad
Optional.
Defines whether the Audio element is an advertisement. This is used to suppress
advertisements if the cardholder has chosen not to listen to advertisements during the
voice-guided session.
Valid values are as follows:
true - This element is an advertisement
false - This element is not an advertisement.
If this sub-element is not present, it is assumed that the element is not an
advertisement.
repetitions
Optional.
Defines the number of times this element is repeated. Valid values are between 0 and
9, inclusive. A value of 0 repeats the message indefinitely, or as long as the associated
screen is displayed.
If not present, the message is played only once.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-31
Configuring Voice Guidance
XML Schema
Element Name
Description
ParamSourceID
Optional.
Defines the screen number that contains the variable placeholder audio (the base
screen).
This sub-element is used when you use a screen as a placeholder screen for variable
audio data sent in the screen update field of the Transaction Reply message. In this
situation, the host typically only updates the variable screen data. The
ParamSourceID element allows the production of voiced data to match the displayed
screen. This can be used in the following ways:

The base screen includes a nested screen call to the transaction-specific screen
containing the fixed screen display text. The audioID associated with the nested
screen contains this ParamSourceID element

A transaction-specific screen nests the updated base screen. The
transaction-specific screen contains the ParamSourceID element
An audioID associated with the base screen must be defined, although the audio
text defined for this audioID will not be voiced. If you want to voice the selected key,
the keyText element must be defined in this audioID
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-32
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
Element Name
Description
keyText
Optional.
Plays the message defined by the Audio elements with an audioID equal to the
four-digit screen number followed by a dash (-) and the value of the selected key (for
example C for Cancel). For example, the message can echo the key selection, “Three”,
or the meaning of the key selection, “Withdrawal”. A maximum of 15 seconds is
allowed for the message.
This sub-element is only valid for use with the following states and when the FDKs are
mapped to the numeric keys of the keypad:

Four FDK Selection Function State

FDK Information Entry State

Eight FDK Selection Function State
For details of these states, refer to the APTRA Advance NDC, Reference Manual.
This sub-element must be included in the Audio element associated with the base
screen. It must not be used with nested screens.
Only the keys used by the screen must be defined. For example, if the screen activates
numeric keys 1, 2, and the Cancel key, only the audioID for <screen number>-1,
<screen number>-2 and <screen-number>-C need to be defined for the screen.
Valid values are as follows:
true - Play the message
false - SST beeps to provide audio feedback for a key press.
If this sub-element is not present, the SST beeps to provide audio feedback for a key
press.
Voicing the Clear Key Press
When the Clear key is pressed, the text defined in the Audio element is voiced. For
this, set the keyText attribute in the XML file to "true", and set the audioID
attribute to the four-digit NDC screen number (1234) followed by a dash (-) and then
“CLR” for the Clear key.
For example, if the keyText attribute is set to "true" for audioID “1234” and
“1234-CLR” is configured in XML file, the text associated with “1234-CLR” will be
voiced when the Clear key is pressed.
This feature is valid in the following states:

PIN Entry

Information Entry

Amount entry

Enhanced amount entry

Note mix selection

ITR
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-33
Configuring Voice Guidance
XML Schema
Element Name
Description
Text
Optional.
Defines the message to be spoken in a specified language by the TTS software and the
playing of recorded voice using .wav files. The message can be repeated. Pauses,
nested audio elements and recorded voice files can be included. The sequence is
controlled by Advance NDC.
Nested elements:

lang

state
Embedded elements:
Pause

Link

PlaceHolder

Recording

lang
Optional.
Defines the language used by the TTS software.
If the TTS software does not support the defined language, the whole Text element
and all sub-elements are ignored.
If this sub-element is not present, the language is assumed to be English.
See Table Note 2
state
Optional.
Defines the target device for the message.
Valid values are as follows:
public - Play the message through the speaker
private - Play the message through the audio jack.
This sub-element is not supported by Advance NDC. The message is always played
through the audio jack.
Pause
Optional.
Defines the duration of the pause in the playback.
The duration is defined in tenths of a second. Valid values are between 1 and 999,
inclusive. A duration of 10 causes a one second pause in the playback.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-34
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
Element Name
Description
Link
Optional.
Specifies a nested audioID sub-element to be included in the message.
This sub-element include identifiers for both the audioID and groupID containing
the linked information. If the specified audioID does not exist, this sub-element is
ignored. The specified audioID sub-element must include only the Text
sub-element.
This sub-element is not needed if displaying a screen that includes nested screens with
their own audioID sub-elements.
PlaceHolder
Optional.
Specifies data to be substituted within the text.
The type of placeholder is implied by the content, as in the following examples:

“$123” is currency and is played as “One hundred and twenty three Dollars”

“1 2 3 4 5” are separate digits and are played as “One, Two, Three, Four, Five”

“12345” is an amount and is played as “Twelve thousand, three hundred, forty
five”

“savings” is a string and is played as “Savings”
The data cannot contain commas.
Nested Audio IDs have only one placeholder.
Recording
Optional.
Specifies recorded voice in .wav files to be played with the text in a message.
This is usually used when the TTS software does not have support for a particular
language or for voicing dynamic text.
Nested elements:

lang

File

state
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-35
Configuring Voice Guidance
XML Schema
Element Name
Description
lang
Optional.
Defines the language associated with the recording.
If this is specified, the Recording element is played only if the specified language
matches the language used in the current voice guided session.
If this is not specified, the Recording element is played as part of the audio element.
See Table Note 2.
File
Mandatory.
Defines the name of the file containing the recorded voice.
If the file is copied to the C:\Program Files\NCR APTRA\Advance NDC\Media folder,
the path is not required, otherwise the full path and filename must be specified.
state
Optional.
Defines the target device for the message.
Valid values are as follows:
public - Play the message through the speaker
private - Play the message through the audio jack.
This sub-element is not supported by Advance NDC. The message is always played
through the audio jack.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-36
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
XML Schema
Table Note 1: An integer value defines the position of a key as
illustrated in the following diagram. Shaded positions cannot be
defined in the XML configuration:
Figure 6-5
Key Positions
FDK Left
Numeric Keypad
FDK Right
17
1
2
3
4
18
19
5
6
7
8
20
21
9
10
11
12
22
23
13
14
15
16
24
Table Note 2: The Spanish language has been coded as in some
legacy configurations. To support these configurations, this value is
automatically converted to the correct two-character ISO code (es).
Table Note 3: The language code positions are defined as follows:
0
1
2
3
4
5
6
7
Table Note 4: If the PIN & Language Select State is used with voice
guidance, the screen offset defined in the XML file must match the
screen offset of the downloaded screens. For details of the PIN &
Language Select State, refer to the APTRA Advance NDC, Reference
Manual.
Table Note 5: The screen offset used in voice guidance screens is
different from that applied in Advance NDC where an offset of 5
would offset the screens by 5,000.
Table Note 6: Valid Tab: Valid codes that can be assigned in the
code sub-element are given in Table 6-2.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-37
Configuring Voice Guidance
XML Schema
Table 6-2
Codes for Defined Keys
Encoding Formats for
Voice Guidance
6
Code (Hex)
Description
30
ASCII ‘0’
31
ASCII ‘1’
32
ASCII ‘2’
33
ASCII ‘3’
34
ASCII ‘4’
35
ASCII ‘5’
36
ASCII ‘6’
37
ASCII ‘7’
38
ASCII ‘8’
39
ASCII ‘9’
F1
Enter
F2
Cancel
F3
FDK ‘D’
F4
FDK ‘C’
F5
FDK ‘B’
F6
FDK ‘A’
F7
FDK ‘F’
F8
FDK ‘G’
F9
FDK ‘H’
FA
FDK ‘I’
FF
Clear
The encoding formats used in AudioGuidanceData.xml can be
changed from "ISO-8859-1" to any other format such as "UTF-8" or
"UTF-9", however, the file must be saved in the same format or it
will be invalid. In addition, the TTS software used must support the
specified encoding format or the audio message will not be played.
For information on changing the encoding format, see “Specifying
the Character Encoding” on page 6-7.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-38
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Example XML Configuration File
Example XML Configuration File
6
The following example XML file references the schema described in
“XML Schema” on page 6-12.
Figure 6-6
Example Voice Guidance XML File
<?xml version="1.0" encoding="ISO-8859-1"?>
<x:NCRAudioGuidance xmlns:x="urn:xsdNCRAudioGuidance">
<Config groupID="0000" restartKeyPos="6" repeatDelay="30" configRetryCount="2"
timersAdjust="45" blankScreenID="0196" cardPromptScreen="0197" defaultVolume="50">
<afaTrigger useLang="false" triggerKeyPos="6" confirmationAudioID="confirm"
timeoutAudioID="timeOut"/>
<afaLang screen="0190" opCodePos="7">
<LangOption lang="en" keyPos="1" opCode="C" opCodeNoALT="A" screenOffset="0"
treqFieldID="&#60;"/>
<LangOption lang="sp" keyPos="2" opCode="D" opCodeNoALT="B" screenOffset="0"
treqFieldID="&#60;"/>
</afaLang>
<audioVolume screen="0191" plusKeyPos="1" minusKeyPos="2" doneKeyPos="4"/>
<!---1 to 4 question -->
<afaOption name="blankScreen" screen="0192" yesKeyPos="1" yesAudioID="blankYes"
noKeyPos="2" noAudioID="blankNo" defaultResponse="false"/>
<afaOption name="ads" screen="0193" yesKeyPos="1" yesAudioID="adsyes" noKeyPos="2"
noAudioID="adsNo" defaultResponse="true"/>
<afaOption name="OrientationSkip" screen="0194" yesKeyPos="1" yesAudioID="orientYes"
noKeyPos="2" noAudioID="orienNo"/>
<afaOption name="OrientationScript" screen="0195" yesKeyPos="1" yesAudioID="" noKeyPos="2"
noAudioID=""/>
</Config>
<!-- 2 FDK:FD -->
<Keyboard keyboardID="102">
<Key pos="1" code="F7"/>
<Key pos="2" code="F3"/>
</Keyboard>
<!-- 2 FDK:GC -->
<Keyboard keyboardID="110">
<Key pos="1" code="F8"/>
<Key pos="2" code="F4"/>
</Keyboard>
<!-- 2 FDK:AB -->
<Keyboard keyboardID="100">
<Key pos="1" code="F6"/>
<Key pos="2" code="F5"/>
</Keyboard>
<!-- 2 FDK:CD -->
<Keyboard keyboardID="103">
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-39
Configuring Voice Guidance
Example XML Configuration File
<Key pos="1" code="F4"/>
<Key pos="2" code="F3"/>
</Keyboard>
<!-- 3 FDK:ABC -->
<Keyboard keyboardID="105">
<Key pos="1" code="F6"/>
<Key pos="2" code="F5"/>
<Key pos="3" code="F4"/>
</Keyboard>
<!-- 4 FDK:ABCD -->
<Keyboard keyboardID="106">
<Key pos="1" code="F6"/>
<Key pos="2" code="F5"/>
<Key pos="3" code="F4"/>
<Key pos="5" code="F3"/>
</Keyboard>
<!-- 8 FDK:ABCDFGHI -->
<Keyboard keyboardID="113">
<Key pos="1" code="F6"/>
<Key pos="2" code="F5"/>
<Key pos="3" code="F4"/>
<Key pos="5" code="F3"/>
<Key pos="6" code="F7"/>
<Key pos="7" code="F8"/>
<Key pos="9" code="F9"/>
<Key pos="10" code="FA"/>
</Keyboard>
<!-- AFA Option messages -->
<Audio audioID="blankYes" groupID="0000">
<Text lang="en" state="private"> You have chosen to hide the screens. </Text>
</Audio>
<Audio audioID="blankNo" groupID="0000">
<Text lang="en" state="private"> You have chosen to display the screens. </Text>
</Audio>
<Audio audioID="adsYes" groupID="0000">
<Text lang="en" state="private"> You have chosen to hear the advertisements </Text>
</Audio>
<Audio audioID="adsNo" groupID="0000">
<Text lang="en" state="private"> You have chosen not to hear the advertisements. </Text>
</Audio>
<Audio audioID="orientNo" groupID="0000">
<Text lang="en" state="private"> You have chosen to listen to the orientation </Text>
</Audio>
<Audio audioID="orientYes" groupID="0000">
<Text lang="en" state="private"> You have chosen not to listen to the orientation. </Text>
</Audio>
<Audio audioID="timeOut" groupID="0000">
<Text lang="en" state="private"> Time alloted to make a selection has expired. </Text>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-40
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Example XML Configuration File
<Recording file="timeout" state="private"/>
</Audio>
<Audio audioID="confirm" groupID="0000" repetitions="0" keyboardID="010">
<Text lang="en" state="private"> To confirm audio session activation, please press the 5 key
once more. </Text>
</Audio>
<Audio audioID="0190" groupID="0000" keyboardID="010" repetitions="0">
<Text lang="en" state="private"> Please choose a language. For English, press 1. For Spanish,
press 2. </Text>
</Audio>
<Audio audioID="0191" groupID="0000" repetitions="0" keyboardID="010">
<Text lang="en" state="private"> <Link audioID="Link0191" groupID="0000"/> <Pause
duration="20"/> To increase volume, please press 1. To decrease volume, please press 2. To
accept this volume, please press the Enter key. </Text>
</Audio>
<Audio audioID="Link0191">
<Text lang="en" state="private"> Welcome to the audio session. If you wish to use the default
settings, which consist of the current volume level and displaying the screens, please insert
your card. If you wish to customise the options, please continue with the selection menus.
Please note that you can press the Cancel key at any point during the selection setting to begin
again. </Text>
<Recording file="PlayWelcome" state="private"/>
</Audio>
<Audio audioID="0192" groupID="0000" repetitions="0" keyboardID="010">
<Text lang="en" state="private"> The audio session allows you to hide or display the SST
screen for privacy during your banking session. To hide the SST screens, please press 1. To
display SST screens, please press 2. </Text>
</Audio>
<Audio audioID="0193" groupID="0000" repetitions="0" keyboardID="010">
<Text lang="en" state="private"> The audio session allows you to skip any advertising
messages, please press 2. </Text>
</Audio>
<Audio audioID="0194" groupID="0000" repetitions="0" keyboardID="010">
<Text lang="en" state="private"> The audio session allows you to hear a short orientation
before starting your transaction. To skip the orientation, please press 1. To hear the
orientation, please press 2. </Text>
</Audio>
<Audio audioID="0195" groupID="0000" repetitions="1">
<Text lang="en" state="private"> Voice guidance allows a visually impaired individual to use
an SST. Choices are made using the 8-function display keys are reassigned to the numeric keypad.
Press 1 to listen to the orientation again. Press 2 to begin your transaction. </Text>
</Audio>
<Audio audioID="0197" groupID="0000" repetitions="0">
<Text lang="en" state="private"> Please insert your card. </Text>
</Audio>
<!-- English messages -->
<Audio audioID="0000" groupID="0000" keyboardID="100" repetitions="0" keyText="true">
<Text lang="en" state="private"> If you need more time, please press 1 for yes, press 2 for
no. </Text>
</Audio>
<Audio audioID="0000-1" groupID="0000">
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-41
Configuring Voice Guidance
Example XML Configuration File
<Text lang="en" state="private"> Yes </Text>
</Audio>
<Audio audioID="0000-2" groupID="0000">
<Text lang="en" state="private"> No </Text>
</Audio>
<Audio audioID="0000-C" groupID="0000">
<Text lang="en" state="private"> Cancel </Text>
</Audio>
<Audio audioID="0001" groupID="0000" repetitions="0">
<Text lang="en" state="private"> We’re sorry, this machine is currently unavailable. </Text>
</Audio>
<Audio audioID="0002" groupID="0000" repetitions="0">
<Text lang="en" state="private"> We’re sorry, this machine is currently unavailable. </Text>
</Audio>
<Audio audioID="0003" groupID="0000" repetitions="0">
<Text lang="en" state="private"> We’re sorry, this machine is currently unavailable. </Text>
</Audio>
<Audio audioID="0010" groupID="0000" repetitions="0" keyboardID="010">
<Text lang="en" state="private"> Welcome. To begin a voice-guided session please press the
5 key. </Text>
</Audio>
<!-- <Audio audioID="0102" groupID="0000" keyboardID="102" repetitions="0" keyText="true">
-->
<!-- English Translation flow screen messages -->
<Audio audioID="0012" groupID="0000" repetitions="1" keyText="true">
<Text lang="en" state="private"> Please enter your secret code, then press the Enter key
when you are finished. Press the Clear key if you wish to re-enter your secret code. </Text>
</Audio>
<Audio audioID="0012-CLR" groupID="0000">
<Text lang="en" state="private"> Cleared. Please re-enter your secret code. </Text>
</Audio>
<Audio audioID="0015" groupID="0000" repetitions="0" keyboardID="100" keyText="true">
<Text lang="en" state="private"> Please choose a transaction. To withdraw cash, press 1. To
check your balance, press 2. To cancel a transaction, press Cancel. </Text>
</Audio>
<Audio audioID="0015-1" groupID="0000">
<Text lang="en" state="private"> Withdrawal. </Text>
</Audio>
<Audio audioID="0015-2" groupID="0000">
<Text lang="en" state="private"> Balance. </Text>
</Audio>
<Audio audioID="0015-C" groupID="0000">
<Text lang="en" state="private"> Cancel. </Text>
</Audio>
<Audio audioID="0023" groupID="0000" repetitions="0">
<Text lang="en" state="private"> Key in the amount and press Enter. Press the Clear key if
you want to re-enter the amount. </Text>
</Audio>
<Audio audioID="0023-CLR " groupID="0000">
<Text lang="en" state="private"> Amount entered is cleared. Please re-enter the amount.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-42
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Example XML Configuration File
</Text>
</Audio>
<Audio audioID="0624" groupID="0000" repetitions="0">
<Text lang="en" state="private"> Please wait while your transaction is processing. </Text>
<Recording file="DAUDIA04.WAV" state="prvate"/>
</Audio>
<Audio audioID="0036" groupID="0000" repetitions="2">
<Text lang="en" state="private"> Please take your cash. </Text>
</Audio>
<Audio audioID="0050" groupID="0000" repetitions="0">
<Text lang="en" state="private"> Thank you for banking with us. Please take your receipt.
</Text>
</Audio>
<Audio audioID="0118" groupID="0000" repetitions="0" keyText="true">
<Text lang="en" state="private"> Key in your account number and press Enter. Press the Clear
key if you wish to re-enter the number. </Text>
</Audio>
<Audio audioID="0118-CLR" groupID="0000">
<Text lang="en" state="private"> Cleared. Please re-enter your account number </Text>
<!-- English reply message used in receipt data with Placeholder -->
<Audio audioID="0132" groupID="0000" repetitions="0">
<Text lang="en" state="private"> Your current balance is <PlaceHolder/>. </Text>
</Audio>
</x:NCRAudioGuidance>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-43
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Voice-Guided Sessions without Host
Update
This section explains the structure of the XML file used to configure
voice-guided sessions with no host update.
It also describes and illustrates how the Interactive Transaction
Response (ITR) and Transaction Reply messages are adjusted by the
XML file during a voice-guided session without host update.
Finally, the section describes how the configuration information
sent in response to Send Configuration Information requests is
updated.
No Host Update XML
Elements
6
Although no schema file is provided with Advance NDC for
voice-guided sessions without host update, your XML file must
conform to the structure defined in the following table.
You must create your configuration file, called NHCVGAudio.xml,
and install it to the C:\Program Files\NCR APTRA\Advance
NDC\Config folder using your preferred method.
The no host update XML elements are described in the following
table.
Table 6-3
No Host Update XML Schema Elements
Element Name
Description
NHCVGAudio
Mandatory.
This is the root element.
The whole file is enclosed within NHCVGAudio tags.
Nested elements:
ITRScreen

ScreenUpdate

PrintData

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-44
APTRA Advance NDC, Developer’s Guide
6
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Element Name
Description
ITRScreen
Mandatory.
Appears once only.
Defines the parsing rules for the Interactive Transaction Response message when
using voice guidance without host update.
Nested elements:

Screen
Screen
Mandatory.
Defines the information used to replace fields in an Interactive Transaction Response
message in a voice-guided session. The formatting used for each attribute is the same
as that described for the associated field in the APTRA Advance NDC, Reference
Manual unless otherwise stated.
This element has the following attributes:
Number. Mandatory. Identifies the data to be displayed on the cardholder screen
instead of using field ‘j’. This is either a four-character string containing the
screen number (indirect audio text format) or blank (direct audio text format)

timerValue. Optional. Identifies the timer value in ticks to use instead of using
field ‘i’

repeatCount. Optional. Identifies the number of times to repeat the content of
the Text element. This is an integer between 0 and 9 to define the number of
times to repeat the text. If this is set to 0 or is blank, the text is only played once
and not repeated. If this is set to a number in the range 1 to 9, either the
repeatDelay or repeatDelayString attribute must also be defined

repeatDelay. Optional. Defines the delay in tenths of a second between the
repeat of the content of the Text element

repeatDelayString. Optional. Defines the control sequence used by the TTS
in use to add a delay between the repeat of the content of the Text element.
Not supported by Advance NDC

displayFlag. Optional. Defines the masking of the cardholder display to apply
instead of using field ‘g’

activeKeysMask. Optional. Defines the keys enabled instead of using field ‘h’

enterKeyMap. Optional. Defines the key to use as the Enter key when
activeKeysMask is used

cancelKeyMap. Optional. Defines the key to use as the Cancel key when
activeKeysMask is used

appendScreenUpdateData. Optional. Defines the screen display data with or
without the audio data. If the value is set to 0 (default), the screen display data is
replaced with audio data only. If the value is set to 1, Screen Data Field will play
audio data and screen display data.
Nested elements:

AudioData

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-45
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Element Name
Description
AudioData
Mandatory.
Defines the language used in a voice-guided session without host update.
This element has the following attributes:

lang. Mandatory. Identifies the language to use. The language selected by the
cardholder at the start of the voice-guided session is matched with this attribute
to determine which AudioData element to use in the transaction. If there is no
match, no audio data is built. The two-character string must comply with the ISO
639-1 standard for codes representing the names of languages
Nested elements:
DynamicTextDetails

Text

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-46
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Element Name
Description
DynamicTextDetails
Mandatory.
Defines a specific piece of variable data. There can be one or more
DynamicTextDetails sub-elements, and used in sequential order. Any spaces are
automatically deleted from dynamic data, and if only spaces are included the
dynamic data is considered to be “not found” unless the dynDataDefault attribute
is specified. This element has the following attributes:

name. Mandatory. Identifies the dynamic data being searched for. This attribute
must be unique for each DynamicTextDetails sub-element. It is used to reference
dynamic data in the Text and Criteria sub-elements and is case sensitive.

Numeric. Mandatory. Defines how the dynamic data is voiced. Valid values are
as follows:
— true The dynamic data must be voiced one digit or character at a time. Each
character of the dynamic data is modified so that it is separated by a space
character
— false The dynamic data is not modified or voiced one character at a time.
This is the default setting used if this attribute is blank or undefined

Location. Mandatory. Defines where the dynamic data is located with regard to
the search string. Valid values are as follows:
— sameAs The dynamic data is the search string, if found. If any control
characters in the range hex 00 to hex 1F are included in the dynamic data,
they are removed. If this is used, the dynDataDefault attribute must be
blank or undefined
— toRight The dynamic data is located to the right of the search string, if
found. All spaces and any characters from the beginning and end of the
string as defined in the StartPosition and EndPosition sub-elements
are trimmed and either the ExtractCharsFromLast or
ExtractCharsFromStart sub-elements are applied. This is the default
setting used if this attribute is blank or undefined

dynDataDefault. Optional. Defines the variable-length string to use as the
dynamic data if the search string is not found. If this is used, the dynamic data is
considered “found” when tested with the Criteria element. This must be
blank or undefined if the Location attribute is set to sameAs.

searchType. Mandatory. Defines where to start the search for the dynamic data.
Valid values are as follows:
— sequential The search begins at the point following the previous
successful search. If the previous successful search included the EndStr
element, the search starts from first character of the EndStr data. This is the
default setting used if this attribute is blank or undefined
— startFromBeginning The dynamic data is HERE.
Nested elements:

SearchStr

EndStr

StartPosition

EndPosition

ExtractCharsFromLast

ExtractCharsFromStart
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-47
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Element Name
Description
SearchStr
Mandatory.
Defines the location at which to start the search of the variable data.
If the search string defined in the value element is not found, the dynamic data is
considered not found.
Nested elements:

value
value
Mandatory.
Defines the character string to be searched for when locating the start of the variable
data.
There can be one or more value elements within a SearchStr element, and each
defined string is searched for in turn.
Nested elements:
hex

hex
Optional.
Defines hexadecimal data or an XML special character within the search string. Each
hex element can only contain one hexadecimal or special character. If more than one
is required, you must use multiple hex elements.
EndStr
Optional.
Defines the location at which to end the search of the variable data when the
Location attribute of the DynamicTextDetails element is set to toRight. If the
Location attribute is set to sameAs, the EndStr element is ignored.
If the Location attribute of the DynamicTextDetails element is set to toRight
and the search string defined in the value element of the SearchStr element is
found, the EndStr element can be used as follows:


If the value element of the EndStr element is defined, the data defined in the
value element of the EndStr is located and defines the end of the variable
data. If the search string defined in the value element is not found, the dynamic
data is considered not found
If the value element of the EndStr element is not defined, the end of the
variable data is considered to be the end of the data to be searched.
Nested elements:
value

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-48
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Element Name
Description
value
Optional.
Defines the character string to be searched for when locating the end of the variable
data.
There can be one or more value elements within an EndStr element, and each
defined string is searched for in turn.
Nested elements:

hex
hex
Optional.
Defines hexadecimal data or XML special characters within the search string. Each
hex element can only contain one hex or special character, if more than one hex or
special character is required, you must use multiple hex elements.
StartPosition
Optional.
Defines the number of characters to skip after the search string defined in the
SearchStr element and after removing any leading spaces.
If this element is blank or undefined, no characters are skipped.
EndPosition
Optional.
Defines the number of characters to skip backwards from the search string defined in
the EndStr element and after removing any trailing spaces.
If this element is blank or undefined, no characters are skipped.
ExtractCharsFromLast
Optional.
Defines the number of characters to extract from the end of the located string after
any adjustment as defined by the EndPosition element. This extracted set of
characters is used as the dynamic text for this DynamicTextDetails element.
If this element is used, the ExtractCharsFromLast element must be blank or
undefined.
ExtractCharsFromStart
Optional.
Defines the number of characters to extract from the start of the located string after
any adjustment as defined by the StartPosition element. This extracted set of
characters is used as the dynamic text for this DynamicTextDetails element.
If this element is used, the ExtractCharsFromLast element must be blank or
undefined.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-49
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Element Name
Description
Text
Mandatory
Defines the static and dynamic text to be passed to the TTS engine for this transaction
message using the language defined in the AudioData element.
Dynamic text is defined using the DynamicTextDetails element and its nested
elements. Dynamic data can be embedded into static text and can be tested using the
Criteria element to determine whether it has been found. You can include certain
text depending on the result of the Criteria test.
Nested elements:

FreeText

Criteria
FreeText
Mandatory
Defines the text to be voiced along with any dynamic data, spaces and control
characters.
NCR recommends that the text for a given phrase or paragraph is defined on a single
line. Use multiple lines with separate FreeText elements to prevent control
characters from being voiced. Multiple consecutive lines must have a space at either
the end of the previous or the start of the next line of text.
Static text followed by dynamic data must have a space character included at the end
of the static text.
A space character is automatically inserted immediately after each piece of dynamic
data.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-50
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Element Name
Description
Criteria
Mandatory.
Tests whether the dynamic data is found or not. You can test multiple dynamic text
names within a single Criteria element using OR logic or use nested Criteria
elements to apply AND logic.
When testing the ITRScreen element, the following names can be used to test
whether any of the FDK, numeric or Cancel keys are active:
ITR_FDK_A
ITR_FDK_B

ITR_FDK_C

ITR_FDK_D

ITR_FDK_F

ITR_FDK_G

ITR_FDK_H

ITR_FDK_I

ITR_Numerics

ITR_Cancel
These names reflect the keys activated by the activeKeysMask parameter of the
Screen element if used, otherwise they reflect the keys activated by the ITR
message sent by the host.


ScreenUpdate
Mandatory.
Appears once only.
Defines the parsing rules for the screens containing updated screen data in the
Transaction Reply message when using voice guidance without host update.
Nested elements:
Screen

Screen
Mandatory.
Defines the screen used to replace that given in field ‘n’ of a Transaction Reply
message in a voice-guided session.
This element has the following attributes:
Number. Mandatory. Identifies the four-character screen number that identifies
the screen containing the updated screen data.

Nested elements:
DynamicTextDetails

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-51
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Element Name
Description
DynamicTextDetails
For details, see DynamicTextDetails on 6-47
The dynamic text data located by the searches is passed as placeholder data in the
order that the data is found. If dynamic data is not found, it is not included in the list
of placeholder data. The placeholder data is referenced in the AudioGuidanceData.xml
file by the Audio element with an audioID matching the screen number of the
updated screen data. For details of the Audio element, see “XML Schema” on
page 6-12.
PrintData
Mandatory.
Appears once only.
Defines the parsing rules for the print data in the Transaction Reply message when
using voice guidance without host update.
Nested elements:

TranReply
TranReply
Mandatory.
Defines the print data parsing rules. There can be one or more TranReply
sub-elements. This element has the following attributes:



FuncId. Mandatory. Defines the Function ID to use instead of the Function ID in
field ‘l’ of the Transaction Reply message
NextState. Mandatory. Defines the next state to instead of the next state in field
‘f’ of the Transaction Reply message
ScrToDisplay. Mandatory. Defines the screen number to use instead of the
screen number in field ‘m’ of the Transaction Reply message.
For details of the Transaction Reply message, refer to Chapter 10, “Central to
Terminal Messages”, in the APTRA Advance NDC, Reference Manual.
Nested elements:

AudioData
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-52
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Element Name
Description
AudioData
Mandatory.
Defines the language used in a voice-guided session without host update.
This element has the following attributes:

lang. Mandatory. Identifies the language to use. The language selected by the
cardholder at the start of the voice-guided session is matched with this attribute
to determine which AudioData element to use in the transaction. If there is no
match, no audio data is built. The two-character string must comply with the ISO
639-1 standard for codes representing the names of languages
Nested elements:

DynamicTextDetails

Text
Transaction Reply
6
The host can pass variable data that might require audio as part of
the Screen Display Update field or in the Printer Data field in the
Transaction Reply. Each method is discussed below.
For details of the Transaction Reply, refer to Chapter 10, “Central to
Terminal Messages”, in the APTRA Advance NDC Reference Manual.
Screen Display Update Field
6
The Screen element in the NHCVGAudio.xml file can be used to
replace information in field ‘n’ of the Transaction Reply.
If field ‘n’ contains a screen number, the Number parameter is
checked for a matching entry.
If a matching entry is located, placeholder data is built based on the
parsing rules. The audio escape sequence containing the
placeholder data is added to the beginning of the data in the
Transaction Reply following the screen number. No data is removed
from the message. However, if any audio escape sequences are
already present for use with a .wav file, these escape sequences are
removed.
Note: Support for .wav files is provided through the standard voice
guidance processing.
If no matching entry is located, one of the following occurs:


If there are further screen numbers in field ‘n’, the Number
parameter is checked again for a matching entry
If there are no further screen numbers in field ‘n’, the Print Data
field is used as described in “Printer Data Field” on page 6-55.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-53
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
If no screen number is contained in field ‘j’, the rules associated with
the default screen number are used to parse and build the voice
data.
Example Transaction Reply Conversion
section are as follows:




The examples in this
Figure 6-7 shows the original Transaction Reply sent by the host
Figure 6-8 shows an example of Voice Guidance XML Extract
from the AudioGuidanceData.xml file
Figure 6-9 shows an example of Screen Update XML Extract
from the NHCVGAudio.xml file
Figure 6-10 shows the Transaction Reply updated using the
XML elements.
Figure 6-7
Original Transaction Reply
4<fs><fs><fs>125<fs><fs>19365100134<ff><si>AA<so>125<si>DF $1.75<fs>000
Figure 6-8
Example Voice Guidance XML Extract
<Audio audioID="0134" groupID="0000" repetitions="0" keyboardID="100" keyText="true">
<Text lang="en" state="private"> A fee of <PlaceHolder/> will be charged for this transaction.
Do you accept this fee? To accept, press 1. To decline, press 2 or press the Cancel key.
</Text>
</Audio>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-54
6
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Figure 6-9
Example Screen Update XML Extract
<NHCVGAudio>
<ScreenUpdate>
<Screen Number="0134">
<DynamicTextDetails name="PlaceholderSurcharge" numeric="false" Location="toRight"
dynDataDefault="" searchType="sequential">
<SearchStr>
<value><hex>0F</hex>D</value>
</SearchStr>
<EndStr>
<value><hex>0F</hex></value>
<value><hex>1C</hex></value>
</EndStr>
<StartPosition>1</StartPosition>
<EndPosition></EndPosition>
<ExtractCharsFromLast></ExtractCharsFromLast>
<ExtractCharsFromStart></ExtractCharsFromStart>
</DynamicTextDetails>
</Screen>
</ScreenUpdate>
</NHCVGAudio>
Figure 6-10
Updated Transaction Reply
4<fs><fs><fs>125<fs><fs>19365100134<sc>P0000;1;$1.75<esc>\<ff><si>AA<So>125<si>DF$
1.75<fs>000
Printer Data Field
6
The PrintData element in the NHCVGAudio.xml file can be used to
replace information in fields ‘r’ of the Transaction Reply. If multiple
print groups are included in the Transaction Reply, all print groups
are included as one string for the parsing.
If there is no print data included in the Transaction Reply, the
processing for voice-guided session without host update is
complete.
The parameters in the TranReply sub-element are used to update
the Transaction Reply as follows:



The FuncId parameter is used instead of field ‘l’
The NextState parameter is used instead of field ‘f’
The ScrToDisplay parameter is used instead of field ‘m’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-55
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
If parsing rules are applied, the voice data is built based on these
rules and the ‘>’ printer flag followed by the built voice data within
double quotation marks is added to the Transaction Reply.
Example Transaction Reply Conversion
section are as follows:



The examples in this
Figure 6-11 shows the original Transaction Reply sent by the
host
Figure 6-12 shows an example of Print Data XML Extract from
the NHCVGAudio.xml file
Figure 6-13 shows the Transaction Reply updated using the
XML elements.
Figure 6-11
Original Transaction Reply
4<fs><fs><fs>118<fs>0000<fs>00285123<fs>102YOUR BANK<lf><lf>2/21/09<so>511:11
AM<lf><so>:******0123<lf><so>:11-22-09<lf><lf><lf><lf>CHECKING<lf>BALANCE
$77273.54<lf><lf>00028<ff>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-56
APTRA Advance NDC, Developer’s Guide
6
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Figure 6-12
Example Print Data XML Extract
<NHCVGAudio>
<PrintData>
<TranReply FuncId="5" NextState="118" ScrToDisplay="0123">
<AudioData lang="en">
<DynamicTextDetails name="DynamicChecking" numeric="false" Location="sameAs"
dynDataDefault="" searchType="sequential">
<SearchStr>
<value><hex>0A</hex><hex>0A</hex><hex>0A</hex>CHECKING</value>
</SearchStr>
<EndStr>
<value><hex>0A</hex></value>
</EndStr>
<StartPosition>0</StartPosition>
<EndPosition></EndPosition>
<ExtractCharsFromLast></ExtractCharsFromLast>
<ExtractCharsFromStart></ExtractCharsFromStart>
</DynamicTextDetails>
<Text>
<Criteria DynamicChecking="found">
<FreeText>Your new checking account balance is </FreeText>
</Criteria>
</Text>
</AudioData>
</TranReply>
</PrintData>
</NHCVGAudio>
Figure 6-13
Updated Transation Reply
4<fs><fs><fs>118<fs>0000<fs>00285123<fs>102YOUR BANK<lf><lf>2/21/09<so>511:11
AM<lf><so>:******0123<lf><so>:11-22-09<lf><lf><lf><lf>CHECKING<lf>BALANCE
$77273.54<lf><lf>00028<ff><gs>>”Your new CHECKING account balance is $77273.54”
Interactive Transaction
Response
6
The ITR message is used to gather further information from the
cardholder, for example to identify the account to debit for a
withdrawal. For details of the ITR message, refer to Chapter 10,
“Central to Terminal Messages”, in the APTRA Advance NDC
Reference Manual.
The Screen element in the NHCVGAudio.xml file is used to replace
information in some fields of the ITR and Transaction Request
messages, as described in the following sections.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-57
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
ITR Screen Data Fields
6
The Screen Data Fields can be configured to display the screen data
or only the audio data by setting an attribute to the
appendScreenUpdateData, for details, see the Screen element in
Table 6-3, “No Host Update XML Schema Elements” on page 6-44.
Screen data can be provided using fields 'j1' and 'j2' of the ITR
message
Field ‘j1’ can contain a screen number. The screen number is
converted as follows:



A three-digit screen number, for example 123, is prefixed with
‘0’
A four-digit screen number enclosed in quotation marks, for
example “1234”, has the quotation marks removed
A four-digit screen number with prefixed with either ‘u’ or ‘l’,
for example u1234, has the prefix removed.
After the screen number has been converted, the Number parameter
is checked for a matching entry.
Note: If field ‘j1’ contains more than one screen number, the first
number is used.
If a matching entry is located, the associated rules are used to parse
and build the voice data for the current ITR message in Direct
Audio Text format.
If no matching entry is located, field ‘j1’ is not modified.
If no screen number is contained in field ‘j1’, the rules associated
with the default screen number are used to parse and build the
voice data.
Field 'j2', is only used in a voice-guided session with data provided
by the host.
ITR Screen Timer Field
6
The timerValue parameter is used, if present, to define time-out
intervals from the cardholder screen display. This replaces any
information supplied in field ‘i’ of the ITR.
ITR Display Flag Field
The displayFlag parameter is used, if present, to define how to
display cardholder keyboard entry on the screen. This replaces any
information supplied in field ‘g’ of the ITR.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-58
APTRA Advance NDC, Developer’s Guide
6
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
ITR Active Keys/Touch Areas Field
6
The activeKeysMask parameter is used, if present, to active the
required keys or touch areas for cardholder responses. This replaces
any information supplied by field ‘h’ in the ITR.
Transaction Request General Purpose Buffer B field
6
The enterKeyMap or cancelKeyMap parameters are used, if present
and if the cardholder has selected the Enter or Cancel key, to update
field ‘m’ before the message is sent on to the host.
For example, this mapping is required if numeric keys are used for
numeric entry and FDKs are active to allow selection of the Enter or
Cancel keys.
Example ITR Message Conversion
6
The examples in this section are as follows:



Figure 6-14 shows the original ITR sent by the host
Figure 6-15 shows the Example XML Extract from the
NHCVGAudio.xml file
Figure 6-15 shows the ITR updated using the XML elements.
The message is updated, as follows:


The Screen Timer Field is updated from a value of ‘080’ to a
value of ‘050’
The audio data is provided.
The extract also shows that FDK C, FDK D and the Cancel key are
active.
Figure 6-14
Original ITR Message
3<fs><fs><fs>20000111<fs>050<fs><ff><so>060<si>ABYOUR BANK <si>CB$1.00
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-59
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Figure 6-15
Example XML Extract
<NHCVGAudio>
<ITRScreen>
<Screen Number="0060" timerValue="080" repeatCount="0" repeatDelay="" repeatDelayString=""
displayFlag="" activeKeysMask="" enterKeyMap="" cancelKeyMap="">
<AudioData lang="en">
<DynamicTextDetails name="DynamicText_BANK" Numeric="false" Location="toRight"
dynDataDefault="" searchType=”sequential”>
<SearchStr>
<value><hex>0F</hex>AB</value>
</SearchStr>
<EndStr>
<value><hex>0F</hex></value>
</EndStr>
<StartPosition>0</StartPosition>
<EndPosition></EndPosition>
<ExtractCharsFromLast></ExtractCharsFromLast>
<ExtractCharsFromStart></ExtractCharsFromStart>
</DynamicTextDetails>
<DynamicTextDetails name="DynamicText_Fee" Numeric="false" Location="toRight"
dynDataDefault="" searchType=”sequential”>
<SearchStr>
<value><hex>0F</hex>CB</value>
</SearchStr>
<EndStr>
</EndStr>
<StartPosition>0</StartPosition>
<EndPosition></EndPosition>
<ExtractCharsFromLast></ExtractCharsFromLast>
<ExtractCharsFromStart></ExtractCharsFromStart>
</DynamicTextDetails>
<Text>
<FreeText>For this transaction, </FreeText>
<DynamicText_BANK/>
<FreeText> will charge a fee of </FreeText>
<DynamicText_Fee/>
<FreeText>. This fee is in addition to any fees your </FreeText>
<FreeText>institution may charge you. If you accept this </FreeText>
<FreeText>fee and would like to continue with this </FreeText>
<FreeText>transaction, press 3. To decline this fee </FreeText>
<FreeText>and terminate this transaction, press 4, or </FreeText>
<FreeText>press the cancel key.</FreeText>
</Text>
</AudioData>
</Screen>
</ITRScreen>
</NHCVGAudio>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-60
APTRA Advance NDC, Developer’s Guide
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Figure 6-16
Updated ITR Message
3<fs><fs><fs>20000111<fs>080<fs>For this transaction, YOUR BANK will charge a fee
of $1.00. This fee is in addition to any fees your institution may charge you. If
you accept this fee and would like to continue with this transaction, press 3. To
decline this fee and cancel this transaction, press 4 or the Cancel key.
Send Configuration
Information
6
When voice guidance is enabled using Supervisor message mode
option digit 1 and voice-guided sessions without host update are
being used, the host will not understand the hardware
configuration and fitness configuration information.
In this situation, the information about voice guidance is updated as
follows:



Responses to Send Configuration Information command (code
'7') and a command modifier of ‘6’ contain voice guidance
information in position 32 of fields ‘g3’ and ‘g4’. Field ‘g3’ is
updated to contain ‘0’ and field ‘g4’ is updated to contain ‘00’
Responses to Send Configuration Information command (code
'7') and a command modifier of ‘1’ contain voice guidance
information in field ‘g4’. The hardware configuration data
device identifier, ‘a’, and its associated value are removed from
field ‘g4’
Responses to Send Configuration Information command (code
'7') and a command modifier of ‘3’ contain voice guidance
information in field ‘g2’. The fitness data device identifier, ‘a’,
and its associated value are removed from field ‘g2’.
For details of Option Digit 1, refer to the APTRA Advance NDC,
Supervisor’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
6-61
Configuring Voice Guidance
Voice-Guided Sessions without Host Update
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-62
APTRA Advance NDC, Developer’s Guide
Table of Contents
Introducing the Advance NDC Authored Applications
Chapter 7
Introducing the Advance NDC
Authored Applications
Overview
7-1
The APTRA Author
7-2
Customisation Layer
Customisation Layer Applications Catalog
Cardholder Session
Start from State 0
NDC Processing State Executor
AP Synch NDC State Processing - Session
State Types Catalog
Card Read States
Close State
Suspend Mode
Customisation Layer Catalog
Transaction Reply Functions Catalog
CDI - <name> Catalog
NDC Core Catalog
NDC Transactions Catalog
NDC Encryption Keys Catalog
NDC Field Workers Catalog
7-3
7-3
7-5
7-6
7-6
7-7
7-7
7-7
7-8
7-8
7-9
7-9
7-9
7-9
7-9
7-9
7-9
Application Core
Application Core Project
Start of Day
Keymanager
Initialise
Start of Day Hook
Mode Handler
Application Core Catalog
User Controls Catalog
User Stores and Signals Catalog
Synchronising with the Customisation Layer
Session Releaser
7-10
7-10
7-12
7-13
7-13
7-15
7-15
7-18
7-18
7-18
7-18
7-19
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Table of Contents
Introducing the Advance NDC Authored Applications
Checking the Status of the Customisation Layer
Mode Handling
Message Handling
Message Processing Director
Message Handler
Terminal Command Processing
Customisation Data Processing
Transaction Reply Command Processing
7-19
7-19
7-21
7-22
7-24
7-24
7-26
7-27
Supervisor Mode
Handle Switch Work Group
Activating the Supervisor Application
Supervisor Project
Supervisor Mode Start-Up
Shared Stores
7-29
7-30
7-31
7-31
7-33
7-34
Testing the Advance NDC Application
Running in the PC Environment
Running in the Author Environment
SSDS DLL Interface
Testing State Types and Transaction Reply Functions
Using the XFS Simulator
Preparing the XFS Simulator for Use
Text Terminal Unit (TTU)
Receipt Printer
Simulated PINpad
Card Reader
Currency Dispenser
Coin Dispenser
Cash Acceptor
Bunch Cheque Acceptor
TCP/IP Configuration
Simulating Communications
Simulating a Passbook Printer
7-35
7-36
7-36
7-37
7-37
7-38
7-38
7-38
7-38
7-39
7-39
7-40
7-40
7-41
7-43
7-44
7-44
7-44
Using the Command Line Utility
The Customisation Data Database File
Using the Custdat.exe Utility
Exporting
Importing
Error Messages
7-46
7-46
7-47
7-47
7-48
7-48
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Overview
G
Overview
7
Read this chapter if you want to familiarise yourself with the
Advance NDC application flow in the Author (the Customisation
Layer, Application Core and Supervisor applications).
“Supervisor Mode” on page 7-29 also includes an overview of the
separate Supervisor application. Before Advance NDC 2.05, this
functionality was provided as part of the Application Core.
Information on how to test the applications on a development
system is provided in “Testing the Advance NDC Application” on
page 7-35.
If you simply want to migrate your NDC+ application to Advance
NDC and use your existing (unchanged) NDC+ download with
Windows XP, see Chapter 3, “Migrating Existing NDC+
Applications to Advance NDC”.
If you want to upgrade from a previous release of Advance NDC,
see Chapter 4, “Upgrading from Earlier Releases of Advance NDC”.
If you intend enhancing the Advance NDC applications, read this
chapter first, and then read Chapter 8, “Modifying the
Customisation Layer”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-1
Introducing the Advance NDC Authored Applications
The APTRA Author
The APTRA Author
7
As described in Chapter 1, “Introducing Advance NDC”, the
Application Core, Customisation Layer and Supervisor are three
projects in the Author. If you want to view or edit them, you need to
know how to use the APTRA Author. If you have the XFS Simulator
installed, you can use it to simulate devices on the development PC.
To learn how to use the Author and the XFS Simulator, refer to the
following:


Author - APTRA Author User’s Guide
XFS Simulator - APTRA Simulator, On-line Documentation
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-2
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Customisation Layer
Customisation Layer
7
Before you can modify the Customisation Layer, you need to
understand how the application is structured.
The Customisation layer is modularised, separating the state types
and transaction reply functions into application DLLs, which are
identified and executed through application links configured in the
registry. This reduces the size of the Customisation Layer and
simplifies both maintenance and modification. The self-contained
application DLLs can be loaded at start of day or when required.
The Customisation Layer is built as an application DLL driven by a
single executable, the Application Core.
The project file is named CustomisationLayer.mpj and can be found in
your <global>\final\support\user directory.
To access the supplied project file, start the Author and open the
CustomisationLayer.mpj project.
The project contains several catalogs (under File | Open Catalog...).
The main Advance NDC catalogs for transactions are as follows:





Customisation Layer Applications
Customisation Layer
State Types (DLLs)
Transaction Reply Functions (DLLs)
User-defined CDI stores (UCDIs).
Each of these catalogs is described in the following subsections.
Related catalogs are described on page 7-9.
Customisation Layer
Applications Catalog
7
The Customisation Layer Applications catalog contains the
Customisation Layer application, and the nested catalogs, State
Types, and Transaction Reply Functions, for easy reference. The
Customisation Layer application starts and finishes a session at
State 0, using the NDC Processing State Executor to load and
execute one state type internally (as a black box).
You can see the link build information for each application by
selecting an icon in the catalog, clicking right on Application
Settings and then double-clicking Application Link Build
Information.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-3
Introducing the Advance NDC Authored Applications
Customisation Layer
The following screenshot shows the link and build information for
the Card Read States application:
Figure 7-1
Application Link Build Information
The fields have the following meaning:
Table 7-1
Application Link and Build Information
Field
Description
ApplicationName
The name of the application in the Author
ComponentId
The unique identifier in the Author
Description
A readable version of the application name
ApplicationLink
FileInfo
The DLL name and the link name, in the registry
under HKLM/SOFTWARE/NCR/Advance
NDC/Application Links
—DllName
In the registry, the DLL name in Data value.
—LinkName
In the registry, the application link in Name value
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-4
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Customisation Layer
Cardholder Session
7
In a cardholder session, every state can be executed. On completion
of a cardholder session, that is, State 0 has been reached again, the
Application Core can regain control.
Note: The Session Releaser is described in “Synchronising with the
Customisation Layer” on page 7-18.
Before reading on, open a view of the Customisation Layer
application by doing the following:
1
Open the Customisation Layer Applications catalog.
2
Double-click the Customisation Layer application.
3
Double-click the Cardholder Session Director.
As well as browsing the application in the Author, you can also
browse the Component Descriptions and On-line Help in the
Author.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-5
Introducing the Advance NDC Authored Applications
Customisation Layer
Look at the following diagram to familiarise yourself with the
Cardholder Session Director in the Customisation Layer
application:
Figure 7-2
Example of the Advance NDC Director in
the Customisation Layer
The work groups in the Cardholder Session Director perform the
following jobs:
Start from State 0
7
This work group sets the next state number to be executed by the
NDC Processing State Executor. The state processing loop is
performed until the next state number is 0, at which point the
cardholder session is complete and the application flow returns to
the Application Core.
NDC Processing State Executor
7
This worker executes a single NDC state and then signals Executed.
State Execution The NDC Processing State Executor worker loads
the State Type application DLL specified by the next state number.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-6
APTRA Advance NDC, Developer’s Guide
7
Introducing the Advance NDC Authored Applications
Customisation Layer
If a Transaction Request State application DLL is loaded, it uses the
Transaction Request State worker to build and send a Transaction
Request message (such as, authorise a cash dispense) to the Central
application and receives a response (such as to dispense cash). It
then loads the appropriate Transaction Reply application DLL to
execute the function.
The Customisation Layer retains control until a Close state is
executed and the next state number is 0, at which point the
cardholder session is complete.
AP Synch NDC State Processing - Session
7
If APTRA Promote is installed and Dialogs are enabled, this worker
provides an opportunity for the Presentation Client to synchronise
with the application flow.
Note: This worker is no longer required as APTRA Promote 4.0
must now be used and it does not use the Presentation Client.
State Types Catalog
7
This catalog contains applications for authored state type DLLs and
Suspend Mode. These applications use unconsumed signals to
indicate they have completed their operation and return control to
the NDC Processing State Executor. If you open one of the provided
state types and do a Signals Check, you can see these unconsumed
signals, with (Exit) attached to the end of the name.
The following subsections look at the functionality of three
applications you will find in the State Types catalog:



Card Read States
Close State
Suspend Mode.
Card Read States
7
The Card Read States application DLL performs the Card Read ‘A’
state or Card Read PIN Entry Initiation ‘T’ state and completes the
following:



Checks if the journal configuration has changed since the last
transaction. If it has changed, the appropriate journal
configuration is activated
Clears CDI data from the previous cardholder session
Enables the Card Reader device and prompts the cardholder to
enter a card.
While waiting for a card to be entered, a Session Releaser
worker monitors for mode changes (such as, go Out Of Service)
occurring in the Application Core. The Session Releaser is used
to give up control of the Customisation Layer to the Application
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-7
Introducing the Advance NDC Authored Applications
Customisation Layer
Core. However, control is only relinquished when the
cardholder session is either idle, waiting for card entry, or at
another suitable point in the application when it is safe to return
to Out Of Service Mode.

If a cardholder session is initiated by a cardholder entering a
card into the reader, the card is read and a Financial Institution
Table (FIT) search is performed.
Any mode changes in the Application Core are delayed until the
current cardholder session is completed. The session is
completed when a Close state is executed and the next state
number is 0.

If State ‘T’ is executed, attempts to read the card, and if
successful, prompts the cardholder to enter a Personal
Identification Number (PIN).
A cardless transaction prompts for a PIN, if track 2 data is
specified in the registry. For details, seeTable 5-33 “Cardless
Transaction Registry Entries” on page 5-117


Performs any error recovery (for example, if the card read fails,
the card needs to be ejected/captured)
Sends any unsolicited Device Fault Status messages to the
Central application.
Close State
7
This application DLL performs the following:



Clears media from the Receipt Printer, BNA, CPM, Card Reader
and Statement Printer devices if required
Sends any unsolicited Device Fault Status messages regarding
device activity, since completing the last transaction, to the
Central application
Sets up the Next State Number to execute.
Suspend Mode
Although Suspend Mode is not a state type, it is included in the
State Types catalog for convenience. This support application DLL
performs the following:


Handles any suspend condition which may arise with the
devices used by the terminal (for example, customer tampering).
This effectively puts the Customisation Layer out of service
before attempting to clear the suspend condition, ready for a
new cardholder session
Displays the Out Of Service screen until either a Go In Service
command is received or five minutes have elapsed, after which
the suspend condition is cleared.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-8
APTRA Advance NDC, Developer’s Guide
7
Introducing the Advance NDC Authored Applications
Customisation Layer
Customisation Layer
Catalog
Transaction Reply
Functions Catalog
This catalog contains Advance NDC workers specific to the
Customisation Layer and related DLLs.
7
7
CDI - <name> Catalog
NDC Core Catalog
NDC Transactions Catalog
7
7
7
This catalog contains application DLLs for the 15 authored
transaction reply functions. These applications use unconsumed
signals to return control to the authored flow.
The CDI - <name> catalog contains Common Data Interface (CDI)
stores. These stores represent items of data that Advance NDC
makes available as shared data (such as, configuration options and
transaction related buffers). For details of the CDI stores we
provide, see Appendix C, “Common Data Interface Stores”.
This catalog contains all the Advance NDC workers common to
both the Customisation Layer and Application Core.
This catalog contains all authored functions for the Transaction
Request State and NDC Transaction Handler workers to execute a
Transaction Reply function.
The workers in this catalog are used in the Tr Reply Function work
group of the Transaction Request State and NDC Transaction
Handler workers. For details of the NDC Transaction Handler
worker, see “NDC Transaction Handler” on page 8-20 and
Appendix B, “Advance NDC Workers Supplied”
NDC Encryption Keys
Catalog
NDC Field Workers
Catalog
7
7
This catalog contains the Encryption Keys used by Advance NDC
for Security purposes. These keys are used for PIN Verification and
calculating the MAC (Message Authentication Code) in a message.
This catalog contains the NDC Field workers which are used to specify
the different optional fields that can be included in a Transaction
Request message to Central. These workers would be included in
the NDC Field work group of an NDC Transaction Handler worker.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-9
Introducing the Advance NDC Authored Applications
Application Core
Application Core
The Application Core has three main purposes:



To preserve the NDC message interface
To separate the fixed part of Advance NDC (the Application
Core) from the customisable part (the Customisation Layer,
States and Screens)
To drive the Customisation Layer (cardholder) and Supervisor
sessions.
The Application Core deals with the tasks of mode handling,
synchronising with Customisation Layer, and handling messages
from Central. The remaining sections in this chapter describe how
these functions are authored in the Advance NDC application.
Note: For details of the Supervisor Mode functionality, which is
provided in a separate Supervisor application DLL, see “Supervisor
Mode” on page 7-29.
The sections are designed to be read in conjunction with the
Application Core project file we supply, ApplicationCore.mpj, located
in <global>\final\support\user.
First, open the ApplicationCore.mpj project in the Author.The main
Advance NDC catalogs relating to the functionality of the
Application Core are described in the following sections:





Application Core Project
7
Application Core Applications
Application Core
User Messages/Terminal Data Examples
User Messages/Terminal Data Workers
User Stores and Signals.
The Application Core Applications catalog contains the authored
Application Core.
Open a view of the Application Core application as follows:
1
Open the Application Core Applications catalog.
2
Double-click the Application Core application.
3
Double-click the Application Core director and then the
AppCore director.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-10
APTRA Advance NDC, Developer’s Guide
7
Introducing the Advance NDC Authored Applications
Application Core
Figure 7-3
Application Core Director
By browsing the application in the Author at the same time as
reading this section, you will make the most of the information. You
can also browse the Component Descriptions and On-line Help in
the Author.
Open a view of the App Core director and familiarise yourself with
its contents in the Application Core application:
Figure 7-4
AppCore Work Group
The following sections describe the Start of Day, Keymanager Init,
Initialise, Start of Day Hook and Mode Handler work groups.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-11
Introducing the Advance NDC Authored Applications
Application Core
Start of Day
7
The following screenshot shows the Start of Day work group:
Figure 7-5
Start Of Day Work Group
The Start of Day Director and its subworkers perform the following
tasks:





Initialise the Customisation Data work group:
— Put the In Service Indicators off
— Initialise or re-load the customisation data from disk
according to the Config ID
Configure the Journal:
— Check the printer status
— Configure the journal printer, including which mode of
journal printing is in operation
— Activate back up
Initialise Promote:
— If APTRA Promote is installed, check whether Dialogs are
installed
— Hook for a Promote campaign
Initialise the GBRU
— If a GBRU is installed, check each cash handler
— Reset if required
Customisation Layer
— Check for installed devices and their status
— Configure the registry setting for the cash handler
Status Information Status information is logged for the following
devices: Statement Printer, Receipt Printer, Cash Handler, Envelope
Depository, Envelope Dispenser, Journal Printer, Encryptor, Card
Reader, Front Keyboard, Bunch Note Acceptor (BNA) and Cheque
Processing Module (CPM).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-12
APTRA Advance NDC, Developer’s Guide
7
Introducing the Advance NDC Authored Applications
Application Core
Note: The receipt printer is initialised and prints a test receipt. This
pushes any receipt that has not been removed out. If the test receipt
is not removed, it will be retracted where the hardware has the
capability.
Journal Configuration Journal mode is persistent. At Start of Day,
the Configure Journal process checks whether a physical journal
printer is present or not. If a printer is found, the previous journal
mode is retrieved from persistent storage (pmdata file) and used. If a
printer is not found, persistent storage is checked for the previous
mode setting. If the previous mode was EJ, the journal mode is
configured for electronic journaling. If the previous mode was not
EJ, the journal mode is set to NONE.
7
Note: At initial boot-up after installation of Advance NDC, the
journal mode is set to PAPER. If persistent storage is unavailable
(pmdata is corrupt or has been deleted), the journal mode will
default to PAPER or NONE depending on whether a journal printer
is present or not.
Keymanager
7
The Keymanager work group contains two workers: KeyManager
and OtherVendorInit.
Figure 7-6
Keymanager Work Group
KeyManager processes remote key management for NCR SSTs and
OtherVendorInit processes remote key management for other
vendors’ SSTs.
Initialise
7
The Initialise work group contains two workers: Initialise Mode and
AC Status Initialisation.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-13
Introducing the Advance NDC Authored Applications
Application Core
The Initialise Mode Director performs the following initialisation
functions:
Figure 7-7
Initialisation Functions








Check Boot Type:
— Initialisation of communications with Central (if the mode
switch is in the Normal position)
— Initialisation of printing on the journal depending on the
status of communications
Determine Powerfail:
— System re-initialisation based on the restart mode
— Send a Power Up message to Central
Encryptor:
— Re-initialisation of the encryptor if one is present
Powerfail During Dispense?:
— If Powerfail flag set, sets up note counts and performs
security trace on last dispense
Setup no. of cassette types
— Check the value of option 76, Cash Handlers
— Set the number of cassette types for basic or enhanced cash
handling
Initialise EJ Recurrence
— Start EJ recurrence
— Set the local EJ file size
Initialise Web Exit
— Set up web exits
Supervisor Mode?:
— Check whether the Supervisor switch is in the Supervisor
position on start up
The AC Status Initialisation work group checks whether EJ or dual
mode is configured for the journal and enables the EJ.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-14
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Application Core
Start of Day Hook
7
This work group contains the following two hooks:


Start Of Day Hook
Mode Change Hook
Mode Handler
7
This work group performs the following:
Handles changes in NDC+ modes (see below for more
information)

Monitors and reports changes in the state of all Tamper
Indicating and Alarm sensors

While the terminal is not in Supervisor Mode, it displays a
cycling list of the terminal’s current device-related faults on the
Enhanced Operator Panel (if present).
The Mode Handler is authored as a Director with a fixed number of
work groups. Each work group is occupied by workers, typically in
sub-Directors, to perform the functionality required of each of the
NDC+ modes. The work flows between the work groups are used to
handle the transitions that occur from mode to mode.

Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-15
Introducing the Advance NDC Authored Applications
Application Core
Figure 7-8
Mode Handler Director
Changes between modes are driven by the following factors:






Terminal Commands (Go In Service, Go Out Of Service)
Supervisor Mode Switch (Supervisor Entry, Supervisor Exit)
Option digits, allowing the previous mode to be entered on
return from the current mode
Suspend conditions being detected by the Customisation Layer
Communications errors
UPS signals.
Advance NDC will only enter modes based on valid transitions
from the current mode. For example, it is only possible to enter
Supervisor mode if the mode switch is moved to the Supervisor
position and the SST is idle, or the SST is Out of Service awaiting a
message.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-16
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Application Core
The following sections summarise the functionality of each of the
modes. For more information about synchronising the
Customisation Layer and Application Core, see “Synchronising with
the Customisation Layer” on page 7-18. For more information about
mode and message handling, see “Mode Handling” on page 7-19
and “Message Handling” on page 7-21.
In Service Mode In Service Mode is authored as a Director, with
subworkers sequenced to perform the required functionality. This
worker and its subworkers perform the following:


7
Correct handling of messages received with respect to mode of
operation
Synchronisation with Customisation Layer cardholder session
activities.
Transitions can be made to the Supervisor Mode, Out Of Service
Mode, and Offline Mode work groups.
Out Of Service Mode The Out Of Service Mode is authored as a
Director, with subworkers sequenced to perform the required
functionality. This worker and its subworkers perform the correct
handling of messages received with respect to mode of operation.
7
Transitions are valid to the Supervisor Mode, Offline Mode and In
Service Mode work groups.
Offline Mode The Offline Mode is authored as a Director, with
subworkers sequenced to perform the required functionality for
Offline Mode. This worker and its subworkers return to correct
mode when communications are restored.
7
Transitions are valid to the Supervisor Mode, In Service Mode and
Out of Service Mode work groups.
Supervisor Mode This work group contains subworkers to
execute the Supervisor Mode of Advance NDC.
7
Supervisor mode is implemented in the same way as for NDC+ and
includes the following functionality:




Activation of correct interface on entry to Supervisor Mode
Correct handling of messages received with respect to mode of
operation
Execution of operator selected Supervisor functions
Return to correct mode on exit from Supervisor Mode.
Transitions are valid to the Out Of Service Mode, Offline Mode and
In Service Mode work groups.
For full details of Supervisor Mode, refer to the APTRA Advance
NDC, Supervisor’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-17
Introducing the Advance NDC Authored Applications
Application Core
Application Core Catalog
User Controls Catalog
User Stores and Signals
Catalog
7
7
7
This catalog contains Advance NDC workers specific to the
Application Core.
This catalog contains the default versions of the ‘User Messages’
and ‘User Terminal Data’ directors used in the Application Core.
This catalog contains the stores and signals (that is, Store workers
and Integer Signaller workers) that you are likely to need when
updating User Messages or User Terminal Data. These stores and signals
should be shared from this catalog when using them in the authored
flow.
For details of the stores, see Appendix B, “Advance NDC Workers
Supplied”.
The values of the signals are important and must be maintained.
Table 7-2
Signal Values
Synchronising with the
Customisation Layer
7
Signal
Value
When should you use this signal?
Ready9
1
To return a Ready9 terminal state message.
Applies only to User Messages.
Reject
2
To return a Command Reject.
Applies to both the User Messages and User
Terminal Data.
Send Terminal
State
3
After setting up the Status Info CDI store with
the terminal state message, use this signal to
send the message.
Applies only to User Messages.
Processing
Complete
4
To signal that no reply is to be sent to a new
message (class or terminal command) received
from Central.
Typically used when storing a terminal
command.
Applies only to User Messages.
Send Message
5
To send a new message to Central, in response
to receiving a new message class.
Applies only to User Messages.
TC Processing
Complete
1
To send the terminal state message. Any
additional data will have already been added
to the message.
Applies only to User Terminal Data.
When the Application Core activates the Customisation Layer work
group, the Cardholder Session Application Link is activated. A
Session Releaser worker is used at various points to allow the
Application Core to regain control at appropriate times.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-18
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Application Core
Session Releaser
7
When the session is idle and awaiting card entry or in Suspend
mode, the Application Core can stop the current cardholder session
while the Session Releaser worker in the Customisation Layer is
active. In this case, the SST appears Out Of Service to the cardholder
until the Customisation Layer can be activated again.
The Session Releaser signals only when the Customisation Layer is
stopped by the Application Core if a mode change occurs (Mode
switch, OOS, Off-line and so on).
Checking the Status of the Customisation Layer
7
The Application Core can query the status of the Customisation
Layer during a cardholder session by accessing a CDI Store worker
called Customisation Layer Status, found in the 'CDI - Transaction
Processing Flags' catalog. This is used to determine if further
message processing can take place at various stages in the
application execution. This status information is not available to the
Customisation Layer directly as it is updated internally by Session
Releaser workers.
The table below shows the possible status values of the
Customisation Layer.
Table 7-3
Customisation Layer Status Values
Mode Handling
7
Status
Description
WAITING
Waiting for a Request to be granted.
IDLE
Waiting for a cardholder session to be initiated. The
Session Releaser worker is now active, allowing
control to be given up by the Customisation Layer.
PROCESSING
Actually performing a cardholder session.
TRANSACTION
Within the Transaction Request State; that is,
expecting a Transaction Reply or Interactive
Transaction Response (ITR) message. This value is
set by the Transaction Handler after a Transaction
Request has been sent to Central. It will be set to
PROCESSING when the Transaction Handler
completes.
The functionality that handles the changing of modes is called the
‘Mode Handler’. The information provided in this section is for
information only. Do not modify the Mode Handler.
The way in which the Application Core transitions between modes
reflects the way in which NDC+ worked. Mode changes only occur
at specific points in the application, and the way in which a mode
change is initiated is similar for each mode.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-19
Introducing the Advance NDC Authored Applications
Application Core
Caller and Listener pairs are used to detect mode changes. The
mode to change to is assigned to the Mode Store and then the Mode
Changed Caller is activated. The Mode Changed Listener (below) is
concurrent with all activities in the current mode and so will signal
when the Mode Changed Caller is activated.
To display the following view from the Mode Handler, double-click
Out Of Service | Out of Service (in OOS Mode) | Handle Messages..
(in OOS Mode) | Message Handler..| Check for Supervisor..(in
Receive Message) | Set Supervisor.. then Assign Return.. and Current
Mode...
Figure 7-9
Mode Handling
To display the following view from the Mode Handler, double-click
Out Of Service | OOS Mode Change.
Figure 7-10
OOS Mode Change
The Validate Change work group contains Testers to check whether
the current mode change is valid. If it is, a Tester will signal and a
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-20
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Application Core
mode change will occur. Otherwise, no mode change occurs and the
Listener is activated to listen for another mode change. This
mechanism is used in each mode, allowing the exit to another mode
to be initiated from a single exit point.
When a valid mode change is called, all operations in the current
mode will be stopped and a mode change will occur. It is important
that a mode change should only be called when it is safe to do so. If
a mode change has to be delayed until an operation has finished, the
operation should be synchronised with the mode change. This will
ensure that the operation finishes before the current mode exits.
Note: Do not modify the Mode Handler functionality. To prevent
you from accidentally modifying the Mode Handler functionality,
its workers have been assigned to a different module from those
parts of the application you can modify. You can, however, view the
mode changes. A Mode Change Hook is called every time a mode
change occurs. There are eight Mode Change Hooks, one for each
mode.
Message Handling
7
Message handling occurs in each of the modes (except for the
Offline Mode). Message handling involves receiving a message,
processing it and then sending a response (a Ready9, Reject or
Terminal State message) to the message. The messages that can be
accepted in each mode are clearly defined and are therefore easily
processed within each mode. Any message received from Central is
processed based on the message class and current operating mode.
Message handling has been authored to allow you to extend the SST
to Central message interface to process new Message Classes and
add additional data to Terminal State messages.
To display the following view from the Mode Handler, double-click
Out Of Service | Out of Service | Handle Messages..| Message
Handler...
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-21
Introducing the Advance NDC Authored Applications
Application Core
Figure 7-11
Message Handling
The Message Handler director handles any incoming messages received
from Central. It contains the following work groups:




Process Pending TCs? - checks for pending Terminal
Commands stored in Supervisor and stores the pending
commands in the Host Message CDI store
Message Processing - processes messages from Central and
sends appropriate replies. This functionality is discussed in
more detail in the following section
Process Pending EJ - checks for pending EJ upload requests
stored in Supervisor and stores pending EJ uploads in the Host
Message CDI store
Receive Message - awaits an incoming message, while checking
for the mode switch being moved to the Supervisor position
Message Processing Director
The Message Processing Director processes messages from Central and
sends appropriate replies. It contains the following main work
groups:




Process Message - for the particular mode; the next section
discusses the work group for Out-of-Service (OOS) Messages as
an example
Ready 9/B - sends a Ready9/B message to Central
Mode Change? - checks if a mode change is required. If no
change is required, the flow goes on to wait for the next message
to be received in this mode
Send Reject - builds and sends a Command Reject or Specific
Command Reject Solicited Status Response message to Central,
and prints on the journal
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-22
APTRA Advance NDC, Developer’s Guide
7
Introducing the Advance NDC Authored Applications
Application Core



Send Terminal - builds and sends a Terminal State Solicited
Status Response message to Central
Send EJ Upload - checks whether the electronic journal is
enabled and assesses the impact of the request before uploading
to Central
Send EID Message - builds and sends an Encryptor Initialisation
message to Central.
Note that the Message Processing Director is ‘shared’ in two work
groups. The first occurrence processes any pending Terminal
Commands, and the second processes other messages received until
the mode is exited.
Process Message The following diagram shows a view of the
Process Message workers for OOS Messages.
7
Figure 7-12
Process Message
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-23
Introducing the Advance NDC Authored Applications
Application Core
The message is processed by the appropriate work group as follows:





Message Handler
7
Message Handler processes messages received from Central. For
details, see “Message Handler” on page 7-24.
Ready9, Send Reject or Send Terminal.. Pass-thru workers - when a
Ready9, Reject or Terminal State message is to be sent to Central,
a signal is sent from the Message Handler
Mode Change? - work group that sets the values for the required
mode and sends a signal for a Ready9 message to be sent to
Central
Send EJ Upload or Send EID Msg. Pass-thru workers - when the EJ
upload or an Encryptor Initialisation message is to be sent to
Central, a signal is sent from the Message Handler
Continue Pass-thru worker - this signal is required for situations
where the Message Handler is not sending a reply to a message (for
example, exit execution).
The Message Handler functionality processes the following
messages from Central:



Terminal Commands
Customisation Data Commands
Transaction Replies.
This section describes how the Message Handler processes these
messages.
Terminal Command Processing
7
Terminal Commands (Message Class 1) in Advance NDC are
processed based on the command code of the received message. The
range for the command code is 1 to '?' (ASCII 0x30 to 0x3F). Any
other command code outside this range is processed by the User
Messages director.
The table below shows how the Application Core responds to
Terminal Command messages, depending on the current mode. The
subsequent table defines the abbreviations used.
Table 7-4
Application Core Terminal Command
Responses
Command
Power Up
Out of Service
Supervisor
In Service
Suspend
Go In Service
P1
A1
A2
A
S
Go Out of Service
P1
A
A2
A3
A
Config. ID Request
P1
C
C
C
C
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-24
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Application Core
Command
Power Up
Out of Service
Supervisor
In Service
Suspend
Config. Info. Request. See Note 1:
P1
D
D
D
D
Counters Request
P1
D
P
R
R
Tallies Request
P1
D
P
R
R
Error Log Request
P1
D
P
R
R
Date/Time Request
P1
D
P
R
R
EKC Retrieve Hallmark Key. See Note 2:
P1
D
P
R
R
FREE JDATA Enable. See Note 2:
P1
A
A
R
R
Enable Image Dumping. See Note 2:
P1
A
A
A
A
Note 1: The information returned by a Config. Info. Request
depends on the Command Modifier that is used.
Note 2: These commands are not supported in Advance NDC.
Table 7-5
Application Core Response Definitions
Ref.
Response Description
A
Response is Ready 9 status.
A1
Change Mode to In Service. Response is Ready 9 status.
A2
Hold until Supervisor mode exited, then process. Response is
Ready 9 status. (If more than one command is received while in
Supervisor mode, only the last is recognised. The others are
dropped and no response is given.)
A3
Mode change to Out of Service when terminal is idle at the Card
Read State. Response is Ready 9 status.
C
Response is a Terminal State Message containing the Config ID.
D
Response is a Terminal State Message containing the requested
information.
P
Hold until Supervisor mode exited and then process according to
mode entered.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-25
Introducing the Advance NDC Authored Applications
Application Core
Ref.
Response Description
P1
Hold until Power Up mode exited and then process according to
mode entered. No check is made for pending messages on entry
to Supervisor or Offline modes, so the message will only be
processed on entry to Out of Service mode (unless overwritten by
a new request received in Supervisor mode).
R
Response is Command Reject or Specific Command Reject. In
order to use these requests the terminal should be put Out of
Service. This is to avoid the information being updated by card
holder activity while the messages are being created.
S
Hold until Suspend Mode exited and then process. Response is
Ready 9 status.
While in service, all Terminal Commands, (except for Config ID
requests) are held until the terminal is idle, and then processed.
Commands are not stacked and a new request overrides the
previous request to which no response is sent.
User Messages and User Terminal Data When the Message
Handler receives either an unknown message class or a request for
specific terminal state information, it sends a signal to activate the
appropriate User work group. This enables you to process new
Message Classes and add to existing Terminal State messages.
Customisation Data Processing
Customisation Data commands (Message Class 3, Sub-class 1 or 3)
are processed in a similar way to Terminal Commands. The
commands are only accepted while the SST is Out Of Service or in
Supervisor mode.
Messages with sub-class 2 are interactive transaction response (ITR)
messages. These are accepted by the terminal only in response to a
Transaction Request message, in order to obtain additional
information during a cardholder session. An ITR message received
while the terminal is in In Service mode and the Custom Layer
Status is TRANSACTION, is processed by a Transaction Handler.
The response will normally be another Transaction Request
message. Otherwise, the message is rejected (Specific Reject
Status/Qualifier ‘C04’). An ITR message received in Out of Service
or Supervisor Mode will be rejected (Specific Reject Status/Qualifier
‘C03’).
The table below shows how the Application Core responds to
Customisation Data Commands depending on the current mode.
The subsequent table defines the abbreviations used.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-26
APTRA Advance NDC, Developer’s Guide
7
7
Introducing the Advance NDC Authored Applications
Application Core
Table 7-6
Application Core Customisation Data
Command Responses
Command
Power Up
Out of Service
Supervisor
In Service
Suspend
State Table Load
-
A
A
R
R
Screen/Keyboard Data Load
-
A
A
R
R
Config. Params Load
-
A
A
R
R
FIT Data Load
-
A
A
R
R
Encryption Key Change
-
A
A
A
R
Extended Encryption Key Change
-
A
A
A
R
Config ID Number Load
-
A
A
R
R
Enh. Config. Params Load
-
A
A
R
R
Diebold PIN Info Load
-
A
A
R
R
Date and Time Load
-
A
A
R
R
MAC Field Selection Load
-
A
A
R
R
Dispenser Currency Cassette Mapping Table
-
A
A
R
R
Override Reserved Screen
-
A
A
R
R
Interactive Transaction Response
-
R
R
A1
A1
Table 7-7
Application Core Response Definitions
Ref.
Response Description
A
Accept for processing. Response is Ready 9 status.
A1
Accept for processing. Response is Transaction Request if the
Custom Layer status is 'Transaction', otherwise it is a Command
Reject or Specific Command Reject.
R
Response is Command Reject or Specific Command Reject. In
order to use these requests the terminal should be put Out of
Service.
Transaction Reply Command Processing
7
Transaction Reply (Message Class 4) handling relies heavily on the
processing carried out in the Customisation Layer and should not
be altered. The complete Transaction Request/Reply mechanism is
encompassed within Transaction Handler workers to protect the
ordering of messages and their content from being erroneously
changed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-27
Introducing the Advance NDC Authored Applications
Application Core
The first table below shows how the Application Core responds to
Transaction Reply Commands depending on the current mode. The
subsequent table defines the abbreviations used.
Table 7-8
Application Core Transaction Reply
Command Response
Command
Power Up
Out of Service
Supervisor
In Service (Tran. Req. State)
In Service (not Tran. Req. State)
Suspend
Print
Immediate
-
A
A1
A
R
R
Other
-
R
R
A
R
R
Table 7-9
Application Core Response Definitions
Ref.
Response Description
A
Accept for processing. If completed successfully, response is
Ready 9 or Ready B status. If a device error occurs, response is a
device fault Solicited Status. If there is a message format error,
response is Command Reject or Specific Command Reject.
A1
If mode was entered from Out of Service, hold until Supervisor
mode exited (i.e. Out of Service mode re-entered), then process
as A. Otherwise, the response is Command Reject or Specific
Command Reject.
If more than one command is received while in Supervisor
mode, only the last is recognised. The others are dropped, and
no response is given.
R
Response is Command Reject or Specific Command Reject.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-28
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Supervisor Mode
Supervisor Mode
7
In Advance NDC 2.05, the Supervisor mode functions were moved
from the Application Core to a separate APTRA Author project
called Supervisor.mpj. The Application Core was thus reduced in
size, improving the performance of the Completeness Check and
Build Final operations.
From Advance NDC 3.03, Supervisor is an application DLL, driven
by the Application Core. When Supervisor Mode is activated, the
Application Core gives control to the Supervisor DLL.
Supervisor Common Data Interface (CDI) stores are listed in the
“Supervisor” section in Appendix C, “Common Data Interface
Stores”. Shared stores are listed under heading “Shared Stores” on
page 7-34.
The next sections of this chapter should be read in conjunction with
the following project files:


Supervisor.mpj
ApplicationCore.mpj
These files are in <global>\final\support\user.
By browsing the application in the Author at the same time as
reading this section, you will make the most of the information. You
can also browse the Worker Class Help by right-clicking on any
worker and selecting Help.
The following diagrams are for illustration purposes only; you will
gain a more complete and up-to-date understanding of the
provided Application Core and Supervisor projects by browsing
through them yourself.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-29
Introducing the Advance NDC Authored Applications
Supervisor Mode
Handle Switch Work
Group
The following diagram illustrates the Handle Switch work group in
the Application Core.
7
Open the ApplicationCore.mpj project in the Author, then select
Advance NDC | Initialise Mode | Handle Switch.
Figure 7-13
Application Core Handle Switch
The Application Core activates a Supervisor session.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-30
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Supervisor Mode
Activating the Supervisor
Application
7
The following diagram illustrates how the Supervisor Application is
activated from the Application Core (App Core | Mode Handler |
Supervisor | Supervisor Mode).
Figure 7-14
Activating the Supervisor Application
In activation of the Supervisor Application, notice that:



Supervisor Project
7
Voice guidance is checked and enabled and then enter
Supervisor Mode is entered
Message and Diagnostics handling are started concurrently with
Supervisor Session
The Diagnostics Handler waits for diagnostics to be selected in
the Supervisor before acquiring diagnostics and releasing the
consumer resource. When diagnostics are complete, the
diagnostics are released and the consumer resource is
re-acquired.
The following diagram illustrates the Supervisor Application
authored project.
Open the Supervisor.mpj project in the Author, and then a view of
the Supervisor Application.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-31
Introducing the Advance NDC Authored Applications
Supervisor Mode
Figure 7-15
Supervisor Project
In the Supervisor Application authored project, notice that:



The Supervisor Application acknowledges to the Application
Core that it has started, using a Caller
The Supervisor then performs any required initialisation, such
as setting up communications, and initialising CDI stores
On Supervisor entry, Supervisor Mode is executed (see the
following Supervisor Mode Start-Up sub-section).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-32
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Supervisor Mode
Supervisor Mode Start-Up
7
The following diagram illustrates the Menu Control in Supervisor
Mode Start-Up:
Figure 7-16
Supervisor Mode Start-Up
In Menu Control, notice that:



No message handling is performed
Mode monitoring is performed here.
The Mini Self-Service Assistant (referred to as MAST) is run
here, providing access to vendor-dependent mode (VDM)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-33
Introducing the Advance NDC Authored Applications
Supervisor Mode
Shared Stores
7
To enable data to be shared between the Application Core and the
Supervisor application, the following stores are shared stores:
Table 7-10
Shared Stores
Previous
Store Type
Previous
Worker ID
Current
Store Type
Current
Worker ID
Current
Shared/CDI Store
Do Not Reset Comms
Flag
Integer Store
2r2738r24
Sharable
Integer Store
6n2299dc125
Shared
Supervisor Boot
Integer Store
5r2301r22
Sharable
Integer Store
18n2299dc125
Shared
Offline Return Mode
Integer Store
5s846g101
Sharable
Integer Store
20n2299dc125
Shared
Message Processing Flag
(renamed Supervisor
Message Processing Flag)
Integer Store
2p8d1
Sharable
Integer Store
4r633ichl21
Shared
Supervisor Entry
Message (pending)
Integer Store
0n622dc4
Common Data
String Store
28r633ichl21
CDI
Supervisor Exit Message
(pending)
Integer Store
5n578dc4
Common Data
String Store
31r633ichl21
CDI
Store Name
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-34
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Testing the Advance NDC Application
Testing the Advance NDC
Application
7
Advance NDC in conjunction with the XFS Simulator allows
authored applications to be run in a simulated development
environment.
If you have the XFS Simulator installed, you can use it for testing on
a development PC. For example, if you want to run a test
application for the Customisation Layer from the
CustomisationLayer.mpj Author project, you can run the Application
Core, which runs the Customisation Layer and Supervisor
applications as DLLs.
You need to configure all the SST devices you want to simulate on
the PC. For details of configuring the communications connection,
see “Simulating Communications” on page 7-44.
Advance NDC applications can be run on a development PC in two
ways:


Running from within the Author using the Start command on an
application icon is called “running in the Author environment”.
The Author application controls the application context such as
path and exception handling.
Starting the applications from Windows Explorer or a command
prompt is called “running in the PC environment”. The
application runs in the context of the development PC,
including path and exception handling.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Developer’s Guide
7-35
Introducing the Advance NDC Authored Applications
Testing the Advance NDC Application
Figure 7-17
Advance NDC Test Environment Directory
Structure
There are two important environment variables:
Running in the PC
Environment
7
%MAPS_GLOBAL%
The directory where the development environment
is installed. This is set by the installer. The default is
\NTGlobal.
%ANDC_PATH%
The directory where the runtime application is
loaded when an application is executed outside the
author environment. The default is
%MAPS_GLOBAL%\final\XFS\dll.
This is embedded in the PATH environment
variable by the development environment installer.
In the PC environment, the applications can be run from Windows
Explorer or a command prompt. By default, the application
windows are full size and cannot be resized. To run the applications
in a smaller resizable window, create a system environment variable
APTRA_FINAL_RUNTEST=1. This will start the applications in a
smaller window and all NDC screen displays will be drawn in the
top left corner of the screen independently of the applications.
The DLL path used is %MAPS_GLOBAL%\final\XFS\Dll
Running in the Author
Environment
7
Testing within the Authored environment allows developers to ‘see’
the flow of execution of an application while developing it. The
Authored environment also gives extended error information and
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-36
APTRA Advance NDC, Developer’s Guide
Introducing the Advance NDC Authored Applications
Testing the Advance NDC Application
access to help. The application windows can be resized to allow
easier access to other applications on the desktop. The Supervisor
project is too large to run in the Author environment but
Customisation Layer state ty