b66180 Reference Manual
Uploaded by
Mbachi Silungweb66180 Reference Manual
Uploaded by
Mbachi SilungweAPTRA™ Advance NDC
Reference Manual
B006‐6180‐R000
Issue 1
October 2015
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 SelfServ are trademarks of NCR Corporation.
Microsoft, Windows and ActiveX are registered trademarks of Microsoft Corporation in the United States and/or other
countries.
Adobe and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States
and/or other countries.
All other brand or product names are trademarks or registered trademarks of their respective companies or organisations.
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 © 2000 ‐ 2015
Product Management Feedback By NCR Corporation
Discovery Centre Duluth, Georgia U.S.A.
3 Fulton Road All Rights Reserved
Dundee, Scotland
DD2 4SW
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Federal Communications Commission (FCC) Radio Frequency Interference Statement
Federal Communications
Commission (FCC) Radio Frequency
Interference Statement
Note: This equipment has been tested and found to comply with
the limits for a Class A digital device, pursuant to Part 15 of the
FCC Rules. These limits are designed to provide reasonable
protection against harmful interference when the equipment is
operated in a commercial environment. This equipment
generates, uses, and can radiate radio frequency energy and, if not
installed and used in accordance with the instruction manual,
may cause harmful interference to radio communications.
Operation of this equipment in a residential area is likely to cause
harmful interference in which case the user will be required to
correct the interference at his own expense.
This digital apparatus does not exceed the Class A limits for radio
Canadian Class A Device noise emissions from digital apparatus set out in the Radio
Declaration Interference Regulations of the Canadian Department of
Communications.
Le présent appareil numérique n’émet pas de bruits
radioélectriques dépassant les limites applicables aux appareils
numériques de la classe A prescrites dans le Réglement sur le
brouillage radioélectrique édicté par le ministère des
Communications du Canada.
This equipment must be installed and used in strict accordance with
Information to User 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.
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
unauthorized modifications, substitutions, or attachments may void
the user’s authority to operate the equipment. The correction of
interference caused by such unauthorized 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, Reference Manual iii
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
iv APTRA™ Advance NDC, Reference Manual
Revision Record
Revision Record
Date Page Description of Change
October New revision for Advance NDC 4.04
2015
xlvi Added abbreviation for the new device BRM ‐
Bunch Recycling Module.
2‐8, 2‐75, Added information about support for contactless
2‐156 & 12‐3 smart card readers in Card Read State A, Card
Read State T and Insert Card Read State z008.
Updated the read conditions for smart card
readers.
2‐7, 2‐69 & Added information about Prepare Dispense
2‐191 feature in Card Read State A and Card Read ‐ Pin
Entry Initiation State T.
Added a section for state z024 ‐ Prepare Dispense
State.
2‐12 Updated Card Read State with tap error screen
and dictionary of failure reasons.
2‐26 & 2‐62 Updated information about triple zero key on
pinpad in Amount Entry State and Enhanced
Amount Entry State.
2‐69, 2‐74 & Added smart delay functionality for smart dip
2‐161 card readers.
2‐107, 2‐119, Added information on setting deposit limit for
2‐124 & state based and transaction reply.
10‐67
2‐189 Added a section for state z021 ‐ CRM Flowpoint
state for use with CRM applications.
3‐45 Added information about the supported codecs.
3‐33 Updated information that more than 999 pictures
can be defined for picture control.
3‐48 Added information that a nested screen specified
is adjusted for a language with group size greater
or equal to 1000.
9‐19 Updated transaction request for contactless EMV.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual v
Date Page Description of Change
9‐30, 9‐83, Updated table to include encryption key errors.
9‐87, 10‐41 Updated the Encryptor Initialisation Data
& 10‐45 Response table to include new information
identifiers that are added for TR31 symmetric key
mechanism and TR34 certificate.
9‐39 & 9‐50 Added information about the product classes that
are supported from this release.
9‐45 & E‐10 Updated table to include that variant 04 and 05
are reported for BRM.
9‐65 & E‐27 Added information in terminal commands to
support contactless EMV.
9‐40, 9‐46 & Added hardware configuration data for
E‐3 contactless card readers.
9‐138 Added unsolicited status message reporting for
contactless card reader configuration failure.
9‐125 Added information about the message, which is
reported when notes are captured as part of the
automatic error recovery in the Close state.
9‐139 & UpdatedM‐Status for Card Reader Failure table
A‐16 for contactless card reader reset, and added
Added Error Screens for 24‐volt reset for
contactless reader.
9‐139 & Updated M‐Status for Card Reader Failure table
A‐16 for contactless card reader reset, and added
Added Error Screens for Firmware Mismatch.
11‐3 Amened information for other vendors’ EPPs.
A‐15 Added a row for the cassette 5 error screen.
A‐16 & A‐26Added Error Screen, Supervisor Menu and
Supervisor and Journal Miscellaneous Screens for
contactless reader.
A‐52 Added new screens that display the media status
for multiple retract bins
A‐69 Added information about the new screen for
reporting an unsolicited message when notes are
retracted as part of automatic error recovery in
the Close state.
A‐69 Added information about the reserved screens
that are used when serial number read fails for
counterfeit, suspect and good notes
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
vi APTRA™ Advance NDC, Reference Manual
Date Page Description of Change
A‐95 Added information about new screens for reject
and retract bin.
A‐98 Amended information of the journal screens for
displaying total retracted and rejected counts in
the screens.
A‐101 dded new screens for Supervisor and Journal
Miscellaneous screens.
A‐101 Added information about the new journal screens
for clearing a cash‐in error through Test Cash
option and cash‐out error through Init BNA
option.
E‐19 Amended information about the number of
physical cassettes and retract bins supported.
E‐25 Added information about fitness data for multiple
retract bins, a reject and counterfeit bin.
E‐31 Added table notes on limitations for Tamper
Indicators on a BRM device.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual vii
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
viii APTRA™ Advance NDC, Reference Manual
Table of Contents
Contents
Preface
Purpose and Audience ..........................................................................xli
Audience ...........................................................................................xli
How to Use This Publication ...............................................................xlii
Contents of the Publication ...........................................................xlii
Roadmap to the Publication .........................................................xliv
Navigating the Publication............................................................xlv
Terms and Abbreviations Used in the Publication ....................xlv
What Else Should I Read?........................................................... xlvii
Support Information ......................................................................... xlviii
Chapter 1
Introducing the Advance NDC System
Overview ................................................................................................1‐1
SST Start‐Up Sequence..........................................................................1‐2
In‐Service Transaction Processing................................................1‐3
Customisation Data...............................................................................1‐4
Role of the Central Control Application ............................................1‐5
Chapter 2
State Tables
Overview ................................................................................................2‐1
Introduction to State Tables .................................................................2‐2
Invalid State Handling ...................................................................2‐2
Customising States..........................................................................2‐2
Unsupported State Types ..............................................................2‐2
Advance NDC States ......................................................................2‐3
Reserved States................................................................................2‐3
Exit States .........................................................................................2‐3
Standard State Types......................................................................2‐3
State Numbers .................................................................................2‐5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC Reference Manual ix
Table of Contents
Screen Numbers ..............................................................................2‐5
Extension States...............................................................................2‐6
A ‐ Card Read State ...............................................................................2‐7
Card Read State and Multiple Card Readers..............................2‐9
Defining Dynamic Text for Contactless Tap Error...................2‐13
Read Condition Values ................................................................2‐13
B ‐ PIN Entry State...............................................................................2‐16
C ‐ Envelope Dispenser State.............................................................2‐19
D ‐ Pre‐Set Operation Code Buffer State ..........................................2‐20
E ‐ Four FDK Selection Function State .............................................2‐23
F ‐ Amount Entry State .......................................................................2‐25
Voice‐Guided Sessions and Data Entry .....................................2‐25
State Processing.............................................................................2‐25
Buffer Clearing and AppendBuffer.xml ........................................2‐25
Triple Zero Key on PINpad .........................................................2‐26
Touch‐Screen Emulation..............................................................2‐26
G ‐ Amount Check State .....................................................................2‐29
H ‐ Information Entry State................................................................2‐34
Data Entry ......................................................................................2‐34
Exiting the Information Entry State ...........................................2‐34
Clear Function Key and General‐Purpose Buffers...................2‐35
I ‐ Transaction Request State..............................................................2‐39
J ‐ Close State ........................................................................................2‐45
Function Operations .....................................................................2‐45
K ‐ FIT Switch State .............................................................................2‐52
_ ‐ Expanded FIT Switch State ...........................................................2‐53
L ‐ Card Write State.............................................................................2‐55
M ‐ Enhanced PIN Entry State...........................................................2‐57
N ‐ Camera Control State ...................................................................2‐60
R ‐ Enhanced Amount Entry State ....................................................2‐62
Data Handling ...............................................................................2‐62
Exiting the Enhanced Amount Entry State ...............................2‐63
S ‐ Language Code Switch State ........................................................2‐65
T ‐ Card Read ‐ PIN Entry Initiation State .......................................2‐68
PIN Entry Enabled ........................................................................2‐69
PIN Entry Disabled.......................................................................2‐69
Audio Support...............................................................................2‐69
Smart Dip Card Reader ................................................................2‐69
Card Read, PIN Entry and Multiple Card Readers .................2‐71
U – Device Fitness Flow Select State.................................................2‐76
Supported Devices ........................................................................2‐78
V ‐ Language Select From Card State ...............................................2‐82
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
x APTRA™ Advance NDC Reference Manual
Table of Contents
W ‐ FDK Switch State..........................................................................2‐84
X ‐ FDK Information Entry State .......................................................2‐85
Y ‐ Eight FDK Selection Function State ............................................2‐88
Language Selection in Voice‐Guided Sessions .........................2‐88
b ‐ Customer‐Selectable PIN State ....................................................2‐93
d ... g and z ‐ Exit States......................................................................2‐96
k ‐ Smart FIT Check State ...................................................................2‐97
m ‐ PIN & Language Select State.......................................................2‐98
Considerations for Voice‐Guided Sessions ...............................2‐99
> ‐ Cash Accept State.........................................................................2‐105
Cash Accept State Operations ...................................................2‐105
Pre‐authorised Deposit Limits ..................................................2‐106
Auto‐Finish Cash Accept ...........................................................2‐107
Confirmation Screen...................................................................2‐120
Dynamic Text Definitions..........................................................2‐124
w ‐ Cheque Accept State...................................................................2‐125
z – Master Expansion State ..............................................................2‐132
z001 – Bunch Cheque Accept State .................................................2‐133
Defining Dynamic Text for Cheque Rejection ........................2‐138
Defining Dynamic Text for Cheque Refusal ...........................2‐138
z002 – Bunch Cheque Handling State ............................................2‐140
z003 – Cheque Detail Display State ................................................2‐144
Defining Dynamic Data for Cheque Deposit Status ..............2‐149
z004 – Display Cheque Summary State..........................................2‐150
Current Cheque Index................................................................2‐151
z008 – Insert Card State ....................................................................2‐156
Insert Card State and Multiple Card Readers.........................2‐156
Unsupported Functions .............................................................2‐157
z009 – Buffer Validation State..........................................................2‐163
Date Validation Scenario ...........................................................2‐164
z010 – Local Cash Dispense State....................................................2‐166
Cardless Transactions.................................................................2‐166
Dispense Functionality...............................................................2‐166
Foreign Currency Exchange Transactions...............................2‐166
State Flow after a Successful Dispense ....................................2‐166
State Flow after a Short Dispense .............................................2‐167
State Flow after a Failed Dispense............................................2‐167
State Flow after an Unknown Dispense ..................................2‐168
State Flow on Card Ejection ......................................................2‐168
State Operation............................................................................2‐168
Message Handling ......................................................................2‐170
z013 – Data Copy and Compare State ............................................2‐173
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC Reference Manual xi
Table of Contents
Copy Operations .........................................................................2‐175
Compare Operations ..................................................................2‐176
z014 – Cash Deposit Handling State...............................................2‐177
z017‐ Note Mix Selection State ........................................................2‐180
z020 ‐ FIT Search State ......................................................................2‐187
FIT Search State Exit ...................................................................2‐187
z021 ‐ CRM Flowpoint State.............................................................2‐189
CRM Flowpoint State .................................................................2‐189
z024 ‐ Prepare Dispense State ..........................................................2‐191
& ‐ Barcode Read State......................................................................2‐192
Barcode Extraction Rules ...........................................................2‐197
Time‐Out State ...................................................................................2‐201
Chapter 3
Screen Data
Overview ................................................................................................3‐1
The Screen Interface ..............................................................................3‐2
Customer Screens............................................................................3‐2
Reserved Screens.............................................................................3‐4
Types of Reserved Screen.....................................................................3‐5
C – Cardholder Display .................................................................3‐6
G – Graphic Pictures.......................................................................3‐8
K – Extended Screen Controls.......................................................3‐8
L – Logos ........................................................................................3‐12
M – Supervisor Menus .................................................................3‐12
Editing the Contents of Reserved Screens.................................3‐13
Formatting Rules for Cardholder Display Screens.........................3‐14
Cardholder Screen: Display Characters.....................................3‐14
Operator Interface Display Characters ......................................3‐15
Control Characters ........................................................................3‐16
Track 1 Name Display ..................................................................3‐18
Control Codes for Special Features ............................................3‐20
International Currency Display Format ....................................3‐45
Multi‐Language Screens .....................................................................3‐48
Multi‐Language Screen Numbering ..........................................3‐48
Redefining Reserved Screens ......................................................3‐51
Displaying Pictures .............................................................................3‐52
Picture Resolution .........................................................................3‐52
Guidelines for Pictures.................................................................3‐52
Screen Reset ..........................................................................................3‐53
Supervisor Settlement Screens...........................................................3‐54
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xii APTRA™ Advance NDC Reference Manual
Table of Contents
Using the Front or Rear Interface for Settlement .....................3‐54
Supervisor Settlement Transactions...........................................3‐55
Transactions Parameter Screens (C09–C19) ..............................3‐56
Chapter 4
Keyboard Data and Layouts
Overview ................................................................................................4‐1
The Keyboard Interface ........................................................................4‐2
Physical Keyboards ........................................................................4‐2
Touch Screen Keyboards ...............................................................4‐2
Associating Screens and Keyboards for FDKs ...........................4‐4
Keyboard Mapping Examples ......................................................4‐6
States and Keyboards............................................................................4‐8
Associated Keyboards for FDKs ...................................................4‐9
Secure PIN Entry and Keyboards.................................................4‐9
Keyboards in Operation.................................................................4‐9
Standard Keyboard Layouts ..............................................................4‐10
Transaction Processing.................................................................4‐10
Front Interface: Supervisor Mode...............................................4‐12
Encryption Key Entry...................................................................4‐13
Secure Key Entry...........................................................................4‐13
Rear Interface: Operator Keyboard Layout...............................4‐14
Defining Full Touch Screens ..............................................................4‐16
Touch Areas ...................................................................................4‐16
Calculating Full Touch‐Screen Positions...................................4‐17
Chapter 5
Printer Data
Overview ................................................................................................5‐1
Printer Types Supported by Advance NDC......................................5‐2
PPD Default Print ..................................................................................5‐4
Eight‐Character Amount Buffer ...................................................5‐4
Twelve‐Character Amount Buffer................................................5‐5
Printer Control Characters ...................................................................5‐6
Enhanced Printer Control Codes..................................................5‐7
Character Sets.......................................................................................5‐20
Statement Printer Controls.................................................................5‐23
Left Margin Control......................................................................5‐23
Right Margin Control ...................................................................5‐23
Margin Control Use ......................................................................5‐24
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC Reference Manual xiii
Table of Contents
Lines Per Inch Control..................................................................5‐24
Simulated Pre‐printed Receipt Messages.........................................5‐25
Printing Images Using Screens ‘R00’ and ‘R01’........................5‐25
Other Uses of Screens ‘R00’ and ‘R01’ .......................................5‐26
Sideways Printing on Receipt ............................................................5‐29
Unsupported Functions ...............................................................5‐29
Printer Control Sequences and Registry Settings ...........................5‐30
Chapter 6
Supervisor Messages
Overview ................................................................................................6‐1
Supervisor Messages.............................................................................6‐2
Character Sets ..................................................................................6‐2
Control Codes..................................................................................6‐2
Screen Size Limitations ..................................................................6‐3
Cardholder Screen /Enhanced Operator Interface Layout .......6‐3
Printer Layout..................................................................................6‐4
Automatic Screen Editing ..............................................................6‐4
Media Status Messages ..................................................................6‐4
Test Cash Report .............................................................................6‐4
Chapter 7
Configuration Parameters
Overview ................................................................................................7‐1
Configuration Parameters Load Message..........................................7‐2
Camera Control (Field ‘h’) .............................................................7‐2
Supply Mode, Ready Status & Amount Buffer
Length (Field ‘m’) .........................................................................7‐2
Logical Unit Number – LUNO (Field ‘o’)....................................7‐3
Timer Number (Field ‘p’)...............................................................7‐3
Millisecond Ticks per Timer Field (Field ‘q’)..............................7‐4
Unsupported Parameters...............................................................7‐5
Reserved Parameters ......................................................................7‐5
Enhanced Configuration Parameters Load Message .......................7‐6
Option 00 – Camera Control..........................................................7‐6
Option 01 – Supply Mode, Ready Status, & Amount Buffer
Length.............................................................................................7‐6
Option 02 – Auto Voice ..................................................................7‐7
Option 03 – Date Format................................................................7‐7
Option 04 – Roll Width...................................................................7‐7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xiv APTRA™ Advance NDC Reference Manual
Table of Contents
Option 05 – Left Print Column......................................................7‐7
Option 07 – Track 1 Format ..........................................................7‐8
Option 12 – Specific Command Reject.........................................7‐8
Option 15 – Transaction Status Information ...............................7‐8
Option 16 – Journal Printer Backup Time ...................................7‐8
Option 17 – Journal Printer Backup Print Operations...............7‐8
Option 23 – Envelope Dispenser Status.......................................7‐9
Option 24 – Enhanced/TI Sensor Status Unsolicited
Message ..........................................................................................7‐9
Option 25 – Media Entry/Exit Indicators Flash Rate ...............7‐10
Option 27 – Remote Relay ...........................................................7‐10
Option 30 – Include PAN in DCS Data......................................7‐10
Option 32 – Unsolicited Reporting Control ..............................7‐10
Option 33 – Simulate Supervisor Mode Entry/Exit..................7‐11
Option 34 – MCN Range..............................................................7‐11
Option 35 – Report Dual Mode EJ & Hardcopy B/U
Unsolicited Messages .................................................................7‐13
Option 36 – Enhanced EJ Backup ...............................................7‐13
Option 37 – Print Track 2 to Journal...........................................7‐13
Option 41 – Send Track Details on Card Retract......................7‐14
Option 44 – BNA Journal Notes Count .....................................7‐14
Option 45 – BNA Settings ............................................................7‐15
Option 46 – MCRW Enhanced Card Device Security Jitter ....7‐17
Option 48 – Barcode Reader ........................................................7‐18
Option 69 – EMV Smart Card Extended Status........................7‐18
Option 70 – EMV Smart Card .....................................................7‐18
Option 71 – Time‐Out State Entry ..............................................7‐18
Option 74 – Destination for Cash Deposit Retract ...................7‐18
Option 76 – Cash Handlers..........................................................7‐19
Option 77 – Next State Number..................................................7‐19
Option 78 – GBRU M‐Status Reporting.....................................7‐20
Option 79 – Coin Dispenser.........................................................7‐21
Option 80 – Alphanumeric State Entry......................................7‐21
Option 83 – Cheque Processor ....................................................7‐21
Timer Number...............................................................................7‐22
Number of Seconds per Timer Field ..........................................7‐22
Unsupported Parameters.............................................................7‐22
Timers....................................................................................................7‐24
Time Units for Timers ..................................................................7‐24
Timer Descriptions .......................................................................7‐24
Reserved Timers............................................................................7‐29
Unsupported Timers ....................................................................7‐30
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC Reference Manual xv
Table of Contents
Chapter 8
Financial Institution Tables
Overview ................................................................................................8‐1
FIT Data...................................................................................................8‐2
FIT Message Fields..........................................................................8‐2
FIT Field Descriptions ....................................................................8‐3
Linked FITs...........................................................................................8‐12
Chapter 9
Terminal to Central Messages
Overview ................................................................................................9‐1
Transaction Request Messages ............................................................9‐2
Transaction Request Message Format .........................................9‐2
SST Reply to Interactive Transaction Response .......................9‐19
Message Format for Field bd2 in Transaction Request ...........9‐19
CAM Flags .....................................................................................9‐21
Solicited Status Messages ...................................................................9‐22
Content of Solicited Status Messages.........................................9‐22
Status Information ........................................................................9‐24
Solicited Device Fault Status..............................................................9‐78
Device Fault Status Responses ....................................................9‐78
Device Fault Status Information Field .......................................9‐79
Other Solicited Messages....................................................................9‐82
Encryptor Initialisation Data .......................................................9‐82
Upload EJ Data Message..............................................................9‐90
Unsolicited Status Messages ..............................................................9‐93
Conditions for Sending Unsolicited Messages .........................9‐93
Unsolicited Status Information Field .........................................9‐94
Device Status Information..................................................................9‐96
Time‐Of‐Day Clock (Unsolicited)...............................................9‐96
Power Failure (Unsolicited).........................................................9‐96
Card Reader/Writer (Solicited/Unsolicited)..............................9‐97
Cash Handler (Solicited/Unsolicited) ........................................9‐99
Depository (Solicited/Unsolicited) ...........................................9‐104
Receipt Printer (Solicited/Unsolicited).....................................9‐104
Journal Printer (Unsolicited) .....................................................9‐106
Electronic Journal Printer (Unsolicited)...................................9‐108
Night Safe Depository (Solicited/Unsolicited)........................9‐111
Encryptor (Unsolicited)..............................................................9‐112
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xvi APTRA™ Advance NDC Reference Manual
Table of Contents
Camera (Unsolicited)..................................................................9‐113
Sensors (Unsolicited) ..................................................................9‐114
Touch Screen Keyboard (Unsolicited) .....................................9‐116
Supervisor Keys (Unsolicited) ..................................................9‐117
Cardholder Display Alarm (Unsolicited)................................9‐119
Statement Printer (Solicited/Unsolicited) ................................9‐119
Voice Guidance (Unsolicited) ...................................................9‐121
Note Acceptor (Solicited/Unsolicited) .....................................9‐122
Envelope Dispenser (Unsolicited) ............................................9‐129
Cheque Processor (Solicited/Unsolicited) ...............................9‐131
Coin Dispenser (Solicited/Unsolicited)....................................9‐135
Barcode Reader (Unsolicited)....................................................9‐137
Secondary Card Reader (Unsolicited)......................................9‐138
Chapter 10
Central to Terminal Messages
Overview ..............................................................................................10‐1
Command Limitations........................................................................10‐2
Terminal Command Limitations ................................................10‐2
Customisation Data Command Limitations .............................10‐2
EMV Message Class Support ......................................................10‐2
Terminal Commands ..........................................................................10‐3
Customisation Data Commands .......................................................10‐7
State Tables Load.................................................................................10‐9
Screen/Keyboard Data Load ............................................................10‐11
Managing Keyboards and Associations ..................................10‐13
Configuration Parameters Load......................................................10‐15
Enhanced Configuration Parameters Load ...................................10‐17
FIT Data Load ....................................................................................10‐22
Configuration ID Number Load .....................................................10‐24
Message Authentication Field Selection Load ..............................10‐26
Date and Time Load..........................................................................10‐33
Encryption Key Change....................................................................10‐34
Extended Encryption Key Change..................................................10‐37
Dispenser Currency Cassette Mapping Table...............................10‐46
XML Configuration Download .......................................................10‐49
Transaction Reply Command..........................................................10‐52
Specific Command Reject Messages for
Buffer ‘d’.....................................................................................10‐68
Terminal Functions for Transaction Completion ...................10‐69
Interactive Transaction Response ...................................................10‐91
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC Reference Manual xvii
Table of Contents
Support for Touch‐Screen Emulation ......................................10‐91
Support for Voice‐Guided Sessions..........................................10‐91
Message Coordination Number (MCN) ..................................10‐92
EJ Commands.....................................................................................10‐96
EJ Options and Timers ...............................................................10‐96
Acknowledge EJ Upload Block .................................................10‐97
Acknowledge and Stop EJ .........................................................10‐98
Continuous Upload ....................................................................10‐99
Batch Upload .............................................................................10‐100
Message Validation .........................................................................10‐102
Valid Message Classes..............................................................10‐102
Command Reject Causes..........................................................10‐102
Other Invalid Parameters.........................................................10‐109
Messages Received in Wrong Operational Mode.......................10‐110
Customisation Data Commands.............................................10‐110
Transaction Reply Command Actions...................................10‐111
Actions for Terminal Commands ...........................................10‐112
Chapter 11
Security Features
Overview ..............................................................................................11‐1
BAPE Security ......................................................................................11‐2
EPP Security .........................................................................................11‐3
Remote PIN Block................................................................................11‐4
FIT Fields........................................................................................11‐4
PIN Block Formats ........................................................................11‐4
PIN Block Encryption...................................................................11‐8
Message Authentication ...................................................................11‐10
Message Authentication Code ..................................................11‐10
Full Message Authentication.....................................................11‐12
Selective Message Authentication ............................................11‐13
Using Selective Message Authentication.................................11‐16
Key Verification Values ....................................................................11‐17
Determining Encryptor Key Status ..........................................11‐17
RSA Initial Key Loading...................................................................11‐18
Identify EPP and Determine EPP Capabilities .......................11‐18
RSA Initial Key Loading for Signatures .........................................11‐21
EPP Authentication Process ......................................................11‐21
Loading Initial DES Keys...........................................................11‐26
RSA Encrypted DES Key Format..............................................11‐29
Signature Format.........................................................................11‐30
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xviii APTRA™ Advance NDC Reference Manual
Table of Contents
Base 94 Encoding and Decoding...............................................11‐30
Changing the Encryption Key Entry Mode ............................11‐32
RSA Initial Key Loading for Certificates........................................11‐33
Exchange Certificates .................................................................11‐33
Load a DES Key for Certificates................................................11‐35
Replace a Certificate ...................................................................11‐35
Primary and Secondary Keys....................................................11‐36
Double‐Length Keys .........................................................................11‐37
General Guidelines .....................................................................11‐37
Advance NDC Guidelines .........................................................11‐37
‘Double Length Restricted’ Key Entry Mode..........................11‐38
Journal Printer Backup .....................................................................11‐39
Chapter 12
EMV Smart Card Handling
Overview ..............................................................................................12‐1
Accepting and Reading Cards...........................................................12‐2
Motorised Readers ........................................................................12‐2
DIP Readers ...................................................................................12‐2
Read Conditions and FIT Match.................................................12‐2
Using EMV/CAM2 Exits for Advance NDC ...................................12‐4
Example Chip Data Read State ...................................................12‐6
Guidelines for Handling Smart Card Transactions .................12‐6
Chapter 13
CCM VISA2 Dialup System
Overview ..............................................................................................13‐1
Dialup System Setup...........................................................................13‐2
Baud Rate .......................................................................................13‐2
Dialup Timers................................................................................13‐2
Pre‐Dial and Normal ....................................................................13‐3
EJ Upload .......................................................................................13‐3
Dialup Messages: SST to Central ......................................................13‐4
I’m Alive Message.........................................................................13‐5
Transaction Completion...............................................................13‐6
Message on CP ..............................................................................13‐6
Message Suppression ...................................................................13‐6
Dialup Messages: Central to SST ......................................................13‐7
Disconnect Message......................................................................13‐7
No‐Op Message.............................................................................13‐8
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC Reference Manual xix
Table of Contents
Go Out of Service (Supervisor Mode)........................................13‐9
Appendix A
Reserved Screens
Overview ...............................................................................................A‐1
Screen Content................................................................................A‐1
Understanding the Tables.............................................................A‐1
‘A’ Supervisor Acknowledgements ...................................................A‐3
‘E’ Error Screens....................................................................................A‐5
‘I’ Supervisor Information .................................................................A‐18
‘M’ and ‘m’ Supervisor Menus .........................................................A‐25
‘P’ Supervisor Prompts ......................................................................A‐43
‘S’ Supervisor Information Lines......................................................A‐49
‘T’ and ‘t’ Journal Trace Information ...............................................A‐53
‘U’ Cheque, EMV Smart Card and BNA .........................................A‐63
‘d’ Supervisor Diagnostic Screens....................................................A‐70
‘i’ Supervisor TCP/IP..........................................................................A‐72
‘i’ Supervisor Dialup ..........................................................................A‐75
‘i’ Supervisor BNA .............................................................................A‐88
‘i’ Supervisor Settlement Screens .....................................................A‐92
‘j’ Supervisor and Journal Miscellaneous Screens .........................A‐95
Appendix B
Character Sets
Overview ............................................................................................... B‐1
Character Sets........................................................................................ B‐2
USB Printers and Downloadable Character Sets....................... B‐4
Statement Code Sets ...................................................................... B‐5
Code Pages ............................................................................................ B‐7
OS/2 Code Pages ............................................................................ B‐7
USB Receipt and Journal Code Pages ......................................... B‐7
Mapping Files........................................................................................ B‐8
Font ID Mapping Table...................................................................... B‐12
Appendix C
Cardholder Screen Graphics
Overview ............................................................................................... C‐1
Cardholder Example Graphics ........................................................... C‐2
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xx APTRA™ Advance NDC Reference Manual
Table of Contents
Insert Card (g00.png)..................................................................... C‐3
Press Key (g01.png) ....................................................................... C‐4
Make a Deposit (g03.png)............................................................. C‐5
Take Receipt (g04.png).................................................................. C‐6
Take Cash (g05.png) ...................................................................... C‐7
Take Statement (g06.png) ............................................................. C‐8
Scan Barcode (g10.png) ................................................................. C‐9
Appendix D
Quick Reference to Message Types
Overview ...............................................................................................D‐1
Quick Reference to Message Types ...................................................D‐2
Transaction Request ......................................................................D‐3
Unsolicited Status Messages ........................................................D‐7
Solicited Status Messages .............................................................D‐8
Encryptor Initialisation Data........................................................D‐9
Upload EJ Data Message.............................................................D‐10
Terminal Commands...................................................................D‐10
Customisation Data Commands................................................D‐12
Transaction Reply ........................................................................D‐15
Acknowledge EJ Upload Block Command ..............................D‐21
Acknowledge and Stop EJ Command ......................................D‐21
EJ Options and Timers Command ............................................D‐21
Appendix E
Device Identifiers
Overview ............................................................................................... E‐1
Hardware Configuration Data ........................................................... E‐2
Supplies Data ...................................................................................... E‐12
Cash Acceptor Supplies (DIG ‘w’) ............................................ E‐17
Fitness Data ......................................................................................... E‐20
Cash Acceptor Fitness (DIG ‘w’) ............................................... E‐25
Tamper Data........................................................................................ E‐27
Appendix F
ASCII/EBCDIC Conversion Table
Overview ................................................................................................F‐1
Code Conversion Table ........................................................................F‐2
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC Reference Manual xxi
Table of Contents
Appendix G
Related Documentation
Overview ...............................................................................................G‐1
Advance NDC Documentation ..........................................................G‐2
APTRA Author Documentation.........................................................G‐3
NDC+ Documentation .........................................................................G‐5
Other NCR Documentation ................................................................G‐6
Miscellaneous Documentation ...........................................................G‐7
Glossary
Glossary .................................................................................... Glossary‐1
Index
Index ................................................................................................Index‐1
User Feedback Form
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxii APTRA™ Advance NDC Reference Manual
List of Figures
List of Figures
Chapter 1
Introducing the Advance NDC System
Figure 1‐1 Start‐up Sequence...........................................................1‐2
Chapter 2
State Tables
Figure 2‐1 Read Condition Flow...................................................2‐15
Chapter 3
Screen Data
Figure 3‐1 Cardholder/EOP Screen Layout...................................3‐2
Chapter 4
Keyboard Data and Layouts
Figure 4‐1 Emulated FDKs: Touch Areas ......................................4‐3
Figure 4‐2 Standard Keyboard Layout for Cardholder
Transactions ................................................................4‐10
Figure 4‐3 Supervisor Mode: Keyboard Layout .........................4‐12
Figure 4‐4 Encryption Key Entry Keyboard Layout ..................4‐13
Figure 4‐5 Cardholder Keyboard: Secure Key Entry Layout....4‐13
Figure 4‐6 Operator Keyboard Layout ........................................4‐14
Figure 4‐7 Unary Co‐ordinates .....................................................4‐17
Figure 4‐8 Format for Floating Point Numbers ..........................4‐17
Figure 4‐9 Calculate Exponent ......................................................4‐19
Figure 4‐10 Calculate Mantissa .......................................................4‐19
Figure 4‐11 Calculate Sign ...............................................................4‐20
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xxiii
List of Figures
Figure 4‐12 Calculate Co‐ordinate ..................................................4‐20
Chapter 5
Printer Data
Figure 5‐1 Screen Text Interlacing ................................................5‐26
Figure 5‐2 Final Simulated Pre‐printed Receipt .........................5‐28
Chapter 11
Security Features
Figure 11‐1 Diebold PIN Block........................................................11‐5
Figure 11‐2 ISO PIN Block Format 0 ..............................................11‐5
Figure 11‐3 ISO PIN Block Format 1 ..............................................11‐6
Figure 11‐4 ISO PIN Block Format 3 ..............................................11‐6
Figure 11‐5 BANKSYS PIN Block ...................................................11‐7
Figure 11‐6 PAN Block .....................................................................11‐7
Figure 11‐7 Obtain Key Status Message Exchange ....................11‐17
Figure 11‐8 Identify EPP and Determine EPP Capabilities.......11‐19
Figure 11‐9 HSM ‐ EPP A‐key Message Exchange:
Standard Mode .........................................................11‐22
Figure 11‐10 Authentication of EPP/HSM Public Keys:
Standard Mode .........................................................11‐23
Figure 11‐11 HSM/EPP Signature Verification:
Standard Mode .........................................................11‐23
Figure 11‐12 EPP Authentication Message Sequence:
Standard Mode .........................................................11‐24
Figure 11‐13 Authentication of EPP/HSM Public Keys:
Enhanced Mode........................................................11‐25
Figure 11‐14 EPP Authentication Message Sequence:
Enhanced Mode........................................................11‐26
Figure 11‐15 DES Key Load Standard Message Sequence ..........11‐27
Figure 11‐16 DES Key Load Enhanced Message Sequence.........11‐28
Figure 11‐17 Enhanced Signature Remote Key Load Mode:
Delete PK‐HOST.......................................................11‐29
Figure 11‐18 Enhanced Signature Remote Key Load Mode:
Delete PK‐HOSTRoot ..............................................11‐29
Figure 11‐19 Key Entry Mode Remote Change Sequence...........11‐32
Figure 11‐20 Exchange Certificates.................................................11‐34
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxiv APTRA™ Advance NDC, Reference Manual
List of Figures
Figure 11‐21 Load a Certificate DES Key.......................................11‐35
Figure 11‐22 Replace a Certificate ..................................................11‐35
Chapter 12
EMV Smart Card Handling
Figure 12‐1 Smart Card Handling ..................................................12‐5
Appendix B
Character Sets
Figure B‐1 Alpha 1............................................................................ B‐2
Figure B‐2 Example Mapping File ............................................... B‐11
Appendix C
Cardholder Screen Graphics
Figure C‐1 Insert Card (g00.png).................................................... C‐3
Figure C‐2 Press Key (g01.png) ...................................................... C‐4
Figure C‐3 Make a Deposit (g03.png) ............................................ C‐5
Figure C‐4 Take Receipt (g04.png) ................................................. C‐6
Figure C‐5 Take Cash (g05.png) ..................................................... C‐7
Figure C‐6 Take Statement (g06.png) ............................................ C‐8
Figure C‐7 Scan Barcode (g10.png) ................................................ C‐9
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xxv
List of Figures
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxvi APTRA™ Advance NDC, Reference Manual
List of Tables
List of Tables
Preface
Table Pref‐1 Navigation Aids .............................................................xlv
Table Pref‐2 Terms for Cash Acceptors............................................xlvi
Table Pref‐3 Abbreviations Used in the Publication .................... xlvii
Chapter 1
Introducing the Advance NDC System
Table 1‐1 Customisation Data .......................................................1‐4
Table 1‐2 Host Commands and Messages...................................1‐5
Chapter 2
State Tables
Table 2‐1 State Table Types............................................................2‐3
Table 2‐2 Buffers Initialised for State A .......................................2‐7
Table 2‐3 A ‐ Card Read State .....................................................2‐10
Table 2‐4 Extension 1 to State .....................................................2‐12
Table 2‐5 Dynamic Text for Contactless Tap Error Reasons...2‐13
Table 2‐6 Read Condition Bit Information ................................2‐13
Table 2‐7 B ‐ Pin Entry State ........................................................2‐16
Table 2‐8 C ‐ Envelope Dispenser State .....................................2‐19
Table 2‐9 D ‐ Pre‐set Operation Code Buffer State ...................2‐20
Table 2‐10 Extension to State D .....................................................2‐21
Table 2‐11 E ‐ Four FDK Selection Function State ......................2‐24
Table 2‐12 F ‐ Amount Entry State................................................2‐27
Table 2‐13 G ‐ Amount Check State..............................................2‐30
Table 2‐14 Amount Check Error State..........................................2‐31
Table 2‐15 Amount Check Error State — DCCMT.....................2‐32
Table 2‐16 H ‐ Information Entry State ........................................2‐36
Table 2‐17 I ‐ Transaction Request State ......................................2‐39
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xxvii
List of Tables
Table 2‐18 Track 2 Data Send Modifier ........................................2‐40
Table 2‐19 Track 1/3 Data Send Modifier.....................................2‐40
Table 2‐20 Table Entry 8 for Buffer A...........................................2‐41
Table 2‐21 Extension 1 to State I....................................................2‐41
Table 2‐22 Extension 2 to State I....................................................2‐44
Table 2‐23 J ‐ Close State.................................................................2‐46
Table 2‐24 Extension State 1 to State J ..........................................2‐48
Table 2‐25 Extension State 2 (J ‐ Close State) ...............................2‐51
Table 2‐26 K ‐ FIT Switch State......................................................2‐52
Table 2‐27 _ ‐ Expanded FIT Switch State....................................2‐53
Table 2‐28 Extension to State _ ......................................................2‐54
Table 2‐29 L ‐ Card Write State......................................................2‐56
Table 2‐30 M ‐ Enhanced PIN Entry State ...................................2‐58
Table 2‐31 Security Camera Image Filename Format ................2‐60
Table 2‐32 N ‐ Camera Control State ............................................2‐61
Table 2‐33 R ‐ Enhanced Amount Entry State.............................2‐63
Table 2‐34 Extension to State R......................................................2‐64
Table 2‐35 S ‐ Language Code Switch State.................................2‐65
Table 2‐36 Extension to State S ......................................................2‐67
Table 2‐37 T ‐ Card Read ‐ PIN Entry Initiation State................2‐72
Table 2‐38 Extension 1 to State T...................................................2‐73
Table 2‐39 Extension 2 to State T...................................................2‐75
Table 2‐40 U – Device Fitness Flow Select State .........................2‐76
Table 2‐41 State ‘U’ ‐ Supported Devices.....................................2‐78
Table 2‐42 Cash Handler Fitness Examples.................................2‐81
Table 2‐43 V ‐ Language Select from Card State.........................2‐82
Table 2‐44 W ‐ FDK Switch State...................................................2‐84
Table 2‐45 X ‐ FDK Information Entry State................................2‐85
Table 2‐46 Extension to State X......................................................2‐87
Table 2‐47 Y ‐ Eight FDK Selection Function State.....................2‐89
Table 2‐48 Extension 1 to State Y...................................................2‐91
Table 2‐49 Extension 2 to State Y...................................................2‐92
Table 2‐50 b ‐ Customer‐Selectable PIN State .............................2‐93
Table 2‐51 Extension to State b ......................................................2‐95
Table 2‐52 k ‐ Smart FIT Check State ............................................2‐97
Table 2‐53 m ‐ PIN & Language Select State ...............................2‐99
Table 2‐54 PIN & Language FDK Active Mask.........................2‐101
Table 2‐55 Extension 1 to State m................................................2‐101
Table 2‐56 Extension 2 to State m................................................2‐102
Table 2‐57 Extension 3 to State m................................................2‐103
Table 2‐58 > ‐ Cash Accept State..................................................2‐108
Table 2‐59 Extension 1 to State > (Cash Accept) .......................2‐109
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxviii APTRA™ Advance NDC, Reference Manual
List of Tables
Table 2‐60 Extension 2 to State > (Cash Accept) .......................2‐112
Table 2‐61 Extension 3 to State > (Cash Accept) .......................2‐114
Table 2‐62 Extension 4 to State > (Cash Accept) .......................2‐116
Table 2‐63 Extension 5 to State > (Cash Accept) .......................2‐119
Table 2‐64 Rejected Notes Dynamic Text ..................................2‐124
Table 2‐65 w ‐ Cheque Accept State ...........................................2‐125
Table 2‐66 Extension 1 to State w................................................2‐128
Table 2‐67 Extension 2 to State w................................................2‐130
Table 2‐68 z ‐ Master Expansion State........................................2‐132
Table 2‐69 z001 ‐ Bunch Cheque Accept State ..........................2‐133
Table 2‐70 Extension 1 to State z001 ...........................................2‐135
Table 2‐71 Extension 2 to State z001 ...........................................2‐136
Table 2‐72 Extension 3 to State z001 ...........................................2‐137
Table 2‐73 Rejected Reasons ........................................................2‐138
Table 2‐74 Refused Reasons.........................................................2‐138
Table 2‐75 z002 ‐ Bunch Cheque Handling State......................2‐140
Table 2‐76 Extension 1 to State z002 ...........................................2‐141
Table 2‐77 Extension 2 to State z002 ...........................................2‐142
Table 2‐78 z003 ‐ Cheque Detail Display State..........................2‐145
Table 2‐79 Extension 1 to State z003 ...........................................2‐147
Table 2‐80 Extension 2 to State z003 ...........................................2‐148
Table 2‐81 Cheque Acceptance States ........................................2‐149
Table 2‐82 z004 ‐ Cheque Summary Display State ...................2‐151
Table 2‐83 Extension 1 to State z004 ...........................................2‐152
Table 2‐84 Extension 2 to State z004 ...........................................2‐153
Table 2‐85 Extension 3 to State z004 ...........................................2‐154
Table 2‐86 z008 ‐ Insert Card State .............................................2‐158
Table 2‐87 Extension 1 to State z008 ...........................................2‐159
Table 2‐88 Extension 2 to State z008 ...........................................2‐161
Table 2‐89 z009 ‐ Buffer Validation State ..................................2‐164
Table 2‐90 z010 – Local Cash Dispense State ............................2‐170
Table 2‐91 Extension 1 to State z010 ...........................................2‐171
Table 2‐92 z013 – Data Copy and Compare State.....................2‐173
Table 2‐93 Extension 1 to State z013 ...........................................2‐174
Table 2‐94 z014 – Offline Encash/Refund State.........................2‐178
Table 2‐95 Extension 1 to State z014 ...........................................2‐179
Table 2‐96 z017‐ Note Mix Selection State .................................2‐181
Table 2‐97 Extension 1 to State z017 ...........................................2‐182
Table 2‐98 Extension 2 to State z017 ...........................................2‐183
Table 2‐99 Extension 3 to State z017 ...........................................2‐185
Table 2‐100 Extension 4 to State z017 ...........................................2‐186
Table 2‐101 FITSearch State ‘z020’ ................................................2‐188
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xxix
List of Tables
Table 2‐102 ‘z021‐CRM Flowpoint State’ .....................................2‐190
Table 2‐103 ‘z024‐Prepare Dispense State’...................................2‐191
Table 2‐104 & ‐ Barcode Reader State...........................................2‐193
Table 2‐105 Extension 1 to State & ................................................2‐195
Table 2‐106 Extensions 2—8 to State & ........................................2‐196
Table 2‐107 Entry Conditions for the Time‐Out State................2‐201
Table 2‐108 Action Taken on Selection of FDK B for
Each Entry Condition ..............................................2‐202
Table 2‐109 Action Taken on Selection of the Cancel Key for
Each Entry Condition ..............................................2‐203
Chapter 3
Screen Data
Table 3‐1 K – Extended Screen Controls: Restoring Settings ....3‐9
Table 3‐2 Screen Contents ‘K01’ ....................................................3‐9
Table 3‐3 Screen Contents ‘K09’ ..................................................3‐10
Table 3‐4 Screen Contents ‘K02’ ..................................................3‐10
Table 3‐5 Screen Contents ‘K010’ ................................................3‐10
Table 3‐6 Screen Contents ‘K07’ ..................................................3‐11
Table 3‐7 Screen Contents ‘K08’ ..................................................3‐11
Table 3‐8 Screen Contents ‘K03’ ..................................................3‐11
Table 3‐9 Cardholder Screen: Character Sets ............................3‐14
Table 3‐10 Character Sets with Customer‐Defined
Characters....................................................................3‐15
Table 3‐11 Enhanced Operator Interface: Character Set ............3‐15
Table 3‐12 Cardholder Screen: Control Character Functions ...3‐16
Table 3‐13 Track 1 Data Formats...................................................3‐18
Table 3‐14 Screen Display Special Features.................................3‐20
Table 3‐15 Digital Audio Control in Screen Display..................3‐22
Table 3‐16 Digital Audio Control for Voice Guidance...............3‐23
Table 3‐17 Screen Blinking and Colour Control .........................3‐27
Table 3‐18 Blinking Commands ....................................................3‐27
Table 3‐19 Foreground Colour Commands.................................3‐28
Table 3‐20 Background Colour Commands ................................3‐28
Table 3‐21 Default Foreground Colour Commands...................3‐29
Table 3‐22 Default Background Colour Commands ..................3‐29
Table 3‐23 Change Display While Idle .........................................3‐30
Table 3‐24 Select Primary Character Set ......................................3‐31
Table 3‐25 Select Secondary Character Set ..................................3‐31
Table 3‐26 Set Left Margin Position ..............................................3‐32
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxx APTRA™ Advance NDC, Reference Manual
List of Tables
Table 3‐27 Select Logo ....................................................................3‐33
Table 3‐28 Picture Control Command..........................................3‐34
Table 3‐29 Display Image File Command....................................3‐34
Table 3‐30 Display Lifted Cheque Image Command.................3‐35
Table 3‐31 Bunch Cheque Image Display Control .....................3‐36
Table 3‐32 Bunch Cheque Codeline Display Control ................3‐37
Table 3‐33 Bunch Cheque Amount Display Control .................3‐37
Table 3‐34 Bunch Cheque Value Display Control ......................3‐38
Table 3‐35 Display Dynamic Text Dictionary Control...............3‐40
Table 3‐36 Dynamic Button Definition.........................................3‐42
Table 3‐37 Syntax of Conditional Expressions............................3‐43
Table 3‐38 Dynamic Text Definition.............................................3‐44
Table 3‐39 Video and Animation File Formats ...........................3‐45
Table 3‐40 Currency Echo Example..............................................3‐46
Table 3‐41 Default Echo Display Format .....................................3‐47
Table 3‐42 Field Definitions for Screens C09–C19 ......................3‐56
Chapter 4
Keyboard Data and Layouts
Table 4‐1 Emulated FDKs: Touch Area Measurements.............4‐3
Table 4‐2 FDKs, Key Codes and CEN‐XFS equivalents ............4‐5
Table 4‐3 Mapping CEN‐XFS Keys...............................................4‐5
Table 4‐4 Mapping CEN‐XFS Example........................................4‐7
Table 4‐5 Numeric Autoactivators (PIN)...................................4‐11
Table 4‐6 Non‐Numeric Autoactivators (PIN)..........................4‐11
Table 4‐7 Supervisor Mode Autoactivators (PIN) ....................4‐12
Table 4‐8 Encryption Key Entry Autoactivators (PIN) ............4‐13
Table 4‐9 Encryption Key Entry Autoactivators (TTU) ...........4‐13
Table 4‐10 Non‐Numeric Autoactivators (TTU).........................4‐15
Table 4‐11 Touch Area Definition .................................................4‐16
Chapter 5
Printer Data
Table 5‐1 Printer Control Characters............................................5‐6
Table 5‐2 Maximum Printed Lines ...............................................5‐7
Table 5‐3 Set Left Margin Position................................................5‐8
Table 5‐4 Set Right Margin Position .............................................5‐8
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xxxi
List of Tables
Table 5‐5 Select OS/2 Code Page ...................................................5‐9
Table 5‐6 Select International Character Sets ............................5‐10
Table 5‐7 Select Arabic Character Sets .......................................5‐10
Table 5‐8 Print Downloadable Bit Image ...................................5‐11
Table 5‐9 Print Barcode.................................................................5‐12
Table 5‐10 Print Graphics ...............................................................5‐13
Table 5‐11 Print Cheque Image .....................................................5‐14
Table 5‐12 Define Downloadable Character Set .........................5‐15
Table 5‐13 Define Downloadable Bit Image ................................5‐16
Table 5‐14 Select HRI Character Printing Position .....................5‐17
Table 5‐15 Select Barcode Width ...................................................5‐17
Table 5‐16 Select Barcode Horizontal Height..............................5‐18
Table 5‐17 Select Dual‐sided Printing ..........................................5‐18
Table 5‐18 Character Set Designators ...........................................5‐20
Table 5‐19 Select Primary Print Page............................................5‐22
Table 5‐20 Select Secondary Print Page........................................5‐22
Table 5‐21 Set Left Margin (Statement Printer)...........................5‐23
Table 5‐22 Set Right Margin (Statement Printer) ........................5‐23
Table 5‐23 Switch Lines Per Inch (6/8)..........................................5‐24
Table 5‐24 Line Spacing Values.....................................................5‐24
Table 5‐25 Invalid Control Sequences for Screen R01................5‐26
Table 5‐26 Screen R00 Data ............................................................5‐27
Table 5‐27 Screen R01 Data and Interlaced Data from
Central .........................................................................5‐27
Table 5‐28 Printer Control Sequences and Registry Settings ....5‐30
Table 5‐29 Print Cheque Image Variable Data ............................5‐35
Table 5‐30 USB Receipt and Journal Printer: Barcode Types,
Length, and Data........................................................5‐36
Chapter 6
Supervisor Messages
Table 6‐1 Screen Size Limits...........................................................6‐3
Table 6‐2 Display Positions............................................................6‐3
Chapter 7
Configuration Parameters
Table 7‐1 Values for Camera Control ...........................................7‐2
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxii APTRA™ Advance NDC, Reference Manual
List of Tables
Table 7‐2 Values for Supply Mode, Ready Status and
Amount Buffer Length ................................................7‐2
Table 7‐3 Summary of Timers .......................................................7‐4
Table 7‐4 Option 02: Auto Voice Values ......................................7‐7
Table 7‐5 Option 03: Date Formats ...............................................7‐7
Table 7‐6 Option 07: Track 1 Format Values ...............................7‐8
Table 7‐7 Option 12: Specific Command Reject Values .............7‐8
Table 7‐8 Option 15: Transaction Status Information Values ...7‐8
Table 7‐9 Option 23: Envelope Dispenser Status Values...........7‐9
Table 7‐10 Option 24: Enhanced/TI Sensor Status Unsolicited
Message Values ............................................................7‐9
Table 7‐11 Option 24: Media Entry/Exit Indicators Flash
Rate...............................................................................7‐10
Table 7‐12 Option 27: Remote Relay.............................................7‐10
Table 7‐13 Option 30: Include PAN in DCS data........................7‐10
Table 7‐14 Option 32: Unsolicited Reporting Control ...............7‐11
Table 7‐15 Option 33: Simulate Supervisor Mode
Entry/Exit Values .......................................................7‐11
Table 7‐16 Option 34: MCN Range Values ..................................7‐11
Table 7‐17 Option 34: MCN Range Option Code Examples .....7‐12
Table 7‐18 Option 35: Report Dual Mode & Hardcopy B/U
Unsolicited Message Values.....................................7‐13
Table 7‐19 Option 36: Enhanced EJ Backup Values ...................7‐13
Table 7‐20 Option 37: Print Track 2 to Journal............................7‐13
Table 7‐21 Option 41: Send Track Details on Card Retract .......7‐14
Table 7‐22 Option 44: BNA Journal Notes
Count Values ..............................................................7‐14
Table 7‐23 Option 45: BNA Settings Bit Values ..........................7‐15
Table 7‐24 Example Option 45: BNA Settings Values................7‐17
Table 7‐25 Option 46: MCRW Enhanced Card Device
Security Jitter Values .................................................7‐17
Table 7‐26 Option 48: Barcode Reader Values ............................7‐18
Table 7‐27 Option 71: Time‐Out State Entry ...............................7‐18
Table 7‐28 Option 74: Destination Values for Retracted
Notes During Cash Deposit......................................7‐18
Table 7‐29 Option 76: Cash Handlers...........................................7‐19
Table 7‐30 Option 77: Next State Number Values......................7‐19
Table 7‐31 Option 78: GBRU M‐Status Reporting ......................7‐20
Table 7‐32 Option 79: Coin Dispenser..........................................7‐21
Table 7‐33 Option 80: Alphanumeric State Entry.......................7‐21
Table 7‐34 Option 83: Cheque Processor .....................................7‐21
Table 7‐35 Unsupported Parameters ............................................7‐22
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xxxiii
List of Tables
Chapter 8
Financial Institution Tables
Table 8‐1 FIT Fields .........................................................................8‐2
Table 8‐2 PIN Block Type Selection ..............................................8‐5
Table 8‐3 PINPD Bit Encoding Significance ................................8‐6
Table 8‐4 PINPD First Digit Coding .............................................8‐6
Table 8‐5 PINDX Index Reference Point ....................................8‐10
Table 8‐6 PINDX Digit Assignment............................................8‐11
Chapter 9
Terminal to Central Messages
Table 9‐1 Transaction Request Message Format.........................9‐2
Table 9‐2 E13B Codeline Encoding .............................................9‐17
Table 9‐3 CMC7 Codeline Encoding ..........................................9‐17
Table 9‐4 Transaction Request in Reply to an Interactive
Transaction Response ................................................9‐19
Table 9‐5 Message Format for Field bd2 in Transaction
Request ........................................................................9‐20
Table 9‐6 CAM Flags.....................................................................9‐21
Table 9‐7 Solicited Status Message Format................................9‐22
Table 9‐8 Ready (‘B’) ‐ Status Information.................................9‐26
Table 9‐9 Cash Deposit: Recycle Data ........................................9‐27
Table 9‐10 Recycle Cassette: Dispense Data ................................9‐28
Table 9‐11 Specific Command Reject ‐ Status Information .......9‐29
Table 9‐12 Terminal State ‐ Status Information
Sub‐Field ‘g1’ ..............................................................9‐32
Table 9‐13 Send Configuration Information Response..............9‐34
Table 9‐14 Hardware Fitness Sub‐Field ‘g3’................................9‐36
Table 9‐15 Hardware Fitness Severity Values.............................9‐38
Table 9‐16 Hardware Configuration Data: Sub‐Field ‘g4’.........9‐38
Table 9‐17 Supplies Status Sub‐Field ‘g5’ ....................................9‐46
Table 9‐18 Supplies Status Values.................................................9‐48
Table 9‐19 Hardware Configuration Data Response .................9‐48
Table 9‐20 Note Acceptor Capabilities .........................................9‐51
Table 9‐21 Note Acceptor Capabilities: Example Data ..............9‐52
Table 9‐22 Supplies Data Response ..............................................9‐53
Table 9‐23 Fitness Data Response .................................................9‐54
Table 9‐24 Tamper and Sensor Data Response ...........................9‐56
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxiv APTRA™ Advance NDC, Reference Manual
List of Tables
Table 9‐25 Software ID and Release Number Data
Response......................................................................9‐58
Table 9‐26 Local Configuration Option Digits Response ..........9‐59
Table 9‐27 Note Definitions (BNA) Response.............................9‐60
Table 9‐28 Send Supply Counters Response ...............................9‐62
Table 9‐29 Status Message Description ........................................9‐66
Table 9‐30 Send Supply Counters: Extended Response ............9‐67
Table 9‐31 Send Tally Information Response..............................9‐74
Table 9‐32 Send Error Log Information Response......................9‐75
Table 9‐33 Send Date/Time Information Response ....................9‐76
Table 9‐34 Send Configuration ID Response...............................9‐77
Table 9‐35 Device Fault Status in Response to Transaction
Reply Commands.......................................................9‐78
Table 9‐36 Device Fault Status Information Field ......................9‐79
Table 9‐37 Encryptor Initialisation Data Response ....................9‐82
Table 9‐38 Encryption Keys ...........................................................9‐89
Table 9‐39 Key Status Data (Key IDs 001 ‐ 004) ..........................9‐90
Table 9‐40 Key Status Data for the Key ID 008 ...........................9‐90
Table 9‐41 Format of the Upload EJ Data Message ....................9‐91
Table 9‐42 Unsolicited Status: Message Format..........................9‐94
Table 9‐43 Unsolicited Status: Status Information Field............9‐95
Table 9‐44 Time‐Of‐Day Clock Status ..........................................9‐96
Table 9‐45 Power Failure Status ....................................................9‐97
Table 9‐46 Card Reader/Writer Status..........................................9‐98
Table 9‐47 Additional Track Data on Card Retract ....................9‐99
Table 9‐48 Cash Handler Status ....................................................9‐99
Table 9‐49 Depository Status .......................................................9‐104
Table 9‐50 Receipt Printer Status ................................................9‐105
Table 9‐51 Journal Printer Status.................................................9‐106
Table 9‐52 Electronic Journal Printer Status ..............................9‐108
Table 9‐53 Unsolicited Message Sequences for Option 35
(EJ Dual Mode) .........................................................9‐110
Table 9‐54 Night Safe Depository Status ...................................9‐111
Table 9‐55 Encryptor Status .........................................................9‐112
Table 9‐56 Camera Status .............................................................9‐113
Table 9‐57 Sensors Status .............................................................9‐114
Table 9‐58 Touch Screen Keyboard Status.................................9‐116
Table 9‐59 Supervisor Keys Status..............................................9‐117
Table 9‐60 Cardholder Display Alarm Status ...........................9‐119
Table 9‐61 Statement Printer Status............................................9‐119
Table 9‐62 Voice Guidance Status...............................................9‐121
Table 9‐63 Bunch Note Acceptor Status.....................................9‐124
Table 9‐64 Additional Cardholder Data ....................................9‐128
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xxxv
List of Tables
Table 9‐65 Envelope Dispenser Status........................................9‐129
Table 9‐66 Cheque Processor Status ...........................................9‐131
Table 9‐67 Coin Dispenser Status................................................9‐135
Table 9‐68 Barcode Reader Status ...............................................9‐137
Table 9‐69 Secondary Card Reader Status .................................9‐139
Table 9‐70 M‐Status for Card Reader Failure............................9‐139
Chapter 10
Central to Terminal Messages
Table 10‐1 Terminal Commands ...................................................10‐3
Table 10‐2 Customisation Data Commands ................................10‐7
Table 10‐3 State Tables Load..........................................................10‐9
Table 10‐4 Screen/keyboard Data Load......................................10‐11
Table 10‐5 Configuration Parameters Load...............................10‐15
Table 10‐6 Enhanced Configuration Parameters Load ............10‐17
Table 10‐7 FIT Data Load .............................................................10‐22
Table 10‐8 Configuration ID Number Load ..............................10‐24
Table 10‐9 Message Authentication Field Selection Load .......10‐26
Table 10‐10 Data and Time Load ..................................................10‐33
Table 10‐11 Encryption Key Change ............................................10‐35
Table 10‐12 Extended Encryption Key Change ..........................10‐38
Table 10‐13 Dispenser Currency Cassette Mapping ..................10‐46
Table 10‐14 XML Configuration Download Message Format ..10‐50
Table 10‐15 Transaction Reply Command: Message Format....10‐52
Table 10‐16 Invalid Customer/Transaction Data Element
Details ........................................................................10‐68
Table 10‐17 Deposit and Print (Function ID ‘1’ or ‘7’) ...............10‐70
Table 10‐18 Dispense and Print (Function ID ‘2’ or ‘8’) .............10‐71
Table 10‐19 Display and Print (Function ID ‘3’ or ‘9’) ...............10‐72
Table 10‐20 Print Immediate (Function ID ‘4’)............................10‐72
Table 10‐21 Set Next State and Print (Function ID ‘5’)...............10‐73
Table 10‐22 Night Safe Deposit and Print
(Function ID ‘6’)........................................................10‐73
Table 10‐23 Card Before Cash (Function ID ‘A’) ........................10‐74
Table 10‐24 Parallel Eject/Dispense and Print ‐
Fast Cash (Function ID ‘B’ or ‘C’) ..........................10‐75
Table 10‐25 Card Before Parallel Dispense and Print
(Function ID ‘F’) .......................................................10‐76
Table 10‐26 Print Statement and Wait
(Function ID ‘P’) .......................................................10‐77
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxvi APTRA™ Advance NDC, Reference Manual
List of Tables
Table 10‐27 Print Statement and Set Next State
(Function ID ‘Q’) ......................................................10‐78
Table 10‐28 Refund Notes and Set Next State
(Function ID ‘*’)........................................................10‐79
Table 10‐29 Deposit Notes and Print
(Function ID ‘‐’) ........................................................10‐80
Table 10‐30 Deposit Notes and Wait
(Function ID ‘’’) ........................................................10‐81
Table 10‐31 Process Cheque (Function ID ‘:’)..............................10‐81
Table 10‐32 Dispense Cash First During Valuable Media
Exchange (Function ID ‘b’) .....................................10‐82
Table 10‐33 Dispense Cash First During Valuable Media
Exchange: Operational Flow ..................................10‐85
Table 10‐34 Process Multiple Cheques (Function ID ‘c’)...........10‐86
Table 10‐35 Deposit Media First During Valuable Media
Exchange (Function ID ‘f’) ......................................10‐87
Table 10‐36 Deposit Media First During Valuable Media
Exchange: Operational Flow ..................................10‐89
Table 10‐37 Interactive Transaction Response ............................10‐92
Table 10‐38 EJ Options and Timers...............................................10‐96
Table 10‐39 Acknowledge EJ Upload Block ................................10‐98
Table 10‐40 Acknowledge and Stop EJ ........................................10‐99
Table 10‐41 Specific Command Reject Value/Qualifier
Combinations..........................................................10‐103
Table 10‐42 Actions for Customisation Data Commands .......10‐110
Table 10‐43 Actions for Transaction Reply Commands ..........10‐111
Table 10‐44 Actions for Terminal Commands ..........................10‐112
Chapter 11
Security Features
Table 11‐1 PINPD First Digit Bit Significance .............................11‐8
Table 11‐2 PINPD FIT Field ...........................................................11‐8
Table 11‐3 Message Authentication Configuration Flag 1 ......11‐12
Table 11‐4 Message Authentication Configuration Flag 2 ......11‐12
Table 11‐5 Message Authentication Configuration Flag 8 ......11‐12
Table 11‐6 Message Authentication Configuration Flag 9 ......11‐13
Table 11‐7 Message Authentication Configuration Flag 10 ....11‐13
Table 11‐8 MAC Field Selection: Solicited Status Message.....11‐14
Table 11‐9 MAC Field Selection ‐ Other Messages...................11‐14
Table 11‐10 MAC Field Selection ‐ Track 1, Track 2, Track 3....11‐15
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xxxvii
List of Tables
Table 11‐11 MAC Field Selection For EMV ICC Configuration
Messages....................................................................11‐15
Table 11‐12 Selective MAC Default Field Values .......................11‐16
Chapter 12
EMV Smart Card Handling
Table 12‐1 Chip Data Read State ...................................................12‐6
Chapter 13
CCM VISA2 Dialup System
Table 13‐1 Modem Timers..............................................................13‐2
Table 13‐2 Application Timer Settings for Dialup......................13‐3
Table 13‐3 SST Messages Header Format ....................................13‐4
Table 13‐4 I’m Alive Message Format ..........................................13‐5
Table 13‐5 Central Messages Header Format..............................13‐7
Table 13‐6 Disconnect Message Format .......................................13‐7
Table 13‐7 No‐Op Message Format ..............................................13‐8
Appendix A
Reserved Screens
Table A‐1 Supervisor Acknowledgement Screens .....................A‐3
Table A‐2 Error Screens ..................................................................A‐5
Table A‐3 Supervisor Information Screens................................A‐18
Table A‐4 Supervisor Menu Screens...........................................A‐25
Table A‐5 Supervisor Prompts Screens ......................................A‐43
Table A‐6 Supervisor Information Lines Screens .....................A‐49
Table A‐7 Journal Trace Screens..................................................A‐53
Table A‐8 Cheque, EMV Smart Card and BNA Screens..........A‐63
Table A‐9 Supervisor Diagnostic Screens ..................................A‐70
Table A‐10 Supervisor TCP/IP Screens ........................................A‐72
Table A‐11 Supervisor Dialup Screens.........................................A‐75
Table A‐12 Supervisor BNA Screens ............................................A‐88
Table A‐13 Supervisor Settlement Screens ..................................A‐92
Table A‐14 Supervisor Miscellaneous Screens ............................A‐95
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxviii APTRA™ Advance NDC, Reference Manual
List of Tables
Appendix B
Character Sets
Table B‐1 Character Sets ................................................................ B‐3
Table B‐2 Statement Printer Character Sets ................................ B‐5
Table B‐3 Mapping File Conventions .......................................... B‐9
Table B‐4 Font ID Mapping Table .............................................. B‐12
Appendix D
Quick Reference to Message Types
Table D‐1 Quick Reference to Message Types ............................D‐2
Table D‐2 Transaction Request Message Format........................D‐3
Table D‐3 Unsolicited Status Message Format............................D‐7
Table D‐4 Solicited Status Message Fields...................................D‐8
Table D‐5 Solicited Status Message Field Values .......................D‐8
Table D‐6 Encryptor Initialisation Data .......................................D‐9
Table D‐7 Upload EJ Data Message ............................................D‐10
Table D‐8 Terminal Command Fields ........................................D‐10
Table D‐9 Field Values for Terminal Commands.....................D‐10
Table D‐10 Customisation Data Command Fields .....................D‐12
Table D‐11 Field Values for Data Commands.............................D‐13
Table D‐12 Transaction Reply .......................................................D‐15
Table D‐13 Acknowledge EJ Upload Block Command .............D‐21
Table D‐14 Acknowledge and Stop EJ Command......................D‐21
Table D‐15 EJ Options and Timers Command............................D‐21
Appendix E
Device Identifiers
Table E‐1 Device Hardware Configuration Data....................... E‐2
Table E‐2 Device Supplies Data.................................................. E‐12
Table E‐3 Supplies Status of all Cash Acceptor Cassettes ...... E‐17
Table E‐4 Most Severe BNA Cassette Supplies Status
Reporting.................................................................... E‐18
Table E‐5 Least Severe BNA Cassette Supplies Status
Reporting.................................................................... E‐18
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xxxix
List of Tables
Table E‐6 Cash Acceptor Supplies:
Extended Message Format....................................... E‐19
Table E‐7 Device Fitness Data..................................................... E‐20
Table E‐8 Cash Acceptor Fitness:
Extended Message Format....................................... E‐25
Table E‐9 Device Tamper Data ................................................... E‐27
Table E‐10 TI Bins (Alarms) Sensor Types .................................. E‐31
Appendix F
ASCII/EBCDIC Conversion Table
Table F‐1 ASCII to EBCDIC Code Conversion............................F‐2
Appendix G
Related Documentation
Table G‐1 Advance NDC Documentation ...................................G‐2
Table G‐2 Provided APTRA Author Documentation ................G‐3
Table G‐3 Other Authoring Environment Documentation .......G‐4
Table G‐4 Additional NDC+ Documentation..............................G‐5
Table G‐5 Other NCR Documentation .........................................G‐6
Table G‐6 CEN‐XFS Documentation ............................................G‐7
Table G‐7 ISO Documentation.......................................................G‐7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xl APTRA™ Advance NDC, Reference Manual
Preface
Purpose and Audience
Purpose and Audience
The publication provides reference data used in Advance NDC as
follows:
Standard NDC state tables, screen, keyboard and printer data,
Supervisor messages, configuration parameters
Financial Institution Tables (FITs)
Terminal to Central messages
Central to terminal messages
Security features
Reserved screens.
The publication is intended for the following:
Audience
Developers who have customised, or wish to customise, the
self‐service terminal (SST) configuration or the messages
between the SST and Central
Programmers responsible for the terminal configuration that
customises the APTRA Advance NDC software
Programmers who write or modify Central control applications
to support SSTs running Advance NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xli
Preface
How to Use This Publication
How to Use This Publication
This section summarises the contents of the Advance NDC, Reference
Manual, and how to use it for different purposes. It also explains the
navigational aids provided, the conventions used and where to
obtain support.
The publication contains the following information:
Contents of the Publication
Chapter 1, “Introducing the Advance NDC System”
Provides an outline of the Advance NDC software, with references
to the APTRA Advance NDC, Overview and the APTRA Advance
NDC, Developer’s Guide for further introductory information.
Chapter 2, “State Tables”
Provides details of the function and format of the standard state
tables, required for customised terminal configuration using
Advance NDC.
Chapter 3, “Screen Data”
Provides details of the screen data, required for customised screen
configuration using Advance NDC; a worksheet for the cardholder
screen layout, including FDK alignment; and some points to
consider when you are preparing screens for display on the
terminal. It also includes the format and use of reserved screens
C09‐C19 for Supervisor settlement transactions.
Chapter 4, “Keyboard Data and Layouts”
Provides details of the keyboard data, required for customised
keyboard configuration using Advance NDC; the keyboard layouts
provided with Advance NDC; and how to calculate the co‐ordinates
that are used to define touch areas on the screen.
Chapter 5, “Printer Data”
Provides details of the printer data, required for customised printer
configuration using Advance NDC.
Chapter 6, “Supervisor Messages”
Provides details of the Supervisor messages, required for
customised Supervisor messages using Advance NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xlii APTRA™ Advance NDC, Reference Manual
Preface
How to Use This Publication
Chapter 7, “Configuration Parameters”
Provides details of the configuration parameters, required for
customised terminal configuration using Advance NDC.
Chapter 8, “Financial Institution Tables”
Provides details of the Financial Institution Tables (FITs), required
for customised FITs using Advance NDC.
Chapter 9, “Terminal to Central Messages”
Provides details of the function and format of each type of message
that is sent from the terminal to Central. This information will help
you to create or modify your Central control application.
Chapter 10, “Central to Terminal Messages”
Provides details of the function and format of each type of message
that is sent from Central to the terminal. This information will help
you to create or modify your Central control application.
Chapter 11, “Security Features”
Provides details of the features that Advance NDC provides to
safeguard against message interference and fraudulent cards. This
information will help you to decode the messages sent from the
terminal to Central, if you are creating or modifying the Central
control application.
Chapter 12, “EMV Smart Card Handling”
Provides an introduction to the smart‐card handling enabled with
Advance NDC.
Chapter 13, “CCM VISA2 Dialup System”
Provides information about message handling when using a
modem for communications with Central.
Appendix A, “Reserved Screens”
Shows the screen positions of all Supervisor and other reserved
screens.
Appendix B, “Character Sets”
Shows the character sets and code pages provided on screens and
printers.
Appendix C, “Cardholder Screen Graphics”
Lists the example cardholder screen graphics provided with
Advance NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xliii
Preface
How to Use This Publication
Appendix D, “Quick Reference to Message Types”
Provides a quick reference to the types of message sent between
Central and the terminal. For each message type, the message class,
sub‐class and fields within the message are identified. This will help
you, if you are a programmer designing the Central control
application, to identify the messages that pass to and from Central.
Appendix E, “Device Identifiers”
Provides details of the device identifiers for each terminal device
and the configuration data associated with them.
Appendix F, “ASCII/EBCDIC Conversion Table”
Defines the code conversion between ASCII, EBCDIC and graphic
characters.
Appendix G, “Related Documentation”
Provides a list of the documentation available to help you migrate to
Advance NDC, and modify or enhance an Advance NDC
application.
If you are a programmer creating the terminal configuration that
Roadmap to the customises the Advance NDC software, see chapters 2 to 8 for
Publication details of state tables, screen, keyboard and printer data, supervisor
messages, configuration parameters and FITs.
If you are a programmer creating a control application for host or
switch (Central), see chapters 9 and 10 for details of the message
types sent between the terminal and Central.
If you are a programmer who has extended or intends to extend
Advance NDC with customised routines (‘Exits’) for the terminal,
see the following:
For information about the creation of Exit States, and the
message types that can pass between Central and Exits, chapters
2 to 4
For information about the message security features you can
use, chapter 11.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xliv APTRA™ Advance NDC, Reference Manual
Preface
How to Use This Publication
The publication can be viewed on‐screen or printed with the Adobe
Navigating the Publication Reader.
The following are available on‐screen:
Hyperlinked page references, for example, from the table of
contents and index
Hyperlinked notes referenced in tables; the table notes are given
at the end of the relevant table and numbered consecutively
within each chapter
Hyperlinked bookmarks in the PDF Bookmarks pane; the
bookmarks give the structure of the publication down to three
heading levels.
The structure of the publication contains the following to help you
find information, or submit comments:
Table Pref-1 Element Description
Navigation Aids
Revision Record Lists updates for the current release in page order
with hyperlinks
Table of Contents Lists the first two heading levels in page order with
page references
Table of Contents Lists the first three heading levels in page order
for chapter or with page references
appendix
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
User Feedback Allows you to comment on the publication by:
Form — Printing the form to fill in and post
— Selecting the email link
— Selecting the web link.
All references to USB printers (receipt, journal and statement) refer
Terms and Abbreviations to devices running on the NCR range of SelfServ SSTs.
Used in the Publication
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xlv
Preface
How to Use This Publication
Devices that allow notes to be deposited and can also allow
notes to be dispensed from separate cassettes (cash in/cash out)
Devices that allow notes to be deposited and can also allow
notes to be dispensed from the same cassette (recycling).
The following table describes the terms used in this publication
when referring to cash acceptors and their variants:
Table Pref-2 Term Refers to...
Terms for Cash Acceptors
Cash acceptor Generic term for any device that accepts note
deposits
See Note 1:
Recycling Generic terms for any device that can accept note
unit/Recycler deposits and also dispense notes and recycle
deposited notes (that is, dispense the deposited
notes)
SNA Single note acceptor
An NCR device that accepts deposits of multiple
notes one by one
See Note 2:
BNA Bunch note acceptor
An NCR 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 device with configurable cassettes that can
accept note deposits and can dispense notes from
separate cassettes
GBRU Global bill recycling unit
An NCR device that accepts note deposits and can
dispense notes using the same cassettes
BRM Bunch Recycling Module
An NCR term for a device that accepts and dispenses
notes as configured using the same cassettes or
separate 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.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xlvi APTRA™ Advance NDC, Reference Manual
Preface
How to Use This Publication
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.
Abbreviations
The following abbreviations are used throughout the publication:
Table Pref‐3 Full Form Abbreviated Form
Abbreviations Used in the Publication
Europay, Mastercard, VISA EMV
CPM and bunch cheque acceptor Cheque processor (when the
information applies to both
devices)
Integrated Circuit Card ICC
Microsoft Windows XP Windows
Professional, Microsoft Windows 7
and POSReady7
For a list of terms and abbreviations used in the publication, see the
Glossary.
NCR recommends you first read the APTRA Advance NDC,
What Else Should I Read? Overview (B006‐6597) and the APTRA Advance NDC, Developer’s
Guide (B006‐6046).
If you are working with Advance NDC on other vendors’ SSTs, you
will also need the APTRA Advance NDC, Multi‐Vendor Support
Reference Manual (B006‐6344).
If you want to extend the functionality of the Advance NDC
application, read APTRA Advance NDC, Extending the Product
(B006‐6926).
All the documentation related to Advance NDC is listed and
described in Appendix G, “Related Documentation”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual xlvii
Preface
Support Information
Support Information
If you have a problem using the software, please contact your
internal support department, or 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 publication, see the “User
Feedback Form” at the back of the publication for our electronic and
postal addresses. Please take the time to reply; your comments are
appreciated.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xlviii APTRA™ Advance NDC, Reference Manual
Table of Contents
Introducing the Advance NDC System
Chapter 1
Introducing the Advance NDC
System
Overview 1‐1
SST Start‐Up Sequence 1‐2
In‐Service Transaction Processing 1‐3
Customisation Data 1‐4
Role of the Central Control Application 1‐5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Introducing the Advance NDC System
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Introducing the Advance NDC System
A
Overview
Overview 1
This chapter introduces Advance NDC under the following topics:
How the SST operates
SST operating modes
Creating the customisation data
Role of the control application on the host or switch (Central).
For information on clearing persistent memory, refer to the APTRA
Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 1-1
Introducing the Advance NDC System
SST Start-Up Sequence
SST Start‐Up Sequence 1
The SST follows the same start‐up sequence when it is switched on.
After the Advance NDC software is loaded, a power‐up message is
sent to the host. The host downloads any necessary data to the SST
in a series of messages. After each message is sent, the SST sends an
acknowledgement back. When the host has sent all the data
successfully, it puts the SST into service, as shown in the following
figure:
Figure 1-1
Start-up Sequence
The SST is now ready for consumers to use.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-2 APTRA™ Advance NDC, Reference Manual
Introducing the Advance NDC System
SST Start-Up Sequence
A consumer transaction is processed as follows:
In‐Service Transaction
Processing 1
1 The SST gathers details from the consumer, and card if one is
used.
2 The SST sends the information in a Transaction Request
message to the host.
3 The host sends a Transaction Reply command instructing the
SST what to do.
4 The SST completes the transaction.
If a fault occurs, the SST sends a message to the host and waits for a
further Transaction Reply command before completing the
transaction. Once the transaction has been completed successfully,
the SST sends a message to the host to confirm it.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 1-3
Introducing the Advance NDC System
Customisation Data
Customisation Data 1
The following table, “Customisation Data”, describes the types of
customisation data downloaded from the host and where to find
further information in this publication.
Table 1-1
Customisation Data
Customisation Data Description
State Tables State definitions that determine how the SST processes transactions. For
details, see Chapter 2, “State Tables”
Screens Information displayed while the consumer is using the SST. For details,
see Chapter 3, “Screen Data”
Printed Screens Information printed while the consumer is using the SST. For details, see
Chapter 5, “Printer Data”
Supervisor Messages The Supervisor messages output to the consumer screen, the enhanced
operator panel, and the receipt and journal printers. For details, see
Chapter 6, “Supervisor Messages”
Configuration Parameters Local configuration parameters such as Amount Buffer size, card
reader/writer error thresholds, and timers. For details, see Chapter 7,
“Configuration Parameters”
Financial Institution Tables (FITs) The financial institutions the SST supports. For each institution, the table
defines whether PIN verification is local or remote, the type of data
encryption, and the position of details on the card. For details, see
Chapter 8, “Financial Institution Tables”
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-4 APTRA™ Advance NDC, Reference Manual
Introducing the Advance NDC System
Role of the Central Control Application
Role of the Central Control
Application 1
The central application on the host or switch must be able to decode
and act on messages it receives from the SST. It must also be able to
code messages in the format that the software running on the SST
can understand — the NDC message format as described in this
publication.
The following table describes the commands and responses sent by
the host to the SST:
Table 1-2
Host Commands and Messages
Command/Response Description
Terminal Commands Instructions sent to the SST
See “Terminal Commands” on page 10‐3.
Transaction Reply Commands Responses from the host to a Transaction Request message from the SST,
telling the SST how to complete the transaction
See “Transaction Reply Command” on page 10‐52.
Customisation Data Commands Customisation data sent to the SST
See “Customisation Data” on the next page and “Customisation Data
Commands” on page 10‐7.
Interactive Transaction Response Messages to the SST to prompt the consumer for more information
See “Interactive Transaction Response” on page 10‐91.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 1-5
Introducing the Advance NDC System
Role of the Central Control Application
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
1-6 APTRA™ Advance NDC, Reference Manual
Table of Contents
State Tables
Chapter 2
State Tables
Overview 2‐1
Introduction to State Tables 2‐2
Invalid State Handling 2‐2
Customising States 2‐2
Unsupported State Types 2‐2
Advance NDC States 2‐3
Reserved States 2‐3
Exit States 2‐3
Standard State Types 2‐3
State Numbers 2‐5
Screen Numbers 2‐5
Extension States 2‐6
Table Entry Value 255 2‐6
Table Entry Value 000 2‐6
A ‐ Card Read State 2‐7
Read Conditions for Smart Card Readers 2‐8
Card Read State and Multiple Card Readers 2‐9
Card Reader Precedence 2‐9
Using the Extension State 2‐10
Defining Dynamic Text for Contactless Tap Error 2‐13
Read Condition Values 2‐13
B ‐ PIN Entry State 2‐16
C ‐ Envelope Dispenser State 2‐19
D ‐ Pre‐Set Operation Code Buffer State 2‐20
E ‐ Four FDK Selection Function State 2‐23
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
State Tables
F ‐ Amount Entry State 2‐25
Voice‐Guided Sessions and Data Entry 2‐25
State Processing 2‐25
Buffer Clearing and AppendBuffer.xml 2‐25
Triple Zero Key on PINpad 2‐26
Touch‐Screen Emulation 2‐26
G ‐ Amount Check State 2‐29
H ‐ Information Entry State 2‐34
Data Entry 2‐34
Overriding Entry Mode, Buffer and Display Parameters 2‐34
Data Entry and Voice Guidance 2‐34
Exiting the Information Entry State 2‐34
Emulated FDKs and Touch‐screen Keyboards 2‐35
Clear Function Key and General‐Purpose Buffers 2‐35
I ‐ Transaction Request State 2‐39
J ‐ Close State 2‐45
Function Operations 2‐45
Receipts, Statements and Envelopes 2‐45
Cards 2‐45
Cardless Transactions 2‐46
Audio 2‐46
K ‐ FIT Switch State 2‐52
_ ‐ Expanded FIT Switch State 2‐53
L ‐ Card Write State 2‐55
M ‐ Enhanced PIN Entry State 2‐57
N ‐ Camera Control State 2‐60
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
State Tables
R ‐ Enhanced Amount Entry State 2‐62
Data Handling 2‐62
Exiting the Enhanced Amount Entry State 2‐63
S ‐ Language Code Switch State 2‐65
T ‐ Card Read ‐ PIN Entry Initiation State 2‐68
PIN Entry Enabled 2‐69
PIN Entry Disabled 2‐69
Audio Support 2‐69
Smart Dip Card Reader 2‐69
Delay Latch/Smart Delay Functionality 2‐70
Card Read, PIN Entry and Multiple Card Readers 2‐71
Card Reader Precedence 2‐71
Using Extension State 2 2‐71
U – Device Fitness Flow Select State 2‐76
Supported Devices 2‐78
Cash Handlers 2‐81
V ‐ Language Select From Card State 2‐82
W ‐ FDK Switch State 2‐84
X ‐ FDK Information Entry State 2‐85
Y ‐ Eight FDK Selection Function State 2‐88
Language Selection in Voice‐Guided Sessions 2‐88
b ‐ Customer‐Selectable PIN State 2‐93
d ... g and z ‐ Exit States 2‐96
k ‐ Smart FIT Check State 2‐97
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
State Tables
m ‐ PIN & Language Select State 2‐98
Considerations for Voice‐Guided Sessions 2‐99
> ‐ Cash Accept State 2‐105
Cash Accept State Operations 2‐105
Pre‐authorised Deposit Limits 2‐106
Auto‐Finish Cash Accept 2‐107
Confirmation Screen 2‐120
Refundable Deposits 2‐121
Direct Deposits 2‐121
Explicit Shutter Control 2‐121
Direct Deposit Error Screen 2‐123
Dynamic Text Definitions 2‐124
Defining Reasons for Note Refusal 2‐124
w ‐ Cheque Accept State 2‐125
z – Master Expansion State 2‐132
z001 – Bunch Cheque Accept State 2‐133
Defining Dynamic Text for Cheque Rejection 2‐138
Defining Dynamic Text for Cheque Refusal 2‐138
z002 – Bunch Cheque Handling State 2‐140
z003 – Cheque Detail Display State 2‐144
Defining Dynamic Data for Cheque Deposit Status 2‐149
z004 – Display Cheque Summary State 2‐150
Current Cheque Index 2‐151
z008 – Insert Card State 2‐156
Insert Card State and Multiple Card Readers 2‐156
Card Reader Precedence 2‐157
Using Extension State 2 2‐157
Unsupported Functions 2‐157
APTRA Promote Flow Points 2‐157
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
State Tables
z009 – Buffer Validation State 2‐163
Date Validation Scenario 2‐164
z010 – Local Cash Dispense State 2‐166
Cardless Transactions 2‐166
Dispense Functionality 2‐166
Foreign Currency Exchange Transactions 2‐166
State Flow after a Successful Dispense 2‐166
Successful Dispense Examples 2‐167
State Flow after a Short Dispense 2‐167
State Flow after a Failed Dispense 2‐167
State Flow after an Unknown Dispense 2‐168
State Flow on Card Ejection 2‐168
State Operation 2‐168
CDI Stores 2‐168
Journaling and Printing 2‐169
Status Updates and Counts 2‐169
Message Handling 2‐170
Unsolicited Status Messages 2‐170
Counts 2‐170
z013 – Data Copy and Compare State 2‐173
Copy Operations 2‐175
Compare Operations 2‐176
z014 – Cash Deposit Handling State 2‐177
Journaling 2‐177
Data Printing 2‐177
z017‐ Note Mix Selection State 2‐180
z020 ‐ FIT Search State 2‐187
FIT Search State Exit 2‐187
z021 ‐ CRM Flowpoint State 2‐189
CRM Flowpoint State 2‐189
z024 ‐ Prepare Dispense State 2‐191
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
State Tables
& ‐ Barcode Read State 2‐192
Barcode Extraction Rules 2‐197
Scenario 1: Barcode Data not within the Limits of Rule
Pattern 2‐198
Scenario 2: Length of Extracted Data Does not Exceed Track
2 Data Length 2‐198
Scenario 3: Extracted Data Length Exceeds Track 2 Data
Length 2‐199
Time‐Out State 2‐201
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
State Tables
B
Overview
Overview 2
States control the information‐gathering part of consumer
transactions. Advance NDC provides a set of standard states, and
mechanisms for replacing standard states or adding new ones.
States that you write yourself are called Exit States.
This chapter describes the function and format of each of the
standard state table types supported in Advance NDC.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-1
State Tables
Introduction to State Tables
Introduction to State Tables 2
A state table is made up of the state number and state type, with
table data. Most states include a screen number and a next state
number as part of the table data. A state number can be decimal
(base 10) or alphanumeric (base 36). In general, where a screen is
present, it is displayed when the state is entered, the SST performs
the action specified by the state type, and the transaction flow
continues from the specified next state. These screens can also
reference associated keyboard layouts for FDKs. For details, see
Chapter 4, “Keyboard Data and Layouts”.
If the next state specified is invalid or undefined, due to either the
Invalid State Handling 2
state table or the Transaction Reply specifying a state that has not
been downloaded, the transaction flow continues from a default
Close state.
When the default Close state is taken, the consumer transaction is
completed by the delivery of a receipt or statement, and the return
or capture of the card as specified. The number of the last state taken
is displayed in the top left hand corner of the consumer screen. This
allows you to check the parameters of the last state taken to find out
which state the SST was attempting to take. From this you can
specify the missing state and include it in the download.
Note: The full state flow can be traced using the STATEDATA trace
stream in the DebugLog or Silent Debug tools. For further
information on these tools, refer to the APTRA Advance NDC,
Developer’s Guide.
You customise a state by assigning values to its parameters. To
Customising States 2
build a state flow, you select different state types and place them in
the application flow by linking the states together—one state
references another with one or more of its parameters or entries.
When you have finished customising the state tables, Central
downloads the information to the SST in Customisation Data
commands. Chapter 10, “Central To SST Messages” describes the
format of these commands.
The following states are not supported in Advance NDC:
Unsupported State Types 2
‘P’ – Courtesy Amount Verification
‘Q’ – DPM Document Accept
‘i’ – Audio Control
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-2 APTRA™ Advance NDC, Reference Manual
State Tables
Introduction to State Tables
The following states are specific to Advance NDC, are not part of
Advance NDC States 2
the standard NDC message interface and require the Advance NDC
application:
Connections State
The Connections state allows the control of a transaction to be
passed to APTRA Connections for completion. For further
information on the Connections state, refer to Appendix H,
“Advance NDC and APTRA Connections” in the APTRA
Advance NDC, Developer’s Guide.
Web Exit State
The Web Exit state can be executed anywhere within the state
flow where an Exit state can be executed. For further
information on the Web Exit state, refer to Appendix G,
“User‐Configurable States” in the APTRA Advance NDC,
Developer’s Guide.
Cardholder Verification State
Cardholder Verification state allows cardholder verification by
Central for transactions that will be processed by another host,
such as a web host for web transactions. For further information
on the Cardholder Verification state, refer to Appendix G,
“User‐Configurable States” in the APTRA Advance NDC,
Developer’s Guide.
The following states are reserved:
Reserved States 2
‘c’ – Device Test state
‘z010’ to ‘z899’ (Master expansion state ‘z’ with sub‐state range)
As well as states ‘d’ to ‘g’, sub‐states ‘z900’ to ‘z999’ are reserved for
Exit States 2
Exit states.
The following table lists each of the supported standard state types
Standard State Types 2
that control transaction processing:
Table 2-1 State Table Type Description
State Table Types
A Card Read
B PIN Entry
C Envelope Dispenser
D Pre‐Set Operation Code Buffer
E Four FDK Selection Function
F Amount Entry
G Amount Check
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-3
State Tables
Introduction to State Tables
State Table Type Description
H Information Entry
I Transaction Request
J Close
K FIT Switch
_ Expanded FIT Switch
L Card Write
M Enhanced PIN Entry
N Camera Control
O Cardholder Verification
R Enhanced Amount Entry
S Language Code Switch
T Card Read ‐ PIN Entry Initiation
U Device Fitness Flow Select
V Language Select From Card
W FDK Switch
X FDK Information Entry
Y Eight FDK Selection Function
Z Extension State
b Customer Selectable PIN State
d ... g Available as identifiers for Exit States
k Smart FIT Check State
m PIN & Language Select State
> Cash Accept State
w Cheque Accept State
z Master Expansion State
z001 Bunch Cheque Accept State
z002 Bunch Cheque Handling State
z003 Cheque Detail Display State
z004 Display Cheque Summary State
z008 Insert Card State
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-4 APTRA™ Advance NDC, Reference Manual
State Tables
Introduction to State Tables
State Table Type Description
z009 Buffer Validation State
z010 Local Cash Dispense State
z013 Data Copy and Compare State
z014 Cash Deposit Handling State
z017 Note Mix Selection State
z020 FIT Search State
z024 Prepare Dispense State
& Barcode Reader State
z900 to z999 Available as identifiers for Exit States
Note: During transaction processing, before entry to each state,
Advance NDC checks the keyboard layout to be used. If the screen
that is about to be used references a touch‐screen keyboard number
but the touch‐screen keyboard layout does not provide definitions
of all the required keys, the transaction flow goes to the default
Close state.
Alphanumeric (base 36) numbers in state table entries are supported
State Numbers 2
as well as decimal (base 10). Using alphanumeric data provides
support for up to 46655 state numbers, without changing the table
entry length. In previous releases of Advance NDC only decimal
(base 10) numbers were supported, providing a maximum of 999
state numbers. The character field in the state entries contains either
a decimal or alphanumeric number, depending on the value of
Option 80. For details, see “Option 80 – Alphanumeric State Entry”
on page 7‐21.
Decimal numbers are in the range ‘000’ to ‘999’.
Alphanumeric numbers are in the range ‘000’ to ‘ZZZ’.
The value ‘255’ is always reserved unless stated otherwise in the
table entry.
Up to 999 screens can be specified in state table entries for screens,
Screen Numbers 2
using the range 000 to 999. For the first character of the screen
number, using an alphabetic character in the range A to Z instead of
a digit extends support to more than 999 screens, including
multi‐language screens, without changing the table entry length.
With alphabetic characters, the range of screen numbers is ‘000’ to
‘Z99’. The characters are mapped to digits starting with A, which is
equal to 10, and increasing by one until Z, which is equal to 35. For
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-5
State Tables
Introduction to State Tables
example, a screen defined as A34 is mapped to 1034 and a screen
defined as Z34 is mapped to 3534. The actual screens displayed
depend on the specification of the first screen (the screen base) in
each range of screens for the selected language (screen group).
Typically, the full range of 9999 screens supported by Advance
NDC can be accessed by setting an offset to select a language. For
information on the way in which the screen numbering is affected
by the use of offsets, the screen base and language selection, see
“Multi‐Language Screens” on page 3‐48.
Many state types allow the use of extension states (state type ‘Z’).
Extension States 2
The use of each extension state is described in the state tables.
Table Entry Value 255 2
Unless specified in the state table description, the value ‘255’ is
reserved. Using a value of ‘255’ when not explicitly specified in the
state table description can result in unintended consequences
during state execution.
Table Entry Value 000 2
Whether an extension state is optional or mandatory depends on the
context and conditions of the transaction flow. Conditions for the
use of value ‘000’ are as follows:
If an extension state is not mandatory and not used in the
transaction flow, use the value ‘000’ unless a different value is
explicitly specified in the state table description.
If an extension state is mandatory, do not use the ‘000’ value.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-6 APTRA™ Advance NDC, Reference Manual
State Tables
A - Card Read State
A ‐ Card Read State 2
When you use the Card Read state table, ensure it is the first table
used during transaction processing by assigning state number 000
to it. The SST automatically enters state 000 when put In‐Service.
Cardless transactions can be initiated in this state if Enhanced
Configuration Parameter option 77 is used. For details, see “Option
77 – Next State Number” on page 7‐19.
Note: If a Dip and Smart Hardware (DASH) reader is used with
this state, the DASH reader behaves as a standard dip reader.
When the SST enters the Card Read state, the following buffers are
initialised:
Table 2-2 Buffer Initialised to...
Buffers Initialised for State A
Card Data buffers no data
PIN and General Purpose buffer no data
Amount buffer zero filled
Operation Code buffer space filled
FDK buffer zero filled
The Card Read state performs the following actions:
Displays the screen selected to prompt the consumer to enter a
card
Displays the error screen selected if the card cannot be read
If all the read conditions are magnetic only, attempts to read
Track 1 for future name display
Sets the Media Entry Indicator flashing while the card reader is
waiting for the consumer to enter a card. The indicator is
switched off when the card is entered.
Executes the Prepare Dispense operation after a successful card
read or upon initiation of a cardless transaction. For information
on Prepare Dispense feature, refer to section “Prepare Dispense”
in Chapter 5, “Configuring Advance NDC and Associated
Components” of the APTRA Advance NDC, Developer’s Guide.
It also sets the following information:
The next state number the SST goes to if the card is read
successfully
Which track(s) and/or chip data on the card will be read
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-7
State Tables
A - Card Read State
When the card should be returned to the consumer. You can
specify in table entry 8 that the card is returned immediately or
after the SST has received a Transaction Reply command from
Central
The next state number the SST goes to if the financial institution
ID on the card does not match any FIT entry
The next state number the SST goes to if the card is a smart card,
and the read condition being evaluated has the chip connect bit
set.
If an attempted card eject fails during the above state processing, the
card is captured and screen ‘C04’ is displayed for the time specified
by timer 02. For details of reserved screens, see the “C – Cardholder
Display” section in Chapter 3, “Screen Data”. For details of timers,
see the “Configuration Parameters Load” section in Chapter 10,
“Central to Terminal Messages”.
If the card read conditions are not satisfied due to an invalid card or
a mechanism error, the card is ejected and screen ‘C02’ is displayed.
After two attempts at ejecting the card, Advance NDC tries to
capture the card. If the card reader jams during card capture,
Advance NDC reports an unsolicited status message (card jam
during capture) with a fatal severity status.
If the consumer does not take the card before timer 09 expires, the
SST captures the card. When an invalid card is removed by the
consumer or captured by the SST, the card reader is enabled for the
next card entry.
If you have specified in table entry 8 that the card should be
returned immediately, the transaction will proceed to the next
defined state following card removal. However, if the card is
captured after an eject, the card reader is enabled for the next card
entry.
Read Conditions for Smart Card Readers 2
For all types of smart card readers, if the chip connect bit is to be set,
NCR recommends this be set in the Read Condition 3 (table entry 7
of Card Read State A and Card Read ‐ PIN Entry Initiation State T,
and table entry 8 of Insert Card State z008) to permit the magnetic
read conditions to be fully tested first. If a magnetic read condition
is met, the state will attempt to match the relevant card data to the
FIT data. For details on read conditions, see “A ‐ Card Read State”
on page 2‐10, “T ‐ Card Read ‐ PIN Entry Initiation State” on
page 2‐68 and “z008 – Insert Card State” on page 2‐156.
For contact smart card readers, if the chip connect bit is to be set in
any of the read conditions, the ‘EMV/CAM2 Exits for APTRA
Advance NDC’ product is used. If all the magnetic read conditions
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-8 APTRA™ Advance NDC, Reference Manual
State Tables
A - Card Read State
fail and the chip connect bit is set, no FIT match is attempted and the
application proceeds to the No FIT Match Next State.
For contactless smart card readers, if all the magnetic read
conditions fail and the chip connect bit is set, the state will attempt
to match the relevant card data to the FIT data. Depending on the
result of the search either the FIT Match or No FIT Match next state
number will be used. To use contactless card readers, the
‘EMV/CAM2 Exits for APTRA Advance NDC’ product must be
installed.
For more information, see “Read Conditions and FIT Match” on
page 12‐2.
The Card Read state has an extension state to support multiple card
Card Read State and readers. Multiple card readers can be enabled by this state to allow
Multiple Card Readers 2
consumer sessions to be initiated by different types of cards.
Advance NDC supports up to two card readers on an SST: contact
and contactless card readers.
Table entry 8 (Card Return Flag) of the Card Read state table is
overloaded to contain either the Card Return Flag or the value for
the extension state as there are no table entries available to contain
the reference to the extension state.
If the extension state is not provided, all available card readers are
enabled. The following values of the Card Read state table apply to
the enabled card readers:
The read conditions (table entries 5 to 7)
The Good Read Next State Number (table entry 3) or the No FIT
Match Next State Number (table entry 9)
Note: Enabled card readers are always journaled. For more
information on card reader journaling, refer to section, “Journaling
Card Reader Events” in Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC, Developer’s
Guide.
Card Reader Precedence 2
When multiple card readers are active, and one of them is a contact
card reader and the other is a contactless card reader, the contact
card reader takes precedence over the contactless card reader.
If an SST has both card readers, and a card is inserted into the
contact card reader, the contactless card reader is disabled. If a card
is detected by both card readers, the card detected by the contact
card reader will be processed and the card detected by the
contactless card reader will be ignored. Misreads can occur if a card
is inserted and a card tapped simultaneously, due to the way the
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-9
State Tables
A - Card Read State
Advance NDC application processes card reads. For details, refer to
section “Configuring Readers” in Chapter 5, “Configuring Advance
NDC and Associated Components” of the APTRA Advance NDC
Developer’s Guide.
For more information on contactless card readers, refer to section,
“Contactless Card Reader Configuration” in Chapter 5,
“Configuring Advance NDC and Associated Components” of the
APTRA Advance NDC, Developer’s Guide.
Using the Extension State 2
The types of card readers that are enabled are specified in table
entry 3 (Active Card Readers) of the extension state. The extension
state also provides a Secondary Card Reader Good Read Exit (table
entry 2) for cards read by the secondary card reader.
Table 2-3
A - Card Read State
Table Number of
Contents Description
Entry Bytes
1 1 State Type ‘A’
2 3 Screen Number Display screen that prompts the consumer to enter
(Range 000‐Z99) the card. While the SST is waiting for card entry,
this screen is displayed.
3 3 Good Read Next State Number State number to which the SST goes:
(Base 10 range 000‐254 or 1. Following a good read of the card if FITs are not
256‐999) used (Table entry 9 = 000)
(Base 36 range 000‐254 or or
256‐ZZZ) 2. If the Financial Institution number on the card
matches a Financial Institution number in a FIT
4 3 Error (Misread) Screen Number If the read conditions are not satisfied due to a bad
(Range 000‐Z99) card or a mechanism error, the card is ejected and
this screen is displayed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-10 APTRA™ Advance NDC, Reference Manual
State Tables
A - Card Read State
Table Number of
Contents Description
Entry Bytes
5 3 Read Condition 1 These three entries specify which card track(s)
and/or chip data will be read. The possible values
6 3 Read Condition 2 for these entries are shown in Table 2‐6 in the next
7 3 Read Condition 3 section.
8 3 Card Return Flag Card Return Flag
(Range 000‐001) Tells the SST when to return the card to the
or consumer:
Extension State Number 000 ‐ eject the card immediately.
(Base 10 range 002‐254 or 001 ‐ return the card as specified by a Transaction
256‐999) Reply command message.
(Base 36 range 002‐254 or or
256‐ZZZ) Extension State Number
Any value other than 000 or 001 is the state number
for Extension State 1.
For more information about extension states, see
“Extension States” on page 2‐6.
9 3 No FIT Match Next State State number to which the SST goes if either the
Number Financial Institution number on the card does not
(Base 10 range 000‐254 or match any FIT, or if the card reader is a smart card
256‐999) reader and the read condition being evaluated has
(Base 36 range 000‐254 or the chip connect bit set (bit 3).
256‐ZZZ) If FITs are not used, this entry must be 000.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-11
State Tables
A - Card Read State
Table 2-4
Extension 1 to State
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘Z’
2 3 Secondary Card Reader State number to which the SST goes when the secondary card
Good Read Next State reader has successfully read the card and one of the following is
Number true:
(Base 10 range 000‐254 or Following a good read of the card if FITs are not used (Table entry
256‐999) 9 in extension state = 000)
(Base 36 range 000‐254 or
if the financial institution number on the card matches a
256‐ZZZ)
Financial Institution number in a FIT.
3 3 Active Card Readers Tells the SST which card readers to activate as follows:
(Range 000‐003) 000 ‐ All available card readers
001 ‐ Primary card reader
002 ‐ Secondary card reader
003 ‐ Primary and secondary card readers only
The default value is 000.
4 3 Secondary Card Reader
Read Condition 1
These three entries specify which card track(s) will be read. The
5 3 Secondary Card Reader possible values for these entries are shown in Table 2‐6, “Read
Read Condition 2 Condition Bit Information” on page 2‐13
6 3 Secondary Card Reader See Table Note 31
Read Condition 3
7 3 Card Return Flag Tells the SST when to return the card to the consumer:
(Range 000‐001) 000 ‐ eject the card immediately.
001 ‐ return the card as specified by a Transaction Reply command
message.
8 3 Contactless Tap Error This screen is displayed when a problem is detected during a
Screen (000‐Z99) contactless card tap. If this parameter is ‘000’, then the screen
identified by the Error (Misread) Screen Number (table entry 4 of
the Card Read State A, see “A ‐ Card Read State” on page 2‐10) is
displayed.
If the reason for the failure is to be displayed, it must be defined in
a dynamic text for contactless tap error within this screen
definition. The reason is displayed at the screen position where the
dictionary is defined. The reasons for failure that must be included
in the dictionary are described in “Defining Dynamic Text for
Contactless Tap Error” on page 2‐13.
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-12 APTRA™ Advance NDC, Reference Manual
State Tables
A - Card Read State
To define the text to be displayed when reading a contactless card
Defining Dynamic Text for fails during the Card Read state A, the Card Read ‐ PIN Entry
Contactless Tap Error 2
Initiation State T or Insert Card State z008, the enumerated values
and definitions must be defined. These values and definitions are
included in a dynamic text dictionary control sequence with a
Dictionary ID of 000. For details of this control sequence, see
“Display Dynamic Text Dictionary Control Sequence” on page 3‐39.
Table 2‐5 lists the enumerated values and their definitions. The
display text must reflect these definitions and match the available
space and language of the screen.
Table 2-5 Enumerated Value Definition
Dynamic Text for Contactless Tap Error
Reasons 001 Please insert a card into the card reader
002 Try a different card
003 See Phone for Instructions
(This option is currently not supported.)
004 Please present only one card
999 The optional default text to display when specific text
is not provided.
Read Condition Values 2
The following table, “Read Condition Bit Information” shows which
tracks are read when each bit is set in the read condition. The
decimal values shown correspond to the state table entries
described in Table 2‐3, “A ‐ Card Read State” on page 2‐10.
Table 2-6 Bit Number Binary Decimal Meaning
Read Condition Bit Information
0 0001 001 Read Track 3
1 0010 002 Read Track 2
1 and 0 0011 003 Read Track 2 and 3
2 0100 004 Read Track 1
2 and 0 0101 005 Read Track 1 and 3
2 and 1 0110 006 Read Track 1 and 2
2, 1 and 0 0111 007 All tracks
3 1000 008 Chip connect ‐ read smart data
4‐7 Reserved
A read condition will fail if it is set to a decimal value outside the
range shown.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-13
State Tables
A - Card Read State
Read conditions are evaluated in order. For an example of the
evaluation process for magnetic‐only read conditions (that is, none
of the read conditions has the chip connect bit set), see the graphic
“Read Condition Flow” on page 2‐15. For information on read
condition operations, where the chip bit is set in one or more
conditions, see Chapter 12, “EMV Smart Card Handling”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-14 APTRA™ Advance NDC, Reference Manual
State Tables
A - Card Read State
Figure 2-1
Read Condition Flow Evaluate Read
Condition 1
Y
Satisfied?
Evaluate Read
Condition 2
Y
Good Read Next State Number
Satisfied?
(table entry 3)
Evaluate Read
Condition 3
Y
Satisfied?
Error Screen Number (table
entry 4)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-15
State Tables
B - PIN Entry State
B ‐ PIN Entry State 2
The SST should not enter this state unless the Financial Institution
number on the card matches a Financial Institution number in a FIT
during the Card Read state. For details, see Chapter 8, “Financial
Institution Tables”. This state does not have to be the next state after
the Card Read state.
When specified in the FIT, PIN verification can take place at either
the SST or Central. If verified at Central, the PIN is transmitted in an
encrypted form. If local DES PIN verification is specified in the FIT
and no DES encryptor is available, the Maximum Bad PINs Next
State exit is taken. If DES encrypted PIN transmission is specified in
the FIT and no DES encryptor is available, an empty PIN buffer field
is included in the Transaction Request message.
If the conditions specified in the FIT Data Load message (detailed
on page 10‐22) for local PIN verification, remote PIN encryption and
indirect next state processing are not met, PIN verification will fail
and the Maximum Bad PINs Next State exit is taken.
The consumer enters the PIN, which can consist of four to sixteen
digits, on the facia keyboard. If the consumer enters fewer than the
number of digits specified in the FIT entry, PMXPN, the consumer
must press FDK ‘A’ (or FDK ‘I’ if the keys to the left of the consumer
screen are enabled) or the Enter key after the last digit has been
entered. Pressing the Clear key clears all digits.
Table 2-7
B - Pin Entry State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘B’
2 3 Screen Number Display screen that prompts the consumer to enter
(Range 000‐Z99) the PIN the first time. This screen, which is
displayed on entering the PIN Entry state, must
leave the consumer screen cursor at the start of the
PIN Entry display area. An ‘X’ is displayed for each
key pressed.
3 3 Time‐Out Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or does not enter the PIN within the permitted time
256‐999) limit. Enter 255 if the time‐out function is not
(Base 36 range 000‐254 or required.
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-16 APTRA™ Advance NDC, Reference Manual
State Tables
B - PIN Entry State
Table Number of
Contents Description
Entry Characters
4 3 Cancel Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or presses the Cancel key before the maximum number
256‐999) of digits specified for the PIN have been entered.
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Local PIN Check Good PIN State number to which the SST goes after
Next State Number verification of a correct PIN entry. A Pre‐Set
(Base 10 range 000‐254 or Operation Code Buffer state (clearing the function
256‐999) key buffer before Transaction Selection) usually
(Base 36 range 000‐254 or follows a correct PIN entry.
256‐ZZZ)
See Table Note 2.
6 3 Local PIN Check Maximum Bad State number to which the SST goes if the correct
PINs Next State Number PIN has not been entered after the number of
(Base 10 range 000‐254 or attempts allowed by table entry 9. The SST
256‐999) normally enters a Close state if this occurs.
(Base 36 range 000‐254 or
256‐ZZZ)
See Table Note 1, Table Note 2.
7 3 Local PIN Check Error Screen Display screen that prompts the consumer to
Number re‐enter the PIN. This screen is displayed after each
(Range 000‐Z99) incorrect PIN entry attempt. An ‘X’ is displayed for
See Table Note 1, Table Note 2. each key pressed. After the number of re‐entry
attempts allowed by table entry 9, the SST enters
the state determined by table entry 6.
8 3 Remote PIN Check Next State State number to which the SST goes when local PIN
Number verification is not performed.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
9 3 Local PIN Check Maximum PIN Maximum number of incorrect PIN entries allowed
retries before the SST enters the state determined by table
(Range 001‐009) entry 6.
See Table Note 1, Table Note 2.
Table Note 1: These Local PIN fields (6, 7 and 9) are also used
when the Check Remote PIN minimum length option is used; they
are used in the same way as for Local PIN verification. An incorrect
PIN is one which is less than the minimum length.
As these Local PIN fields can be used with Remote PIN verification,
they must contain valid entries when either Remote or Local PIN
verification is used.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-17
State Tables
B - PIN Entry State
Table Note 2: To support secure PIN encryption, fields 5, 6, 7 and 9
must always be set up, as they are used to control the number of
allowed PIN retries when fewer than four PIN digits are entered.
With secure PIN encryption, a check for the minimum four PIN
digits is performed regardless of whether the FIT specifies to check
for shorter PINs or not.
For FIT data details, see Chapter 8, “Financial Institution Tables”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-18 APTRA™ Advance NDC, Reference Manual
State Tables
C - Envelope Dispenser State
C ‐ Envelope Dispenser State 2
Use this state if your SST has an envelope dispenser. If the state is
entered on an SST without the dispenser, it performs no action and
takes the next state exit immediately. On an SST with an envelope
dispenser, an envelope is presented before the exit is taken. If the
envelope is presented successfully, the MEI is switched on where a
combined envelope dispenser and depository MEI is present. The
MEI is switched off when the envelope is taken or retracted. If the
envelope is not taken by the consumer, it is retracted when the SST
enters the Close state.
Note: In Advance NDC, an envelope is dispensed when the
Transaction Reply command message is processed if an envelope
has not previously been dispensed in the Envelope Dispenser state.
Advance NDC does not attempt to dispense envelopes unless
envelopes are present in the dispenser.
Table 2-8
C - Envelope Dispenser State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘C’
2 3 Next State Number State number that the SST enters immediately or
(Base 10 range 000‐254 or after an envelope is presented.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3‐9 21 Must be 000. Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-19
State Tables
D - Pre-Set Operation Code Buffer State
D ‐ Pre‐Set Operation Code Buffer
State 2
This state will either clear the Operation Code buffer by filling
selected bytes (to a maximum of eight) with the graphic character
‘space’, or it will pre‐set the buffer with graphic characters ‘A’, ‘B’,
‘C’, ‘D’, ‘F’, ‘G’, ‘H’ or ‘I’. These characters correspond to the eight
Function Display Keys.
Table 2-9
D - Pre-set Operation Code Buffer State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘D’
2 3 Next State Number State number to which the SST goes after
(Base 10 range 000‐254 or pre‐setting the Operation Code buffer.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Clear Mask Specifies bytes of Operation Code buffer to be
(Range 000‐255) cleared to graphic ‘space’. Each bit relates to a byte
in the Operation Code buffer. If a bit is zero, the
corresponding entry is cleared. If a bit is one, the
corresponding entry is unchanged.
See Table Note 3.
4 3 ‘A’ Pre‐Set Mask The buffer contains eight bytes. This entry sets the
(Range 000‐255) specified bytes to ‘A’. If a bit is one, the
corresponding entry is set to ‘A’. If a bit is zero, the
corresponding entry is unchanged.
See Table Note 3.
5 3 ‘B’ Pre‐Set Mask The buffer contains eight bytes. This entry sets the
(Range 000‐255) specified bytes to ‘B’. If a bit is one, the
corresponding entry is set to ‘B’. If a bit is zero, the
corresponding entry is unchanged.
See Table Note 3.
6 3 ‘C’ Pre‐Set Mask The buffer contains eight bytes. This entry sets the
(Range 000‐255) specified bytes to ‘C’. If a bit is one, the
corresponding entry is set to ‘C’. If a bit is zero, the
corresponding entry is unchanged.
See Table Note 3.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-20 APTRA™ Advance NDC, Reference Manual
State Tables
D - Pre-Set Operation Code Buffer State
Table Number of
Contents Description
Entry Characters
7 3 ‘D’ Pre‐Set Mask The buffer contains eight bytes. This entry sets the
(Range 000‐255) specified bytes to ‘D’. If a bit is one, the
corresponding entry is set to ‘D’. If a bit is zero, the
corresponding entry is unchanged.
See Table Note 3.
8 3 Must be 000. Reserved
9 3 Extension State Number State number of the Extension state containing
(Base 10 range 000‐254 or information on how the other operation codes are
256‐999) pre‐set.
(Base 36 range 000‐254 or For more information about extension states, see
256‐ZZZ) “Extension States” on page 2‐6.
Table 2-10
Extension to State D
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 ‘F’ Pre‐Set Mask The buffer contains eight bytes. This entry sets the
(Range 000‐255) specified bytes to ‘F’. If a bit is one, the
corresponding entry is set to ‘F’. If a bit is zero, the
corresponding entry is unchanged.
See Table Note 3.
3 3 ‘G’ Pre‐Set Mask The buffer contains eight bytes. This entry sets the
(Range 000‐255) specified bytes to ‘G’. If a bit is one, the
corresponding entry is set to ‘G’. If a bit is zero, the
corresponding entry is unchanged.
See Table Note 3.
4 3 ‘H’ Pre‐Set Mask The buffer contains eight bytes. This entry sets the
(Range 000‐255) specified bytes to ‘H’. If a bit is one, the
corresponding entry is set to ‘H’. If a bit is zero, the
corresponding entry is unchanged.
See Table Note 3.
5 3 ‘I’ Pre‐Set Mask The buffer contains eight bytes. This entry sets the
(Range 000‐255) specified bytes to ‘I’. If a bit is one, the
corresponding entry is set to ‘I’. If a bit is zero, the
corresponding entry is unchanged.
See Table Note 3.
6‐9 12 Must be 000. Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-21
State Tables
D - Pre-Set Operation Code Buffer State
Table Note 3: The eight bits represent the binary equivalent of their
respective masks. Bit 0 relates to the first entry, bit 7 relates to the
eighth entry. For example, in the following mask,
b7 b6 b5 b4 b3 b2 b1 b0
0 0 1 0 1 0 1 0
the three decimal characters in the table entry are 042. The bytes in
the Operation Code buffer modified are 2, 4 and 6.
The Operation Code buffer is set in the order:
‘space’, ‘A’, ‘B’, ‘C’, ‘D’, ‘F’, ‘G’, ‘H’ and ‘I’.
Therefore, if a later value sets the same bit, it will be the one that is
pre‐set.
For example, F = 042 and I = 006 results in the following Operation
Code buffer:
‘_IIF_F__’
while F = 042 and I = 004 results in the following:
‘_FIF_F__’
In this example, ‘_’ represents a space character.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-22 APTRA™ Advance NDC, Reference Manual
State Tables
E - Four FDK Selection Function State
E ‐ Four FDK Selection Function
State 2
This state reads which one of the four FDKs (Function Display Keys)
to the right of the consumer screen (‘A’, ‘B’, ‘C’ or ‘D’) has been
selected by the consumer.
You can enable the four FDKs to the left of the screen (‘I’, ‘H’, ‘G’
and ‘F’), instead of the four to the right, by setting option digit 7a.
For information on option digits, refer to the APTRA Advance NDC,
Supervisor’s Guide.
Enabling the four keys to the left of the screen means that keys ‘I’,
‘H’, ‘G’ and ‘F’ assume the functionality of keys ‘A’, ‘B’, ‘C’ and ‘D’
respectively. If the consumer selects one of these keys, the key code
for that function is stored in the Operation Code buffer as key ‘A’ to
‘D’. The transaction then goes to the next state.
In Table 2‐11, “E ‐ Four FDK Selection Function State” on page 2‐24,
entries 5 to 8 define which FDKs are to be active during this state. If
you need to use any other FDK, you should use the Eight FDK
Selection Function state table.
The SST may support Touch Screen FDK Emulation instead of
regular FDKs. In this case, eight fixed touch areas are defined on the
screen, which the consumer touches instead of pressing the
corresponding FDK. The touch areas are enabled/disabled in exactly
the same way as the FDKs. For details, see the “FDK Emulation”
section in Chapter 4, “Keyboard Data and Layouts”.
Alternatively, the SST may support full touch screen keyboards. In
this case, touch areas are defined on the screen for all the required
keys. The consumer touches these instead of pressing a key on the
keypad or an FDK. For details, see Chapter 4, “Keyboard Data and
Layouts”.
Note: For a voice‐guided session, this state checks
AudioGuidanceData.xml to identify the numeric keys used to
represent the FDKs. If the consumer chooses to turn on the Hide
Screen option, the FDKs are disabled for all entry states. If the Hide
Screen option is off, both the FDKs and numeric keys are active.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-23
State Tables
E - Four FDK Selection Function State
Table 2-11
E - Four FDK Selection Function State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘E’
2 3 Screen Number Display screen that requests the consumer to
(Range 000‐Z99) choose between transaction types, account names,
and so on. This screen must be aligned with the
active FDKs, and is displayed when the SST enters
the Four FDK Selection Function state. For details,
see the “C – Cardholder Display” on page 3‐6.
3 3 Time‐Out Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or does not respond to the screen message within the
256‐999) permitted time limit. Enter 255 if the time‐out
(Base 36 range 000‐254 or function is not required.
256‐ZZZ)
4 3 Cancel Next State Number State number to which the SST goes if the Cancel
(Base 10 range 000‐254 or key is pressed.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 FDK ‘A’ (or ‘I’) State number to which the SST goes if the specified
Next State Number FDK or touch area is pressed.
(Base 10 range 000‐254 or 256‐999)
6 3 FDK ‘B’ (or ‘H’) (Base 36 range 000‐254 or 256‐ZZZ)
Next State Number Enter 255 to deactivate any FDK or touch area.
7 3 FDK ‘C’ (or ‘G’)
Next State Number
8 3 FDK ‘D’ (or ‘F’)
Next State Number
9 3 Buffer Location Defines the Operation Code buffer byte in which
(Range 000‐007) the keycode for the selected FDK is stored.
Entry Value Position in Buffer
‘000’ 1st byte
‘001’ 2nd byte
‘002’ .
‘003’ .
‘004’ .
‘005’ .
‘006’ .
‘007’ 8th byte
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-24 APTRA™ Advance NDC, Reference Manual
State Tables
F - Amount Entry State
F ‐ Amount Entry State 2
This state reads the amount entered by the consumer, displays it on
the consumer screen, and saves it in the Amount buffer, the contents
of which are sent in the Transaction Request message. The field
length for this buffer is eight digits, or twelve if Enhanced
Configuration Parameter option 1 is used. A parameter in
AppendBuffer.xml, AmountEntryLength, allows the consumer to
enter any number of characters in the screen echo field, up to a
maximum of twelve.
If you require multi‐lingual support for amount entry, see “R ‐
Enhanced Amount Entry State” on page 2‐62. If you want to let the
consumer select the note mix to be dispensed, see “z017‐ Note Mix
Selection State” on page 2‐180.
For details of the issues to be considered when a a consumer selects
Voice‐Guided Sessions and a voice‐guided session, see “Data Entry and Voice Guidance” on
Data Entry 2
page 2‐34.
The SST exits from the Amount Entry state once the consumer
State Processing 2
presses an active FDK or the Cancel key. It also exits from this state if
the consumer does not press a key within the specified time limit.
For details of timers, see the “Configuration Parameters Load”
section in Chapter 10, “Central to Terminal Messages”.
If the consumer presses the Enter key, the behaviour depends on the
value set in the MapEnterKeyToFDK registry entry. For information
on mapping the Enter key to an FDK, refer to Chapter 5,
“Configuring Advance NDC and Associated Components” in the
APTRA Advance NDC, Developer’s Guide.
If the consumer presses the Clear key, which is always active, the
Amount buffer and the screen echo field are cleared to allow the
consumer to re‐enter the correct amount.
Once the configured number of characters is reached, the next key
Buffer Clearing and clears the buffer, resetting the value to 0 and restarting the entry
AppendBuffer.xml 2
from the beginning. A parameter in AppendBuffer.xml can be
configured to prevent clearing of the amount when the configured
limit is reached.
AppendBuffer.xml can be downloaded as described in “XML
Configuration Download” on page 10‐49 or installed locally. For
details of AppendBuffer.xml, refer to the APTRA Advance NDC,
Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-25
State Tables
F - Amount Entry State
Advance NDC supports the 000 key on PINpad in the Amount Entry
Triple Zero Key on state. The 000 key is enabled by configuring the bape.cnf file. If the
PINpad 2
number of digits in the amount entry field is less than or equal to the
size of the amount buffer (8 or 12 digits based on the Enhanced
Configuration Parameter option 01) or the amount entry length
configured in the AppendBuffer.xml file, then the key appends three
zeros in a single key press to the existing amount.
The following are the attributes defined in the AppendBuffer.xml file:
AmountEntryLength
AllowUpToMaxLength
NoOfZeros
For more information on the attributes, refer to table, “Amount
Entry XML Schema” in Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC, Developer
Guide.
When the AllowUpToMaxLength attribute value is YES, Advance
NDC verifies if the number of digits in the amount field that is
generated after pressing the 000 key does not increment beyond the
configured amount entry length. If the number of digits is less than
or equal to the configured amount entry length, three zeros are
added.
For example, if the AmountEntryLength attribute value is 8 and
amount entered is 88888, pressing the 000 key will make the
amount entry field as 88888000. However, if the amount entered is
8888888, pressing the 000 key will not add any digits to the entered
amount and will display the amount as 8888888.
When the AllowUpToMaxLength attribute value is NO, Advance
NDC verifies if the number of digits in the amount field that is
generated after pressing the 000 key does not increment beyond the
configured amount entry length. If the number of digits is less than
or equal to the configured amount entry length, the screen echo
field is enabled for further input.
For example, if the AmountEntryLength attribute is 8 and amount
entered is 888, pressing the 000 key will make the amount entry field
as 8888000. However, if the amount entered is 8888888,
pressing the 000 key will not add any digits to the entered amount
and will make the amount field as 0.
If the SST supports touch‐screen FDK emulation instead of physical
Touch‐Screen Emulation 2
FDKs, eight fixed touch areas are defined on the screen, which the
consumer touches instead of pressing the corresponding FDK. The
touch areas are enabled and disabled in exactly the same way as the
FDKs. For details, see “FDK Emulation” on page 4‐2 of Chapter 4,
“Keyboard Data and Layouts”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-26 APTRA™ Advance NDC, Reference Manual
State Tables
F - Amount Entry State
Alternatively, the SST may support full touch‐screen keyboards. In
this case, touch areas are defined on the screen for all the required
keys. The consumer touches these instead of pressing a key on the
keypad or an FDK. For details, see Chapter 4, “Keyboard Data and
Layouts”.
Note: In a voice‐guided session, keyboard echoing is available but
.wav files are not supported for amount entry echoing.
Table 2-12
F - Amount Entry State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘F’
2 3 Screen Number Display screen that prompts the consumer to enter
(Range 000‐Z99) an amount. This screen is displayed when the SST
enters the Amount Entry state.
3 3 Time‐Out Next State Number State number to which the SST goes if the amount
(Base 10 range 000‐254 or entry is not made within the permitted time limit.
256‐999) Enter 255 if the time‐out function is not required.
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Cancel Next State Number State number to which the SST goes if the Cancel
(Base 10 range 000‐254 or key is pressed.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 FDK ‘A’ (or ‘I’) State number to which the SST goes if the consumer
Next State Number presses an FDK or touch area. Normally one FDK
or touch area is designated for correct amount
6 3 FDK ‘B’ (or ‘H’) entries and another for incorrect amount entries.
Next State Number The remaining two FDKs or touch areas are
7 3 FDK ‘C’ (or ‘G’) inactive.
Next State Number (Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or 256‐ZZZ)
8 3 FDK ‘D’ (or ‘F’) Enter 255 to deactivate an FDK or touch area.
Next State Number
9 3 Amount Display Screen Overlay screen for setting the consumer screen
Number cursor position.
(Range 000‐Z99) See Table Note 4
Additional zeroes can be added automatically to
the amount buffer.
See Table Note 5.
The default echo field for eight digits is:
bbbbb$b0.00
where b = space.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-27
State Tables
F - Amount Entry State
Table Number of
Contents Description
Entry Characters
The default echo field for twelve digits is:
bbbbbbbbb$b0.00
where b = space.
Table Note 4: This screen optionally defines the initial display
format before amount entry by the consumer. The cursor should be
set on the left‐hand side of the echo field on the screen. This is space
filled until the required start position for the currency character is
reached. For details, see “International Currency Display Format”
on page 3‐44.
Table Note 5: If required by the host, the screen can be configured
to add extra zeros automatically to the amount buffer, after the
decimal point. This configuration is defined in the AppendBuffer.xml
file.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-28 APTRA™ Advance NDC, Reference Manual
State Tables
G - Amount Check State
G ‐ Amount Check State 2
This state checks whether the amount entered can be dispensed.
This does not check for coins. Two checks are performed:
Whether the amount held within a specified buffer is a multiple
of an identified value.
Whether the amount held within a specified buffer is
dispensable when taking into account the currency required,
denominations available, dispenser status and cassette status.
Note counts are ignored.
Note: For dual cash handlers, this state is not supported when the
“Amount Check Condition (Range 000 ‐ 003)” on page 2‐31 is set to
003.
To be able to check that an amount is dispensable, Central must
have downloaded the Dispenser Currency Cassette Mapping Table,
which associates the currency type, cassette type and denomination
for the host and SST (see page 10‐46). If this table has not been
downloaded, or a currency type identified in table entry 7 below is
not present in the Dispenser Currency Cassette Mapping Table,
processing will go to the default Close state.
When debugging, you can view the reason for a failure of this state
in the Debug Log window. For example, an invalid length/value in
the Dispenser Currency Cassette Mapping table will cause an error
to be displayed, specifying the invalid value, field and position. The
possible errors/causes are given after this state table.
Note 1: Only use Debug Log when debugging, not in a live SST
environment.
Note 2: The XFS currency denominations configured in the Cash
Dispenser service provider are not considered by this state.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-29
State Tables
G - Amount Check State
Table 2-13
G
- Amount Check State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘G’
2 3 Amount Check Condition True State number to which the SST goes when the
Next State Number amount check condition indicated by table entry 8
(Base 10 range 000‐254 or evaluates to TRUE.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Amount Check Condition False State number to which the SST goes when the
Next State Number amount check condition indicated by table entry 8
(Base 10 range 000‐254 or evaluates to FALSE.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Buffer to be checked This field specifies which buffer is to be checked:
(Range 000 ‐ 002) 000 ‐ Amount buffer
001 ‐ Buffer B
002 ‐ Buffer C
If Buffer B or C contains more than 12 digits, the
amount check condition evaluates to FALSE.
5 3 Integer Multiple Value Integer multiple value used in checking specified
(Range 000 ‐ 999) buffer.
For example, to check that the specified buffer
contains a multiple of the minimum denomination
$5, this field would be set to ʹ005ʹ.
This field is ignored if table entry 8 is not ‘002’.
6 3 Number of Decimal Places Number of decimal places used in specified buffer.
(Range 000 ‐ 004) For example, $5 is sent as 500 cents, so has 002
decimal places.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-30 APTRA™ Advance NDC, Reference Manual
State Tables
G - Amount Check State
Table Number of
Contents Description
Entry Characters
7 3 Currency Type Currency type of amount in specified buffer.
(Range 001 ‐ 255) Used in conjunction with the Dispenser Currency
Cassette Mapping Table.
This field is ignored if table entry 8 is not ‘003’.
8 3 Amount Check Condition Amount check condition required.
(Range 000 ‐ 003) If the condition is TRUE, processing goes to the next
state identified in table entry 2.
If the condition is FALSE, processing goes to the
next state identified in table entry 3.
All conditions check the buffer indicated by table
entry 4, and take account of the decimal point
location in table entry 6. The state evaluates the
values as follows:
000 — whether the value to the right of the
decimal point position is zero.
001 — and whether the value is zero, or if
Buffer B or C contains more than 12 digits.
002 — and whether the value is a whole
number multiple of the value identified in table
entry 5.
003 — whether the value is dispensable by the
SST, taking into account the Dispenser
Currency Cassette Mapping Table entries,
currency type required (table entry 7), the
currency type denominations available,
dispenser status and cassette status.
9 3 Must be 000. Reserved
The following table lists the possible errors associated with the
Amount Check state, which you may see in Debug Log. The causes
for each error are also included, to assist in correcting the error.
Table 2-14
Amount Check Error State
Error Message Cause(s)
Amount Check State FAILED ‐ Non‐whole 1) A non‐whole amount has been entered
amount entered 2) The Amount Check state is checking the wrong buffer. For
example, the Amount entered is stored in buffer B, but the
Amount Check state specifies buffer C is to be checked in table
entry 4
Amount Check State FAILED ‐ Amount Amount entered is 0
entered = 0
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-31
State Tables
G - Amount Check State
Error Message Cause(s)
Amount Check State FAILED ‐ Buffer B The length of buffer B is more than 12 digits in length
contains more than 12 digits
Amount Check State FAILED ‐ Buffer C The length of buffer C is more than 12 digits in length
contains more than 12 digits
Amount Check State FAILED ‐ X is not a X is not a whole number multiple of Y, where X is the amount
whole number multiple of Y entered, and Y is the Integer Multiple Value specified in table
entry 5
Amount Check State FAILED ‐ Currency The Currency Type X was not found in the Dispenser Currency
Type ‘X’ not found in Dispenser Currency Cassette Mapping Table, where X is the Currency Type specified
Cassette Mapping Table ‐ Proceeding to in table entry 7. Possible causes are:
Default Close State 1) The Dispenser Currency Cassette Mapping Table has not been
downloaded
2) Currency Type X could not be found in the Dispenser
Currency Cassette Mapping Table
Amount Check State FAILED ‐ Amount A Note Mix for the amount requested cannot be created because:
requested cannot be satisfied from physical 1) More than 50 notes are required
cassette types present 2) The amount cannot be created from the denominations
specified in the Dispenser Currency Cassette Mapping Table
3) The cassette(s) containing the denominations required for the
Note Mix have a bad status
Amount Check State FAILED ‐ No valid There are no Cassette Types specified in the Dispenser Currency
entries found in the Dispenser Currency Cassette Mapping Table which are in the currently supported
Cassette Mapping Table range of 1 ‐ 4
Amount Check State FAILED ‐ Cash The Cash Handler has a status of FATAL or SUSPEND
Handler device error
You may also see the following errors, associated with the
Dispenser Currency Cassette Mapping Table:
Table 2-15
Amount Check Error State — DCCMT
Error Message Cause(s)
ERROR ‐ Invalid length error found in Dispenser The specific command reject received by Central
Currency Cassette Mapping Table indicates a message length error
ERROR ‐ Invalid Value ‘< field h1 value >’ found in The value of sub‐field h1 must be a two digit ASCII hex
field h1 of Dispenser Currency Cassette Mapping value in the range ‘01’ to ‘FF’ inclusive. If it is not, the
Table command reject ‘B08 ‐ Field value error, data field value
out of range’ is returned.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-32 APTRA™ Advance NDC, Reference Manual
State Tables
G - Amount Check State
Error Message Cause(s)
ERROR ‐ Invalid Value ‘< field h2 value >’ found in The value of sub‐field h2 must be a two digit ASCII hex
field h2 (at position <value>) of Dispenser value in the range ‘01’ to ‘FF’ inclusive. If it is not, the
Currency Cassette Mapping Table command reject ‘B08 ‐ Field value error, data field value
out of range’ is returned. The error output to the Debug
Log gives the position of the error in the Dispenser
Currency Cassette Mapping Table message. The value
given is the number of characters from the beginning of
the message to where the sub‐field starts.
ERROR ‐ Invalid Value ‘< field h3 value >’ found in The value of sub‐field h3 must be a single digit ASCII hex
field h3 (at position <value>) of Dispenser value in the range ‘0’ to ‘F’ inclusive. If it is not, the
Currency Cassette Mapping Table command reject ‘B08 ‐ Field value error, data field value
out of range’ is returned. The error output to the Debug
Log gives the position of the error in the Dispenser
Currency Cassette Mapping Table message. The value
given is the number of characters from the beginning of
the message to where the sub‐field starts.
ERROR ‐ Invalid Value ‘<field h4 value>’ found in The value of sub‐field h4 must be a five digit ASCII
field h4 (at position <value>) of Dispenser numeric value in the range ʹ00000ʹ to ʹ99999ʹ inclusive. If it
Currency Cassette Mapping Table is not, the command reject ‘B08 ‐ Field value error, data
field value out of range’ is returned. The error output to
the Debug Log gives the position of the error in the
Dispenser Currency Cassette Mapping Table message.
The value given is the number of characters from the
beginning of the message to where the sub‐field starts.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-33
State Tables
H - Information Entry State
H ‐ Information Entry State 2
In this state, data can be entered using one or a combination of the
following:
The numeric keypad for digits or SMS‐style alphanumeric data
entry
A PC keyboard
FDKs (Function Display Keys) or emulated touch‐screen FDKs
Full touch‐screen keyboards for alphanumeric data entry
When the consumer enters data, this state reads in the data and
Data Entry 2
saves it in one of two general‐purpose buffers. You specify in table
entry 9 which buffer is to be used, and whether the actual data the
consumer enters is displayed on screen, or if ‘X’ is displayed for
each key pressed.
Overriding Entry Mode, Buffer and Display Parameters 2
The parameters specified in table entry 9 can be overridden using
the DisplayDataFormat.xml file. For details, refer to Chapter 5,
“Configuring Advance NDC and Associated Components” in the
APTRA Advance NDC Developer’s Guide.
Data Entry and Voice Guidance 2
If the consumer has selected a voice‐guided session, the following
points must be considered:
If the entered data is masked on the screen in this state, the SST
will echo key selection with a beep only
If the Hide Screen option is selected by the consumer, entered
data is not displayed, but only voiced except when masked
If this state requires both FDKs and numeric keys, the
voice‐guided session cannot map the FDKs to the numeric
keypad.
The SST exits from the Information Entry state once the consumer
Exiting the Information presses an active FDK or the Cancel key. It also exits from this state if
Entry State 2
the consumer does not press a key within the specified time limit.
If the consumer presses the Enter key, the behaviour depends on the
value set in the MapEnterKeyToFDK registry entry. For information
on mapping the Enter key to an FDK, refer to Chapter 5,
“Configuring Advance NDC and Associated Components” in the
APTRA Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-34 APTRA™ Advance NDC, Reference Manual
State Tables
H - Information Entry State
Emulated FDKs and Touch‐screen Keyboards 2
The SST may support touch‐screen FDK emulation instead of
physical FDKs. In this case, eight fixed touch areas are defined on
the screen, which the consumer touches instead of pressing the
corresponding FDK. The touch areas are enabled/disabled in exactly
the same way as the FDKs. For details, see the “FDK Emulation”
section in Chapter 4, “Keyboard Data and Layouts”.
Alternatively, the SST may support full touch‐screen keyboards,
with touch areas defined on the screen for all the required keys. The
consumer touches these instead of pressing a key on the keypad or
an FDK. For details, see Chapter 4, “Keyboard Data and Layouts”.
For information about configuring consumer data entry and the
touch‐screen sample keyboards provided with Advance NDC, refer
to chapter 5, “Configuring Advance NDC and Associated
Components” of the APTRA Advance NDC Developer’s Guide.
The Clear function key is always active. If the consumer presses the
Clear Function Key and key, the general‐purpose buffer and the echo field displayed on the
General‐Purpose Buffers 2
consumer screen are cleared. The consumer can now re‐enter
information.
The general‐purpose buffers can hold a maximum of 32 bytes of
data. When the SST exits from the Information Entry state, the
buffer specified in table entry 9 or the DisplayDataFormat.xml file
contains the data that the consumer has entered. If the consumer has
not entered any data, the buffer will be empty. For details of the
general‐purpose buffers refer to the APTRA Advance NDC,
Developer’s Guide.
Note: For numeric data entry using the numeric keypad, if the
amount entered exceeds the 32‐byte limit, the next key press clears
the buffer, resetting the value to 0 and restarting the entry from the
beginning.
Table entry 9 can support alphanumeric data entry using a PC
keyboard, a touch‐screen or the numeric keypad for short message
service (SMS) style data. Default configurations are supplied in
NDCKeyboard.xml, which can be reconfigured. For alphanumeric
data entry, when the maximum input size is reached, any keys
pressed will generate a beep, but the cursor is not displayed.
Note: For numeric keypad entry and PC keyboard entry, the
consumer can enter up to 32 characters during the Information
Entry state. The characters will be echoed on the screen and
formatted as defined in the DisplayDataFormat.xml file or table entry
9.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-35
State Tables
H - Information Entry State
Table 2-16
H - Information Entry State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘H’
2 3 Screen Number Display screen that prompts the consumer to enter
(Range 000‐Z99) data. This screen is displayed on entering the
Information Entry state, and must leave the cursor at
the start of the display area.
3 3 Time‐Out Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or does not respond to the consumer screen message
256‐999) within the permitted time limit. Enter 255 if the
(Base 36 range 000‐254 or time‐out function is not required.
256‐ZZZ) See Table Note 6.
4 3 Cancel Next State Number State number to which the SST goes if the Cancel key is
(Base 10 range 000‐254 or pressed.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 FDK ‘A’ (or ‘I’) State number to which the SST goes if the consumer
Next State Number presses an FDK or touch area. Enter 255 to make an
FDK or touch area inactive while the SST is in the
6 3 FDK ‘B’ (or ‘H’) Information Entry state.
Next State Number (Base 10 range 000‐254 or 256‐999)
7 3 FDK ‘C’ (or ‘G’) (Base 36 range 000‐254 or 256‐ZZZ)
Next State Number
8 3 FDK ‘D’ (or ‘F’)
Next State Number
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-36 APTRA™ Advance NDC, Reference Manual
State Tables
H - Information Entry State
Table Number of
Contents Description
Entry Characters
9 3 Entry Mode, Buffer and Entry Mode:
Display Parameters NN = 00 ‐ Numeric key entry, maximum input size 32.
(Format NND, NN = 01 ‐ 32: SMS‐style, PC‐keyboard and
Range NN = 00 and 01 ‐ 32, touch‐screen keyboard alphanumeric entry. Maximum
Range D = 0 ‐ 3) input size is NN.
See Table Note 7.
Buffer:
Defines which buffer of the following to use for
storage:
general‐purpose buffer B
general‐purpose buffer C
Display:
Defines whether the input data is to be displayed on
the consumer screen, or masked. The display begins
from the current cursor position. Buffer and display
parameters are as follows: See Table Note 8.
D = 0 ‐ Display ‘X’ for each numeric key pressed. Store
data in general‐purpose buffer C.
D = 1 ‐ Display data as keyed in. Store data in general‐
purpose buffer C.
D = 2 ‐ Display ‘X’ for each numeric key pressed. Store
data in general‐purpose buffer B.
D = 3 ‐ Display data as keyed in. Store data in general‐
purpose buffer B.
See Table Note 9 and Table Note 10.
Table Note 6: When a time‐out occurs, the consumer is asked
whether more time is needed. If the response is yes, the consumer
can enter data again, but all previously entered data is lost.
Table Note 7: If required, the SMS‐style alphanumeric keyboard
layout can be installed or configured either by editing
NDCKeyboard.xml and downloading it during software distribution,
or by using the XML configuration download message, described in
“XML Configuration Download” on page 10‐49. For details of
NDCKeyboard.xml, refer to the APTRA Advance NDC, Developer’s
Guide.
The XML schema definition provided with Advance NDC is used to
validate the XML file. If the XML file is not valid, Advance NDC
goes to the default Close state.
Table Note 8: Advance NDC does not support masking of
characters for SMS‐style entry, only for PC keyboard entry.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-37
State Tables
H - Information Entry State
Table Note 9: When used in state H, the buffer identifies where the
input data is stored for further processing, that is, in the transaction
request sent to the host.
Table Note 10 If required, the DisplayDataFormat.xml file can be
used to override the parameters defined in table entry 9. For details
of the DisplayDataFormat.xml file, refer to Chapter 5, “Configuring
Advance NDC and Associated Components” in the APTRA Advance
NDC Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-38 APTRA™ Advance NDC, Reference Manual
State Tables
I - Transaction Request State
I ‐ Transaction Request State 2
This state sends a Transaction Request message to Central, and
executes the Transaction Reply command received from Central.
The information to be included in the Transaction Request message
is defined in the following table. For more details, see the
“Transaction Request Messages” section in Chapter 9, “Terminal to
Central Messages”.
On an SST with digital audio capability and auto‐voice enabled,
message 1 is played when a Transaction Request message is sent to
Central. For details, see “Voice” on page 3‐21.
Table 2-17
I - Transaction Request State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘I’
2 3 Screen Number Display screen shown on the consumer screen
(Range 000‐Z99) while the SST sends a Transaction Request to
Central and waits for a Transaction Reply
command. This is usually a ‘Please Wait’ screen.
3 3 Central Response Timeout Next State number to which the SST goes if Central fails
State Number to reply to the Transaction Request within the
(Base 10 range 000‐254 or permitted time interval (timer 03).
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Send Track 2 Data See Table Note 11.
5 3 Send Track 1 and/or Track 3 Data See Table Note 12.
6 3 Send Operation Code Data See Table Note 11.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-39
State Tables
I - Transaction Request State
Table Number of
Contents Description
Entry Characters
7 3 Send Amount Data See Table Note 11.
8 3 Send PIN Buffer (Buffer A) Data/ See Table Note 11 and Table Note 13.
Select Extended format
9 3 Send General Purpose Buffer B To send the general purpose buffer, the following
and/or General Purpose Buffer C values apply:
or 000 ‐ Send no buffers
Extension State Number 001 ‐ Send Buffer B
(Base 10 range 000‐003 or 002 ‐ Send Buffer C
000‐254, 256‐999) 003 ‐ Send Buffers B and C
(Base 36 range 000‐003 or 004‐007 ‐ Reserved
000‐254, 256‐ZZZ) If the extended format is selected in table entry 8,
this entry is an Extension state number. For more
information about extension states, see “Extension
States” on page 2‐6.
See Table Note 13.
Table Note 11: The following values determine whether or not the
specified data is included in the corresponding Transaction Request
message field sent to Central:
Table 2-18 Value Send Data
Track 2 Data Send Modifier
000 No
001 Yes
Table Note 12: The following values apply only to table entry 5,
and determine whether or not Track 1 and Track 3 data are included
in the Transaction Request message sent to Central:
Table 2-19 Value Track 1 Data Track 3 Data
Track 1/3 Data Send Modifier
000 No No
001 No Yes
002 Yes No
003 Yes Yes
004 No No
005 No Yes
006 Yes No
007 Yes Yes
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-40 APTRA™ Advance NDC, Reference Manual
State Tables
I - Transaction Request State
Table Note 13: The least significant bit of table entry 8 is used to
indicate whether Buffer A is to be sent in the Transaction Request
message. Bit 7 is used to select an extended format for the
Transaction Request state parameter table which allows table entry
9 to hold the state number of the associated extension state number,
as shown in the following table:
Table 2-20 Value Description
Table Entry 8 for Buffer A
000 Standard format. Do not send Buffer A.
001 Standard format. Send Buffer A.
128 Extended format. Do not send Buffer A.
129 Extended format. Send Buffer A.
When Extended format is selected, table entry 9 has its meaning
changed so that it can reference an Extension state number. When
this is the case, table entry 2 of the Extension state controls the
sending of Buffers B and C.
Table 2-21
Extension 1 to State I
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Send General Purpose Buffers B To send the general purpose buffers, these values
and/or C apply:
000 ‐ Send no buffers
001 ‐ Send Buffer B
002 ‐ Send Buffer C
003 ‐ Send Buffers B and C.
3 3 Send Optional Data Fields This entry is bit‐encoded to control the sending of
‘A’ ‐ ‘H’ individual optional data fields in the Transaction
(Range 000‐255) Request message. If a bit is set, the corresponding
data field is sent. If a bit is clear, the data field is not
sent.
Bit Data ID
1 ‘A’ (Reserved)
2 ‘B’ (Reserved)
3 ‘C’
4 ‘D’
5 ‘E’
6 ‘F’
7 ‘G’
8 ‘H’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-41
State Tables
I - Transaction Request State
Table Number of
Contents Description
Entry Characters
4 3 Send Optional Data Fields This entry is as for table entry 3 but the data fields
‘I’ ‐ ‘L’ are as follows:
(Range 000‐015)
Bit Data ID
1 ‘I’
2 ‘J’
3 ‘K’
4 ‘L’
5 Reserved for ‘M’
6 Reserved for ‘N’
7 Reserved for ‘O’
8 Reserved for ‘P’
5 3 Send Optional Data Fields ‘Q’ to This entry is as for table entry 3 but the data fields
V, ‘w’ and ‘a’ are as follows:
(Range 000‐255)
Bit Data ID
1 ‘Q’
2 ‘R’
3 ‘S’
4 Reserved for ‘T’
5 ‘U’
6 ‘V’
7 ‘w’ (Cash Deposit Data)
8 ‘a’ (Cheque processor ‐ MICR/codeline)
See Table Note 14 and Table Note 15
6 3 Send Optional Data. This entry is as for table entry 3 but the data fields
(Range 000‐255) are as follows:
Bit Data ID
1 ‘User Data Fields’
2 ‘b’ (Count of good notes and suspect notes
in escrow or directly deposited to cassette)
3 ‘c’ (Note type counts for suspect notes)
4 ‘d’ (Note type counts for counterfeit notes)
5 ‘e’ (Barcode data)
6 ‘g’ (Bunch cheque deposit data)
See Table Note 14
7 Reserved
8 Reserved
7 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-42 APTRA™ Advance NDC, Reference Manual
State Tables
I - Transaction Request State
Table Number of
Contents Description
Entry Characters
8 3 EMV/CAM2 Processing Flag This entry is bit‐encoded to control the level of
(Range 000‐003) EMV/CAM2 processing to be performed, as
follows:
Bit Value
1 Indicates whether EMV/CAM2 processing
is to be performed as follows:
0 = Do not perform EMV/CAM2 processing
(default)
1 = Perform EMV/CAM2 processing
2 If bit 1 is set, bit 2 indicates whether full or
partial EMV/CAM2 processing is to be
performed as follows:
0 = Perform full EMV/CAM2 processing
(default)
1 = Perform partial EMV Processing.
Include EMV/CAM2 buffer but do not
perform any EMV chip processing
See Table Note 16 and Table Note 17
3 Reserved
4 Reserved
5 Reserved
6 Reserved
7 Reserved
8 Reserved
9 3 Extension State Number State number of Extension state 2.
(Base 10 range 000‐254, 256‐999) A value of 000 disables this extension.
(Base 36 range 000‐254, If a value of 255 is used for this entry, the
256‐ZZZ) application goes to the default Close state.
For more information about extension states, see
“Extension States” on page 2‐6.
Table Note 14: Cheque Processor buffer ʹaʹ and Bunch Cheque
Deposit buffer ʹgʹ are mutually exclusive. If both are set, buffer ʹgʹ
takes precedence and buffer ʹaʹ is not included in the Transaction
Request.
Table Note 15: If Cheque Processor buffer ʹaʹ is used to deposit a
bunch of cheques, the codelines are not included in the Transaction
Request, that is, the MICR/codeline detected field is set to ʹ0ʹ and the
MICR/codeline field is empty.
Table Note 16: If bit 2 (partial EMV/CAM2 processing) is set, the
EMV/CAM2 buffer is sent to Central with all currently known data
requested by Central but without any EMV pre‐authorisation
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-43
State Tables
I - Transaction Request State
processing with the chip. The main purpose is to allow a dynamic
currency conversion (DCC) transaction to take place. This requires
some chip information to be sent to Central to decide whether to
offer a DCC transaction and also allow Central to update the
currency type and amount for the transaction before sending them
to the chip during EMV pre‐authorisation processing.
Table Note 17 If a contactless card is used for a transaction, bit 2
will be ignored. Bit 1 will only determine whether or not to add
EMV/CAM buffers.
Table 2-22
Extension 2 to State I
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Offline Decline Next State State number the SST goes to if, during a
Number chip‐based transaction, the chip or SST chooses not
Base 10 range 000‐254, 256‐999) to go online but requests that the transaction is
(Base 36 range 000‐254, declined offline.
256‐ZZZ)
3‐9 21 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-44 APTRA™ Advance NDC, Reference Manual
State Tables
J - Close State
J ‐ Close State 2
This state terminates the consumer’s current SST session. All data
elements are cleared and valuable media such as cards and money
are handled during this state.
Processing of the Close state depends on the functional operations
Function Operations 2
to be completed.
Receipts, Statements and Envelopes 2
If a receipt and/or statement has been printed but not delivered
during a previous Transaction Request state, it is presented to the
consumer now. If the card has not been ejected or captured, it is
returned or retained depending on the instruction in the last
Transaction Reply message. The appropriate message from those
specified in entries 2, 4, 5 and 6 of Table 2‐23, “J ‐ Close State” on
page 2‐46, is displayed on the consumer screen.
If a statement is presented and not taken by the consumer then after
Timer 02 (page 7‐25) has expired and prior to state exit, Timer 95
(page 7‐29) is started. When this timer expires, the statement is
captured (this does not apply to receipt sideways printing). If the
statement is taken, the timer is stopped. While the timer is running
and until the next statement is staged after capture, exit from the
Close state is delayed. If no statement is presented, Timer 95 is not
started and exit from the Close state is delayed until the next
statement is staged.
If the receipt printer supports retract and Timer 69 (page 7‐28)
expires, any receipt that has not been removed is handled as
follows:
A long receipts is not retracted.
A normal‐length receipt is handled according to the registry
configuration for handling receipts. For details, refer to the
APTRA Advance NDC Developer’s Guide.
On an SST with an envelope dispenser, any envelope that is not
taken by the consumer is retracted. When the envelope is taken or
retracted, the MEI is switched off.
Cards 2
If the card cannot be ejected, it is captured and screen ‘C04’ is
displayed for the period specified by Timer 02. If the card is ejected
but not taken within the time period specified by Timer 09
(page 7‐27), it is captured. For details of consumer display screens,
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-45
State Tables
J - Close State
see “C – Cardholder Display” on page 3‐6. For details of timer
format in a message, see “Configuration Parameters Load” on
page 10‐15.
When a card is ejected, or if no card is present when the Close state
is entered, Timer 02 is started. The SST does not exit from the Close
state until this timer expires. This timer provides a guaranteed
minimum display time for the close screen.
When a card is ejected, the beeper is sounded to remind the
consumer to take the card. If you do not want to use this feature,
you can set Message Mode option 4b to inhibit the beeper. For
details of the option, refer to the APTRA Advance NDC, Supervisor’s
Guide.
Cardless Transactions 2
For cardless transactions, the screen displayed is the screen set up
prior to card eject processing and Timer 02 defines the minimum
time the screen is displayed.
Audio 2
On an SST with digital audio capability, where auto‐voice is enabled
and voice guidance disabled, message 8 is played as soon as the
card is taken during the Close state. If the card has already been
taken, the message is played on entry to the Close state. For details,
see “Voice” on page 3‐21.
Table 2-23
J - Close State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘J’
2 3 Receipt Delivered Screen Screen displayed on entry to the Close state. This is
Number only displayed if a receipt is delivered in the Close
(Range 000‐Z99) state and the SST has not been instructed by the last
Transaction Reply message to capture the card. The
last Transaction Reply Command performed
determines the screen text as follows:
Card Before Cash ‐ ‘Take cash and receipt’
Fast Cash ‐ ‘Take card, cash and receipt’
Other Commands ‐ ‘Take card and receipt’
Note: If the receipt is ejected before reaching the
Close state, the Receipt Delivered screen is not
displayed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-46 APTRA™ Advance NDC, Reference Manual
State Tables
J - Close State
Table Number of
Contents Description
Entry Characters
3 3 Next State Number State number to which the SST goes after the state
(Must be 000) is completed.
4 3 No Receipt Delivered Screen Screen displayed on entry to the Close state. This is
Number only displayed if no receipt is delivered in the
(Range 000‐Z99) Close state and the SST has not been instructed by
the last Transaction Reply message to capture the
card. The last Transaction Reply Command
performed determines the screen text as follows:
Card Before Cash ‐ ‘Take cash’
Fast Cash ‐ ‘Take cash and card’
Other Commands ‐ ‘Take card’
5 3 Card Retained Screen Number Screen displayed on entry to the Close state,
(Range 000‐Z99) informing the consumer that the card has been
retained. This is only displayed if the SST has been
instructed by the last Transaction Reply message to
capture the card during the Close state. This screen
is also displayed for four seconds if the card is
captured due to timer 09 expiring (card not taken).
6 3 Statement Delivered Screen Display screen to be overlaid when either the
Number receipt is delivered (entry 2) or there is no receipt
(Range 000‐Z99) delivery (entry 4). This screen is only displayed if
the statement is cut and delivered in a Close state
and the SST has not been instructed by the last
Transaction Reply message to capture the card.
7 3 Must be 000 Reserved
8 3 BNA Notes Returned Screen Screen displayed on entry to the Close state,
Number informing the consumer that the Bunch Note
(Range 000‐Z99) Acceptor (BNA) notes are being returned.
9 3 Extension State Number The state number of the optional extension state 1.
(Base 10 range 000‐254 or For more information about extension states, see
256‐999) “Extension States” on page 2‐6.
(Base 36 range 000‐254 or See Table Note 18.
256‐ZZZ)
Table Note 18: You can use either of the following methods to
process ‘Card Before Cash’ and ‘Fast Cash’ transactions:
Use different Close states
Send a screen modification with the Transaction Reply
command.
For details of ‘Card Before Cash’, ‘Fast Cash’ and ‘Process
Document With Cash’ transactions, see the “Terminal Functions for
Transaction Completion” on page 10‐69.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-47
State Tables
J - Close State
Table 2-24
Extension State 1 to State J
Table Number Of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Cheque Processor Take Screen number required for the error recovery
Document Screen Number actions which may take place in this state if the
(Range 000‐Z99) cheque processor is present and the Cheque
Processor Document Return/Retain Flag is set to
either 001 or 002.
3 3 Cheque Processor Document This flag controls the error recovery actions which
Return/Retain Flag may take place in this state if the cheque processor
(Range 000‐002) is present.
The flag can be set as follows:
000 ‐ Retain
001 ‐ Return and retract if not taken
002 ‐ Return and do not retract if not taken.
See Table Note 19.
4 3 Must be 000 Reserved
5 3 Extension State Number Extension state 2. This value is ʹ000ʹ if the
parameters in the extension state are not applicable
or required.
For more information about extension states, see
“Extension States” on page 2‐6.
See Table Note 20.
6‐7 6 Must be 000 Reserved
8 3 BNA Notes Return/Retain/ This flag controls the error recovery actions which
Leave Flag may take place in this state if a BNA is present.
(Range 000‐002) The flag can be set as follows:
000 ‐ Return
001 ‐ Retain
002 ‐ Leave notes in the escrow. If this is set, the
INIT BNA Supervisor option must be used to clear
the device, depending on how automatic error
recovery is configured.
See Table Note 21, Table Note 22 and Table Note 23.
9 3 Musts be 000 Reserved.
Table Note 19: On entry to the Close state, the application
determines whether a cheque processor is configured, and if so,
whether any error recovery action is required. If the device has a
recoverable error condition and still has a cheque within it, it will
attempt to retain/capture or return the document as defined by
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-48 APTRA™ Advance NDC, Reference Manual
State Tables
J - Close State
extension state entry 3 (Cheque Processor Document Return/Retain
Flag).
If the Close state does not define an extension state, the default error
recovery action is to retain any document found in the Close state.
If the cheque is to be retained (Cheque Processor Return/Retain Flag
= 000), an attempt is made to move it into the Reject Bin (bin 2) if
present, otherwise bin 1 if only one bin is available. In a CPM, the
retained cheque is endorsed with a customisable string, which is
defined in screen U0057. In a bunch cheque acceptor, the retained
cheques cannot be endorsed.
If the cheque is to be retained or captured, an unsolicited message is
sent to the host if Enhanced Configuration option 83 is configured.
For details, see “Option 83 – Cheque Processor” on page 7‐21.
If the cheque is to be returned (Cheque Processor Return/Retain
Flag = 001 or 002), an attempt is made to return it to the consumer. If
the document successfully reaches the exit, the screen defined in
table entry 2 (Take Document Screen Number) will be displayed for
the period specified by timer 94, or until the document is taken. The
beeper is also sounded unless option 2c has been set. If the
document does not reach the exit, or the consumer fails to take the
document within the time specified by Timer 94, the following
action is taken depending on the setting of the flag in entry 3:
If Cheque Processor Return/Retain Flag = 001, an attempt is
made to move it to the Reject Bin (bin 2)
If Cheque Processor Return/Retain Flag = 002, the document is
left at the exit.
If the cheque eject fails or the ejected cheque is not taken before
timer 94 expires, the message ‘CHEQUE EJECT FAILED’ (screen
U0088) is journaled.
Using a bunch cheque acceptor, more than one bunch of cheques
can be returned to the consumer. The screen defined in table entry 2
of extension 2 (Cheque Processor Wait for Cheque Screen Number)
is displayed while the bunches are being transported, and the screen
defined in table entry 2 of extension 1 (Cheque Processor Take
Document Screen Number) is displayed when the bunch is
presented.
If the document is moved successfully to the bin, screen U0058 is
journaled together with the security trace header message. If the
document is not moved successfully to the bin and the consumer
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-49
State Tables
J - Close State
does not have access, screen U0059 is journaled together with the
security trace header.
If an error occurs while moving the document to bin 2, an
unsolicited message is sent to the host. If the error has an associated
severity of fatal, then any further attempts to use the device will
yield an error message.
All cheque data is deleted when this state is taken, including files
that have been copied and renamed for use by the ImageMark
Passport ATM Image Agent.
Table Note 20: If an extension state is not included, the default
action for the cheque processor document error recovery is to retain
any cheque found in the Close state.
Table Note 21: On entry to the Close state, the SST will detect
whether a cash acceptor or a recycling unit is configured. If the
device is in a recoverable state and still has notes in the escrow or a
direct deposit is still in progress, the action defined in extension
state entry 8 (BNA Return/Retain/Leave Flag) is attempted. If a
direct deposit is in progress, the notes cannot be returned.
If returned notes not taken by the consumer have been retracted to
the escrow, the notes are not moved from the escrow whatever the
setting of extension state entry 8. For details of configuring note
retract to the escrow, refer to Chapter 5, “Configuring Advance
NDC and Associated Components” in the APTRA Advance NDC,
Developer’s Guide.
If the returned notes are taken late by the consumer, that is, just as
the retract operation starts, Advance NDC does not send an
unsolicited (w7) message but any configured ‘retract notes’ screen is
displayed when the retract operation starts.
Note counts are journaled as follows:
If the deposit uses the escrow, the escrow note counts are
journaled
If the deposit does not use the escrow, the vaulted note counts
are journaled.
If error conditions are detected, automatic error recovery (AER) is
started at the end of the Close state after the card has been returned
to the consumer. Automatic error recovery is configurable through
the Class Configurator. For details, refer to the APTRA Advance
NDC Developer’s Guide.
Table Note 22: If the Close state extension state entry 8 (BNA Notes
Return/Retain/Leave Flag) is set to 001 (Retain) and the Transaction
Request is lost on the network, there is no way to identify the
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-50 APTRA™ Advance NDC, Reference Manual
State Tables
J - Close State
consumer to whom the notes belong due to the masking of the card
number. This is in compliance with Payment Card Industry (PCI)
rules.
Table Note 23: If AER is enabled and notes are left in the escrow in
the Close state, the notes will be processed as part of AER. If you
require notes to be left in the escrow, AER must be turned off or
configured to leave notes in the escrow. For details of AER
configuration, refer to Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC Developer’s
Guide.
Table 2-25
Extension State 2 (J - Close State)
Table Number Of
Contents Description
Entry Characters
1 1 State Type ‘Z’ ‐ Extension type
2 3 Cheque Processor Wait for This screen is used to ask the customer to wait for
Cheques Screen Number (range additional cheques to be returned when more than
000‐Z99) one bunch of cheques is to be returned. If this value
is ʹ000ʹ or this extension state is not present, the
Cheque Processor Take Document Screen is
displayed until all bunches have been taken
3 3 Retracting Presented Media Screen displayed if media presented within this
Screen Number (range 000‐Z99) state are not taken and are being retracted. This
screen does not apply to cards or passbooks, which
have specific screens defined for this purpose.
The wording used in the screen should be designed
to handle all media types that can be returned and
retracted by this state.
If this parameter is ʹ000ʹ (or the optional Extension
state is missing) and if the reserved generic “Please
wait...” screen (screen C20) is defined, screen C20 is
displayed during the retract operation. If this
parameter is ʹ000ʹ (or the optional Extension state is
missing) and screen C20 is not defined, no screen
will be displayed during the retract (unless a
specific screen is available in one of the other
parameters).
4‐9 18 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-51
State Tables
K - FIT Switch State
K ‐ FIT Switch State 2
Each Financial Institution Table (FIT) contains a next state index
number. This index number refers to the next state number that the
SST goes to when it exits from the FIT Switch state, if the Financial
Institution number on the card matches a Financial Institution
number in a FIT. For more details, see the“A ‐ Card Read State”
section.
The FIT Switch state table contains a list of these next state numbers,
together with an index which matches the index numbers of the
FITs.
For example, if the FIT that has been identified during the Card
Read state contains a next state index number of 3, this corresponds
to index number 3 in the FIT Switch state table. This index number
is found in table entry 5, so the SST goes to the next state number
contained in table entry 5 when it exits from this state.
Table 2-26
K - FIT Switch State
Table Number
Index Contents Description
Entry of Chars
1 1 State Type ‘K’
2 0 3 Next State Number State to which the SST goes depending on the next
state index stored in the FIT.
3 1 3 Next State Number (Base 10 range 000‐254 or 256‐999)
4 2 3 Next State Number (Base 36 range 000‐254 or 256‐ZZZ)
5 3 3 Next State Number
6 4 3 Next State Number
7 5 3 Next State Number
8 6 3 Next State Number
9 7 3 Next State Number
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-52 APTRA™ Advance NDC, Reference Manual
State Tables
_ - Expanded FIT Switch State
_ ‐ Expanded FIT Switch State 2
This state operates as state type ‘K’, described on the previous page,
except that more switch capacity has been added through a
mandatory extension state. For example, if the FIT identified during
the Card Read state contains a next state index of 3, the next state
number is found in table entry 5.
Table 2-27
_ - Expanded FIT Switch State
Table Number
Index Contents Description
Entry of Chars
1 1 State Type ‘_’
2 0 3 Next State Number State to which the SST goes depending on the next
state index stored in the FIT.
3 1 3 Next State Number (Base 10 range 000‐254 or 256‐999)
4 2 3 Next State Number (Base 36 range 000‐254 or 256‐ZZZ)
5 3 3 Next State Number
6 4 3 Next State Number
7 5 3 Next State Number
8 6 3 Next State Number
9 3 Extension State Number State number of the mandatory Extension state.
(Base 10 range 000‐254 or For more information about extension states, see
256‐999) “Extension States” on page 2‐6.
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-53
State Tables
_ - Expanded FIT Switch State
Table 2-28
Extension to State _
Table Number
Index Contents Description
Entry of Chars
1 1 State Type ‘Z’
2 7 3 Next State Number State to which the SST goes depending on the next
state index stored in the FIT.
3 8 3 Next State Number (Base 10 range 000‐254 or 256‐999)
4 9 3 Next State Number (Base 36 range 000‐254 or 256‐ZZZ)
5 10 3 Next State Number
6 11 3 Next State Number
7 12 3 Next State Number
8 13 3 Next State Number
9 14 3 Next State Number
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-54 APTRA™ Advance NDC, Reference Manual
State Tables
L - Card Write State
L ‐ Card Write State 2
During a Card Read state, the Card Data buffers are cleared of all
previous data. The Card Read state defines the card tracks to be
read and stores the card track data in the corresponding Card Data
buffer. In the Transaction Request state, the SST sends a Transaction
Request message to Central. You can specify whether or not track
data is included in this message. Central responds to this message
by sending a Transaction Reply command to the SST. Within this
command are fields which contain updated track data. This data
replaces any previous data in the track data buffers on the SST.
During the Card Write state, the SST writes the contents of the track
data buffers onto the magnetic stripe of the card. You specify which
screen is to be displayed on the consumer screen during this
operation.
Writing takes place only if the track data buffers contain data
obtained from either of the following:
A successful card read during a Card Read state
Updated track data from a Transaction Reply command.
There are three next state numbers that the SST can go to when it
leaves the Card Write state. One exit is taken if the track write is
successful. Another is taken if the track write is unsuccessful. A
third exit is taken if the track data buffers are empty or contain
invalid data, and no writing is attempted.
If the SST is to write to more than one track, the order is Track 1,
Track 2 and Track 3. Before writing, a check is made to ensure that
the data is valid. If the data is not valid, the write state will exit
without writing any of the tracks. If the data is valid and a track
write fails, the SST will not attempt any further requested track
writes and the write state will exit.
To use the Card Write state, the magnetic stripe card must still be in
the reader. The following conditions apply:
Table entry 8 of the Card Read state must not be 000 (return card
immediately)
A Card Before Cash Transaction Reply must not have been
performed
A Parallel Eject/Dispense and Print (Fast Cash) Transaction
Reply must not have been performed
A card reader with the ability to write to the tracks specified
must be present.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-55
State Tables
L - Card Write State
Table 2-29
L - Card Write State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘L’
2 3 Screen Number Screen displayed during a Card Write operation.
(Range 000‐Z99)
3 3 Good Write Next State Number State number to which the SST goes after a
(Base 10 range 000‐254 or satisfactory Track write operation.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Bad Write Next State Number State number to which the SST goes if the Track
(Base 10 range 000‐254 or write is unsuccessful.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 No Write Attempted Next State State number to which the SST goes if no data or
Number invalid data is present in the Track buffer. This
(Base 10 range 000‐254 or state is also used if a start and/or end sentinel is
256‐999) missing, or the Track data buffers are too long.
(Base 36 range 000‐254 or
256‐ZZZ)
6‐9 12 Must be 000 for each table entry Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-56 APTRA™ Advance NDC, Reference Manual
State Tables
M - Enhanced PIN Entry State
M ‐ Enhanced PIN Entry State 2
This state performs the same functions as the PIN Entry state. It also
supports Track 3 retries if the FIT specifies local PIN check and
indicates that there is a Track 3 retry field on the card.
If the FIT specifies Track 3 retries but there is no data in the Track 3
buffer, the Cancel Next State exit is taken.
Before the consumer can enter a PIN for a local PIN check with
Track 3 retries, the PIN retry field on the card is checked. For a
Mutual Institutions Transfer System (MINTS) format card, the retry
field of the Track 3 data buffer must not equal or exceed the limit
specified in state table entry 9. If an International Standards
Organisation (ISO) format card is used, the retry field must not
equal 0. If they do, in both situations the SST exits to the Maximum
Bad PINs Next State specified in table entry 6. This check is made
before the start of each PIN entry attempt.
After the PIN is entered by the consumer and compared with the
calculated PIN, the PIN retry field in the Track 3 data buffer is
updated. For MINTS format cards, if the entered PIN is correct, the
PIN retry field is set to 0. For ISO format cards, the retry field is set
to the value specified in state table entry 9. If the entered PIN is
incorrect, the PIN retry field is incremented for MINTS format cards
and decremented for ISO format cards. The updated Track 3 data
buffer is available for transmission through the Transaction Request
state. The buffer can also be written on the card using the Card
Write state.
On an SST with digital audio capability and auto voice enabled,
message 7 is played on entry to this state. For details, see the
“Control Codes for Special Features” section in Chapter 3, “Screen
Data”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-57
State Tables
M - Enhanced PIN Entry State
Table 2-30
M - Enhanced PIN Entry State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘M’
2 3 Screen Number Display screen that prompts the consumer to enter
(Range 000‐Z99) the PIN the first time. This screen is displayed on
entering the PIN Entry state. It must leave the
cursor at the start of the PIN Entry display area. An
‘X’ is displayed for each key pressed.
3 3 Time‐Out Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or does not enter the PIN within the permitted time
256‐999) limit. Enter state number 255 if the time‐out
(Base 36 range 000‐254 or function is not required.
256‐ZZZ)
4 3 Cancel Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or presses the Cancel key before the maximum number
256‐999) of digits specified for the PIN have been entered.
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Local PIN Check Good PIN State number to which the SST goes after
Next State Number verification of a correct PIN entry. A Pre‐Set
(Base 10 range 000‐254 or Operation Code buffer state (clearing the function
256‐999) key buffer before Transaction Selection) usually
(Base 36 range 000‐254 or follows a correct PIN entry. See Table Note 26.
256‐ZZZ)
6 3 Local PIN Check Maximum Bad State number to which the SST goes if the correct
PINs Next State Number PIN has not been entered after the number of
(Base 10 range 000‐254 or attempts allowed by table entry 9. This could be a
256‐999) Card Write state in order to update the Track 3 PIN
(Base 36 range 000‐254 or retry field.
256‐ZZZ) See Table Note 24, Table Note 25, and Table Note
26.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-58 APTRA™ Advance NDC, Reference Manual
State Tables
M - Enhanced PIN Entry State
Table Number of
Contents Description
Entry Characters
7 3 Local PIN Check Error Screen Display screen that prompts the consumer to
Number re‐enter the PIN. This screen is displayed after each
(Range 000‐Z99) incorrect PIN entry attempt. An ‘X’ is displayed for
each key pressed. After the number of re‐entry
attempts allowed by table entry 9, the SST enters
the state determined by table entry 6.
See Table Note 24 and Table Note 26.
8 3 Remote PIN Check Next State State number to which the SST goes when local PIN
Number verification is not performed.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
9 3 Local PIN Check Maximum PIN Maximum number of incorrect PIN entries before
Check Retries the SST enters the state determined by table entry 6.
(Range 001‐009) This entry is used as the PIN retry count if the PIN
retry count is not on the card (FIT entry PRCNT =
FF). See Table Note 24 and Table Note 26.
Table Note 24: These fields are also used when the Check Remote
PIN minimum length option in the FIT is used. (The high order
three bits of PANLN are not 0 and contain a value less than or equal
to PMXPN. PANLN does not contain FF hex.) The fields are used in
the same way as for local verification. An incorrect PIN is one that is
less than the minimum length.
Table Note 25: The ‘Local PIN Check Maximum Bad PINs Next
State Number’ should be set to a non‐zero valid value, or an error
will occur.
Table Note 26: To support secure PIN encryption, fields 5, 6, 7 and
9 must always be set up, as they are used to control the number of
allowed PIN retries when fewer than four PIN digits are entered.
With secure PIN encryption, a check for the minimum four PIN
digits is performed whether or not the FIT specifies to check for
shorter PINs.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-59
State Tables
N - Camera Control State
N ‐ Camera Control State 2
When the application enters this state, the camera takes a picture.
Images are stored in a configurable location on the SST.
Note: It is not necessary to add this state to the Advance NDC
application flow as points have already been added for picture
taking. They can be configured through the XML file downloaded
from the host. For details, refer to section “Security Cameras” in
Chapter 5, “Configuring Advance NDC and Associated
Components” of the APTRA Advance NDC, Developer’s Guide.
The default location for storing images is
C:\Program files\NCR APTRA\Advance NDC\Snapshots.
Information supplied by the SST is included in the filename of the
stored image. The filename has the following format:
NNNNNN_TTTT_DDMMYY_HHMMSS.mmm_CCCC_PPP_x.BMP
Table 2-31 Filename Variable Description
Security Camera Image Filename Format
NNNNNN SST machine number
TTTT Transaction serial number
As this is populated by reply data from the
host, some flow points in the application will
have 4 underscores “____” instead
DDMMYY Date in a format dependent on ECP option 3
(see “Option 03 – Date Format” on page 7‐7)
HHMMSS.mmm Time in HHMMSS.mmm format
CCCC Last four digits of the consumer’s card
number
Blank data (in cardless transactions) is treated
as colons for command data and underscores
for saving a file.
PPP The number identifying the flow point at
which the picture was taken
If a picture is taken using the Camera Control
state, this is always 000
x A number in the range 1‐3 identifying the
sequence of the images if multiple pictures
have been taken
This is only included in the filename if
multiple pictures were taken
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-60 APTRA™ Advance NDC, Reference Manual
State Tables
N - Camera Control State
On an SST without a camera, this state does not perform any action
and the application flow goes to the next state.
Whether unsolicited messages are reported depends on enhanced
configuration parameter option 32. For details, see “Option 32 –
Unsolicited Reporting Control” on page 7‐10.
Table 2-32
N - Camera Control State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘N’
2 3 Picture Type Specifies the SST‐supplied data to superimpose on
(Range 000‐001) the image
000 ‐ picture type 0
001 ‐ picture type 1
See Table Note 27 and Table Note 28
3 3 Next State Number State number to which the SST goes after taking the
(Base 10 range 000‐254 or picture
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4‐9 18 Must be 000 for each table entry Reserved
Table Note 27: In Advance NDC, there is no difference in the two
picture types.
Table Note 28 On NCR SSTs, it is not possible to superimpose SST
data on the image because APTRA XFS does not support this
feature. However, the information is included in the filename of the
saved image. For details of superimposed data support on other
vendor’s hardware, refer to the APTRA Advance NDC, Multi‐Vendor
Support Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-61
State Tables
R - Enhanced Amount Entry State
R ‐ Enhanced Amount Entry State 2
Use this state if you wish to use multi‐language screens for
enhanced amount entry. The field length for this buffer is eight
digits, or twelve if Enhanced Configuration Parameter option 1 is
used. A parameter in AppendBuffer.xml, AmountEntryLength,
allows the consumer to enter any number of characters in the screen
echo field, up to a maximum of twelve.
Note: If you want to allow the consumer to select the note mix to be
dispensed, see “z017‐ Note Mix Selection State” on page 2‐180.
This state reads the amount entered by the consumer, displays it on
Data Handling 2
the consumer screen, and saves it in the buffers specified by the
state table. Once the configured number of digits is reached, the
next key press clears the buffer, resetting the value to 0 and
restarting the entry from the beginning. A parameter in
AppendBuffer.xml can be configured to prevent clearing of the
amount when the configured limit is reached.
The Clear key is always active and clears the amount entered and the
screen echo field to allow data entry retries within the Amount
Entry state.
If the consumer presses the Enter key, the behaviour depends on the
value set in the MapEnterKeyToFDK registry entry. If required by the
host, the screen can be configured to add extra zeros automatically
to the Amount buffer, after the decimal point. This configuration is
defined in the AppendBuffer.xml file. The file can be downloaded, as
described in “XML Configuration Download” on page 10‐49, or can
be installed locally.
For more information, refer to Chapter 5, “Configuring Advance
NDC and Associated Components” in the APTRA Advance NDC,
Developer’s Guide under the following sections:
“Mapping the Enter key to an FDK” for the registry setting
“Configuring Amount Entry” for details of AppendBuffer.xml
Advance NDC supports the 000 key on PINpad in the Enhanced
Amount Entry state. If the number of digits in the amount entry
field is less than or equal to the size of the amount buffer (8 or 12
digits based on the Enhanced Configuration Parameter option 01) or
the amount entry length configured in the AppendBuffer.xml file,
then the key appends three zeros in a single key press to the existing
amount after adding 000 .
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-62 APTRA™ Advance NDC, Reference Manual
State Tables
R - Enhanced Amount Entry State
For more information on triple zero entry, see “Triple Zero Key on
PINpad” on page 2‐26.
Exit from the Enhanced Amount Entry state occurs when an active
Exiting the Enhanced FDK is pressed, the Cancel key is pressed or a time‐out occurs.
Amount Entry State 2
Table 2-33
R - Enhanced Amount Entry State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘R’
2 3 Screen Number Number of display screen prompting an amount
(Range 000‐Z99) entry.
3 3 Time‐Out Next State Number State number to which the application goes if the
(Base 10 range 000‐254 or 256‐999) consumer fails to enter the amount within the
(Base 36 range 000‐254 or specified time limit. Enter 255 if the time‐out
256‐ZZZ) function is not required.
4 3 Cancel Next State Number State number to which the application goes if the
(Base 10 range 000‐254 or 256‐999) consumer presses the Cancel key.
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 FDK ‘A’ (or ‘I’) State number to which the SST goes if the consumer
Next State Number presses the specified FDK. Normally one FDK is
used to specify whether the amount entry is correct
6 3 FDK ‘B’ (or ‘H’) and another to specify incorrect. The other keys are
Next State Number inactive. Enter 255 to deactivate any FDK or touch
7 3 FDK ‘C’ (or ‘G’) area.
Next State Number (Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or 256‐ZZZ)
8 3 FDK ‘D’ (or ‘F’)
Next State Number
9 3 Extension State Number State number of the Extension state.
(Base 10 range 000‐254 or 256‐999) For more information about extension states, see
(Base 36 range 000‐254 or “Extension States” on page 2‐6.
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-63
State Tables
R - Enhanced Amount Entry State
Table 2-34
Extension to State R
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Document Amount Buffer This field determines which buffer the amount
(Range 000‐002) entered will be stored in:
000 ‐ Amount buffer
001 ‐ Buffer B
002 ‐ Buffer C
3 3 Amount Display Screen Overlay screen for setting the cursor position on
Number the consumer screen. This screen optionally defines
(Range 000‐Z99) the initial display format before amount entry by
See Table Note 29. the consumer. The cursor should be set on the
left‐hand side of the echo field on the screen. This is
space filled until the required start position for the
currency character is reached. For details, see
“International Currency Display Format” on
page 3‐45.
The default echo field for eight digits is:
bbbbb$b0.00
where b = space.
The default echo field for twelve digits is:
bbbbbbbbb$b0.00
where b = space.
4 3 Start CAV command Not used by Advance NDC.
(Range 000‐001)
5 3 Language Dependent Screen This flag determines if the screen defined in table
Flag entry 3 of this extension state is language
(Range 000‐001) dependent:
000 ‐ Not language dependent
001 ‐ Language dependent, regardless of language
group size.
6‐9 12 Must be 000 Reserved
Table Note 29: The Amount Entry Screen will not be adjusted for
language, unless a language has been selected and the language
group size is 1000 or greater. If the language adjusted screen has not
been loaded, the unadjusted screen will be used instead.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-64 APTRA™ Advance NDC, Reference Manual
State Tables
S - Language Code Switch State
S ‐ Language Code Switch State 2
In this state, the flow of a transaction is switched depending on
whether a language code is present in the card data or not.
You can use this state to select the language to be used
automatically from the code on the card, or to allow manual
selection for cards which have either no language code or an invalid
language code.
The language used is determined by state V ‐ Language Select From
Card state, and state Y ‐ Eight FDK Selection Function state.
This state is subject to the same restrictions as the Language Select
state. For details, see the “V ‐ Language Select From Card State”
section.
Note: If 255 is placed in any of the language code exits or the ‘no
language code’ exit, the SST performs a default Close state. This
means that the consumer’s card is returned and the transaction is
terminated.
Table 2-35
S - Language Code Switch State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘S’
2 3 No Language Code Next State State number to which the SST goes if the language
Number code is illegal or cannot be read.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Language Code = 0 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 0.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Language Code = 1 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 1.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-65
State Tables
S - Language Code Switch State
Table Number of
Contents Description
Entry Characters
5 3 Language Code = 2 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 2.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 Language Code = 3 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 3.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
7 3 Language Code = 4 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 4.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
8 3 Language Code = 5 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 5.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
9 3 Extension state number State number of the Extension state containing the
(Range 000‐999 or 000‐ZZZ) next states for language codes 6‐9.
A value of 255 means that there is no Extension
state, and language codes 6‐9 cause the No
Language Code next state exit to be taken.
For more information about extension states, see
“Extension States” on page 2‐6.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-66 APTRA™ Advance NDC, Reference Manual
State Tables
S - Language Code Switch State
Table 2-36
Extension to State S
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Language Code = 6 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 6.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Language Code = 7 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 7.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Language Code = 8 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 8.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Language Code = 9 Next State State number to which the SST goes if the language
(Base 10 range 000‐254 or code is 9.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
6‐9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-67
State Tables
T - Card Read - PIN Entry Initiation State
T ‐ Card Read ‐ PIN Entry Initiation
State 2
You can use this state instead of the Card Read state and optionally
initiate PIN entry by the consumer at the same time as the card is
read.
This state must be used if a smart dip card reader is used and smart
cards are to be accepted. However, if the smart dip card reader is
used without the chip connect bit being set, it will behave as a
standard dip reader. In this case, Card Read state A can also be
used.
A difference between this state and the Card Read state is that this
state does not allow the card to be returned early using the Card
Return Flag in table entry 8.
When used, this state must be the first state table used during
transaction processing by assigning state number 000 to it. The SST
automatically enters state 000 when put into service.
This state performs the same functions as the ‘A’ Card Read state
and optionally enables the keyboard for PIN entry while the card is
being read, as follows:
The SST displays a screen prompting the consumer to enter a
card
Optionally, the SST displays a screen prompting the consumer
to enter a PIN while the card is read
The state table identifies the next state number that the SST goes
to following a successful card read
The SST displays an error screen if the card cannot be read
The state table specifies which card tracks are to be read.
If PIN entry is enabled while the card is being read, the keyboard is
enabled for a maximum number of numeric keys (16). You can
specify which FDKs are to be active as Accept or Clear keys. The Clear
key itself is always active during PIN entry. The Enter key is active if
you specify FDK ‘A’ as an Accept key.
Note 1: The BAPE (Basic Alphanumeric PINpad Encryptor) does
not support this early enabling of the keyboard with secure PIN
entry. When the BAPE is configured, the keyboard is not enabled for
PIN entry in this state; the keyboard is enabled only in the PIN
Entry state.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-68 APTRA™ Advance NDC, Reference Manual
State Tables
T - Card Read - PIN Entry Initiation State
Note 2: This state also supports smart cards. For details of how
smart cards are handled, see the “A ‐ Card Read State” section.
Once the card has been read successfully or if a cardless transaction
is initiated, the Prepare Dispense operation is executed and
processing continues to the next state. For information on Prepare
Dispense feature, refer to section “Prepare Dispense” in Chapter 5,
“Configuring Advance NDC and Associated Components” of the
APTRA Advance NDC, Developer’s Guide.
If PIN entry initiation is enabled, the next state must be a PIN Entry
PIN Entry Enabled 2
state. An intervening FIT Switch state is allowed.
The minimum and maximum PIN entry length is obtained from the
FIT before PIN entry commences. If the consumer fails to input the
PIN quickly enough, the transaction flow will proceed to the
Timeout state.
The layout of associated keyboards must be identical to those
specified for the state that follows the Card Read ‐ PIN Entry
Initiation state.
For security reasons, it is safer to enter the PIN using the physical
keyboard rather than a touch screen keyboard.
If PIN entry initiation is disabled, there are no restrictions on the
PIN Entry Disabled 2
following state and PIN entry can take place later under normal
state flow control, for example, after language selection or just
before the Transaction Request message is sent.
On an SST with digital audio capability and auto voice enabled,
Audio Support 2
message 7 is played as soon as the card is detected by the SST. For
details, see the “Control Codes for Special Features” section in
Chapter 3, “Screen Data”.
State ʹTʹ supports the smart dip card reader for EMV processing. If
Smart Dip Card Reader 2
the SST has a smart dip card reader and one or more of the Card
Read Conditions (state entries 5‐7) has the Chip Connect Bit set,
then the card is latched on entry to the reader and an attempt is
made to power on the chip on the smart card.
If the power on attempt is successful, then the No FIT Match next
state is taken and no magnetic stripe information will be read.
If the power on attempt fails, the reader unlatches the card and the
consumer is asked to remove the card and wait. The screen defined
in Extension state entry 6 is available for this. If the card is removed,
the magnetic stripe data is read, magnetic stripe processing
commences and the card read conditions are checked.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-69
State Tables
T - Card Read - PIN Entry Initiation State
Note 1: If the state is configured to latch the card and the power on
is successful, the PIN entry screen is never displayed and PIN entry
initiation will commence if enabled.
Note 2: If a smart dip reader is used, but no chip connect bit is set,
the smart dip reader behaves as a standard dip reader.
Delay Latch/Smart Delay Functionality 2
When a magnetic card or a smart card is inserted in a smart dip card
reader, the following are the possible scenarios:
Magnetic Card Inserted and Removed from the Card Reader:
After the card is inserted and removed, the state flow takes the
Good Read Next State exit. Configure the state flow such that
the state goes to the ‘+’ state to check the ATB (Alternative
Technology Byte) on Track 2, and finds the card is not a smart
card. The state flow then proceeds to the normal magnetic card
handling flow.
Magnetic Card Inserted and Left in the Card Reader:
When the card is inserted and left in the reader and the delay
latch/smart delay timer expires, the card is unlatched and the
Take Card screen defined in the T State (Card Read ‐ PIN Entry
Initiation State) extension table entry 6 is displayed to prompt
the card holder to remove the card. The magnetic stripe data is
read on card removal and takes the Good Read Next State exit
(table entry 3). Configure the state flow such that the state goes
to the ‘+’ state to check the ATB on Track 2, and finds the card is
not a smart card. The state flow then proceeds to the normal
magnetic stripe handling flow.
Smart card inserted and left in the reader
When the smart card is inserted and left in the reader and the
delay latch/smart delay timer expires, the card is latched and it
attempts to connect to the smart chip. When this succeeds, the
state flow proceeds to the normal smart card state flow.
Smart card inserted and removed from the reader immediately
After the smart card is inserted and removed immediately, the
state flow takes the Good Read Next State exit (table entry 3),
goes to the ‘+’ state to check the ATB on Track 2, finds the card is
a smart card. The state flow then proceeds to the z008 Insert
Card state to prompt the card holder to insert and leave the card
in the reader. The card is latched after it is inserted and then
proceed to the normal smart card state flow.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-70 APTRA™ Advance NDC, Reference Manual
State Tables
T - Card Read - PIN Entry Initiation State
For more information about smart card handling in Advance NDC,
see Chapter 12, “EMV Smart Card Handling”.
The Card Read ‐ PIN Entry Initiation state has an extension state
Card Read, PIN Entry and (Extension State 2) to support multiple card readers. Multiple card
Multiple Card Readers 2
readers can be enabled by this state to allow consumer sessions to be
initiated by different types of cards. Advance NDC supports up to
two card readers on an SST: a contact and a contactless card reader.
If Extension State 2 is not provided, all available card readers are
enabled. The following values apply to enabled card readers:
The read conditions (table entries 5 to 7) of the Card Read ‐ PIN
Entry Initiation state
The Good Read Next State Number (table entry 3) of the Card
Read ‐ PIN Entry Initiation state or the No FIT Match Next State
Number (table entry 3) of Extension State 1.
Note: Enabled card readers are always journaled. For more
information on card reader journaling, refer to section, “Journaling
Card Reader Events” in Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC, Developer’s
Guide.
Card Reader Precedence 2
When multiple card readers are active, and one of them is a contact
card reader and the other is a contactless card reader, the contact
card reader takes precedence over the contactless card reader.
If an SST has both card readers, and a card is inserted into the
contact card reader, the contactless card reader is disabled. If a card
is detected by both card readers, the card detected by the contact
card reader will be processed and the card detected by the
contactless card reader will be ignored. Misreads can occur if a card
is inserted and a card tapped simultaneously, due to the way the
Advance NDC application processes card reads.
For more information on contactless card readers, refer to section
“Configuring Readers” in Chapter 5, “Configuring Advance NDC
and Associated Components” of the APTRA Advance NDC,
Developer’s Guide.
Using Extension State 2 2
The types of card readers that are enabled are specified in table
entry 3 (Active Card Readers) of Extension State 2. The extension
state also provides a Secondary Card Reader Good Read Exit (table
entry 2) for cards processed by the secondary card reader.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-71
State Tables
T - Card Read - PIN Entry Initiation State
Table 2-37
T - Card Read - PIN Entry Initiation State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘T’
2 3 Screen Number Display screen that prompts the consumer to enter
(Range 000‐Z99) a card. While the SST is waiting for a card entry,
this screen will be displayed.
3 3 Good Read Next State Number State number to which the SST goes:
(Base 10 range 000‐254 or 1. Following a good read of the card if FITs are not
256‐999) used (Table Entry 3 in Extension state = 000)
(Base 36 range 000‐254 or or
256‐ZZZ) 2. If the Financial Institution number on the card
matches a Financial Institution number in a FIT
4 3 Error (Misread) Screen Number Screen that is displayed if an unsuccessful read
(Range 000‐Z99) occurs; or for a smart dip card, the consumer fails
to take the card before timer 72 expires.
5 3 Read Condition 1 These three entries specify which card track(s) and
/ or chip data will be read. The possible values for
6 3 Read Condition 2 these entries are the same as for the ‘A’ Card Read
7 3 Read Condition 3 state in Table 2‐6 on page 2‐13.
8 3 Reserved This field is not used. The early card eject feature is
not supported by this state.
9 3 Extension State Number State number of the Extension state containing
(Base 10 range 000‐254 or information for parallel PIN entry.
256‐999) For more information about extension states, see
(Base 36 range 000‐254 or “Extension States” on page 2‐6.
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-72 APTRA™ Advance NDC, Reference Manual
State Tables
T - Card Read - PIN Entry Initiation State
Table 2-38
Extension 1 to State T
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Screen Number Display screen that prompts the consumer to enter a PIN.
(Range 000‐Z99) This screen is displayed on card entry. The screen must leave
the cursor positioned at the beginning of the PIN Entry
display area. An ‘X’ is displayed for each key pressed. The
Track 1 name cannot be displayed at this time because the
card has not been read.
If this entry is 000, PIN entry initiation is not enabled.
3 3 No FIT Match Next State State number to which the SST goes if the financial institution
Number number on the card does not match any FIT. If FITs are not
(Base 10 range 000‐254 or used, this entry must be 000. The No FIT match exit is also
256‐999) taken if the SST has a smart dip reader, one of the chip
(Base 36 range 000‐254 or connect bits is set, and the ATR succeeds.
256‐ZZZ)
4 3 Clear Key Mask A binary‐encoded value specifying the FDKs or touch areas
(Range 000‐255) that are active as Clear keys during PIN entry. Each bit relates
to an FDK or touch area. Bit 0 relates to FDK ‘A’ (or FDK ‘A’
touch area); bit 7 relates to FDK ‘I’ (or FDK ‘I’ touch area). If a
bit is ‘1’, the relative FDK or touch area is active. If a bit is ‘0’,
the relative FDK or touch area is inactive.
See Table Note 30.
5 3 Accept Key Mask A binary encoded value which specifies the FDKs or touch
(Range 000‐255) areas that are active as Accept keys during PIN entry. Each bit
relates to an FDK or touch area. Bit 0 relates to FDK ‘A’ (or
FDK ‘A’ touch area); bit 7 relates to FDK ‘I’ (or FDK ‘I’ touch
area). If a bit is ‘1’, the relative FDK or touch area is active. If a
bit is ‘0’, the relative FDK or touch area is inactive.
See Table Note 30.
6 3 Screen Number Display screen that prompts the consumer to remove the card
(Range 000‐Z99) and wait ‐ if the card reader is a smart dip card reader, and a
chip connect bit is set, but the ATR fails. This screen is
displayed until the consumer removes the card or timer 72
expires.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-73
State Tables
T - Card Read - PIN Entry Initiation State
Table Number of
Contents Description
Entry Characters
7 3 Smart DIP Reader Delayed Time to delay in one tenth of a second to latch the card when
Latch Timer the card reader is a smart dip card reader and a chip connect
(Range 000‐999) bit is set
If this entry is 000, there is no delay in latching the card.
For more information, see “Delay Latch/Smart Delay
Functionality” on page 2‐70. For information on how to
configure, refer to “Smart Delay Timer for Smart Dip Card
Reader” in Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC,
Developer’s Guide.
8 3 Reserved Must be 000
9 3 Extension State Number State number for Extension State 2.
(Base 10 range 000‐254 or For more information about extension states, see “Extension
256‐999) States” on page 2‐6.
(Base 36 range 000‐254 or
256‐ZZZ)
Table Note 30: The eight bits represent the binary equivalent of an
Accept key or Clear key mask.
For example, in the following mask:
b7 b6 b5 b4 b3 b2 b1 b0
0 0 0 1 0 0 1 0
the three decimal characters in table entry 4 or 5 are 018 and the
active FDKs or touch areas are B and F.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-74 APTRA™ Advance NDC, Reference Manual
State Tables
T - Card Read - PIN Entry Initiation State
Table 2-39
Extension 2 to State T
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘Z’
2 3 Secondary Card Reader State number to which the SST goes when the secondary card
Good Read Next State reader has successfully read the card and one of the following is
Number true:
(Base 10 range 000‐254 or FITs are not used (Table Entry 9 in Extension state = 000)
256‐999)
The Financial Institution number on the card matches a Financial
(Base 36 range 000‐254 or
Institution number in a FIT.
256‐ZZZ)
3 3 Active Card Readers Tells the SST which card readers to activate as follows:
(Range 000‐003) 000 ‐ All available card readers
001 ‐ Primary card reader
002 ‐ Secondary card reader
003 ‐ Primary and secondary card readers only
The default value is 000.
4 3 Secondary Card Reader
Read Condition 1
These three entries specify which card track(s) will be read. The
5 3 Secondary Card Reader possible values for these entries are shown in Table 2‐6, “Read
Read Condition 2 Condition Bit Information” on page 2‐13
6 3 Secondary Card Reader See Table Note 31
Read Condition 3
7 3 Contactless Tap Error This screen is displayed when a problem is detected during a
Screen (Range 000‐Z99) contactless card tap. If this parameter is ‘000’, then the screen
identified by the Error (Misread) Screen Number (table entry 4 of
the Card Read ‐ PIN Entry Initiation State T table, see “T ‐ Card
Read ‐ PIN Entry Initiation State” on page 2‐72) is displayed.
If the reason for the failure is to be displayed, it must be defined in
a dynamic text for contactless tap error within this screen
definition. The reason is displayed at the screen position where the
dictionary is defined. The reasons for failure that must be included
in the dictionary are described in “Defining Dynamic Text for
Contactless Tap Error” on page 2‐13.
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Table Note 31 The chip connect bit set (bit 3) of the read conditions
is an invalid value for a secondary card reader.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-75
State Tables
U – Device Fitness Flow Select State
U – Device Fitness Flow Select State 2
The Device Fitness Flow Select state is used to test the operational
condition of a device, or sub‐component, and make a branch in the
state flow. For example, the Device Fitness Flow Select state can be
used to test the operational condition of the receipt printer and if it
is inoperative, cause a branch in the state flow to display a screen
allowing the consumer to select whether to continue with the
transaction.
The device fitness value used in the test is the same value that
would be reported to the host if it requested the device fitness. The
values reflect the current status of the devices when Supervisor is
exited and are updated as device status messages are sent to the
host.
This state must not be used if the host does not explicitly check the
device fitness on exit from Supervisor as the host could be unaware
that a device remains in a fatal condition.
For details of the devices supported by the Device Fitness Flow
Select state, see “Supported Devices” on page 2‐78.
Table 2-40
U – Device Fitness Flow Select State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘U’
2 3 Device Number Device number or 000 (undefined)
For details of the supported devices and their
associated device numbers, see “Supported
Devices” on page 2‐78
If this is defined, it is used to identify the device,
otherwise table entry 4 (Device Identifier Graphic)
is used
The Device Unavailable Next State is taken if the
identified device is not present or not supported, or
if the device number is invalid
See Table Note 32, Table Note 33 and Table Note 34
3 3 Device Available Next State State number to which the SST goes if the device
Number and optional sub‐component are in a good
(Base 10 range 000‐254 or condition
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-76 APTRA™ Advance NDC, Reference Manual
State Tables
U – Device Fitness Flow Select State
Table Number of
Contents Description
Entry Characters
4 3 Device Identifier Graphic (DIG) Decimal representation of the DIG
For details of the supported devices and their
associated DIGs, see “Supported Devices” on
page 2‐78
This is used only if table entry 2 (Device Number)
is undefined (000)
The Device Unavailable Next State is taken if the
identified device is not present, not supported, or
its DIG is invalid
See Table Note 32, Table Note 33 and Table Note 34
5 3 Device Unavailable Next State State number to which the SST goes if the device is
Number in a fatal or suspend condition or is not present
(Base 10 range 000‐254 or See Table Note 34
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 Device Sub‐Component Index of the sub‐component as reported within the
Identifier Fitness Data solicited status message for the
specified DIG or 000 (overall device)
Identifies the sub‐component of a device
This is used only when table entry 4 (Device
Identifier Graphic) has been used to identify a
device and applies only to cash handlers
See Table Note 33 and Table Note 34
7 3 000 Reserved
8 3 000 Reserved
9 3 000 Reserved
Table Note 32: You can specify the device for which you want to
query the fitness in the following ways:
Using table entry 2 (Device Number) to specify the device
number
Using table entry 4 (DIG), and optionally table entry 6
(Sub‐Component Identifier) for cash dispensers, to specify
the DIG.
NCR recommends that you use the DIG to identify the device.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-77
State Tables
U – Device Fitness Flow Select State
Table Note 33: The reporting of fitness for dual cash handlers
depends on the setting of Enhanced Configuration Option 76, as
follows:
If Enhanced Configuration Option 76 is set to 000, querying
the device fitness reports the combined fitness of the cash
handler and cassettes (DIG ‘E’). The fitness of the primary
(DIG ‘d’) or secondary (DIG ‘e’) cash handler will be
reported as unavailable
If Enhanced Configuration Option 76 is set to 001, querying
the device fitness reports the combined fitness of the cash
handler and cassettes (DIG ‘E’). The fitness of the primary
cash handler (DIG ‘d’) will be reported as cash handler 0.
The fitness of the secondary cash handler (DIG ‘e’) will be
reported as cash handler 1.
For details of Enhanced Configuration Option 76, see “Option 76
– Cash Handlers” on page 7‐19.
Table Note 34: The Sub‐Component Identifier is only used when
querying a cash handler for the fitness of a cassette type. If the
cassette type is not present, it is reported as unavailable.
The following table lists the supported devices and the associated
Supported Devices 2
Device Number and DIG for use in the Device Fitness Flow Select
state:
Table 2-41
State ‘U’ - Supported Devices
Device Number
Device Decimal Value of DIG (table entry 4) and Subcomponent Index (table entry 6)
(table entry 2)
Card Reader/Writer 003 068 = D
Cash Handler 004 069 = E
See Table Note 35
Envelope Depository 005 070 = F
Receipt Printer 006 071 = G
Journal Printer 007 072 = H
See Table Note 36
Night Safe 010 075 = K
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-78 APTRA™ Advance NDC, Reference Manual
State Tables
U – Device Fitness Flow Select State
Device Number
Device Decimal Value of DIG (table entry 4) and Subcomponent Index (table entry 6)
(table entry 2)
Cassette Type 1 015 Depending on device configuration, as follows:
See Table Note 37 Table entry 4:
69 = E (single cash handler or dual cash handler emulating
a single cash handler)
100 = d (primary cash handler)
101 = e (secondary cash handler)
Table entry 6:
001
Cassette Type 2 016 Depending on device configuration, as follows:
See Table Note 37 Table entry 4:
69 = E (single cash handler or dual cash handler emulating
a single cash handler)
100 = d (primary cash handler)
101 = e (secondary cash handler)
Table entry 6:
002
Cassette Type 3 017 Depending on device configuration, as follows:
See Table Note 37 Table entry 4:
69 = E (single cash handler or dual cash handler emulating
a single cash handler)
100 = d (primary cash handler)
101 = e (secondary cash handler)
Table entry 6:
003
Cassette Type 4 018 Depending on device configuration, as follows:
See Table Note 37 Table entry 4:
69 = E (single cash handler or dual cash handler emulating
a single cash handler)
100 = d (primary cash handler)
101 = e (secondary cash handler)
Table entry 6:
004
Cassette Type 5 095 Depending on device configuration, as follows:
See Table Note 37 Table entry 4:
69 = E (single cash handler or dual cash handler emulating
a single cash handler)
100 = d (primary cash handler)
101 = e (secondary cash handler)
Table entry 6:
005
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-79
State Tables
U – Device Fitness Flow Select State
Device Number
Device Decimal Value of DIG (table entry 4) and Subcomponent Index (table entry 6)
(table entry 2)
Cassette Type 6 096 Depending on device configuration, as follows:
See Table Note 37 For table entry 4:
E = 69 Single cash handler or dual cash handler emulating
a single cash handler
100 = d (primary cash handler)
101 = e (secondary cash handler)
For table entry 6:
006
Cassette Type 7 097 Depending on device configuration, as follows:
See Table Note 37 Table entry 4:
69 = E (single cash handler or dual cash handler emulating
a single cash handler)
100 = d (primary cash handler)
101 = e (secondary cash handler)
Table entry 6:
007
Statement Printer 021 086 = V
Envelope Dispenser 027 092 = \
Coin Dispenser 024 089 = Y
Bunch Note Acceptor 034 119 = w
Cheque Processing Module 035 113 = q
Barcode Reader 094 102 = f
Primary Cash Handler 098 100 = d
Secondary Cash Handler 099 101 = e
Biometrics Capture Device N/A 120 = x
Passbook Printer N/A 088 = X
The Passbook Printer is not supported in Advance NDC but
the application can be enhanced or extended for it.
Table Note 35: If Enhanced Configuration Option 76 is set to 000,
querying the device fitness reports the combined fitness of the cash
handler and cassettes.
Table Note 36: If Enhanced Configuration Option 35 is set to 001
(EJ only) or 002 (dual mode), the journal printer fitness is reported
as good if the EJ log file is in a good condition even if the hardcopy
journal printer is in a fatal condition.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-80 APTRA™ Advance NDC, Reference Manual
State Tables
U – Device Fitness Flow Select State
Table Note 37: This is available only when Enhanced
Configuration option 76 is set to 001
Cash Handlers 2
The following table gives examples of the table entries used in the
Device Fitness Flow Select state to query the fitness of different cash
handler configurations:
Table 2-42
Cash Handler Fitness Examples
Table Entry 6
Table Entry 2 Table Entry 4
(Sub-Component Description
(Device Number) (DIG)
Identifier)
000 069 000 Queries the fitness of the entire cash handler as follows:
Table entry 2 is undefined, so table entry 4 is checked
Table entry 4 identifies the device as a single cash handler
or dual cash handler configured to emulate a single cash
handler
Table entry 6 identifies the whole device
000 069 001 Queries the fitness of cassette type 1 as follows:
Table entry 2 is undefined, so table entry 4 is checked
Table entry 4 identifies the device as a single cash handler
or dual cash handler configured to emulate a single cash
handler
Table entry 6 identifies cassette type 1
017 000 000 Queries the fitness of cassette type 3 as follows:
Table entry 2 identifies cassette type 3, so table entry 4 is
not checked
Table entry 6 is not checked because table entry 4 is not
used
017 100 004 Queries the fitness of cassette type 3 as follows:
Table entry 2 identifies cassette type 3, so table entry 4 is
not checked
Table entry 6 is not checked because table entry 4 is not
used
000 100 003 Queries the fitness of cassette type 3 in the primary cash
handler as follows:
Table entry 2 is undefined, so table entry 4 is checked
Table entry 4 identifies the device as the primary cash
handler
Table entry 6 identifies cassette type 3
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-81
State Tables
V - Language Select From Card State
V ‐ Language Select From Card State 2
In this state you can use one set of state tables to display screens in
different languages within the same transaction. This is determined
by a code on the consumer’s card. The code is a one‐character field
and is located using the Language Code Index parameter (PLNDX)
in the FIT. For more details, see Chapter 8, “Financial Institution
Tables”.
Note: A language selected by the consumer on the initiation of a
voice‐guided session takes precedence over the language selected
from the card.
You can use up to six screen groups in this state, and you specify
which language is to be used in each group. You also specify in table
entry 9 how many screens each group will contain. For more details,
see the “Multi‐Language Screens” section in Chapter 3, “Screen
Data”.
Table 2-43
V - Language Select from Card State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘V’
2 3 Next State Number State number to which the SST goes after selecting
(Base 10 range 000‐254 or the screen group.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Language Code Decimal number in the range 0‐9 identifying the
(Range 0‐9) code for screen group 1.
4 3 Language Code Decimal number in the range 0‐9 identifying the
(Range 0‐9) code for screen group 2.
5 3 Language Code Decimal number in the range 0‐9 identifying the
(Range 0‐9) code for screen group 3.
6 3 Language Code Decimal number in the range 0‐9 identifying the
(Range 0‐9) code for screen group 4.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-82 APTRA™ Advance NDC, Reference Manual
State Tables
V - Language Select From Card State
Table Number of
Contents Description
Entry Characters
7 3 Language Code Decimal number in the range 0‐9 identifying the
(Range 0‐9) code for screen group 5.
8 3 Language Code Decimal number in the range 0‐9 identifying the
(Range 0‐9) code for screen group 6.
9 3 Screen Group Size Number of screens in each language group.
(Range 000‐400) When a multi‐language screen base in the range
001 to 009 is specified, the value is multiplied by
1000 to give 1000, 2000, ....9000.
If extended screen groups are enabled and a value
in the range 010 to 099 is specified, the value is
multiplied by 100 to give 1000, 1100, 1200....9900.
To specify 1000 screens, set a value of 001.
If extended screen groups are enabled you can
specify a screen group size between 1000 and 5000
using the values ‘010’ to ‘050’. These values are
multiplied by 100 to give the screen group size.
For information on enabling extended screen
groups, refer to Chapter 5, “Configuring Advance
NDC and Associated Components” in the APTRA
Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-83
State Tables
W - FDK Switch State
W ‐ FDK Switch State 2
Data is placed in the FDK buffer during the Eight FDK Selection
Function state or the FDK Information Entry state. This data is read
by the FDK Switch state in order to identify which next state the SST
should go to.
Table 2-44
W - FDK Switch State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘W’
2 3 FDK ‘A’ Next State Number State number to which the SST goes depending on
the key code stored in the FDK buffer
3 3 FDK ‘B’ Next State Number (Base 10 range 000‐254 or 256‐999)
4 3 FDK ‘C’ Next State Number (Base 36 range 000‐254 or 256‐ZZZ).
5 3 FDK ‘D’ Next State Number
6 3 FDK ‘F’ Next State Number
7 3 FDK ‘G’ Next State Number
8 3 FDK ‘H’ Next State Number
9 3 FDK ‘I’ Next State Number
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-84 APTRA™ Advance NDC, Reference Manual
State Tables
X - FDK Information Entry State
X ‐ FDK Information Entry State 2
Table entries 2‐9 in the Extension to this state contain values relating
to FDKs ‘A’ ‐ ‘I’. When the consumer selects an FDK, this state
places the corresponding value in the General Purpose buffer or
Amount buffer that you have specified in Table Entry 7.
You can use this state to display, for example, a screen offering a
selection of fixed amounts that the consumer can select by pressing
a particular FDK. This state translates the FDK selected by the
consumer into a value that is placed in the specified buffer.
The FDK key code is stored in the FDK buffer for use by an FDK
Switch state.
The SST may support touch‐screen FDK emulation instead of
regular FDKs. In this case, eight fixed touch areas are defined on the
screen, which the consumer touches instead of pressing the
corresponding FDK. The touch areas are enabled/disabled in exactly
the same way as the FDKs. For details, see the “FDK Emulation”
section in Chapter 4, “Keyboard Data and Layouts”.
Alternatively, the SST may support full touch‐screen keyboards. In
this case, touch areas are defined on the screen for all the required
keys. The consumer touches these instead of pressing a key on the
keypad or an FDK. For details, see Chapter 4, “Keyboard Data and
Layouts”.
Note: If the consumer has selected a voice‐guided session, this state
checks AudioGuidanceData.xml to identify the numeric keys used to
represent the FDKs, which are also active unless the consumer has
chosen to hide screens.
Table 2-45
X - FDK Information Entry State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘X’
2 3 Screen Number Display screen that prompts key selection by
(Range 000‐Z99) consumer.
3 3 Time‐Out Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or fails to respond to the message within the
256‐999) permitted time limit. Enter 255 if the time‐out
(Base 36 range 000‐254 or function is not required.
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-85
State Tables
X - FDK Information Entry State
Table Number of
Contents Description
Entry Characters
4 3 Cancel Next State Number State number to which the SST goes if the Cancel
(Base 10 range 000‐254 or key is pressed.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 FDK Next State Number State number to which the SST goes if an FDK or
(Base 10 range 000‐254 or touch area is pressed.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 Extension State Number State number of Extension state containing
(Base 10 range 000‐254 or assigned values for the eight FDKs or touch areas.
256‐999) For more information about extension states, see
(Base 36 range 000‐254 or “Extension States” on page 2‐6.
256‐ZZZ)
7 3 Buffer ID Identifies which buffer is to be edited and the
(Range 010‐039) number of zeros to be added to the values specified
in the Extension state:
01X ‐ General purpose buffer B
02X ‐ General purpose buffer C
03X ‐ Amount buffer. See Table Note 39 and
Table 2‐32.
X specifies the number of zeros in the range 0‐9
8 3 FDKs Active Mask Specifies the FDKs or touch areas that are active
(Range 000‐255) during this state. Each bit relates to an FDK or
touch area. Bit 0 relates to FDK ‘A’ (or FDK ‘A’
touch area); bit 7 relates to FDK ‘I’ (or FDK ‘I’ touch
area). If a bit is ‘1’ the relative FDK or touch area is
active. If a bit is ‘0’ the relative FDK or touch area is
inactive. See Table Note 38.
9 3 Must be 000 Reserved
Table Note 38: The eight bits represent the binary equivalent of an
FDK Active Mask. For example, in the following mask
b7 b6 b5 b4 b3 b2 b1 b0
0 0 1 1 1 1 0 0
the three decimal characters in table entry 8 are 060 and the active
FDKs or touch areas are C, D, F and G.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-86 APTRA™ Advance NDC, Reference Manual
State Tables
X - FDK Information Entry State
Table Note 39: If used, the Amount buffer will contain up to twelve
digits, depending on the option selected. If this state is followed by
an Amount Check state with an Amount Check Condition set to
000, the amount entered is assumed to be a whole amount.
Table Note 40: If required by the host, the screen can be
configured to add extra zeros automatically to the amount buffer,
after the decimal point. This configuration is defined in the
AppendBuffer.xml file described in the APTRA Advance NDC,
Developer’s Guide. The file can be downloaded, as described in “XML
Configuration Download” on page 10‐49, or can be installed locally.
Table 2-46
Extension to State X
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Value stored if FDK ‘A’ or FDK Each table entry contains a value that is stored in
‘A’ touch area pressed the buffer specified in the associated FDK
Information Entry state table (table entry 7) if the
3 3 Value stored if FDK ‘B’ or FDK specified FDK or touch area is pressed.
‘B’ touch area pressed (Range 000‐999 or 000‐ZZZ)
4 3 Value stored if FDK ‘C’ or FDK
‘C’ touch area pressed
5 3 Value stored if FDK ‘D’ or FDK
‘D’ touch area pressed
6 3 Value stored if FDK ‘F’ or FDK
‘F’ touch area pressed
7 3 Value stored if FDK ‘G’ or FDK
‘G’ touch area pressed
8 3 Value stored if FDK ‘H’ or FDK
‘H’ touch area pressed
9 3 Value stored if FDK ‘I’ or FDK
‘I’ touch area pressed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-87
State Tables
Y - Eight FDK Selection Function State
Y ‐ Eight FDK Selection Function
State 2
This state reads the FDK selected by the consumer, stores the key
code in an FDK buffer for use by an FDK Switch state, and updates
the Operation Code buffer. If you do not specify an extension state
in table entry 6, the key code of the FDK selected by the consumer is
stored directly in the Operation Code buffer. If you do specify an
extension state, the key code is translated into three pseudo key
codes, which are then stored in the Operation Code buffer.
You can specify a second extension state in table entry 9 to identify
the screen bases for multi‐language screen displays. If you do not
specify this extension state, then multi‐language display is not used.
The SST may support touch‐screen FDK emulation instead of
regular FDKs. In this case, eight fixed touch areas are defined on the
screen, which the consumer touches instead of pressing the
corresponding FDK. The touch areas are enabled/disabled in exactly
the same way as the FDKs. For details, see the “FDK Emulation”
section in Chapter 4, “Keyboard Data and Layouts”.
Alternatively, the SST may support full touch‐screen keyboards. In
this case, touch areas are defined on the screen for all the required
keys. The consumer touches these instead of pressing a key on the
keypad or an FDK. For details, see Chapter 4, “Keyboard Data and
Layouts”.
Note: If the consumer has selected a voice‐guided session, this state
checks AudioGuidanceData.xml to identify the numeric keys used to
represent the FDKs, which are also active unless the consumer has
chosen to hide screens.
No language selection is required in this state if the consumer
Language Selection in previously selected a language when initiating a voice‐guided
Voice‐Guided Sessions 2
session. If this single language selection is disabled, the consumer
will be required to select the language multiple times during their
session.
The following must be considered when voice guidance is enabled:
The screen offset values used in this state must match the screen
Offset sub‐element defined in the XML configuration file for
voice guidance. The secondary languages must match the offset
values used in the screens and states downloaded from Central.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-88 APTRA™ Advance NDC, Reference Manual
State Tables
Y - Eight FDK Selection Function State
The language selected by the consumer during the initiation of a
voice‐guided session determines the language offset used for
the transaction screens
For information on configuring voice guidance, refer to Chapter 6,
“Configuring Voice Guidance” in the APTRA Advance NDC,
Developer’s Guide.
Table 2-47
Y - Eight FDK Selection Function State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Y’
2 3 Screen Number Display screen that prompts the consumer to select
(Range 000‐Z99) keys.
3 3 Time‐Out Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or does not respond to the message within the
256‐999) specified time limit. Enter 255 if the time‐out
(Base 36 range 000‐254 or function is not required.
256‐ZZZ)
4 3 Cancel Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or presses the Cancel key.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 FDK Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or presses an FDK or touch area.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 Extension State Number State number of Extension state containing
(Base 10 range 000‐254 or assigned operation codes for the eight FDKs or
256‐999) touch areas. If there is no Extension state, enter 255.
(Base 36 range 000‐254 or For more information about extension states, see
256‐ZZZ) “Extension States” on page 2‐6.
7 3 Buffer positions If there is no Extension state, this defines the
(Range 000‐007) Operation Code buffer position to be edited by a
value in the range ‘000’ to ‘007’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-89
State Tables
Y - Eight FDK Selection Function State
Table Number of
Contents Description
Entry Characters
If there is an Extension state, this specifies three
bytes of the Operation Code buffer to be set to the
values specified in the Extension state. Three
numeric values, each in the range ‘0’ to ‘7’, are
specified to define three positions in the 8 byte
Operation Code buffer to be edited. These three
values must be ordered to correspond with the edit
characters in the Extension state. If no buffer
positions or fewer than three buffer positions are to
be edited, this is specified in the Extension state.
8 3 FDKs Active Mask Specifies the FDKs or touch areas that are active
(Range 000‐255) during this state. Each bit relates to an FDK or
touch area. Bit 0 relates to FDK ‘A’ (or FDK ‘A’
touch area); bit 7 relates to FDK ‘I’ (or FDK ‘I’ touch
area). If a bit is ‘1’ the relative FDK or touch area is
active. If a bit is ‘0’ the relative FDK or touch area is
inactive.
See Table Note 41.
9 3 Multi‐Language Screens If the state selects the multi‐language screen base,
Selection Extension State this contains the Extension state number. If there is
Number no Extension state, enter 000 or 255.
(Base 10 range 000‐254 or For more information about extension states, see
256‐999) “Extension States” on page 2‐6.
(Base 36 range 000‐254 or
256‐ZZZ)
Table Note 41: The eight bits represent the binary equivalent of an
FDK Active Mask. For example, in the following mask:
b7 b6 b5 b4 b3 b2 b1 b0
0 0 1 1 1 1 0 0
the three decimal characters in table entry 8 are 060 and the active
FDKs or touch areas are C, D, F and G.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-90 APTRA™ Advance NDC, Reference Manual
State Tables
Y - Eight FDK Selection Function State
Table 2-48
Extension 1 to State Y
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Operation Code stored if FDK
‘A’ or FDK ‘A’ touch area is
pressed.
3 3 Operation Code stored if FDK
‘B’ or FDK ‘B’ touch area is
pressed.
4 3 Operation Code stored if FDK
‘C’ or FDK ‘C’ touch area is
pressed. Each table entry contains the Operation Code
characters to be written to the Operation Code
5 3 Operation Code stored if FDK buffer if the specified FDK or touch area is pressed.
‘D’ or FDK ‘D’ touch area is Three characters are specified for each code, which
pressed. must be in the range ‘A’ ‐ ‘I’. They are written, in
order, to the three positions specified in the
6 3 Operation Code stored if FDK associated Eight FDK Selection Function state table
‘F’ or FDK ‘F’ touch area is (table entry 7). Enter ‘@’ if no character is to be
pressed. written to a specified position in the buffer.
7 3 Operation Code stored if FDK See Table Note 42
‘G’ or FDK ‘G’ touch area is
pressed.
8 3 Operation Code stored if FDK
‘H’ or FDK ‘H’ touch area is
pressed.
9 3 Operation Code stored if FDK
‘I’ or FDK ‘I’ touch area is
pressed.
Table Note 42: If specifying characters in the range ‘A’ to ‘I’ and ‘@’
causes difficulties with the state table editor, you can use values ‘1’
to ‘9’ and ‘0’ instead
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-91
State Tables
Y - Eight FDK Selection Function State
Table 2-49
Extension 2 to State Y
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Screen Base if FDK ‘A’ or FDK Each table entry contains the screen number of the
‘A’ touch area is pressed first screen of each language group. The initial base
is 000, and all unused fields should contain this
3 3 Screen Base if FDK ‘B’ or FDK value.
‘B’ touch area is pressed
See Table Note 43
4 3 Screen Base if FDK ‘C’ or FDK
‘C’ touch area is pressed
5 3 Screen Base if FDK ‘D’ or FDK
‘D’ touch area is pressed
6 3 Screen Base if FDK ‘F’ or FDK
‘F’ touch area is pressed
7 3 Screen Base if FDK ‘G’ or FDK
‘G’ touch area is pressed
8 3 Screen Base if FDK ‘H’ or FDK
‘H’ touch area is pressed
9 3 Screen Base if FDK ‘I’ or FDK ‘I’
touch area is pressed
Table Note 43: When a multi‐language screen base in the range 001
to 009 is specified, it is multiplied by 1000 to give 1000, 2000,
3000....9000. If extended screen groups are enabled and a value in
the range 010 to 099 is specified, it is multiplied by 100 to give 1000,
1100, 1200....9900. For information on enabling extended screen
groups, refer to Chapter 5, “Configuring Advance NDC and
Associated Components” in the APTRA Advance NDC, Developer’s
Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-92 APTRA™ Advance NDC, Reference Manual
State Tables
b - Customer-Selectable PIN State
b ‐ Customer‐Selectable PIN State 2
This state allows the consumer to input a new PIN. It differs from
the PIN entry state in the number of retries. The state will prompt
for the new PIN twice and will take a good exit if both are the same
and the SST checking feature is enabled.
If checking is local, the exit will be taken when the two new PINs
have been built into the PIN blocks for transmitting. If checking is
enabled and the two PINs entered are not the same the consumer
will be asked to re‐enter the Customer Selectable PIN (CSP) and the
state will not exit. If the FIT specifies that short PIN entry is to be
tested for, short PINs will be regarded as one try against the limit
specified in the state table.
The screen association for this state is derived from the screen
specified in table entry 2. The consumer PIN is entered on the facia
keyboard and consists of four to sixteen digits. If the number of
digits entered is less than the value specified in the FIT entry
PMXPN the consumer must press FDK A (or FDK I if the option
enabling the keys to the left of the consumer screen is set) or the
‘ENTER’ key on the facia keyboard after the last digit entered. Note
that pressing the ‘CLEAR’ key on the facia clears all the digits.
Table 2-50
b - Customer-Selectable PIN State
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘b’
2 3 First Entry Screen Number Display screen that prompts the consumer to enter
(Range 000‐Z99) the PIN the first time.
3 3 Time‐Out Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or does not make a CSP entry within the specified
256‐999) time limit. Enter 255 if the time‐out function is not
(Base 36 range 000‐254 or required.
256‐ZZZ)
4 3 Cancel Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or presses the Cancel key to stop the CSP transaction.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-93
State Tables
b - Customer-Selectable PIN State
Table Number of
Contents Description
Entry Characters
5 3 Good Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or enters a matching pair of new PIN values.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 CSP Fail Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or fails to enter a matching pair of new PIN digits or
256‐999) the maximum number of retries for local PIN
(Base 36 range 000‐254 or checking is reached.
256‐ZZZ)
This is also taken if:
There is no FIT match.
PIN block generation fails. Note that the option
to send the PIN buffer irrespective of failure
does not operate.
7 3 Second Entry Screen Number Display screen used to ask for confirmation of the
(Range 000‐Z99) CSP.
8 3 Mis‐Match First Entry Screen Display screen that replaces the screen for table
Number entry 2 on each attempt after a CSP pair attempt
Range (000‐Z99) did not match or an error has occurred and there
are still further retries allowed.
9 3 Extension State Number State number of the Extension state.
(Base 10 range 000‐254 or For more information about extension states, see
256‐999) “Extension States” on page 2‐6.
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-94 APTRA™ Advance NDC, Reference Manual
State Tables
b - Customer-Selectable PIN State
Table 2-51
Extension to State b
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Number of attempts allowed to Limits the number of attempts the consumer may
enter a matching CSP pair make to select a new PIN. A value of 0 is no limit.
(Range 000‐010)
3 3 Use local verification of new Specifies which attempts are to be verified locally:
PIN pair attempts
(Range 000‐001) 0 ‐ Do not verify locally. Make attempts available in
transaction request fields ‘U’ and ‘V’.
1 ‐ Verify both attempts locally. Result available in
transaction request field ‘U’. This option is not
possible when using Banksys PIN block
encryption. A random number is used as part of the
encryption and therefore no two consecutive keys
will be the same. If it is selected the CSP Fail Next
State will be taken when an attempt to enter PINs is
made.
See Table Note 44
4‐9 18 Must be 000 Reserved.
Table Note 44: If local check for short PINs is specified, it is
possible to have the CSP failure screen displayed after a short first
PIN entry. The wording of the CSP fail screen should avoid
confusion, for example, “There is a problem with the new PIN
please re‐enter” with the second PIN entry screen worded “Please
re‐enter PIN to confirm new number”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-95
State Tables
d ... g and z - Exit States
d ... g and z ‐ Exit States 2
State identification letters d to g are reserved for Exit states. For
further information, refer to the NCR publication APTRA Advance
NDC, Extending the Product.
Substates 900 to 999 under Master Expansion state ‘z’ are also
reserved for customer Exit states. For details, see “z – Master
Expansion State” on page 2‐132.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-96 APTRA™ Advance NDC, Reference Manual
State Tables
k - Smart FIT Check State
k ‐ Smart FIT Check State 2
This state is required when chip data is to be used in a FIT check.
The Smart FIT Check state is designed to be entered from your own
C‐Exit state, such as the example Chip Data Read state, which will
have read the chip data from the smart card and placed the data in
the magnetic track buffers. For details of the example Chip Data
Read state, see Chapter 12, “EMV Smart Card Handling”.
The Smart FIT Check state then performs a FIT check for a Smart
Card.
It is possible to create more than one Smart FIT Check state to
accommodate multiple FIT checks. This would allow different FIT
checks to be performed on data from the same card.
Table 2-52
k - Smart FIT Check State
Table No. of
Contents Description
Entry Chars
1 1 State type ‘k’ (6BH)
2 3 Reserved (000) Not used ‐ set to 0.
3 3 Good Read Next State number to which the SST goes if the Financial Institution number
State Number on the card matches a Financial Institution number in the FIT.
(Base 10 range
000‐254 or 256‐999)
(Base 36 range
000‐254 or 256‐ZZZ)
4 3 Reserved (000) Not used ‐ set to 0.
5 3 Reserved (000) Not used ‐ set to 0.
6 3 Reserved (000) Not used ‐ set to 0.
7 3 Reserved (000) Not used ‐ set to 0.
8 3 Card Return Flag Tells the SST when the card should be returned to the consumer:
000 ‐ eject the card immediately
001 ‐ return the card as specified by a Transaction Reply message.
9 3 No FIT Match Next State taken if the FIT check fails.
State Number The state may be a Close state, or a return to another C‐Exit state which
places the chip data in the read buffers before calling another Smart
FIT Check state.
If FITs are not used, this entry must be 000.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-97
State Tables
m - PIN & Language Select State
m ‐ PIN & Language Select State 2
This state performs the same functions as the PIN Entry state (state
ʹBʹ or ʹMʹ) combined with the functionality of the Eight FDK
Selection Function state (state ʹYʹ). This state allows language
selection from an FDK following the PIN entry. All the functionality
and conditions of PIN Entry and Eight FDK Selection states apply to
this state.
This state also has several table entries that are included in the first
extension state. Normally, the consumer enters the PIN, which
consists of four to sixteen digits, on the facia keyboard. If a
consumer enters fewer than the number of digits specified in the FIT
entry, PMXPN, the consumer must press an active FDK (as defined
by the FDKs Active Mask) or the Enter key after entering the last
digit. Otherwise, Auto‐enter takes on the language assigned to the
Enter key. If the Enter key is not active on the keyboard, the SST uses
the first active FDK.
If the consumer does not enter a PIN, but presses an Active FDK to
select a language, the SST takes the No PIN Entered Next State
Number (table entry 2) exit. The SST normally enters the PIN Entry
state (state ʹBʹ or ʹMʹ) if this occurs.
If the FIT specifies local DES PIN verification and the consumer
enters an incorrect PIN, the SST takes the Local PIN Entry Error
Next State Number (table entry 5) exit. Usually, a PIN Entry state
(state ʹBʹ or ʹMʹ) is placed in this entry and the screen displayed is in
the language just selected.
If the consumer presses the Enter key or Auto‐enter is used to accept
the PIN, the FDK Enter Key Default Mask (table entry 9) defines
which FDK key code, and therefore the Screen Base, to store in the
FDK buffer.
The state ʹBʹ or state ʹMʹ table entry defines whether the maximum
retry count is on Track 3 of the card or in the state table. Previously,
NDC+ used two separate states, states ʹBʹ and ʹMʹ, to implement this
functionality. To support this function, the FIT must specify local
PIN check and indicate that there is a Track 3 retry field on the card.
For more information about the PIN Entry state, see “B ‐ PIN Entry
State” on page 2‐16. For more information about Eight FDK
Selection Function state, see “Y ‐ Eight FDK Selection Function
State” on page 2‐88.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-98 APTRA™ Advance NDC, Reference Manual
State Tables
m - PIN & Language Select State
If the consumer has selected a voice‐guided session, this state is
Considerations for used only for PIN entry and not for language selection. For details
Voice‐Guided Sessions 2
of the voice guidance XML configuration file, refer to the APTRA
Advance NDC, Developer’s Guide. The following must be considered
when voice guidance is enabled:
The screen offset values used in this state must match the screen
Offset sub‐element defined in the XML configuration file for
voice guidance. The secondary languages must match the offset
used in the screens and states downloaded from Central.
The language selection, performed as part of initialisation of a
voice‐guided session, determines the language offset used for
the transaction screens
The Enter key must be active in this state
If the opCodePos sub‐element is used in the XML configuration
file, this state must use the same buffer position in table entry 7.
The XML configuration file can use a different value than that
used in this state to identify whether the session is a
voice‐guided session
The SST will echo key selection with a beep only if the
information is not displayed on the screen
If this state requires both FDKs and numeric keys, the
voice‐guided session cannot map the FDKs to the numeric
keypad.
Table 2-53
m - PIN & Language Select State
Table No of
Contents Description
Entry Chars
1 1 State Type ‘m’ (ASCII 6d, EBCDIC 94)
2 3 Screen Number Display screen that prompts the consumer to enter the PIN and
(Range 000‐Z99) select a language for the first time. This screen, which is
displayed on entering the PIN & Language Select state, must
leave the cursor at the start of the PIN Entry display area. An
asterisk (*) is displayed for each key pressed.
3 3 Time‐Out Next State State number to which the SST goes if the consumer does not
Number enter the PIN within the permitted time limit. If the time‐out
(Base 10 range 000‐254 or function is not required, enter state number 255.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-99
State Tables
m - PIN & Language Select State
Table No of
Contents Description
Entry Chars
4 3 Cancel Next State Number State number to which the SST goes if the consumer presses the
(Base 10 range 000‐254 or Cancel key before the maximum number of digits specified for
256‐999) the PIN have been entered.
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Next State Options State number of Extension state containing the PIN options;
Extension State Number the Next State numbers that the SST enters after the PIN is
(Base 10 range 000‐254 or entered; and the FDKs ʹEnterʹ Key Mask.
256‐999) For more information about extension states, see “Extension
(Base 36 range 000‐254 or States” on page 2‐6.
256‐ZZZ)
6 3 Operation Codes Extension This entry is the same as state ‘Y’, table entry 6.
State Number State number of the Extension state containing assigned
(Base 10 range 000‐254 or operation codes for the eight FDKs or touch areas.
256‐999) If there is no Extension state, enter 255.
(Base 36 range 000‐254 or For more information about extension states, see “Extension
256‐ZZZ) States” on page 2‐6.
7 3 Buffer Positions This entry is the same as state ‘Y’, table entry 7.
(Range 000‐777) If there is no Extension state, this defines the Operation Code
buffer position to be edited by a value in the range ʹ000ʹ to ʹ007ʹ.
If there is an Extension state, this specifies three bytes of the
Operation Code buffer to be set to the values specified in the
Extension state. Three numeric values, each in the range ʹ0ʹ to ʹ7ʹ,
are specified to define three positions in the 8 byte Operation
Code buffer to be edited. These three values must be ordered to
correspond with the edit characters in the Extension state. If no
buffer positions or fewer than three buffer positions are to be
edited, this is specified in the Extension state. Values greater
than 7 will be ignored.
8 8 FDKs Active Mask This entry is the same as state ‘Y’, table entry 8.
(Range 000‐255) Specifies the FDKs or touch areas that are active during this
state. Each bit relates to an FDK or touch area.
Bit 0 relates to FDK ʹAʹ (or FDK ʹAʹ touch area); bit 7 relates to
FDK ʹIʹ (or FDK ʹIʹ touch area). If a bit is ʹ1ʹ the relative FDK or
touch area is active. If a bit is ʹ0ʹ the relative FDK or touch area is
inactive. Values above 255 will be accepted, but only bits 0 ‐ 7
will be used.
See Table Note 45.
9 3 Multi‐Language Screens This entry is the same as State ‘Y’, table entry 9.
Selection Extension State If the state selects the multi‐language screen base, this contains
Number the Extension state number. If there is no Extension state, enter
(Base 10 range 000‐254 or 000 or 255.
256‐999) For more information about extension states, see “Extension
(Base 36 range 000‐254 or States” on page 2‐6.
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-100 APTRA™ Advance NDC, Reference Manual
State Tables
m - PIN & Language Select State
Table Note 45: The eight bits represent the binary equivalent of an
FDK Active Mask. For example, in the following mask, the three
decimal characters in table entry 8 are 060 and the active FDKs or
touch areas are C, D, F and G:
Table 2-54 b7 b6 b5 b4 b3 b2 b1 b0
PIN & Language FDK Active Mask
0 0 1 1 1 1 0 0
Table 2-55
Extension 1 to State m
Table No of
Contents Description
Entry Chars
1 1 State type ‘Z’ (ASCII 5a, EBCDIC E9)
2 3 No PIN Entered Next State State number to which the SST goes if the consumer does
Number not enter a PIN, but selects a language from an active FDK
(Base 10 range 000‐254 or or touch area. The SST normally enters the PIN Entry state
256‐999) (state ʹBʹ or ʹMʹ) if this occurs.
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Local PIN Check ‐Good PIN This entry is the same as state ‘B’, table entry 5.
Next State Number State number to which the SST goes after verification of a
(Base 10 range 000‐254 or correct PIN entry.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Local PIN Check ‐ Maximum This entry is the same as state ‘B’, table entry 6.
Bad PINs Next State Number State number to which the SST goes if the correct PIN has
(Base 10 range 000‐254 or not been entered after the number of attempts allowed by
256‐999) table entry 7. The SST normally enters a Close state if this
(Base 36 range 000‐254 or occurs.
256‐ZZZ) See Table Note 46.
5 3 Local PIN Check Error Next State number to which the SST goes if an incorrect PIN is
State Number entered. The SST normally enters the PIN Entry state (state
(Base 10 range 000‐254 or ʹBʹ or ʹMʹ) in the language selected from this state as you
256‐999) cannot go back to the ʹmʹ state, since there is no error screen
(Base 36 range 000‐254 or for bad PIN entry. This state type should match the state
256‐ZZZ) type identified in table entry 8 below.
6 3 Remote PIN Check Next State This entry is the same as state ‘B’, table entry 8.
Number State number to which the SST goes when local PIN
(Base 10 range 000‐254 or verification is not performed.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-101
State Tables
m - PIN & Language Select State
Table No of
Contents Description
Entry Chars
7 3 Local PIN Check Maximum This entry is the same as state ‘B’, table entry 9.
PIN Retries (Range 001‐009) Maximum number of incorrect PIN entries allowed before
the SST enters the state determined by table entry 4.
See Table Note 46.
8 3 State ʹBʹ or ʹMʹ Option Specifies whether to use Track 3 retries on the card or from
(Range 000 ‐ 001) the state table. Enter ʹ000ʹ if PIN Entry state B functionality
is needed. Enter ʹ001ʹ if Enhanced PIN Entry state M
functionality is needed.
9 3 FDK Enter Key Default Mask Specifies the FDK or touch area that is the default language
(Range 000 ‐ 128) if the Enter key on the key pad is pressed instead of an FDK.
Each bit relates to an FDK or touch area. Bit 0 relates to FDK
ʹAʹ (or FDK ʹAʹ touch area); bit 7 relates to FDK ʹIʹ (or FDK ʹIʹ
touch area). Set the bit to a ʹ1ʹ to make that FDK the default
ʹEnterʹ key value. The mapped FDK will be set even if the
FDK is inactive. Only one bit should be set to ʹ1ʹ; all other
bits should be ʹ0ʹ. If all bits are set to ʹ0ʹ, the Enter key will
not be active.
Table Note 46: These fields are also used when the Check Remote
PIN minimum length option is used. They are used in the same way
as for Local PIN verification. An incorrect PIN is one which is less
than the minimum length.
Table 2-56
Extension
2 to State m
Table No of Contents Description
Entry Chars
1 1 State Type ʹZʹ (ASCII 5a, EBCDIC E9)
2 3 Operation Code stored if FDK ʹAʹ Each table entry contains the Operation Code characters to
or FDK ʹAʹ touch area pressed be written to the Operation Code buffer if the specified
FDK or touch area is pressed.
3 3 Operation Code stored if FDK ʹBʹ Three characters are specified for each code, which must be
or FDK ʹBʹ touch area pressed in the range ʹAʹ ‐ ʹIʹ. They are written, in order, to the three
4 3 Operation Code stored if FDK ʹCʹ positions specified in the associated Eight FDK Selection
or FDK ʹCʹ touch area pressed Function state table (table entry 7). Enter ʹ@ʹ if no character
is to be written to a specified position in the buffer.
5 3 Operation Code stored if FDK ʹDʹ Note: If specifying characters in the range ʹAʹ to ʹIʹ and ʹ@ʹ
or FDK ʹDʹ touch area pressed causes difficulties with the state table editor, you can use
values ʹ1ʹ to ʹ9ʹ and ʹ0ʹ instead.
6 3 Operation Code stored if FDK ʹFʹ
or FDK ʹFʹ touch area pressed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-102 APTRA™ Advance NDC, Reference Manual
State Tables
m - PIN & Language Select State
Table No of Contents Description
Entry Chars
7 3 Operation Code stored if FDK ʹGʹ
or FDK ʹGʹ touch area pressed
8 3 Operation Code stored if FDK ʹHʹ
or FDK ʹHʹ touch area pressed
9 3 Operation Code stored if FDK ʹIʹ
or FDK ʹIʹ touch area pressed
Table 2-57
Extension 3 to State m
Table No of
Contents Description
Entry Chars
1 1 State Type ʹZʹ (ASCII 5a, EBCDIC E9)
2 3 Screen Base if FDK ʹAʹ or FDK ʹAʹ Each table entry contains the screen number of the first
touch area is pressed screen of each language group. The initial base is 000, and
all unused fields should contain this value.
3 3 Screen Base if FDK ʹBʹ or FDK ʹBʹ
touch area is pressed See Table Note 47
4 3 Screen Base if FDK ʹCʹ or FDK ʹCʹ
touch area is pressed
5 3 Screen Base if FDK ʹDʹ or FDK ʹDʹ
touch area is pressed
6 3 Screen Base if FDK ʹFʹ or FDK ʹFʹ
touch area is pressed
7 3 Screen Base if FDK ʹGʹ or FDK ʹGʹ
touch area is pressed
8 3 Screen Base if FDK ʹHʹ or FDK ʹHʹ
touch area is pressed
9 3 Screen Base if FDK ʹIʹ or FDK ʹIʹ
touch area is pressed
Table Note 47: This Extension state is the same as the Extension 2
to state Y, Table 2‐49 on page 2‐92.
When a multi‐language screen base in the range 001 to 009 is
specified, it is multiplied by 1000 to give 1000, 2000, 3000,…9000. If
extended screen groups are enabled and a value in the range 010 to
099 is specified, it is multiplied by 100 to give 1000, 1100,
1200....9900. For information on enabling extended screen groups,
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-103
State Tables
m - PIN & Language Select State
refer to Chapter 5, “Configuring Advance NDC and Associated
Components” in the APTRA Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-104 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
> ‐ Cash Accept State 2
If a cash acceptor is present, this state can be used to let the
consumer deposit single notes or bunches of notes.
Most of the cash deposit transaction is not controlled by Central, as
the time taken for a successful cash deposit could exceed the
transaction request/reply timers. For this reason, the processing of a
cash deposit transaction is performed by the Cash Accept state
before a transaction request is sent. Cash acceptor unsolicited
messages are sent to inform Central when notes have been
processed or when an error occurs.
Under state table control, the Cash Accept state performs the
Cash Accept State following:
Operations 2
1 Activates and de‐activates acceptable note types according to
the state parameters (Set NDC note type 1‐12...49‐50) in
Table 2‐61 “Extension 3 to State > (Cash Accept)” on page 2‐114.
Note: Extension 3 is mandatory for the Cash Accept state.
2 Accepts a single note or a bunch of notes depending on the
device type.
Note: Whether the bunch of notes is stored in the escrow
(refundable deposit) or deposited directly to the cassettes (direct
deposit) is defined in table entry 5 of extension state 4. For
details, see Table 2‐62, “Extension 4 to State > (Cash Accept)” on
page 2‐116.
3 Identifies the notes.
4 Checks the note type and denomination are active; that is, that
the note type and denomination are accepted by Central.
5 Returns invalid or inactive notes to the consumer.
6 Processes any notes identified as category 2 (counterfeit) or
category 3 (suspect).
7 If refundable deposit is configured, refunds notes if there are
more notes than the escrow capacity or the consumer chooses a
refund of any good notes in the escrow.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-105
State Tables
> - Cash Accept State
8 If the cash acceptor can retract notes and this capability is
enabled, retracts returned notes that have not been taken within
the time specified by timer 78, the retract timer.
Note: If rejected notes are taken late, just as the retract
operation starts, Advance NDC does not send a w7 message but
remains in the Cash Accept state.
9 When extended journaling is enabled with journal level 3 set,
journals each consumer interaction, including time‐outs. For
more information about extended journaling and journal levels,
refer to the APTRA Advance NDC, Supervisor’s Guide.
10 On a single note acceptor, for each processed note, journals the
cumulative counts and sends an unsolicited status message with
the same details. On bunch note acceptors, does the same for
each processed bunch of notes.
If the consumer cancels the transaction, ‘CANCEL’ is journaled.
If the transaction times out, ‘CUSTOMER TIMEOUT’ is journaled.
If a transaction is pre‐authorised by executing a Transaction Request
Pre‐authorised Deposit for the host to approve a deposit transaction before the Cash Accept
Limits 2
state is entered, the host can specify deposit limits in the authorising
Transaction Reply message. For details of the format of the
Customer/Transaction Data Element fields bd1 to bd4 in the
Transaction Reply command, see page 10‐52.
Bit 0 of the Auto Finish Flag state table entry controls what happens
when a deposit limit is exceeded, as described in “Auto‐Finish Cash
Accept” on page 2‐107.
The following deposit limits can be specified by the host in the
Transaction Reply for a specific customer/transaction:
Amount of the deposit
The number of notes
Multiple deposit limit parameters can be specified in the
Customer/Transaction Data Elements within a single Transaction
Reply. For example, if the Customer/Transaction Data Element
buffer contains
d0000000000001GBP200.00<gs>001EUR250.00<gs>002050,
a maximum of 200 pounds sterling, 250 euros and 50 notes can be
deposited.
If any limit is exceeded, no further notes can be deposited, a screen
is displayed and the transaction continues according to the next
consumer action.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-106 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
If a limit set in a Transaction Reply is exceeded and the Auto Finish
Flag (table entry 9 of Extension State 4) is set to 0, the
Customer/Transaction Deposit Limit Exceeded screen (table entry 7
of Extension State 4) is displayed.
If the host specifies the limit for a single currency and the notes
deposited are more than the configured amount or configured notes
count, the excess notes are rejected and Please Remove Refused
Notes screen (table entry 8 of extension state 3) is displayed with the
reason for the refusal of notes.
If the host specifies the limit for multiple currencies and the notes
deposited are more than the configured amount or configured notes
count, then all the notes are rejected and Please Remove Refused
Notes screen (table entry 8 of extension state 3) is displayed with the
reason for the refusal of notes.
For information on reasons for the refusal of notes, see “Defining
Reasons for Note Refusal” on page 2‐124
If the Direct Deposit Limit (table entry 6 of Extension State 4) is
exceeded, the Escrow Full screen (table entry 6 of Extension State 1)
is displayed with the Add More option disabled.
Note: A limit on the deposit amount applies only to the currency
specified for that limit. If a limit on the number of notes is specified,
it applies to all currencies available at the SST and represents the
total number of notes that can be deposited during the transaction.
A Good Next State exit is taken automatically from the Cash Accept
Auto‐Finish Cash Accept 2
State without displaying a confirmation screen when all of the
following apply:
The Auto Finish Flag (Bit 0, table entry 9 of Extension State 4,
described on page 2‐118) is set.
A deposit limit has been set using one or both of the following:
— The Customer/Transaction Data Element buffer (described
on page 10‐64) in the Transaction Reply command
— The Direct Deposit Limit (table entry 6 of Extension State 4,
described on page 2‐117) when in Direct Deposit mode.
Recognized notes are escrowed or deposited.
One of the deposit limits is exceeded.
For escrow deposits, the host decides whether to deposit or refund
the notes as the Good Next State exit will be taken automatically
when there are notes in the escrow.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-107
State Tables
> - Cash Accept State
Table 2-58
> - Cash Accept State
Table No. of
Contents Description
Entry Chars
1 1 State type ‘>’ (6EH)
2 3 Cancel Key Mask Specifies the Cancel FDK which is active when the Please Enter
Notes screen or Counterfeit Notes Retained screen is displayed.
See Table Note 48 and Table Note 49
3 3 Deposit Key Mask Specifies the Deposit FDK which is active when the Confirmation
screen, Counterfeit Notes Retained screen, Escrow Full screen and
Explicit Shutter Control Please Enter Notes screen is displayed.
See Table Note 48 and Table Note 53
4 3 Add More Key Mask Specifies the Add More FDK which is active when the Confirmation
screen is displayed. For both types of deposit, when an Add More
FDK is enabled (Add More Key Mask is not 000), the cash acceptor
is not enabled while the Confirmation screen is displayed.
For direct deposit, when no key is enabled (Add More Key Mask is
000) and the CashInAutoEnabled property is set in
CashInCustom.accfg, the cash acceptor is enabled while the
Confirmation screen is displayed.
5 3 Refund Key Mask Specifies the Refund FDK which is active when the Confirmation
screen or Escrow Full screen is displayed.
See Table Note 48 and Table Note 52
For direct deposits, this value is ignored
6 3 Extension State 1 State number for extension 1
Base 10 range 000‐254 or See “Extension 1 to State > (Cash Accept)”
256‐999)
(Base 36 range 000‐254 For more information about extension states, see “Extension States”
or 256‐ZZZ) on page 2‐6.
7 3 Extension State 2 State number for extension 2
Base 10 range 000‐254 or See “Extension 2 to State > (Cash Accept)” on page 2‐112
256‐999)
(Base 36 range 000‐254 For more information about extension states, see “Extension States”
or 256‐ZZZ) on page 2‐6.
8 3 Extension State 3 State number for extension 3
Base 10 range 000‐254 or See “Extension 3 to State > (Cash Accept)” on page 2‐114
256‐999)
(Base 36 range 000‐254 For more information about extension states, see “Extension States”
or 256‐ZZZ) on page 2‐6.
9 3 Extension State 4 State number for extension 4
Base 10 range 000‐254 or See Table 2‐62 “Extension 4 to State > (Cash Accept)” on page 2‐116
256‐999)
(Base 36 range 000‐254 For more information about extension states, see “Extension States”
or 256‐ZZZ) on page 2‐6.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-108 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
Table Note 48: Each bit relates to an FDK; Bit 0 relates to FDK A,
Bit 7 relates to FDK I. If a bit is 1, the corresponding FDK is active. If
a bit is 0, the corresponding FDK is inactive. The same FDK should
be defined only in one key mask that is active at the same time as
other key masks. For example, in the Confirmation screen, the key
masks used for the Deposit, Add More and Refund functions should each
activate a different key.
Table Note 49: If the Cancel key is pressed before notes are entered,
the Cancel Next State Number table entry is taken. If the Cancel key
is pressed in the Enter Notes screen when there are notes in the
escrow, the Confirmation screen is displayed. If the Cancel key is
pressed at the Confirmation screen, the notes are refunded and the
Cancel Next State Number table entry is taken.
Table Note 50: If direct deposit is configured, the Cancel key is not
enabled in the confirmation screen.
Table Note 51: If direct deposit is configured, the Add More key can
be enabled but is not required.
Table Note 52: If direct deposit is configured, the Refund key is not
enabled.
Table Note 53: If the FDK specified in the Deposit Key Mask table
entry is selected from the Confirmation Screen, the Good Next State
Number table entry will be taken.
Table 2-59
Extension 1 to State > (Cash Accept)
Table No of
Contents Description
Entry Chars
1 1 State type ‘Z’
2 3 Please Enter Notes Screen This screen is displayed when the cash acceptor has been
(Range 000‐Z99) successfully enabled (or re‐enabled) to accept a cash deposit
from the consumer. The screen is displayed immediately after
the shutter opens.
For direct deposits, this screen is displayed during the initial
insertion of notes and after the consumer presses the ADD More
FDK or the Confirmation screen times out.
See Table Note 54
3 3 Please Remove Notes This screen is displayed when notes are returned to the
Screen consumer. It is also displayed for rejected notes that are invalid;
(Range 000‐Z99) for rejected notes that are good, but the note count has exceeded
the escrow capacity; and for refunded notes.
See Table Note 55
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-109
State Tables
> - Cash Accept State
Table No of
Contents Description
Entry Chars
4 3 Confirmation Screen This screen is displayed when all the notes have been processed
(Range 000‐Z99) and are valid or identified as suspect or counterfeit notes under
ECB 6.
The screen shows how many notes of each denomination are
valid or are retained under the ECB 6 regulations, with further
options for the consumer.
Depending on the display mode and confirmation screen
configuration, the screen can also display the total amount to be
deposited or the notes still remaining to be deposited.
When suspect or counterfeit notes are detected, this screen is
preceded by the Counterfeit Notes Retained screen.
See Table Note 56 and “Confirmation Screen” on page 2‐120
5 3 Hardware Error Screen This screen is displayed for the time specified by timer 63 (by
(Range 000‐Z99) default, 15 seconds) when a hardware error such as a note jam
occurs, with the result that the transaction cannot continue.
See Table Note 57
6 3 Escrow Full Screen For refundable deposits, this screen is displayed instead of the
(Range 000‐Z99) Confirmation screen when the maximum number of notes that
can be held in the escrow is reached. The screen displays, for
each denomination, the number of notes in the escrow.
For direct deposits, this screen is displayed when the Direct
Deposit Limit (defined in Extension 4, on page 2‐117) is reached
or exceeded.
The screen is also used in refundable or direct deposit
transactions when one of the deposit limits specific to the
customer/transaction has been reached, but not exceeded.
The screen informs the consumer that the escrow is full and the
Add More option is not available.
See Table Note 58
7 3 Processing Notes Screen This screen is displayed while notes are being processed after
(Range 000‐Z99) insertion. This includes transactions where more than 90 notes
are returned because support for more than 90 notes is not
enabled, as described in “Option 45 – BNA Settings” on
page 7‐15.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-110 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
Table No of
Contents Description
Entry Chars
8 3 Please Remove More than This screen is displayed when all the notes are refunded to the
90 Notes Screen (Range consumer because more than 90 have been inserted but support
000‐Z99) for more than 90 notes is not enabled, as described in “Option 45
– BNA Settings” on page 7‐15.
This screen is not used in direct deposit transactions.
See Table Note 59
9 3 Please Wait Screen (Range This screen is displayed as follows:
000 ‐ Z99) Until the cash acceptor is ready to accept notes.
When the Refund key is selected and until the notes are
ready to be taken
While retracting notes
When note insertion is cancelled
When the More Time key is selected during note entry.
If this screen is set to 000, one of the following occurs:
The generic ‘Please Wait’ screen (C20) is displayed if it is
defined
The screen displayed before entry to this state continues to
be displayed if the generic ‘Please Wait ‘screen is not
defined.
Table Note 54: If the cash acceptor is successfully enabled, the
screen defined by the Please Enter Notes screen will be displayed,
and the Cancel Key Mask will be used. When the cash acceptor is
re‐enabled, for example, by pressing the Add More key on the
Confirmation screen, pressing the Cancel key returns control to the
Confirmation screen.
Table Note 55: If the Remove Refused Notes screen is defined (see
table entry 8 in “Extension 3 to State > (Cash Accept)” on
page 2‐114) and notes are automatically rejected or the consumer
requests a refund when all the notes are in the escrow, the Please
Remove Notes screen will be displayed when the notes are at the
refund slot.
Table Note 56: The format of the dynamic data for the
Confirmation and Escrow Full screens is defined in the
CashInCustom.accfg configuration file. The dynamic data can be
adjusted for the transaction language as multi‐lingual support is
provided. These default screens contain displays of the
denominations in the escrow counts or, if direct deposit is
configured, the vaulted counts. If direct deposit is configured and
depending on the configuration described in the Add More Key
Mask field of the “> ‐ Cash Accept State” on page 2‐108, the cash
acceptor is enabled while the screen is displayed. For more
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-111
State Tables
> - Cash Accept State
information about the configuration of dynamic data, refer to
Chapter 5, “Configuring Advance NDC and Associated
Components” of the APTRA Advance NDC Developer’s Guide.
Table Note 57: If a device error such as a note jam occurs, the
following is performed:
1 The screen defined by the Hardware Error Screen table entry is
displayed.
2 An unsolicited status message is sent to Central containing the
error information.
3 Timer 63 expires.
4 The Device Error Next State Number (Extension State 2, table
entry 4) is taken.
Table Note 58: If the maximum number of notes that can be held in
the escrow is reached, the Escrow Full screen is displayed, and the
Add More FDK is not enabled. If direct deposit is configured, notes
cannot be refunded so not all keys in the screen will be enabled.
Table Note 59: If direct deposit is configured, this screen is not
used.
Table 2-60
Extension 2 to State > (Cash Accept)
Table No of
Contents Description
Entry Chars
1 1 State type ‘Z’
2 3 Good Next State Number State number the SST goes to when the Deposit key is selected.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Cancel Next State Number State number the SST goes to if the consumer presses the Cancel
(Base 10 range 000‐254 or key to stop the deposit or selects Refund on the Confirmation
256‐999) screen and takes the notes or the notes are retracted.
(Base 36 range 000‐254 or See Table Note 60 and Table Note 61
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-112 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
Table No of
Contents Description
Entry Chars
4 3 Device Error Next State State number the SST goes to if an error occurs that may require
Number subsequent action by Central.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Timeout Next State State number the SST goes to if the consumer fails to enter notes
Number into the BNA before timer 77 expires, or fails to respond to the
(Base 10 range 000‐254 or prompts on the Timeout screen.
256‐999) See Table Note 62
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 Notes at Refund Slot Next State number the SST goes to if the notes remain at the refund
State Number slot after timer 78 expires. Applicable only if the retract option is
(Base 10 range 000‐254 or not configured.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
7 3 Reserved (000) Reserved for future use.
8 3 Media Type Not supported
Must be 000
9 3 Retracting Notes Screen This screen is displayed when retract operations are enabled by
(Range 000 ‐ Z99) Option 45 and notes presented for removal are being retracted.
If this is set to 000, the generic ‘Please Wait’ screen (C20) screen
is displayed if it is defined
Table Note 60: If refundable deposit is configured, and the Cancel
key or the Refund key is pressed after the notes have been entered
and no suspect or counterfeit notes are detected, the notes are
returned to the consumer and this next state is taken. In addition, if
suspect or counterfeit notes are detected, they are processed
according to the level of ECB 6 regulation enabled through the
GBXX configuration file. For details, refer to Chapter 5,
“Configuring Advance NDC and Support Applications” in the
APTRA Advance NDC, Developer’s Guide. If direct deposit is
configured, the Cancel Next State Number exit can only be taken
before valid notes are inserted.
Table Note 61: If the Cancel key is pressed after selecting the Add
More FDK, the ‘Please Wait’ screen may be displayed before the
screen defined by the Confirmation screen (table entry 4 in
“Extension 1 to State > (Cash Accept)”) is redisplayed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-113
State Tables
> - Cash Accept State
Table Note 62: If notes are in the escrow when a timeout occurs,
the Timeout Next State exit is taken. When the Close state is
reached, the BNA Notes Return/Retain/Leave Flag in the Extension
to the Close state defines whether notes are left in the escrow,
refunded, or vaulted. The host is therefore in control of what
happens, either directly through a transaction request state, or
indirectly by specifying a Close state. In direct deposits, some notes
may have been already deposited when this exit is taken.
Table 2-61
Extension 3 to State > (Cash Accept)
Table No of
Contents Description
Entry Chars
1 1 State type ‘Z’
2 3 Set NDC note type The three ASCII characters represent 4‐bit nibble hexadecimal
1 ‐ 12 values. Each character represents a bitmap starting from the
rightmost character. The individual bits set the NDC note types
to active or inactive. For example, sending Hex values ʹ10Eʹ sets
note types 2, 3, 4 and 9 to active. The others in the range are
inactive. The active NDC note types will be accepted by the
BNA.
See Table Note 63 and Table Note 64
Hex values ʹ10Eʹ are broken down to binary as follows:
1 0 E
0001 0000 1110
Taking index 1 as the right most digit and index 12 as the left
most digit, the active notes set will be notes indexed 2, 3, 4 and
9.
See Table Note 65
3 3 Set NDC note type The three ASCII characters represent three bitmaps, starting
13 ‐ 24 from the rightmost character. The individual bits set the NDC
note types to active or inactive. The bits map to NDC note types
13 to 24.
See Table Note 64
4 3 Set NDC note type The three ASCII characters represent three bitmaps, starting
25 ‐ 36 from the rightmost character. The individual bits set the NDC
note types to active or inactive. The bits map to NDC note types
25 to 36.
See Table Note 64
5 3 Set NDC note type The three ASCII characters represent three bitmaps, starting
37 ‐ 48 from the rightmost character. The individual bits set the NDC
note types to active or inactive. The bits map to NDC note types
37 to 48.
See Table Note 64
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-114 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
Table No of
Contents Description
Entry Chars
6 3 Set NDC note type The three ASCII characters represent three bitmaps, starting
49 ‐ 50 from the rightmost character. The individual bits set the NDC
note types to active or inactive. Bits 48 and 49 map to NDC note
types 49 and 50 respectively.
See Table Note 64
7 3 Enabled List of Note Type Not supported
Identifiers Selector Must be 000
8 3 Remove Refused Notes This screen is displayed when notes are refused by the device
Screen and returned to the consumer.
(Range 000 ‐ Z99) If this is set to 000, the screen identified in the Please Remove
Notes Screen is displayed.
If the reason for the refusal is to be displayed, the reasons must
be defined in a display dynamic text dictionary control
sequence within this screen definition. The reasons for note
refusal must be included as described in “Defining Reasons for
Note Refusal” on page 2‐124
See Table Note 66
9 3 Counterfeit Notes Retained This screen is displayed to provide extra information to the
Screen consumer about how to proceed when counterfeit or suspect
(Range 000 ‐ Z99) notes are retained under ECB 6 regulations. The screen can be
customised.to contain information such as ‘NOTES RETAINED
FOR VERIFICATION. PLEASE CONTACT YOUR BRANCH’.
The screen also shows the actual number of notes retained
under ECB 6 regulations, and prompts the consumer to continue
to the confirmation screen, or cancel the transaction. The
Deposit Key Mask is used for the Continue FDK and the Cancel
Key Mask for the Cancel FDK. If the consumer does not respond
to the prompt before timer 00 expires, the Confirmation screen
is displayed.
The count is displayed at the current screen cursor position.
If direct deposits are accepted by the SST, no notes can be
returned to the consumer after insertion. NCR therefore
recommends that the value is set to 000 to prevent the screen
from being displayed. In this case, the number of retained notes
is displayed on the Confirmation screen (described on
page 2‐120).
See Table Note 67 and Table Note 68
Table Note 63: If the enable is successful, the subset of active NDC
note types held by the application will be re‐defined by the Set NDC
Note Types table entry.
Table Note 64: If Extension 3 to state > is set to all zeros, it is
ignored and the previous download is retained.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-115
State Tables
> - Cash Accept State
Table Note 65: There is a dependency on which notes are reported
through the SST Command, ‘Send Configuration ‐ Note Definitions’
as to what actual index will be reported as active (for details, see
“Report Cash Deposit Definition” in Chapter 9, “Terminal to
Central Messages”).
Table Note 66: For details of defining a dynamic text dictionary
control sequence, see “Display Dynamic Text Dictionary Control
Sequence” on page 3‐39. The reasons are displayed from the final
cursor position after the base screen is displayed. If the dynamic text
dictionary control sequence is not defined, no reason is displayed.
Table Note 67: The number of notes retained under ECB 6
regulations includes the notes identified as counterfeit. If the
retention of suspect notes is also configured, the number of notes
identified as suspect is added to the counterfeit count.
Table Note 68: If ECB 6 support is enabled, Enhanced
Configuration option 45 must be set to accept more than 90 notes. If
option 45 is not set and more than 90 notes are inserted, notes are
returned to the consumer unless they are to be retained under the
ECB 6 regulations. The Counterfeit Notes Retained screen must be
defined to inform consumers of any retained notes. For details of
setting option 45, see “Option 45 – BNA Settings” on page 7‐15.
Table 2-62
Extension 4 to State > (Cash Accept)
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’
2 3 ECB 6 category 2/3 Cancel Not supported
Next State number Always 000
3 3 ECB 6 category 2/3 Device Not supported
Error Next State number Always 000
4 3 ECB 6 category 2/3 Timeout Not supported
Next State number Always 000
5 3 Direct Deposit Control Determines whether notes are placed in the escrow or deposited
(Range 000 ‐ 001) directly into the cassettes.
Valid values are as follows:
000 — Place inserted notes in the escrow (refundable
deposit)
001 — Deposit inserted notes directly into the cassettes
(direct deposit).
See Table Note 70 and Table Note 69
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-116 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
Table No. of
Contents Description
Entry Chars
6 3 Direct Deposit Limit (Range Defines the number of notes to be inserted during a direct
000 ‐ 999) deposit.
Once this limit is reached, the Escrow Full screen is displayed
and no further notes will be accepted, but notes inserted before
the limit is reached will be processed.
When the value is 000, the default maximum number of notes
for the hardware is applied. For information on defining the
default maximum number of notes, refer to Chapter 5,
“Configuring Advance NDC and Associated Components in the
APTRA Advance NDC, Developer’s Guide.
If the Auto Finish Flag (table entry 9 on the next page) is set and
the Direct Deposit Limit is exceeded, the Cash Accept state is
completed automatically and the state flow goes to the Good
Next State Number.
If the Auto Finish Flag is not set, the state does not exit
automatically when the Direct Deposit Limit is exceeded. The
Escrow Full screen (Extension State 1, table entry 6) is displayed
and the Add More key is disabled.
See Table Note 71
7 3 Customer/Transaction This screen is displayed instead of the Confirmation screen
Deposit Limit Exceeded when the following conditions are true:
Screen (000 ‐ Z99) One of the Customer/Transaction Deposit limits is exceeded
The Auto Finish Flag is not set.
The screen typically includes the number of notes entered for
each denomination.
In Escrow mode, the Add More and Deposit options are not
available as the limit is exceeded. The corresponding FDKs are
disabled. The screen could prompt the consumer to select
Refund to return all the refundable (still in the escrow) notes to
complete the transaction.
In Direct Deposit mode, the Add More option is not available as
the limit is exceeded. The Add More FDK is disabled. The Deposit
option is available to allow the consumer to complete the
transaction as the notes entered are already deposited.
8 3 Extension State 5 State number for extension 5
(Base 10 range 000‐254 or See “Extension 5 to State > (Cash Accept)”
256‐999) For more information about extension states, see “Extension
(Base 36 range 000‐254 or States” on page 2‐6.
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-117
State Tables
> - Cash Accept State
Table No. of
Contents Description
Entry Chars
9 3 Auto Finish Flag A decimal value containing a bit‐mapped set of flags.
(000 ‐ 001) Only bit 0 is used. Bits 1 to 7 are reserved and must be zero.
Bit 0 controls whether the Cash Accept state is completed
automatically on exceeding a deposit limit.
This option is ignored if no deposit limits are set (see the
Customer/Transaction Data Element buffer in the Transaction
Reply and Direct Deposit Limit ‐ table entry 6 above).
If this bit is not set, the state does not exit automatically when a
deposit limit is exceeded.
If this bit is set, the state goes to the Good Next State number
when a deposit limit is exceeded. An information screen is
displayed as follows:
If one of the Customer/Transaction deposit limits is exceeded,
the Customer/Transaction Deposit Limit Exceeded Screen
(table entry 7 above) is displayed.
If the Direct Deposit Limit is exceeded, the Escrow Full screen
(extension state 1, table entry 6) is displayed.
If a Customer/Transaction Deposit Limit and Direct Deposit
Limit are exceeded at the same time, the
Customer/Transaction Deposit Limit Exceeded Screen is
displayed.
In Escrow mode, the Deposit and Add More keys are disabled and
consumer has to press either the Refund or the Cancel key to
complete the deposit. In Direct Deposit mode, the Add More key
is disabled.
If a deposit limit specific to the Customer/Transaction (deposit
amount limit or deposit note number limit) and the Direct
Deposit Limit are both defined, then exceeding either of these
limits causes the deposit limit to be exceeded.
Table Note 69: If this extension is not included in the state table
download or if it is truncated before table entry 5, deposits will use
the escrow.
Table Note 70: If the device does not support the configured
Deposit Control, the Device Error Next State Number is taken as
described in table entry 4 of “Extension 2 to State > (Cash Accept)”
on page 2‐112.
Table Note 71: The host specifies the deposit limit for specific
customers using transaction reply. If both the direct deposit limit
and the transaction reply limits are defined, then the limit specified
by the transaction reply takes precedence.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-118 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
Table 2-63
Extension 5 to State > (Cash Accept)
Table No of
Contents Description
Entry Chars
1 1 State type ‘Z’ ‐ Extension State
2 3 Explicit Shutter Control This screen is displayed immediately after the shutter opens
Please Enter Notes Screen when the cash acceptor device with explicit shutter control is
(Range 000‐Z99) enabled. This screen is displayed to provide information on how
to enter notes and continue a deposit transaction.
This screen is displayed when the following conditions are met:
Cash Acceptor device has explicit shutter control.
Deposit Key mask (table entry 3 of cash accept state) has a
value other than 0 and does not match with the Cancel Key
Mask (state table entry 2 of cash accept state)
Cash Acceptor has been successfully enabled (or re‐enabled)
to accept a cash deposit from the consumer.
If the screen number is other than 000 and the cash acceptor
device does not has explicit shutter control capability, the
following occurs:
The Please Enter Notes screen defined in the Extension 1
(state table entry 2) is displayed.
The application proceeds with implicit shutter control.
If the screen number is set to 000 and the cash acceptor device
has explicit shutter control, the following occurs:
The Please Enter Notes screen defined in the Extension 1
(state table entry 2) is displayed.
The application proceeds with implicit shutter control.
3 3 Enable limits 000 ‐ No deposit limit will be applied.
(Range 000‐003) 001 ‐ Enable deposit limit on the number of items. They are
configured by (Extension State5, table entry 4)
002 ‐ Enable deposit limit on amount. Amount is configured by
(Extension State 5, table entries 6 and 7).
003 ‐ Enable deposit limits on number of items and amount. The
limit exceeded first is applied.(Extension State 5, table entries 4,
6 and 7).
4 3 Number of items When the extension state 5, table entry 3 is set to 001 or 003, the
(Range 000‐999) entry specifies the limit on the number of items that can be
deposited.
See Table Note 72, Table Note 73 and Table Note 74
5 3 Currency Code (ISO ‐4217 Specifies the currency type that has to be limited when the
Numeric Code) extension state table 5, table entry 3 is set to 002 or 003. For
example,
GBP(826), EUR(978), USD(840), OST etc.
See Table Note 72, Table Note 73 and Table Note 74
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-119
State Tables
> - Cash Accept State
Table No of
Contents Description
Entry Chars
6 3 Amount When the extension state 5 table entry 2 is set to 002 or 003, the
total amount limit can be calculated as
Amount(5‐6)*10^Amount Exponent (5‐7).
7 3 Amount Exponent Amount Exponent (000‐999)
(000‐999)
8 3 Reserved (000) Reserved
9 3 Reserved (000) Reserved
Table Note 72: If the amount deposited is more than the configured
amount or the number of notes, the excess notes are rejected and the
Remove Refused Notes screen (extension state 3 of Cash Deposit,
table entry 8) is displayed with the appropriate reason for the
refusal of notes.
Table Note 73: If a direct deposit limit and state based limit
(amount or number of items) are set in a deposit transaction, the
limit that is exceeded first is considered.
Table Note 74: If a state based limit and transaction reply limit
(amount or number of items) are set in a deposit transaction, the
transaction reply limit takes precedence.
The Confirmation screen (defined in table entry 4 in “Extension 1 to
Confirmation Screen 2
State > (Cash Accept)”) is a dynamic screen constructed using the
details of the deposit transaction and overlaid on the screen defined
in the Cash Accept state. If ECB 6 mode 1 is used, any notes retained
as counterfeit or suspect are included in the retained note counts.
The screen also displays the denominations of the deposited notes.
The dynamic Confirmation screen content can be modified using
the .NET Class Configurator file, as described in Chapter 5,
“Configuring Advance NDC and Associated Components” of the
APTRA Advance NDC, Developer’s Guide.
When all the inserted notes are valid, the screen defined by the
Confirmation Screen table entry (table entry 4 in “Extension 1 to
State > (Cash Accept)”) is displayed, and the Add
More/Deposit/Refund Key Mask table entries (described in
Table 2‐58, “> ‐ Cash Accept State” on page 2‐108) are used to
define the active FDKs.
Note: If direct deposit is configured, the Refund key is not enabled
even if it is configured and the cash acceptor will be enabled while
the Confirmation screen defined in table entry 4 in “Extension 1 to
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-120 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
State > (Cash Accept)” is displayed only if the value of Add More
Key Mask is 000 and the CashInAutoEnabled property is true.
Refundable Deposits 2
If the consumer selects the Add More FDK (table entry 4 in “> ‐ Cash
Accept State”) from the Confirmation screen, the screen defined by
the Please Enter Notes Screen table entry (table entry 2 in
“Extension 1 to State > (Cash Accept)”) is displayed, and the Cancel
Key Mask table entry (table entry 2 in “> ‐ Cash Accept State”) is
used.
Direct Deposits 2
If the cash acceptor has been auto‐enabled and timer 00 expires
while the cash acceptor is enabled, and timer 77 is greater than timer
00, the Please Enter Notes Screen table entry is used to define the
screen to display.
If no deposit is made at the Confirmation screen before timer 77
expires and timer 00 is greater than timer 77, the cash acceptor is
disabled and the Time‐Out state is taken. If a deposit is made before
timer 77 expires, the Processing Notes Screen (table entry 7 in
“Extension 1 to State > (Cash Accept)”) is displayed until the notes
have been processed.
To repeat a direct deposit transaction, the SST has to send either a
transaction request or enter into a Close state.
Explicit Shutter Control 2
Cash acceptor devices such as BRM which has explicit shutter
control capability allow the user to close the shutter by pressing an
FDK after inserting the notes. This feature can be enabled by
defining the Explicit Shutter Control Please Enter Notes screen in
the table entry 2 of Extension State 5.
When the device is ready to accept notes, the shutter opens and the
Explicit Shutter Control Please Enter Notes screen will be displayed
with Cancel and Deposit FDKs enabled. The Deposit FDK will initiate
the deposit transaction and Cancel FDK will cancel the deposit
transaction. The application waits for the consumer to press any of
the enabled FDKs to close the shutter to continue the transaction.
Based on the FDKs selected, the Cash Accept state performs the
following actions:
If the consumer presses the Deposit key, after inserting the notes,
the shutter closes and Processing Notes screen will be displayed.
The transaction flow goes to the Confirmation screen.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-121
State Tables
> - Cash Accept State
If the consumer presses the Cancel key, after inserting the notes,
the shutter closes and Processing Notes screen will be displayed.
The transaction flow goes to the Confirmation screen. If the
consumer does not wish to proceed with the transaction, Press
the Cancel key to cancel the transaction and to take the notes.
If the consumer presses the Cancel key, without inserting the
notes, the transaction flow goes to the Cancel Next State.
If the consumer does not select any key, after inserting the notes,
the shutter closes after the time‐out period (timer 77 expires)
without displaying the More Time screen. The Processing Notes
screen is displayed.The transaction flow goes to the
Confirmation screen.
If the consumer does not select any key until time‐out without
inserting any notes, the shutter closes after the time‐out period
(timer 77 expires) and the transaction flow goes to the Time‐Out
Next State.
If the consumer does not select any key until timeout without
inserting any notes, after the time‐out period ((timer 77 expires).
the More Time screen is displayed with Yes and No keys enabled.
If the consumer presses the Yes key, the Explicit Shutter
Control Please Enter Notes screen is displayed to deposit
notes.
If the consumer presses the No/Cancel key, the transaction
flow goes to the Cancel Next State
In the Confirmation screen, if the consumer presses the Add More key,
the shutter opens to accept more notes. The Explicit Shutter Control
Please Enter Notes screen will be displayed with Cancel and Deposit
FDKs enabled.
Based on the FDKs selected, the following actions are performed:
If the consumer presses the Deposit key, after inserting the notes,
the shutter closes and Processing Notes screen will be displayed.
The transaction flow goes to the Confirmation screen, which
displays the total number of notes inserted.
If the consumer presses the Cancel key, after inserting the notes,
the shutter closes and Processing Notes screen will be displayed.
The transaction flow goes to the Confirmation screen, which
displays the total number of notes inserted.
If the consumer presses the Cancel key, without inserting any
notes, the shutter closes and the application displays the
Confirmation screen, which displays the information of the
previously inserted notes.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-122 APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
If the consumer does not select any key after inserting the notes
and time‐out period occurs (timer 77 expires), the shutter closes
and the Processing Notes screen is displayed. The transaction
flow proceeds to the Confirmation screen, which displays the
total number of notes inserted.
If the consumer neither selects any key until time‐out period nor
inserts any notes, after the time‐out period (timer 77 expires),
the shutter closes and the transaction flow goes to the Time‐Out
Next State.
If the consumer does not select any key until time‐out period
without inserting any notes, after the time‐out period (timer 77
expires), the More Time screen is displayed with Yes and No keys
enabled.
If the consumer presses the Yes key, the Explicit Shutter
Control Please Enter Notes screen is displayed to deposit
notes.
If the consumer presses the No/Cancel key, the transaction
flow goes to the Confirmation screen, which again displays
the information of the previously inserted notes.
Direct Deposit Error Screen 2
For direct deposit transactions where an error occurs after some
notes have already been deposited, the following can be configured
to inform the consumer that an error has occurred:
The option to display the Escrow Full screen (by default,
Advance NDC exits showing only a hardware error screen)
An optional error message can be displayed on the Escrow Full
screen.
Note: The Escrow Full screen, showing the counts of the notes
already deposited, is used because the Add More FDK and its text
label are disabled in this situation.
When the Deposit FDK is pressed, the Device Error exit is taken. If the
Deposit FDK is not pressed in time, the Time‐out State becomes
active. If more time is requested or declined or the Cancel key is
pressed, the application flow returns to the Escrow Full screen.
If the Time‐Out state times out, the Device Error exit is taken. This
can result in an unsolicited device error message (w3) followed by
an unsolicited time‐out or cancel message (w1) being sent to the
host.
Note: The error screen will be displayed only if Advance NDC is
configured to do so. For details, refer to section “Configuring Cash
Acceptors” in chapter 5 “Configuring Advance NDC and
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-123
State Tables
> - Cash Accept State
Associated Components” of the APTRA Advance NDC Developer’s
Guide.
The following dynamic text definitions can be used in the Cash
Dynamic Text Definitions 2
Accept state:
Reasons for refusal of notes
The number of counterfeit or suspect notes.
Defining Reasons for Note Refusal 2
Notes can be refused by the SST for various reasons. In some cases,
specific information or guidance needs to be provided to the
consumer. To provide this information, messages can be defined
that correspond to specific values. These values and definitions are
included in a dynamic text dictionary control sequence with a
Dictionary ID of 000. For details of this control sequence, see
“Display Dynamic Text Dictionary Control Sequence” on page 3‐39.
Table 2‐64 lists the enumerated values and their definitions. The
display text must reflect these definitions and match the available
space and language of the screen.
Table 2-64 Enumerated Value Definition
Rejected Notes Dynamic Text
001 The cash unit is full
002 The items have been recognised, but one or more of
the notes are invalid
003 No notes are in the input area
004 A deposit failed for a reason not covered by the other
reasons and the failure is not a fatal hardware problem
005 Failure of a common input component that is shared
by all cash units
006 The intermediate stacker is full
007 Foreign items have been detected in the input position
Note: To use value 007, the service provider must
support the XFS 3.10 standard
012 The number of items has exceeded the item limit
013 The value of items inserted has exceeded the amount
limit.
999 Default text to display when specific text is not
provided
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-124 APTRA™ Advance NDC, Reference Manual
State Tables
w - Cheque Accept State
w ‐ Cheque Accept State 2
If a cheque processor is present, this state can be used to allow
cheques to be entered into the cheque processor.
Under state table control, the Cheque Accept state:
Accepts cheques
Returns physically unacceptable cheques
Returns incorrectly orientated cheques
Lifts full front and/or rear images
Reads the codeline, for Central authorisation
Captures ejected cheques that are not taken
Reports unsolicited events.
Table 2-65
w - Cheque Accept State
Table No. of
Contents Description
Entry Chars
1 1 State type ‘w’ (77H)
2 3 Reserved (000) Reserved for future use
3 3 Leave/Capture Option This entry defines the action to take if a physically unacceptable or
jammed cheque is presented for return, but not taken:
000 ‐ Leave at throat
001 ‐ Capture unacceptable cheque to bin 1
If the returned cheque is unacceptable because it is too short and the
table entry is set to capture the returned cheque, a jam may occur in
the rear transport.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-125
State Tables
w - Cheque Accept State
Table No. of
Contents Description
Entry Chars
4 3 Cheque Entry Retries Specifies the number of cheque entry retries the consumer is
allowed during the execution of the state. Retries may be allowed if
a physically unacceptable or incorrectly orientated cheque is
detected:
000 ‐ Do not allow consumer retries
n01 ‐ Allow one further retry following initial rejection
n02 ‐ Allow two further retries
n03 ‐ Allow three further retries
The variable n can have one of the following values:
0 ‐ After all the permissible retries have failed, the cheque processor
accepts a physically acceptable cheque and continues to process it,
even if the codeline cannot be read.
1 ‐ After all the permissible retries have failed, the state goes to the
state defined by the Cancel/Time Out next state exit.
See Table Note 82.
5 3 Image Lift Specifies whether a front and/or rear image is to be lifted, if
(000 ‐ 003) hardware capabilities allow.
000 ‐ No cheque images are lifted
001 ‐ An image of the front of the cheque is lifted
002 ‐ An image of the back of the cheque is lifted
003 ‐ An image of the front and back of the cheque is lifted
By default the front image of the cheque is displayed. Screen C07
can be modified to display the rear image.
Lifted front and rear images are deleted from the system during the
Close state.
See Table Note 75.
6 3 Extension State 1 State number for extension state 1.
(Range 000‐999 or See “Extension 1 to State w” on page 2‐128.
000‐ZZZ)
If a value of 255 is used for this entry, this indicates there is no
extension state 1.
For more information about extension states, see “Extension States”
on page 2‐6.
7 3 Extension State 2 State number for extension state 2.
(Base 10 range 000‐254 See “Extension 2 to State w” on page 2‐130.
or 256‐999)
(Base 36 range 000‐254 If a value of 255 is used for this entry, this indicates there is no
or 256‐ZZZ) extension state 2.
For more information about extension states, see “Extension States”
on page 2‐6.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-126 APTRA™ Advance NDC, Reference Manual
State Tables
w - Cheque Accept State
Table No. of
Contents Description
Entry Chars
8 3 Cancel Key Mask Specifies the Cancel FDK which is active when the Please Insert
Cheque and Further Processing screens are displayed.
Each bit relates to an FDK, as follows:
Bit 0 ‐ FDK A
Bit 1 ‐ FDK B
Bit 2 ‐ FDK C
Bit 3 ‐ FDK D
Bit 4 ‐ FDK F
Bit 5 ‐ FDK G
Bit 6 ‐ FDK H
Bit 7 ‐ FDK I
If a bit is set to 1, the relevant Cancel FDK is active. If a bit is set to 0,
the relevant FDK is inactive.
9 3 Deposit Key Mask Specifies the Deposit FDK which is active when the Further
Processing screen is displayed.
Each bit relates to an FDK, as follows:
Bit 0 ‐ FDK A
Bit 1 ‐ FDK B
Bit 2 ‐ FDK C
Bit 3 ‐ FDK D
Bit 4 ‐ FDK F
Bit 5 ‐ FDK G
Bit 6 ‐ FDK H
Bit 7 ‐ FDK I
If a bit is set to 1, the relevant Deposit FDK is active. If a bit is set to
0, the relevant FDK is inactive.
See Table Note 76.
Table Note 75: If the lifting of images is requested by the Image Lift
entry in the state table, then these images are lifted.
The image is stored in C:\Program Files\NCR APTRA\Advance
NDC\Data. This can be changed using the registry, as described in
the APTRA Advance NDC, Developer’s Guide.
If the image is to be displayed in an Information Entry state, the
image can be displayed in an associated screen using a standard
display escape sequence, or by referencing screen C07 to display the
image as part of the Further Processing Screen.
Table Note 76: If the Deposit Key Mask is set to 000, the further
processing screen is skipped and the Good Deposit next state is
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-127
State Tables
w - Cheque Accept State
taken. This means that the consumer can enter the cheque and then
immediately enter the amount while the cheque image is displayed
on screen.
Note: The Cheque Accept state does not display the cheque. The
Amount Entry state must ensure the cheque is displayed.
Table 2-66
Extension 1 to State w
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Please Insert Cheque This screen is displayed when the cheque processor has been
Screen successfully enabled (or re‐enabled) to accept a customer’s cheque.
(Range 000‐Z99)
See Table Note 77
3 3 Processing Cheque This screen is displayed when the cheque has been successfully
Screen entered into the cheque processor.
(Range 000‐Z99)
4 3 Unacceptable Cheque This screen is displayed when a cheque cannot be accepted by the
Screen cheque processor.
(Range 000‐Z99)
See Table Note 78
5 3 Incorrect Orientation This screen is displayed when an incorrectly orientated cheque has
Screen been entered and retries still remain.
(Range 000‐Z99)
6 3 Further Processing This screen is displayed after the Processing Cheque screen, and
Screen may be used to display the lifted images.
(Range 000‐Z99)
7 3 Cheque Captured This screen is displayed when a cheque has been captured.
Screen Typically a cheque is captured if it is returned to the consumer but
(Range 000‐Z99) not taken.
This screen is displayed for the period defined by timer 87.
See Table Note 79
8 3 Device Error Screen This screen is displayed when a hardware error such as a cheque
(Range 000‐Z99) jam condition occurs, preventing the transaction from being
continued.
This screen is displayed for a fixed time of 15 seconds.
9 3 Please Remove Cheque This screen is displayed when the cheque is returned, and is waiting
Screen to be taken by the consumer.
(Range 000‐Z99)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-128 APTRA™ Advance NDC, Reference Manual
State Tables
w - Cheque Accept State
Table Note 77: If the cheque processor is empty, the cheque
processor is enabled to accept a cheque. If the cheque processor is
not empty the Cheque Already Present next state exit is taken. If the
cheque processor is successfully enabled, the screen defined by the
Please Insert Cheque Screen table entry is displayed. If option digit
2c is not set, the beeper is sounded. The cheque processor is enabled
for the time specified by timer 04, or until the Cancel key is pressed. If
timer 04 is set to greater than one minute, the cheque processor
firmware will time out, and be treated in the same way as a timer 04
expiry.
The beeper is disabled when a cheque is detected, if the Cancel key is
pressed, or if the timer expires.
If the timer expires or the Cancel key is pressed, an unsolicited
timeout/cancel status message is sent to Central, and the state exits
to the state defined by the Cancel/Time Out next state exit.
If the consumer inserts a physically acceptable cheque, the screen
defined by the Processing Cheque Screen Entry in the state table is
displayed.
Table Note 78: If the consumer inserts a cheque of a size or nature
that makes it unable to be processed (physically unacceptable) or if
the cheque becomes jammed on entry, it is returned to the
consumer, and the screen defined by the Unacceptable Cheque
Screen entry is displayed. The beeper is sounded if the ejection was
performed.
The consumer is presented with the cheque for the time defined by
timer 94. The beeper is stopped when the consumer takes the
cheque, or when the cheque is retracted following a failure by the
consumer to retrieve the cheque.
If the consumer fails to retrieve the cheque, the following actions are
taken:
An unsolicited timeout status message is sent to Central.
An attempt is made to move the cheque to the reject/retain bin if
the Leave/Capture Option in the Cheque Accept state is set to
capture.
The state exits to the Cheque Captured next state exit or the
Cancel/Timeout next state exit, depending on the Leave/Capture
option. If the cheque is successfully moved to the bin, a security
trace message (U0058) is journaled at this point to indicate that the
clearing action has taken place.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-129
State Tables
w - Cheque Accept State
If the consumer retrieves the cheque, the cheque processor is
re‐enabled if there are retries left, as defined by the Cheque Entry
Retries entry in the state table.
If the consumer retrieves the cheque but there are no retries left, the
cheque processor is not re‐enabled, and the state exits to the state
defined by the Cancel/Time Out next state exit.
Table Note 79: When a cheque is captured, it is endorsed with the
locally customisable data using reserved screen U0057. For details
of the locally customisable, refer to Chapter 5, “Configuring
Advance NDC and Associated Components”, the APTRA Advance
NDC, Developer’s Guide.
Table 2‐67
Extension 2 to State w
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Cheque Already Present This exit is taken if a cheque is detected as already present in the
Next State Exit cheque processor. The recommended next state is the Close state, to
(Base 10 range 000‐254 or perform error recovery.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 No Exception Next State This exit is taken if the cheque is accepted and processed without
Exit error, although the codeline may not have been read. The
(Base 10 range 000‐254 or recommended next state is an Information Entry state, which
256‐999) prompts the consumer to enter the amount on the cheque, and
(Base 36 range 000‐254 or optionally displays the image lifted from the cheque.
256‐ZZZ)
See Table Note 78
4 3 Exception Next State Exit This exit is taken when an exception has occurred (that is, a device
(Base 10 range 000‐254 or failure occurs in the cheque processor). The recommended next
256‐999) state is the Close state, to perform error recovery.
(Base 36 range 000‐254 or
256‐ZZZ) See Table Note 80
5 3 Customer Cancel/ This exit is taken when the consumer fails to insert a physically
Timeout Next State Exit acceptable cheque within the required time or number of retries.
(Base 10 range 000‐254 or The recommended next state is the 4 or 8 FDK Selection Function
256‐999) state from which the Cheque Deposit transaction was selected.
(Base 36 range 000‐254 or
256‐ZZZ) See Table Note 81.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-130 APTRA™ Advance NDC, Reference Manual
State Tables
w - Cheque Accept State
Table No. of
Contents Description
Entry Chars
6 3 Cheque Captured Exit This exit is taken when the consumer fails to take a returned
(Base 10 range 000‐254 or cheque, which is then cleared to the cheque processor reject bin.
256‐999)
(Base 36 range 000‐254 or See Table Note 82
256‐ZZZ)
7 3 Reserved (000) Reserved for future use.
8 3 Reserved (000) Reserved for future use.
9 3 Reserved (000) Reserved for future use.
Table Note 80: If a jam occurs during cheque processing, an
unsolicited message with error code ‘5’ is sent. If an error occurs
during cheque processing, an unsolicited message with error code
‘4’ is sent. In either situation, the state takes the Exception next state
exit. For details of the message see “Cheque Processor
(Solicited/Unsolicited)” on page 9‐131.
Table Note 81: When a timeout occurs when the cheque processor
is enabled (timer 94 or hardware internal timer) or during the
Further Processing screen (timer 0), Advance NDC activates the
Time‐Out state to display the ‘Do you need more time’ screen. The
Customer Cancel/Timeout next state exit is taken if the customer
selects No or Cancel, or fails to respond before timer 01 expires.
Table Note 82: On entry to the cheque processor, the front of the
cheque is scanned, and an attempt is made to read the codeline. If a
minimum of four, or more, valid characters is read successfully
from the codeline, the cheque is deemed to be correctly orientated.
This minimum number can be changed using the Active Script Host
worker.
An incorrectly orientated cheque is returned to the consumer if
there are retries left, and the screen defined by the Incorrect
Orientation Screen entry is displayed. If there are no retries left, the
cheque is accepted, and either the No Exception next state exit is
taken to allow Central to determine the acceptability of the cheque
or the state defined by the Cancel/Time Out next state exit.
If the consumer fails to retrieve the invalid cheque, it is cleared to
the Reject/Retained Bin. If this action takes place, an unsolicited
timeout status message is sent to Central, and the state exits to the
Cheque Captured next state exit. A security trace message (U0058)
is journaled to indicate that the clearing action has taken place.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-131
State Tables
z – Master Expansion State
z – Master Expansion State 2
Within the state table, the state type is identified by a single
character field. The Master Expansion state extends the number of
new state types that can be defined.
From Advance NDC 3.04, all new state types have ‘z’ as the state
type, with the first parameter identifying the state subtype.
Note: The Master Expansion status is identified with a lower case
‘z’, whereas extensions to states and state subtypes are identified
with an upper case ‘Z’.
Table 2-68
z - Master Expansion State
Table No. of
Contents Description
Entry Chars
1 1 ‘z’ (7AH) State Type
2 3 State subtype Identifies the state subtype
(Range 000‐999)
3 3 Defined by state subtype As defined in the state subtype state table
4 3 Defined by state subtype As defined in the state subtype state table
5 3 Defined by state subtype As defined in the state subtype state table
6 3 Defined by state subtype As defined in the state subtype state table
7 3 Defined by state subtype As defined in the state subtype state table
8 3 Defined by state subtype As defined in the state subtype state table
9 3 Defined by state subtype As defined in the state subtype state table
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-132 APTRA™ Advance NDC, Reference Manual
State Tables
z001 – Bunch Cheque Accept State
z001 – Bunch Cheque Accept State 2
The Bunch Cheque Accept state allows a bunch of cheques to be
inserted into a bunch cheque acceptor, scanned and the production
of the codeline along with a number of images. Any cheques
refused, (for example, because of the failure of codeline validation)
or rejected (for example, because the cheque is too short) by the
device are returned to the consumer. After the completion of the
Bunch Cheque Accept state, accepted cheques are held in the
escrow.
If cheques are returned, but the consumer does not remove them,
they are retracted to bin 2.
If configured, advanced image recognition features can be used to
do the following:
Automatically obtain the amount for each cheque
Determine the quality of each cheque and return any cheques
that do not meet the required quality level.
Note: If a timeout occurs, or the consumer cancels the transaction,
an unsolicited message is sent to Central and journaled.
Table 2-69
z001 - Bunch Cheque Accept State
Table No. of
Contents Description
Entry Chars
1 1 ‘z’ (7AH) Master Extension State
2 3 State subtype ‘001’
3 3 Cancel Key Mask Specifies the FDK or touch screen area to be used as the Cancel
key when the ‘Please Insert Cheques’ screen is displayed.
See Table Note 83 and Table Note 84
4 3 Enable Image Processing Specifies the level of processing to be carried out on the cheque
(Range 000‐003) images, as follows:
000 ‐ no processing
001 ‐ apply image quality assessment (IQA) tests to determine
cheque acceptability
002 ‐ attempt to obtain the amount for each cheque
This field is a bit mask and each bit enables a feature with
combinations of bits enabling multiple features. For example,
003 applies IQA tests and obtains the amount for each cheque
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-133
State Tables
z001 – Bunch Cheque Accept State
Table No. of
Contents Description
Entry Chars
5 3 Max Items Specifies the maximum number of cheques that can be accepted
(Range 000‐999) into the device
If 000 is specified or the specified value is greater than the
maximum accepted by the device, the device maximum is used
6 3 Extension State 1 State number for extension state 1
(Base 10 range 000‐254 or See “Extension 1 to State z001” on page 2‐135
256‐999)
(Base 36 range 000‐254 or If a value of 255 is used for this entry, the default Close state is
256‐ZZZ) taken
For more information about extension states, see “Extension
States” on page 2‐6.
7 3 Extension State 2 State number for extension state 2
(Base 10 range 000‐254 or See “Extension 2 to State z001” on page 2‐136
256‐999)
(Base 36 range 000‐254 or If a value of 255 is used for this entry, this indicates there is no
256‐ZZZ) extension state 2
For more information about extension states, see “Extension
States” on page 2‐6.
8 3 Extension State 3 State number for extension state 3
(Base 10 range 000‐254 or See “Extension 3 to State z001” on page 2‐137
256‐999)
(Base 36 range 000‐254 or If a value of 255 is used for this entry, this indicates there is no
256‐ZZZ) extension state 3
For more information about extension states, see “Extension
States” on page 2‐6.
9 3 Must be 000 Reserved
Table Note 83: Each bit is associated with an FDK; from bit 0 ‐ FDK
A to bit 7 ‐ FDK I. If a bit is 1, the corresponding FDK is active. If a
bit is 0, the corresponding FDK is inactive. If the same FDK is
defined in more than one mask, the latest key mask is used.
Table Note 84: The Cancel key on the PIN pad will be active, even if
no FDK is defined as Cancel.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-134 APTRA™ Advance NDC, Reference Manual
State Tables
z001 – Bunch Cheque Accept State
Table 2-70
Extension 1 to State z001
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Please Wait for Device Prompts the consumer to wait for the device to be ready to accept
Screen cheques
(Range 000‐Z99) If the screen is not to be changed while waiting for the device, set
this field to 000
3 3 Please Insert Cheques Prompts the consumer to enter cheques when the device is
Screen successfully enabled, or re‐enabled, to accept a cheque deposit
(Range 000‐Z99)
4 3 Processing Cheques Replaces the ‘Please Insert Cheques’ screen while the device
Screen processes the inserted cheques
(Range 000‐Z99)
5 3 Please Wait for Refused Prompts the consumer to wait while refused cheques are returned
Cheques Screen If multiple bunches are returned, this screen can be displayed
(Range 000‐Z99) multiple times
6 3 Retracting Cheques Informs the consumer that returned cheques, which have not been
Screen taken, are being retracted
(Range 000‐Z99) The retract is initiated if Timer 94 expires before the cheques are
taken
See Table Note 85
7 3 Device Unavailable Informs the consumer that the device is unavailable when the
Screen Bunch Cheque Accept state is entered
(Range 000‐Z99) The screen is displayed for the time defined by Timer 63
See Table Note 85
8 3 Hardware Error Screen Informs the consumer that the transaction cannot continue because
(Range 000‐Z99) a hardware error, such as a cheque jam, has occurred
The screen is displayed for the time defined by Timer 63
See Table Note 85
9 3 Stacker/Escrow Full Informs the consumer that the stacker is already full when entering
Screen the Bunch Cheque Accept state
(Range 000‐Z99) The screen is displayed for the time defined by Timer 63
If the timer expires, the Good Exit is taken
See Table Note 85
Table Note 85: For details of the timers, see “Timers” on page 7‐24.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-135
State Tables
z001 – Bunch Cheque Accept State
Table 2-71
Extension 2 to State z001
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Please Remove Rejected Informs the consumer that cheques have been rejected before they
Cheques Screen were fully inserted.
(Range 000‐Z99) If the reason for the rejection is to be displayed, it must be defined
in a display dynamic text dictionary control sequence within this
screen definition. The reason is displayed at the screen position
where the dictionary is defined. The reasons for rejection that must
be included in the dictionary are described in “Defining Dynamic
Text for Contactless Tap Error” on page 2‐13
See Table Note 86
3 3 Please Remove Refused Informs the consumer that cheques have been refused after being
Cheques Screen successfully inserted
(Range 000‐Z99) If the reason for the refusal is to be displayed, it must be defined in
a display dynamic text dictionary control sequence within this
screen definition. The reason is displayed at the screen position
where the dictionary is defined. The reasons for refusal must be
included in the dictionary are described in “Defining Dynamic Text
for Cheque Refusal” on page 2‐138
See Table Note 86
4 3 Must be 000 Reserved
5 3 Must be 000 Reserved
6 3 Must be 000 Reserved
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Table Note 86: For details of defining a dynamic text dictionary
control sequence, see “Display Dynamic Text Dictionary Control
Sequence” on page 3‐39. The reasons are displayed from the final
cursor position after the base screen is displayed. If the dictionary
control sequence dynamic text is not defined, no reason is
displayed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-136 APTRA™ Advance NDC, Reference Manual
State Tables
z001 – Bunch Cheque Accept State
Table 2-72
Extension 3 to State z001
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Good Next State Number State number to which the SST goes if at least one cheque has been
(Base 10 range 000‐254 or successfully accepted into the device and any refused cheques have
256‐999) been taken by the consumer
(Base 36 range 000‐254 or If all cheques have been either refused or rejected, the state does not
256‐ZZZ) take an exit and the device is re‐enabled for cheque insertion
3 3 Cancel Next State State number to which the SST goes if the Cancel key is pressed to
Number stop the cheque deposit or ‘No’ is selected from the Timeout screen.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Device Error Next State State number to which the SST goes if an exception has occurred
Number which may require subsequent action by Central
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Timeout Next State State number to which the SST goes if the consumer fails to enter
Number any cheques before Timer 04 expires
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 Cheques Retracted Next State number to which the SST goes if refused cheques are
State Number subsequently successfully retracted
(Base 10 range 000‐254 or All cheques, not just those that have been rejected, are retracted. All
256‐999) cheques must be retracted because there is no consumer interaction
(Base 36 range 000‐254 or to continue with the deposit of cheques that have been inserted but
256‐ZZZ) not rejected
The retract is initiated after Timer 94 expires
7 3 Good with Refused State number to which the SST goes if at least one cheque is
(Base 10 range 000‐254 or refused, and taken when returned, and at least one good cheque is
256‐99) accepted.
(Base 36 range 000‐254 or If this state parameter is not specified, the SST goes to the Good
256‐ZZZ) Next State Number.
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-137
State Tables
z001 – Bunch Cheque Accept State
To define the text to be displayed when a cheque is rejected during
Defining Dynamic Text for the Bunch Cheque Accept state, the enumerated values and
Cheque Rejection 2
definitions must be defined. These values and definitions are
included in a dynamic text dictionary control sequence with a
Dictionary ID of 000. For details of this control sequence, see
“Display Dynamic Text Dictionary Control Sequence” on page 3‐39.
Table 2‐73 lists the enumerated values and their definitions. The
display text must reflect these definitions and match the available
space and language of the screen.
Table 2-73 Enumerated Value Definition
Rejected Reasons
001 The rejected item is too long
002 The rejected item is too thick
003 More than one item has been detected
004 The item has been removed
005 Metal has been detected in the input position
006 Foreign items have been detected in the input position
999 Optional default text to display when specific text is
not provided
To define the text to be displayed when a bunch of cheques is
Defining Dynamic Text for refused during the Bunch Cheque Accept state, the enumerated
Cheque Refusal 2
values and definitions must be defined. These values and
definitions are included in a dynamic text dictionary control
sequence with a Dictionary ID of 001. For details of this control
sequence, see “Display Dynamic Text Dictionary Control Sequence”
on page 3‐39.
Table 2‐74 lists the enumerated values and their definitions. The
display text must reflect these definitions and match the available
space and language of the screen.
Table 2-74 Enumerated Value Definition
Refused Reasons
001 The cheque has been refused as a result of cheque
validation
002 Foreign items have been detected in the input position
003 The escrow is full or the maximum number of items
that the application allows in escrow has been reached
004 The codeline data has been found, but was invalid
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-138 APTRA™ Advance NDC, Reference Manual
State Tables
z001 – Bunch Cheque Accept State
Enumerated Value Definition
005 The item is invalid
For example, some devices reject blank paper
006 The item is too long
007 The item is too short
008 The item is too wide
009 The item is too narrow
010 The item is too thick
011 The item has been inserted in an invalid orientation
012 The items cannot be separated
013 There are too many items in the refused item area. The
refused items must be returned to the consumer
before any additional items can be accepted
014 Processing of the items did not take place as the bunch
of items is blocking the return of other items
015 Processing of the items did not take place as the bunch
of items presented is invalid
For example, the bunch is too large or has been
incorrectly presented
016 Reserved
017 The item or bunch is causing a jam
018 Metal, for example a staple or paperclip, has been
detected in the input position
999 Default text to display when specific text is not
provided
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-139
State Tables
z002 – Bunch Cheque Handling State
z002 – Bunch Cheque Handling State 2
The Bunch Cheque Handling state allows control of cheques held in
the escrow. This state is used in the following circumstances:
If the consumer cancels the transaction before making a
transaction request and the cheques are to be returned
If the consumer fails to take refused cheques and the cheques are
to be retracted
To deposit the cheques into a bin if an off‐line cheque deposit
solution is required,
Table 2-75
z002 - Bunch Cheque Handling State
Table No. of
Contents Description
Entry Chars
1 1 ‘z’ (7AH) Master Extension State
2 3 State subtype ‘002’
3 3 Media Control Specifies what happens to the cheques, as follows:
(Range 000‐002) 000 ‐ move the cheques to be deposited into the bin specified in
the Bin Number field and return any other cheques to the
consumer. Returned cheques are those that failed validation or
that the consumer requested for return. If the returned cheques
are not taken before Timer 94 expires, the cheques are retracted
and the Customer Timeout next state exit is taken
001 ‐ return the cheques to the consumer and retract them if
there is a problem or they are not taken before Timer 94 expires.
If the cheques are retracted, the Customer Timeout next state
exit is taken
002 ‐ return cheques to the consumer but do not retract them if
they are not taken. If the returned cheques are not taken before
Timer 94 expires, the cheques are left at the entry and the
Customer Timeout next state exit is taken
For details of Timer 94, see “Timers” on page 7‐24
4 3 Deposit Bin Number Specifies the bin number into which the cheque is to be
(Range 000‐999) deposited
This only applies when the Media Control field is set to 000
If an invalid bin number is used, such as 003 when there are
only 2 bins, a value of 001 is used (bin 1)
5 3 Endorse Text Specifies the screen containing the text used to endorse the
(Range 000‐Z99) cheques
If endorsement is not required or the Endorse Control defines
an alternative source for the endorsement data, set this to 000
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-140 APTRA™ Advance NDC, Reference Manual
State Tables
z002 – Bunch Cheque Handling State
Table No. of
Contents Description
Entry Chars
6 3 Stamp Flag Specifies whether to stamp the cheques, as follows:
(Range 000‐001) 000 ‐ do not stamp the cheques
001 ‐ stamp the cheques
This only applies if the device supports stamping
7 3 Must be 000 Reserved
8 3 Extension State 1 State number for extension state 1
(Base 10 range 000‐254 or See “Extension 1 to State z002”
256‐999)
(Base 36 range 000‐254 or For more information about extension states, see “Extension
256‐ZZZ) States” on page 2‐6
9 3 Extension State 2 State number for extension state 2
(Base 10 range 000‐254 or See “Extension 2 to State z002”
256‐999)
(Base 36 range 000‐254 or For more information about extension states, see “Extension
256‐ZZZ) States” on page 2‐6.
Table 2-76
Extension 1 to State z002
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Please Wait Processing Prompts the consumer to wait while the action specified in the
Cheques Screen Media Control field is carried out
(Range 000‐Z99)
3 3 Please Remove Returned Prompts the consumer to remove cheques that have been returned
Cheques Screen
(Range 000‐Z99)
4 3 Please Wait for More Prompts the consumer to wait for further cheques to be returned
Returned Cheques Screen
(Range 000‐Z99)
5 3 Please Wait Retracting Informs the consumer that returned cheques that have not been
Cheques Screen taken are being retracted
(Range 000‐Z99)
6 3 Device Unavailable Informs the consumer that the device is unavailable when the
Screen Bunch Cheque Handling state is entered
(Range 000‐Z99) The screen is displayed for the time defined by Timer 63, described
on page 7‐27
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-141
State Tables
z002 – Bunch Cheque Handling State
Table No. of
Contents Description
Entry Chars
7 3 Hardware Error Screen Informs the consumer that the transaction cannot continue because
(Range 000‐Z99) a hardware error, such as a cheque jam, has occurred
The screen is displayed for the time defined by Timer 63
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Table 2-77
Extension 2 to State z002
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Good Operation Next State number to which the SST goes if the cheques have been
State Number successfully processed as defined in the Media Control field, as
(Base 10 range 000‐254 or follows:
256‐999) If Media Control is 000, the media has been deposited into the
(Base 36 range 000‐254 or specified bin and any returned cheques have been taken by the
256‐ZZZ) consumer
If Media Control is 001 or 002, the media has been returned and
taken by the consumer
3 3 Device Error Next State State number to which the SST goes if an exception has occurred
Number which may require subsequent action by Central
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Customer Timeout Next State number to which the SST goes if the consumer has not taken
State Number the returned cheques
(Base 10 range 000‐254 or If Media Control is 002, this exit is taken after Timer 94 expires,
256‐999) otherwise it is taken after any returned cheques are successfully
(Base 36 range 000‐254 or retracted
256‐ZZZ)
5 3 Endorse Control Defines where and how the data used to endorse the cheque is
(Range 000‐001) defined, as follows:
000 ‐ The Endorse Text table entry (table entry 5). If both
parameters are defined as 000, the endorsement text is not set using
this state
001 ‐ Created using dynamic data elements defined in the local
dynamic endorse configuration file (not supported)
6 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-142 APTRA™ Advance NDC, Reference Manual
State Tables
z002 – Bunch Cheque Handling State
Table No. of
Contents Description
Entry Chars
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-143
State Tables
z003 – Cheque Detail Display State
z003 – Cheque Detail Display State 2
The Cheque Detail Display state prompts the consumer to view
details about the deposited cheques and enter the amount of the
cheque. This state can be configured to operate in the following
modes:
Display details of a specific cheque, but allow navigation
through all cheques
Display details for all cheques
Display details of any cheques that do not have an amount
The display is configured using screen definitions and can contain
the following:
Scaled cheque images
Codeline
Cheque deposit count, for example, “cheque 3 of 4”
Amount of the cheque
FDKs or touch screen areas are used to select the following actions:
Proceed
Request the return of the cheque at the end of the transaction
Cancel the amount entry
If Operation Mode (table entry 3) is set to 001, view the next or
previous cheque
Any cheques requested for return by the consumer are returned as
follows:
In online transactions, during the Transaction Reply processing
In offline transactions, during the Bunch Cheque Handling state
Note: If a timeout occurs or the consumer cancels the transaction,
no unsolicited message is sent to Central or journaled.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-144 APTRA™ Advance NDC, Reference Manual
State Tables
z003 – Cheque Detail Display State
Table 2-78
z003 - Cheque Detail Display State
Table No. of
Contents Description
Entry Chars
1 1 ‘z’ (7AH) Master Extension State
2 3 State subtype ‘003’
3 3 Operation Mode Specifies the mode of operation, as follows:
(Range 001‐003) 001 ‐ display details of the current cheque and allow the
consumer to navigate through all the cheques and edit the
amounts. A description of the current cheque (for
information on the current cheque, see “Current Cheque
Index” on page 2‐151) is provided in the Display Cheque
Summary state. If no cheques are available, an empty
Cheque Detail screen is displayed. The background Cheque
Detail screen must therefore be designed to handle the
situation where no cheque details are displayed. Selecting
the Enter key completes amount entry, but does not provide
any screen navigation. On exit from this state, the current
cheque is set to the last cheque displayed
002 ‐ display all cheques in turn, requesting that the
amount be entered or confirmed for each cheque. The Enter
key on the keypad is used to complete or confirm the
amount and display the next cheque. When the last cheque
is confirmed, the state takes the Proceed Next State exit. If
no cheques are available, the state immediately takes the
Proceed Next State exit. On exit from this state, the current
cheque is set to the first cheque in the cheque list
003 ‐ display the details of all cheques that do not have
amounts available in turn and request that the amount be
entered. The Enter key on the keypad is used to complete or
confirm the amount and display the next cheque. When the
last cheque is confirmed, the state takes the Proceed Next
State exit. If no cheques are available or all cheques have an
amount specified, the state immediately takes the Proceed
Next State exit. On exit from this state, the current cheque is
set to the first cheque in the cheque list
Note: If the operation mode is set to 000, it is treated as 001.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-145
State Tables
z003 – Cheque Detail Display State
Table No. of
Contents Description
Entry Chars
4 3 Allow Zero Specifies whether a cheque can be left with an amount of zero,
(Range 000‐001) as follows:
000 ‐ do not allow a cheque to have a zero amount
001 ‐ allow a cheque to have a zero amount
If the consumer tries deposit cheques without entering an
amount for each cheque and cheques are not allowed to have a
zero amount, the first cheque with a zero amount is displayed
using the Zero Amount Error overlay screen. The consumer
must provide a non‐zero amount or cancel the transaction. If a
cheque is to be returned to the consumer, it is not included in
the evaluation of cheques with a zero amount
5 3 Cheque Detail Screen Informs the consumer of the cheque details and allows an
(Range 000‐Z99) amount to be entered or edited
If the cheque deposit status is to be displayed, a control
sequence for a dynamic text dictionary must be defined within
this screen. For details of the control sequence, see “Display
Dynamic Text Dictionary Control Sequence” on page 3‐39. The
status values that must be included in the dictionary are
described in “Defining Dynamic Data for Cheque Deposit
Status” on page 2‐149
6 3 Amount Display Screen Overlay screen to set the cursor position and optionally defines
Number the initial display format before amount entry or edit by the
(Range 000‐Z99) consumer
The cursor must be set to the left side of the echo field on the
display, which is space‐filled until the required start position
for the currency character is reached
The default echo field is bbbbbSb0.00, where b represents a
space
For more information on amount display, see “International
Currency Display Format” on page 3‐45
7 3 Zero Amount Error Screen Overlay screen to prompt the consumer to provide a non‐zero
(Range 000‐Z99) amount for the displayed cheque
8 3 Extension State 1 State number for extension state 1
(Base 10 range 000‐254 or See “Extension 1 to State z003”
256‐999)
(Base 36 range 000‐254 or For more information about extension states, see “Extension
256‐ZZZ) States” on page 2‐6.
9 3 Extension State2 State number for extension state 2
(Base 10 range 000‐254 or See “Extension 2 to State z003”
256‐999)
(Base 36 range 000‐254 or For more information about extension states, see “Extension
256‐ZZZ) States” on page 2‐6.
Table Note 87: For details of defining a dynamic text dictionary
control sequence, see “Display Dynamic Text Dictionary Control
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-146 APTRA™ Advance NDC, Reference Manual
State Tables
z003 – Cheque Detail Display State
Sequence” on page 3‐39. The reasons are displayed from the final
cursor position after the base screen is displayed. If the dynamic text
dictionary control sequence is not defined, no status is displayed.
Table 2-79
Extension 1 to State z003
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Proceed Next State State number to which the SST goes if the cheques deposited have
Number met the conditions of the transaction and wants to proceed
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Cancel Next State State number to which the SST goes if the Cancel key is pressed
Number If any amount has been modified during this state before the Cancel
(Base 10 range 000‐254 or key is pressed, the modified amount is retained
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Timeout Next State State number to which the SST goes if the consumer fails to respond
Number within the specified time limit
(Base 10 range 000‐254 or Enter 255 if the time‐out function is not required
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Must be 000 Reserved
6 3 Must be 000 Reserved
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-147
State Tables
z003 – Cheque Detail Display State
Table 2-80
Extension 2 to State z003
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Proceed Key Mask Specifies the FDKs or touch screen areas that are active as Proceed
keys
If the Proceed key or touch screen area is pressed while entering an
amount, the amount is accepted before the normal proceed
functionality is completed
If Operation Mode (table entry 3) is set to 002 or 003 and zero
amounts are allowed, this FDK navigates to the next cheque until
the last cheque is displayed
See Table Note 88
3 3 Cancel Key Mask Specifies the FDKs or touch screen areas that are active as Cancel
keys
The Cancel FDK or touch screen area is active on all screens
If the Cancel key or touch screen area is pressed while entering an
amount, the amount being entered is discarded
See Table Note 88
4 3 Return Cheque Key Mask Specifies the FDKs or touch screen areas that are associated with
the option to return the cheque to the consumer and not to provide
an amount
When the Return Cheque Key or touch screen area is used, the
status of the cheque is toggled between ‘return’ and ‘deposit’
Pressing this key does not cause the next cheque to be displayed
See Table Note 88
5 3 Next Cheque Key Mask Specifies the FDKs or touch screen areas that are associated with
the option to move to the next cheque in the list
This is not used when the Operation Mode field (table entry 3) is set
to 002 or 003, as no navigation is possible in these modes
If the Next Cheque Key or touch screen area is pressed while
entering an amount, the amount is accepted before the normal next
cheque functionality is completed
If the cheque displayed is the last cheque, pressing this key
displays the first cheque
See Table Note 88
6 3 Previous Cheque Key Specifies the FDKs or touch screen areas that are associated with
Mask the option to move to the previous cheque in the list
This is not used when the Operation Mode field is set to 002 or 003,
as no navigation is possible in these modes
If the Previous Cheque Key or touch screen area is pressed while
entering an amount, the amount is accepted before the normal
previous cheque functionality is completed
If the cheque displayed is the first cheque, pressing this key
displays the last cheque
See Table Note 88
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-148 APTRA™ Advance NDC, Reference Manual
State Tables
z003 – Cheque Detail Display State
Table No. of
Contents Description
Entry Chars
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Table Note 88: Each bit is associated with an FDK; from bit 0 ‐ FDK
A to bit 7 ‐ FDK I. If a bit is ‘1’, the associated FDK or touch area is
active. If a bit is ‘0’, the associated FDK or touch area is inactive.
When the deposit status of a cheque is to be displayed, the data is
Defining Dynamic Data for defined using an enumerated list. This list is included in a display
Cheque Deposit Status 2
dynamic text dictionary control sequence with a Dictionary ID of
000. For details of this control sequence, see “Display Dynamic Text
Dictionary Control Sequence” on page 3‐39.
Table 2‐81, “Cheque Acceptance States”, lists the enumerated values
and their definitions. The display text must reflect these definitions
and match the available space and language of the screen.
Table 2-81 Enumerated Value Definition
Cheque Acceptance States
001 The cheque will be deposited
002 The cheque will be returned due to consumer selection
003 The cheque will be returned due to validation failure
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-149
State Tables
z004 – Display Cheque Summary State
z004 – Display Cheque Summary
State 2
The Display Cheque Summary state displays a summary of the
cheques that have been accepted during the Bunch Cheque Accept
state (see page 2‐133). This state provides the following:
A summary of the deposit transaction. The summary can
include the following:
— The number of cheques inserted
— The number of cheques that the consumer has selected for
return
— The total deposit amount
— Details of up to nine cheques. The content of the cheque
display can be configured to display a scaled cheque image,
the codeline and the amount
FDKs or touch screen area assigned to select the next and
previous list of cheques
An FDK or touch screen area assigned to take the Proceed Next
State Number exit (extension 3, table entry 3)
An FDK or touch screen area assigned to cancel the deposit
An FDK or touch screen area assigned to allow the insertion of
more cheques
Handling of time‐outs, by either allowing the consumer more
time or by completing the state and taking the Timeout Next
State exit
Note 1: If a timeout occurs, or the consumer cancels the transaction,
no unsolicited message is sent to Central or journaled.
Note 2: The display of number of cheques refused is not supported
in Advance NDC.
Enabling keypad keys to allow the consumer to select a cheque
to view in greater detail using the Cheque Detail Display state.
While viewing the detailed display, the consumer can edit the
amount of the displayed cheque. Each cheque displayed in the
summary screen is associated with one of the 1 to 9 keypad keys.
Selecting a numeric key causes the View Cheque Details State
exit to be taken with the current cheque set to the cheque
associated with the selected key. If no cheque is associated with
the selected numeric key, there is a beep to acknowledge the key
press but nothing else occurs.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-150 APTRA™ Advance NDC, Reference Manual
State Tables
z004 – Display Cheque Summary State
If no cheques are available for display, only the Cheque Summary
screen is displayed.
The Display Cheque Summary state, Bunch Cheque Accept state
Current Cheque Index 2
and Cheque Detail Display state share a current cheque index value.
The Bunch Cheque Accept state initialises the current cheque index
to the first cheque in the cheque list.
The Display Cheque Summary state displays pages of cheques, with
each page containing from one cheque up to the number of cheques
defined by the Max Cheque Details parameter (extension 1, table
entry 7). When the Cheque Detail State exit is taken from the
Display Cheque Summary state, the setting of the current cheque
index depends on the Operation Mode field as follows:
If the Operation Mode field is set to 001, the current cheque
index is set to the cheque selected by the consumer. If you want
the selected cheque to be displayed immediately, the Cheque
Detail Display state must have the Operation Mode field set to
001. On return to the Display Cheque Summary state, the page
of cheques displayed is the page containing the last cheque
displayed in the Cheque Detail Display state
If the Operation Mode field is set to 002 or 003, the current
cheque index is reset to the first cheque in the cheque list. On
return to the Display Cheque Summary state, the current cheque
index is unchanged.
Table 2-82
z004 - Cheque Summary Display State
Table No. of
Contents Description
Entry Chars
1 1 ‘z’ (7AH) Master Extension State
2 3 State subtype ‘004’
3 3 Must be 000 Reserved
4 3 Must be 000 Reserved
5 3 Must be 000 Reserved
6 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-151
State Tables
z004 – Display Cheque Summary State
Table No. of
Contents Description
Entry Chars
7 3 Extension State 1 State number for extension state 1
(Base 10 range 000‐254 or See “Extension 1 to State z004”
256‐999)
(Base 36 range 000‐254 or For more information about extension states, see “Extension
256‐ZZZ) States” on page 2‐6.
8 3 Extension State 2 State number for extension state 2
(Base 10 range 000‐254 or See “Extension 2 to State z004”
256‐999)
(Base 36 range 000‐254 or For more information about extension states, see “Extension
256‐ZZZ) States” on page 2‐6.
9 3 Extension State 3 State number for extension state 3
(Base 10 range 000‐254 or See “Extension 3 to State z004”
256‐999)
(Base 36 range 000‐254 or For more information about extension states, see “Extension
256‐ZZZ) States” on page 2‐6.
Table 2-83
Extension 1 to State z004
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Cheque Summary Screen Contains the background for the cheque summary display
(Range 000‐Z99)
3 3 Next FDK Screen Nested screen to overlay the Cheque Summary screen when the
(Range 000‐Z99) Next FDK key or touch screen area is enabled because there are
more cheques to display than can fit on a single screen
4 3 Previous FDK Screen Nested screen to overlay the Cheque Summary screen when the
(Range 000‐Z99) Previous FDK key or touch screen area is enabled because there are
more cheques to display than can fit on a single screen
5 3 Cheque Display Area Specifies the top of the area used to display dynamic cheque data
Top Row
(Range 000‐015)
6 3 Cheque Display Area Specifies the left of the area used to display dynamic cheque data
Left Column
(Range 000‐031)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-152 APTRA™ Advance NDC, Reference Manual
State Tables
z004 – Display Cheque Summary State
Table No. of
Contents Description
Entry Chars
7 3 Max Cheque Details Specifies the maximum number of cheques to display on a single
(Range 00‐010) screen
8 3 Cheque Details Overlay Overlay screen to define what is displayed for each cheque.
Screen If the cheque deposit status is to be displayed, a dynamic text
(Range 000‐Z99) dictionary control sequence must be defined within this screen. The
status values that must be included in the dictionary are described
in “Defining Dynamic Data for Cheque Deposit Status” on
page 2‐149
See Table Note 89 and Table Note 90
9 3 Cheque Details Overlay Specifies the number of rows allocated for the display of the cheque
Size details
(Range 000‐015)
Table Note 89: Any position co‐ordinates used in the overlay
screen are relative.
Table Note 90: New display control codes are added to allow the
display of dynamic data associated with the inserted cheques.
Table 2-84
Extension 2 to State z004
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Cheque Detail Area Overlay screen to clear the area for cheque detail display on initial
Background Screen entry to the state and when either the Next or Previous FDK or
(Range 000‐Z99) touch screen area is selected
3 3 Cancel Key Mask Specifies the FDKs or touch screen areas that are active as Cancel
keys
The Cancel FDK is active on all screens
See Table Note 91
4 3 Proceed Key Mask Specifies the FDKs or touch screen areas that are associated with
the option to proceed
See Table Note 91
5 3 Next FDK Key Mask Specifies the FDKs or touch screen areas that are associated with
the option to display the next screen of cheques
This FDK or touch screen area is only enabled if there are more
cheques to display than will fit on a single screen
If the cheque displayed is the last cheque, pressing the Next key or
touch screen area displays the screen containing the first cheque
See Table Note 91
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-153
State Tables
z004 – Display Cheque Summary State
Table No. of
Contents Description
Entry Chars
6 3 Previous FDK Key Mask Specifies the FDKs or touch screen areas that are associated with
the option to display the previous screen of cheques
This FDK or touch screen area is only enabled if there are more
cheques to display than will fit on a single screen
If the cheque displayed is the first cheque, pressing the Previous
key or touch screen area displays the screen containing the last
cheque
See Table Note 91
7 3 Add More FDK Key Specifies the FDKs or touch screen areas that are associated with
Mask the option to add more cheques
This FDK or touch screen area is only enabled when the device has
the capacity to accept additional cheques
See Table Note 91
8 3 Add More FDK Screen Nested screen to overlay the Cheque Summary screen when the
(Range 000‐Z99) Add More FDK key or touch screen area is enabled
9 3 Must be 000 Reserved
Table Note 91: Each bit is associated with an FDK; from bit 0 ‐ FDK
A to bit 7 ‐ FDK I. If a bit is ‘1’, the relative FDK or touch area is
active. If a bit is ‘0’, the relative FDK or touch area is inactive.
Table 2-85
Extension 3 to State z004
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Cancel Next State State number to which the SST goes if the Cancel key is pressed
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Proceed Next State State number to which the SST goes if the Proceed key is pressed
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-154 APTRA™ Advance NDC, Reference Manual
State Tables
z004 – Display Cheque Summary State
Table No. of
Contents Description
Entry Chars
4 3 Add More Next State State number to which the SST goes if the Add More key is pressed
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Timeout Next State State number to which the SST goes if the consumer fails to respond
Number in the specified time limit
(Base 10 range 000‐254 or Enter 255 if the time‐out function is not required
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 View Cheque Detail State State number to which the SST goes if the consumer chooses to
Number view the details of a cheque
(Base 10 range 000‐254 or This identifies the Cheque Detail Display state, which must have
256‐999) the Operation Mode set to 001
(Base 36 range 000‐254 or
256‐ZZZ)
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-155
State Tables
z008 – Insert Card State
z008 – Insert Card State 2
The Insert Card state supports motorised card readers, smart dip
card readers and contactless card readers. This state allows card
entry during a transaction. The state operates as follows:
Prompts the consumer to insert a card
Activates the card reader
If beeping is enabled, starts beeping
Starts the MEI flashing to show where to enter the card.
Note: Beeping starts only if table entry 6 of extension state 1 has a
value of 001. If it is set to 000, the beeper does not sound even if this
state is active and the MEI is switched on. After card entry, the MEI
is switched off and the beeping stops.
The Insert Card state enables the Cancel key before card insertion. If
the consumer presses the Cancel key during this time, the application
flow goes to the Cancel Next State. After card insertion, the Cancel
key is disabled.
The Insert Card state initialises the following:
Card Data buffers
Consumer selectable PIN buffers
Buffer A.
If the card read is successful, the Card Data buffers are populated
with the card data. If the card read fails because of an invalid card or
a device error, the previous data in these buffers is retained, the
Next State Exit is taken and the card is ejected.
This state handles time‐outs based on timer 04. If the consumer does
not enter the card before timer 04 expires, the Time‐Out Next State
is taken.
The Insert Card state has an extension state (Extension State 2) to
Insert Card State and support multiple card readers. Multiple card readers can be enabled
Multiple Card Readers 2
by this state to allow consumer sessions to be initiated by different
types of cards. Advance NDC supports up to two card readers on an
SST: a contact and a contactless card reader.
If Extension State 2 is not provided, all available card readers are
enabled. The following values apply to the enabled card readers:
The read conditions (table entries 5 to 7) of the Insert Card state
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-156 APTRA™ Advance NDC, Reference Manual
State Tables
z008 – Insert Card State
The Good Read Next State Number (table entry 3) of the Insert
Card state or the No FIT Match Next State Number (table entry
3) of Extension State 1.
Note: Enabled card readers are always journaled. For more
information on card reader journaling, refer to section, “Journaling
Card Reader Events” in Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC, Developer’s
Guide.
Card Reader Precedence 2
When multiple card readers are active, and one of them is a contact
card reader and the other is a contactless card reader, the contact
card reader takes precedence over the contactless card reader.
If an SST has both card readers, and a card is inserted into the
contact card reader, the contactless card reader is disabled. If a card
is detected by both card readers, the card detected by the contact
card reader will be processed and the card detected by the
contactless card reader will be ignored.
For more information on contactless card readers, refer to section,
“Contactless Card Reader Configuration” in Chapter 5,
“Configuring Advance NDC and Associated Components” of the
APTRA Advance NDC, Developer’s Guide.
Using Extension State 2 2
The types of card readers that are enabled are specified in table
entry 4 (Active Card Readers) of Extension State 2. Extension State 2
also provides a Secondary Card Reader Good Read Exit (table entry
3) for cards processed by the secondary card reader.
The following functions are not supported by the Insert Card state:
Unsupported Functions 2
Cardless entry
Idle sequence
Initialization of the following:
— Buffer B
— Buffer C
— Amount buffer
— Operation code buffer
— FDK buffer
APTRA Promote Flow Points 2
The only APTRA Promote flow point supported in this state is the
ConsumerIdentified flow point. The others are not supported.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-157
State Tables
z008 – Insert Card State
Table 2-86
z008 - Insert Card State
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘z’
2 3 Sub‐Type 008
3 3 Insert Card Screen Prompts the consumer to enter a card. This screen is displayed
Number while the SST is waiting for card entry.
(Range 000‐Z99)
4 3 Good Read Next State State number to which the SST goes in either of the following
Number situations:
(Base 10 range 000‐254 or After a successful read of the card if FITs are not used (Table
256‐999) entry 4 in the extension state = 000).
(Base 36 range 000‐254 or If the Financial Institution number on the card matches a
256‐ZZZ) Financial Institution number in a FIT
5 3 Error (Misread) Screen Screen to display if the read conditions are not satisfied due to an
Number invalid card or a mechanism error.
(Range 000‐Z99) After ejecting the card, the card reader is reactivated and waits for
the card entry.
6 3 Read condition 1 These three entries specify which card track(s) and/or chip data will
be read. The possible values for these entries are shown in
7 3 Read condition 2 Table 2‐6, “Read Condition Bit Information” on page 2‐13.
8 3 Read condition 3
9 3 Extension State Number State number for Extension State 1.
(Base 10 range 000‐254 or For more information about extension states, see “Extension States”
256‐999) on page 2‐6.
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-158 APTRA™ Advance NDC, Reference Manual
State Tables
z008 – Insert Card State
Table 2-87
Extension 1 to State z008
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘Z’
2 3 Cancel next state number State number to which the SST goes if the Cancel key is pressed.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Time‐Out Next state State number to which the SST goes when timer 04 expires or when
number a card is ejected due to an invalid read but not taken by the
(Base 10 range 000‐254 or consumer.
256‐999) If the card is not taken within the duration of timer 09, the card is
(Base 36 range 000‐254 or captured and the Time‐Out Next State is taken.
256‐ZZZ)
4 3 No FIT Match Next state State number to which the SST goes if either the Financial
number Institution number on the card does not match any FIT, or the card
(Base 10 range 000‐254 or reader is a smart card reader and the read condition being
256‐999) evaluated has the chip connect bit set (bit 3).
(Base 36 range 000‐254 or If FITs are not used this entry must be 000.
256‐ZZZ)
5 3 Fatal Next state number State number to which the SST goes in the following situations:
(Base 10 range 000‐254 or The card reader is in a fatal condition
256‐999)
The card reader is out of operation
(Base 36 range 000‐254 or
256‐ZZZ) There is a device error
In these cases, the card is ejected and subsequently captured if it is
not taken by the consumer.
6 3 Enable beeper Enables or disables the beeper as follows:
001 ‐ Enables the beeper when waiting for card entry and when
the card is ejected
000 ‐ Disables the beeper (default).
The default value is used if the value is out of range
7 3 Take Card screen number If the card reader is a smart dip reader and a chip connect bit is set,
(Range 000‐Z99) but the ATR (Answer to Reset) fails, this screen is displayed to
prompt the consumer to remove the card and wait. This screen is
displayed until the consumer removes the card or timer 72 expires.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-159
State Tables
z008 – Insert Card State
Table No. of
Contents Description
Entry Chars
8 3 Card Return Flag Tells the SST when the card is to be returned to the consumer as
follows:
000 – Eject the card immediately
001 – Return the card as specified by a Transaction Reply
command message
This flag is ignored when the read conditions fail or the card reader
is in a fatal condition. In these cases, the card is returned
immediately, irrespective of this flag value.
When the Card Return Flag is 000, the card is returned after a
successful read. If the consumer does not take the card within the
duration of timer 09, the card is left at the throat and the Good Read
Next State is taken.
9 3 Extension State Number State number of Extension State 2. If there is no Extension State 2,
(Base 10 range 000‐254 or enter 000.
256‐999) For more information about extension states, see “Extension States”
(Base 36 range 000‐254 or on page 2‐6.
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-160 APTRA™ Advance NDC, Reference Manual
State Tables
z008 – Insert Card State
Table 2-88
Extension 2 to State z008
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘Z’
2 3 Smart DIP Reader Time to delay in one tenth of a second to latch the card when the
Delayed Latch Timer card reader is a smart dip card reader and a chip connect bit is set
(Range 000‐999) If this entry is 000, there is no delay in latching the card.
For more information, see “Delay Latch/Smart Delay
Functionality” on page 2‐70. For information on how to configure,
refer to “Smart Delay Timer for Smart Dip Card Reader” in Chapter
5, “Configuring Advance NDC and Associated Components” of the
APTRA Advance NDC, Developer’s Guide.
3 3 Secondary Card Reader State number to which the SST goes when the secondary card
Good Read Next State reader has successfully read the card and one of the following is
Number true:
(Base 10 range 000‐254 or Following a good read of the card if FITs are not used (Table
256‐999) Entry 9 in Extension state = 000)
(Base 36 range 000‐254 or
If the Financial Institution number on the card matches a
256‐ZZZ)
Financial Institution number in a FIT
4 3 Active Card Readers Tells the SST which card readers should be activated as follows:
(Range 000‐003) 000 ‐ All available card readers
001 ‐ Primary card reader
002 ‐ Secondary card reader
003 ‐ Primary and secondary card reader
The default value is 000.
5 3 Secondary Card Reader
Read Condition 1
These three entries specify which card track(s) will be read. The
6 3 Secondary Card Reader possible values for these entries are shown in Table 2‐6, “Read
Read Condition 2 Condition Bit Information” on page 2‐13
7 3 Secondary Card Reader See Table Note 92
Read Condition 3
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-161
State Tables
z008 – Insert Card State
Table No. of
Contents Description
Entry Chars
8 3 Contactless Tap Error This screen is displayed when a problem is detected during a
Screen (000‐Z99) contactless card tap. If this parameter is ‘000’, then the screen
identified by the Error (Misread) Screen Number (table entry 5 of
“z008 ‐ Insert Card State” on page 2‐158) is displayed.
If the reason for the failure is to be displayed, it must be defined in
a dynamic text for contactless tap error within this screen
definition. The reason is displayed at the screen position where the
dictionary is defined. The reasons for failure that must be included
in the dictionary are described in “Defining Dynamic Text for
Contactless Tap Error” on page 2‐13“.
9 3 Must be 000 Reserved
Table Note 92 The chip connect bit set (bit 3) of the read conditions
is an invalid value for a secondary card reader.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-162 APTRA™ Advance NDC, Reference Manual
State Tables
z009 – Buffer Validation State
z009 – Buffer Validation State 2
The Buffer Validation state is used to validate data entered by the
consumer and held in buffers B, C or the Amount buffer. The
validation is achieved using an XML configuration file. For details
of the XML configuration file, ValidationRuleSet.xml, and its related
schema, refer to Chapter 5, “Configuring Advance NDC and
Associated Components” in the APTRA Advance NDC, Developer’s
Guide.
Examples of states that use data entry are as follows:
F (Amount Entry)
R (Enhanced Amount Entry)
X (FDK Information Entry)
z017 (Note Mix Selection).
This state ensures that valid data is sent to the host. The following
are examples of data that can be validated using the Buffer
Validation state:
Date formats
The length of data
The content of some data.
Advance NDC attempts to match the RuleSetID from table entry 3
with the same ID in the XML configuration file. If a match is found,
Advance NDC reads the pattern for the rule set. If the rule pattern
matches the buffer data, the Good Validation Next State exit is
taken. If the pattern does not match, the Validation Fail Next State
exit is taken.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-163
State Tables
z009 – Buffer Validation State
Table 2-89
z009 - Buffer Validation State
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘z’
2 3 Subtype 009
3 3 RuleSetID Defines the rule identifier to match with the ID attribute in the
(Range 001‐999) XML configuration file.
4 3 Buffer ID Defines the buffer to be validated.
Valid values are as follows:
001 ‐ Buffer B
002 ‐ Buffer C
003 ‐ Amount Buffer
See Table Note 93
5 3 Good Validation Next State number to go to if the data is successfully validated.
State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 Validation Fail Next State State number to go to if the data validation fails.
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Table Note 93: If the identified buffer contains no data, the
Validation Fail Next State exit is taken.
The following scenario illustrates how the state table and XML
Date Validation Scenario 2
configuration file are used to validate buffer data.
In this scenario, the following are read from the state table:
RuleSetID (table entry 3) set to 123
Buffer ID (table entry 4) set to 001
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-164 APTRA™ Advance NDC, Reference Manual
State Tables
z009 – Buffer Validation State
The XML configuration file contains the following:
<RuleSet ID="123">
<!--Date validation Rule -->
<Rule Pattern="(0[1-9]|1[012])[-
/.](0[1-9]|[12][0-9]|3[01])[- /.](19|20)\d\d"/>
</RuleSet>
The Pattern attribute is defined using regular expressions. For
more information about defining valid string formats using regular
expressions, refer to the Microsoft Developer’s Network page at
http://msdn.microsoft.com/en‐us/library/2k3te2cs(VS.80).aspx.
Advance NDC checks the XML configuration file for a matching
rule set ID and finds one. The rule pattern is checked against the
buffer data. The date format is mm/dd/yyyy and validation is as
follows:
If Buffer B contains 12/31/2009, the data is within the limits
specified in the rule pattern and the Good Validation Next State
exit is taken.
If Buffer B contains 31/12/2009, the month data exceeds the limit
of 12 and the Validation Fail Next State exit is taken.
For details of the XML schema, ValidationRuleSet.xsd,
ValidationRuleSet.xsd refer to section “Configuring Cardholder
Functionality” in Chapter 5, “Configuring Advance NDC and
Associated Components”, of the APTRA Advance NDC, Developer’s
Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-165
State Tables
z010 – Local Cash Dispense State
z010 – Local Cash Dispense State 2
The Local Cash Dispense state can be used to dispense cash without
the need for host authorisation. It is used for transactions that are
authorised and recorded though some other system. This state must
only be used in environments where the cash counters are
maintained on the SST as Central is unaware of any cash dispensed
through this state.
If this state is used with cardless transactions, consumer
Cardless Transactions 2
identification will be required in the event of power failure or a
short dispense. If cardless transactions are used, it will be necessary
to ensure that all sensitive data is collected and processed in
compliance with PA‐DSS requirements.
This state can dispense notes, coins, or a combination of notes and
Dispense Functionality 2
coins. In this state, the cash to be dispensed is specified within CDI
stores. Data to be printed is specified within UCDI stores. If the
operation includes a combination of notes and coins, the notes must
be successfully dispensed before the coins are dispensed.
When notes and coins are to be dispensed but either the cash
dispenser or the coin dispenser is unable to dispense (the device is
not present, is fatal or is in a suspend condition) or one of the
devices cannot dispense the cash specified (cassette or hopper is not
present, is empty or is fatal) neither notes nor coins will be
dispensed.
When the retract option is enabled, the requested notes are
dispensed first and after the notes are taken by the consumer, the
requested coins are dispensed. When the retract option is disabled,
the requested notes are dispensed first, then the requested coins are
dispensed without waiting for the notes to be taken.
A typical use of this state is in a foreign currency exchange
Foreign Currency transaction, where the consumer initiates the transaction (with or
Exchange Transactions 2
without a card) and deposits the foreign currency. The current
exchange rate is used to determine the amount of local currency to
be dispensed. In this scenario, the notes would be deposited using
the Cash Accept state, the currency exchange calculated by an Exit
state and the Local Cash Dispense state would dispense the cash.
Once the cash has been successfully dispensed, the state flow goes
State Flow after a to the Good Dispense Next State. When only notes have to be
Successful Dispense 2
dispensed, the presentation of the notes is treated as a successful
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-166 APTRA™ Advance NDC, Reference Manual
State Tables
z010 – Local Cash Dispense State
dispense and the state flow goes to the Good Dispense Next state.
This applies whether retract is enabled or disabled and notes are
taken or not. If the notes are not taken and retract is enabled, the
notes are retracted and the state flow goes to the Good Dispense
Next State.
Successful Dispense Examples 2
When notes and coins are requested, on successful dispense of
notes and coins, the state flow goes to the Good Dispense Next
State.
When only notes are requested and cash dispenser tampering
occurs while the consumer is taking the presented notes, the
state flow goes to the Good Dispense Next State as the requested
notes have been dispensed.
When only notes are requested and the consumer does not take
the requested notes, the notes are retracted if retract is enabled
or left at the SST throat if retract is disabled and the state flow
goes to the Good Dispense Next State.
When the cash dispensed is less than the amount of requested cash,
State Flow after a Short the state flow goes to the Short Dispense Next State.
Dispense 2
Short Dispense Examples
When notes and coins are requested, but only notes are
presented and no coins are dispensed due to the coin dispenser
hoppers running out of coins in the current transaction, the state
flow goes to the Short Dispense Next State.
If notes and coins are requested and the retract option is
enabled, but the presented notes are not taken by the consumer,
the notes are retracted to the retract bin and the state flow goes
to the Short Dispense Next State
When no cash is dispensed, the state flow goes to the No Dispense
State Flow after a Failed Next State.
Dispense 2
Failed Dispense Examples
When the Advance NDC CDI stores specify that no notes or
coins are to be dispensed, the state flow goes to the No Dispense
Next State.
If the cash dispenser is not present, is fatal or is in a suspend
condition when cash is requested, the state flow goes to the No
Dispense Next State.
If the cash dispenser is available but the coin dispenser is not
present, is fatal, or is in a suspend condition when coins or notes
and coins are requested, the state flow goes to the No Dispense
Next State.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-167
State Tables
z010 – Local Cash Dispense State
When notes have been dispensed and the number of notes
State Flow after an dispensed is unknown, the state goes to the Unknown Dispense
Unknown Dispense 2
Next State.
Unknown Dispense Examples
If the number of notes dispensed is unknown when only notes
are requested, the state flow goes to the Unknown Dispense
Next State.
If the number of notes dispensed is unknown when notes and
coins are requested, coins will not be dispensed and the state
flow goes to the Unknown Dispense Next State.
When this state has to eject the card before the cash is presented, the
State Flow on Card cash is presented only after the card is taken. If the ejected card is
Ejection 2
not taken by the consumer, the card is retracted and any currently
stacked notes are purged; then the No Dispense Next State exit is
taken. If the card reader is not able to eject the card, any currently
stacked notes are purged; then the No Dispense Next State exit is
taken.
The way in which the Local Cash Dispense state works is controlled
State Operation 2
by state table entry 7, operation mode. The state works in the same
way as corresponding Transaction Reply Function IDs in relation to
the following:
Cash stacking
Card ejection
Cash presentation
Coin dispense
Printing
Use of timers.
For example, if the value of state table entry 7 is 001, each of the
above device operations is processed in the same way as the
Transaction Reply function Dispense and Print (ʹ2ʹ or ʹ8ʹ).
CDI Stores 2
Before this state is executed, the idNotesToDispense and
idCoinsToDisp CDI stores have to be populated with the count of
notes and coins to dispense in this state. They are cleared on exit
from the state.
Cash dispense is based on the values stored in the
idNotesToDispense CDI array store. The number of notes to
dispense from the NDC cassette type 1 is stored in index 0 of the
array, the number of notes to dispense from NDC cassette type 2 is
stored in index 1 of the array and so on. To support up to 7 logical
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-168 APTRA™ Advance NDC, Reference Manual
State Tables
z010 – Local Cash Dispense State
cassettes, Enhanced Configuration Parameter option 76 must be set
to 1. For details of option 76, see “Option 76 – Cash Handlers” on
page 7‐19.
Coin dispense is based on the values stored in the idCoinsToDisp
CDI array store. The number of coins to dispense from NDC
Hopper Type 1 is stored in index 0 of the array, the number of coins
to dispense from the NDC Hopper Type 2 is stored in index 1 of the
array and so on.To support up to 8 hopper types, Enhanced
Configuration Parameter option 79 must be set to 1. For details of
option 79, see “Option 79 – Coin Dispenser” on page 7‐21.
Journaling and Printing 2
The Local Cash Dispense state supports cameras, APTRA Promote
and coupon printing.
The Offline Journal Print Buffer, Offline Receipt Print Buffer and
Offline Statement Print Buffer UCDI stores have to be populated
with print data if printing is required. The state prints data only if
the data is present in these stores and it is the application
developerʹs responsibility to populate them. Printer data in these
stores can have printer control characters. The stores are cleared on
exit from the state.
Only unsolicited status messages that are reported in a normal
dispense transaction reply function are journaled. Additional
journaling identifies that the transaction is a local dispense
operation and provides more information as follows:
A security trace message (*NNN*dd/mm/yy*HH.MM*) is journaled
followed by LOCAL CASH DISPENSE STATE.
Except for function ID names, such as Card Before Cash, and the
journal message E0022, all messages are journaled with a timestamp.
For details of the additional journal messages, see “‘j’ Supervisor
and Journal Miscellaneous Screens” on page A‐95.
Status Updates and Counts 2
The Last Transaction Status data that is reported in a Transaction
Request message is not updated by this state. The notes dispensed
counts in unsolicited messages are not updated by this state.
This state updates the following counts in the same way as normal
dispense operations:
Notes in Cassettes
Notes Rejected
Notes Dispensed
Coins Remaining
Coins Dispensed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-169
State Tables
z010 – Local Cash Dispense State
The Local Cash Dispense state does not send all the status messages
Message Handling 2
for the cash dispenser, coin dispenser and card reader if their status
changes during a dispense operation.
Unsolicited Status Messages 2
Only unsolicited status messages that are reported in a normal
dispense transaction reply function are sent to the host. Unsolicited
messages for retract operations are not sent to the host in case they
are interpreted as meaning that the cash dispensed in the last
host‐controlled cash dispense transaction has been retracted. For the
cash dispenser and coin dispenser, additional unsolicited messages
with device status 0 may be sent.
Solicited Status Messages
As solicited status messages are not sent to the host nor journaled,
some error conditions are not reported. For example, the host is not
always informed when a device enters a fatal condition; however
the fatal status will be reported in the next host‐controlled dispense
transaction.
Counts 2
In the response to the Send Supply Counters terminal command, the
following fields always report the current counts in the SST:
Notes in Cassettes
Notes Rejected
Notes Dispensed
Coins Remaining
Coins Dispensed.
The following fields should always report the dispensed counts for
the last host‐controlled transaction, that is, cash dispensed in
response to a Transaction Reply from the host:
Last Transaction Notes Dispensed
Last Transaction Coins Dispensed.
Table 2-90
z010 – Local Cash Dispense State
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘z’ — Master Expansion State
2 3 Subtype 010
3 3 Please Wait Screen Displayed when notes are being stacked. If a spray dispenser is
(Range 000‐ Z99) present this screen is not displayed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-170 APTRA™ Advance NDC, Reference Manual
State Tables
z010 – Local Cash Dispense State
Table No. of
Contents Description
Entry Chars
4 3 Take Card Screen Displayed when the card is ejected. This screen is not displayed if
(Range 000‐Z99) the card is not returned or there is no card in the reader
5 3 Take Notes Screen Displayed when the notes are presented. If a spray dispenser is
(Range 000‐Z99) present, this screen is displayed when the dispense operation starts
to dispense notes.
6 3 Take Coins Screen Displayed when the coins are dispensed
(Range 000 ‐ Z99)
7 3 Operation Mode Specifies how the state is to operate, as follows:
(Range 001 to 004) 001 ‐ Dispense and print without ejecting card
002 ‐ Eject card, then dispense and print ‐ card before cash
003 ‐ Card before parallel dispense and print
004 ‐ Parallel dispense, print and card eject.
8 3 Extension State 1 State number for extension state 1
See “Extension 1 to State z010”
9 3 Must be 000 Reserved
Table 2-91
Extension 1 to State z010
Table No. of
Contents Description
Entry Chars
1 1 State Type Z
2 3 Good Dispense Next State number the SST goes to when the amount of cash requested
State Number has been dispensed
(Base 10 range 000‐254 or
256‐999
Base 36 range 000‐254 or
256‐ZZZ)
3 3 Short Dispense Next State number the SST goes to when the cash dispensed is less than
State Number the cash requested
(Base 10 range 000‐254 or
256‐999
Base 36 range 000‐254 or
256‐ZZZ)
4 3 No Dispense Next State State number the SST goes to when no cash is dispensed.
Number
(Base 10 range 000‐254 or
256‐999
Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-171
State Tables
z010 – Local Cash Dispense State
Table No. of
Contents Description
Entry Chars
5 3 Unknown Dispense Next State number the SST goes to when the number of notes dispensed
State Number is unknown
(Base 10 range 000‐254 or
256‐999
Base 36 range 000‐254 or
256‐ZZZ)
6 3 Must be 000 Reserved
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-172 APTRA™ Advance NDC, Reference Manual
State Tables
z013 – Data Copy and Compare State
z013 – Data Copy and Compare State 2
The Data Copy and Compare state is used to process the data in
Buffer B, Buffer C and the Amount buffer as follows:
To compare the data in two buffers for validation purposes
To copy the data in one buffer to a second buffer, that is, from a
source buffer to a destination buffer.
This state allows data entered by the consumer to be processed
locally on the SST rather than by the host.
For example, when data is entered by the consumer for the first time
in the Information Entry state ‘H’, it is copied to one buffer. When
the data is re‐entered, it is copied to another buffer. The two buffers
can then be compared using the Data Copy and Compare state. If
the values in the two buffers are identical, the data is valid.
Table 2-92
z013 – Data Copy and Compare State
Table No. of
Contents Description
Entry Chars
1 1 State Type ʹzʹ ‐ Master Expansion State
2 3 Subtype ʹ013ʹ ‐ Data Copy and Compare State
3 3 Operation Identifier Specifies the type of operation to be performed.
Valid values are as follows:
001 ‐ Copy from a source buffer to a destination buffer (see “Copy
Operations” on page 2‐175)
002 ‐ Compare buffers (case insensitive)
003 ‐ Compare buffers (case sensitive)
4 3 Copy/Compare Good State number to which the SST proceeds after either of the
Next State Number following:
(Base 10, range 000‐254 or A successful data copy
256‐999)
For a data comparison, the two buffers have identical values.
(Base 36, range 000‐254 or
256‐ZZZ)
5 3 Error Next State Number State number to which the SST proceeds if either of the following
(Base 10, range 000‐254 or errors occurs when the Operation Identifier is 001 (copy):
256‐999) The source buffer length is greater than the destination buffer
(Base 36, range 000‐254 or length
256‐ZZZ
An attempt has been made to copy alphanumeric data to the
Amount buffer.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-173
State Tables
z013 – Data Copy and Compare State
Table No. of
Contents Description
Entry Chars
6 3 Extension State 1 State number for extension state 1.
(Base 10, range 000‐254 or
256‐999)
(Base 36, range 000‐254 or
256‐ZZZ)
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Extension state 1 defines Buffer ID 1, Buffer ID 2, and the next state
numbers to be used when the buffer data values are not identical in
data comparisons. When the two buffers have identical data or
when the data from Buffer ID 1 is copied successfully to Buffer ID 2,
the SST proceeds to the Copy/Compare Good next state.
The following sections on the next page give more information
about the two operations:
“Copy Operations”
“Compare Operations”.
Table 2-93
Extension 1 to State z013
Table No. of
Contents Description
Entry Chars
1 1 State type ‘Z’ (5AH)
2 3 Buffer ID 1 Specifies the buffer to be used as the source buffer for a copy
operation or the left‐hand side of a compare operation.
Valid values are as follows:
001 ‐ Buffer B
002 ‐ Buffer C
003 ‐ Amount buffer
3 3 Buffer ID 2 Specifies the buffer to be used as the destination buffer for the copy
operation or the right‐hand side of the compare operation.
Valid values are as follows:
001 ‐ Buffer B
002 ‐ Buffer C
003 ‐ Amount buffer
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-174 APTRA™ Advance NDC, Reference Manual
State Tables
z013 – Data Copy and Compare State
Table No. of
Contents Description
Entry Chars
4 3 Buffer ID1 Greater Than Used only for data comparisons.
Buffer ID2 Next State State number to which the SST proceeds when the data value in
Number Buffer ID 1 is greater than the data value in Buffer ID 2
(Base 10, range 000‐254 or
256‐999)
(Base 36, range 000‐254 or
256‐ZZZ)
5 3 Buffer ID1 Less Than Used only for data comparisons
Buffer ID2 Next State State number to which the SST proceeds when the data value in
Number Buffer ID 1 is less than the data value in Buffer ID 2.
(Base 10, range 000‐254 or
256‐999)
(Base 36, range 000‐254 or
256‐ZZZ)
6 3 Must be 000 Reserved
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
The following conventions apply to copy operations:
Copy Operations 2
Only numeric data can be copied to the Amount buffer.
If the data being copied to the Amount buffer is less than the
Amount buffer length, then the required number of leading
zeros is added to make it a fixed length of either 8 or 12
characters. The length can be specified through AppendBuffer.xml
or Enhanced Configuration Parameter option 1.
If the data being copied from the Amount buffer to Buffer B or
Buffer C contains any leading zeros, all the data including the
zeros is copied to the destination buffer.
If the data being copied to the Amount buffer from Buffer B or
Buffer C has one or more leading or trailing spaces, the spaces
are ignored. Only the numeric part of the data without spaces is
copied to the Amount buffer
When data is copied to Buffer B or Buffer C, the full buffer is
copied including any spaces.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-175
State Tables
z013 – Data Copy and Compare State
Buffer comparison is done character by character using the ASCII
Compare Operations 2
values of the characters. ASCII values are checked first, then length.
The following examples show the outcome of possible comparisons:
Data values of different types:
Buffer ID 1 = ʺ1234ʺ; Buffer ID 2 = ʺxyzʺ
The ASCII value of the first numeric character in Buffer ID 1 is
less than the ASCII value of the first alphabetic character in
Buffer ID 2 so the state number specified in table entry 5 of the
extension state (Buffer ID1 Less Than Buffer ID2) is taken.
Data values of the same type and length
Buffer ID 1 = ʺABCʺ; Buffer ID 2 = ʺabcʺ
If the Operation Identifier = 002, case is ignored and the data
values are treated as identical, so the state number specified in
table entry 4 of the primary state table (Copy/Compare Good
Next State) is taken.
If the Operation Identifier = 003, case is taken into account
during the comparison. The ASCII value of the first character in
Buffer ID 1 is less than the ASCII value of the first character in
Buffer ID 2, so the state number specified in table entry 5 of the
extension state is taken.
Data values of different lengths:
Buffer ID 1 = ʺxyzaaʺ; Buffer ID 2 = ʺxyzʺ
As there is a fourth character in Buffer ID 1 but Buffer ID 2 does
not have a fourth character, the value in Buffer ID 1 is greater
than Buffer ID 2 so the state number specified in table entry 4 of
the extension state (Buffer ID1 Greater Than Buffer ID2) is taken.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-176 APTRA™ Advance NDC, Reference Manual
State Tables
z014 – Cash Deposit Handling State
z014 – Cash Deposit Handling State 2
This state supports off‐line deposit and refund of notes during
cash‐in transactions, that is, these transactions are completed
without host interaction. This state offers similar functionality to the
Deposit Media and Refund Media transaction reply functions to
complete a transaction where notes have been accepted during the
Cash Accept State. It is an alternative to those Transaction Reply
functions, offering an off‐line option to handle the notes.
Refundable notes, that is, notes still in the escrow, can be refunded
or deposited. For notes accepted during a direct deposit, the refund
option is not available.
The state flow has to be designed to avoid using the refund option
for direct deposit transactions as the notes are not refundable.
Journaling 2
Two messages are journaled each time the state is run. The first
message journals the start of the state, which includes the function
requested and the second gives the completion result.
This journaling is only done if the journal level is 3.
Data Printing 2
Print data is output in parallel when the device starts the encash
operation, and after notes are taken in the refund function, or after
an error occurs during a refund.
Off‐line receipt printing is called from the following print points:
OfflineDeposit
OfflineRefundSuccess
OfflineRefundFailed.
Equivalent journal entries are output by default.
For more information about customising or configuring this print
output, refer to Chapter 10, “Developing Hooks” in APTRA Advance
NDC, Extending the Product.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-177
State Tables
z014 – Cash Deposit Handling State
Table 2-94
z014 – Offline Encash/Refund State
Table No. of
Contents Description
Entry Chars
1 1 State Type ʹzʹ ‐ Master Expansion State
2 3 Subtype ʹ014ʹ ‐ Cash Deposit Handling State
3 3 Function ID (000 ‐ 001) Specifies the type of operation to perform:
ʹ000ʹ ‐ Encash
ʹ001ʹ ‐ Refund
4 3 Processing Items Screen This screen is displayed while the items are being encashed or
(000 ‐ Z99) refunded
5 3 Please Remove Items This screen is displayed when the Cash Acceptor has returned
Screen items to the cardholder. Only used in the Refund Function.
(000 ‐ Z99)
6 3 Retracting Items Screen This screen is displayed during the retract operation, which occurs
(000 ‐ Z99) if the Presented items are not taken before timer 78 expires, and
option 45 is configured to enable retract operations. Only used in
the refund Function.
7 3 Extension State 1 State number for extension 1
(000‐ZZZ)
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Note: The handling of counts in this state matches how the counts
are updated in the Close state. The Last Transaction Counts are not
updated and the updating of counts is not authorised by the host.
For the encash function, the deposit is treated as authorised off‐line,
in the same way as notes encashed in the Close state are treated.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-178 APTRA™ Advance NDC, Reference Manual
State Tables
z014 – Cash Deposit Handling State
Table 2-95
Extension 1 to State z014
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘Z’ (5AH)
2 3 Good Next State Number State number the SST goes to after a successfully completed
(000‐ZZZ) operation.
For the encash function, this is after the encash operation is
completed successfully.
For the refund function, this is after the final bunch of refunded
items is taken.
3 3 Device Error Next State State number the SST goes to when an error occurs during either
Number (000‐ZZZ) the encash operation or the refund operation
4 3 Timeout Next State State number the SST goes to if items are not taken. If retract is
Number enabled, this follows after completion of the retract operation,
(000‐ZZZ) otherwise this exit is taken as soon as timer 78 expires.
5 3 Must be 000 Reserved
6 3 Must be 000 Reserved
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-179
State Tables
z017- Note Mix Selection State
z017‐ Note Mix Selection State 2
Use this state if you wish to allow the consumer to select the note
mix to be dispensed.
This state maps denominations to FDKs allowing the consumer to
specify the amount and the note mix to dispense. The amount is
increased by the denomination mapped to the FDK each time the
consumer selects the key.
Exit from the Note Mix Selection state occurs on a time‐out or when
one of the following keys is pressed:
Enter
Cancel
A Next State FDK
Table entry 4 of extension 1 defines the next state to progress to
when the Enter key is pressed. The Clear key is always active; if it is
pressed the amount entered and the screen echo are cleared.
The standard field length for the Amount buffer is eight digits, or
twelve if Enhanced Configuration Parameter option 1 is used; but it
can be configured for any number up to twelve digits through
AppendBuffer.xml. If the consumer selects further denomination
FDKs after the configured number of digits is reached, the buffer is
cleared and the amount is reset to 0. A parameter in
AppendBuffer.xml can be configured to prevent clearing of the
amount when the configured limit is reached.
If required by the host, the screen can be configured to add extra
zeros automatically to the amount buffer, after the decimal point.
This configuration is defined in the AppendBuffer.xml file. The file
can be downloaded, as described in “XML Configuration
Download” on page 10‐49, or can be installed locally.
For details of AppendBuffer.xml, refer to the APTRA Advance NDC,
Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-180 APTRA™ Advance NDC, Reference Manual
State Tables
z017- Note Mix Selection State
Table 2-96
z017- Note Mix Selection State
Table Number of
Contents Description
Entry Characters
1 1 State Type ʹzʹ ‐ Master Expansion State
2 3 Sub Type ʹ017ʹ ‐ Note Mix Selection State
3 3 Screen Number Number of display screen prompting an amount
(Range 000‐Z99) entry.
4 3 Extension State 1 State number for extension 1
(Base 10 range 000‐254 or 256‐999) See “Extension 1 to State z017” on page 2‐182
(Base 36 range 000‐254 or For more information about extension states, see
256‐ZZZ) “Extension States” on page 2‐6.
5 3 Extension State 2 State number for extension 2
(Base 10 range 000‐254 or 256‐999) See “Extension 2 to State z017” on page 2‐183
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 Extension State 3 State number for extension 3
(Base 10 range 000‐254 or 256‐999) See “Extension 3 to State z017” on page 2‐185
(Base 36 range 000‐254 or
256‐ZZZ)
7 3 Extension State 4 State number for extension 4
(Base 10 range 000‐254 or 256‐999) See “Extension 4 to State z017” on page 2‐186
(Base 36 range 000‐254 or
256‐ZZZ)
8 3 Reserved (000) Reserved for future use.
9 3 Reserved (000) Reserved for future use.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-181
State Tables
z017- Note Mix Selection State
Table 2-97
Extension 1 to State z017
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Timeout Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or fails to enter an amount within the specified time
256‐999) limit.
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Cancel Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or presses the Cancel key.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Enter Next State Number State number to which the SST goes if the consumer
(Base 10 range 000‐254 or presses the Enter key.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 No Cassette Types Available State number to which the SST goes if no cassette
Next State Number type values specified in “Extension 3 to State z017”
(Base 10 range 000‐254 or are available.
256‐999) This can occur because of the following:
(Base 36 range 000‐254 or No dispenser is present
256‐ZZZ) The dispenser is in a fatal condition
All cassette types are missing or in a fatal
condition
Cassette types 5 to 7 are used, but Enhanced
Configuration option 76 is set to 000 (four
cassette types)
Extension 3 cannot be found.
6 3 Keyboard Input Timeout Specifies the time‐out value for this state:
(Range 000‐255) ʹ000ʹ ‐ Use timer 0
ʹ001ʹ to ‘255’ ‐ Specifies the time‐out to use in
seconds
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-182 APTRA™ Advance NDC, Reference Manual
State Tables
z017- Note Mix Selection State
Table 2-98
Extension 2 to State z017
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 Next State FDK Flags This field specifies the FDKs used to select the next
(Range 000‐255) state
Each bit relates to an FDK; Bit 0 relates to FDK A,
Bit 7 relates to FDK I.
If a bit is 1, the corresponding FDK in “Extension 3
to State z017” specifies the next state number.
3 3 Note Selection FDK Flags This field specifies the FDKs used to select NDC
(Range 000‐255) cassette types
Each bit relates to an FDK; Bit 0 relates to FDK A,
Bit 7 relates to FDK I.
If a bit is 1, the corresponding FDK in “Extension 3
to State z017” specifies an NDC cassette type
4 3 Amount Display Screen Overlay screen to set the cursor position and
Number optionally defines the initial display format before
(Range 000‐Z99) amount entry or edit by the consumer
The cursor must be set to the left side of the echo
field on the display, which is space‐filled until the
required start position for the currency character is
reached
The default echo field is bbbbb$b0.00, where b
represents a space
If the option to extend the Amount buffer to 12
digits is selected, the amount entry screen position
must reflect this. The default screen is
bbbbbbbbb$b0.00, where b represents a space.
The amount entry screen is not adjusted for
language unless a language has been selected and
the language group size is equal to or greater than
1000. For more information on language screens,
see “Multi‐Language Screens” on page 3‐48.
For more information on amount display, see
“International Currency Display Format” on
page 3‐45
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-183
State Tables
z017- Note Mix Selection State
Table Number of
Contents Description
Entry Characters
5 3 Language Dependency and This flag determines if the screens defined in table
Overlay Screen Flag entry 4 of this extension state and table entries 2 to
(Range 000‐003) 9 of “Extension 4 to State z017”are language
dependent and whether overlay screens are to be
used for the note selection FDKs:
000 ‐ Not language dependent. Use overlay screens
for note selection FDKs.
001 ‐ Language dependent, regardless of language
group size. Use overlay screens for note selection
FDKs.
002 ‐ Not language dependent. Do not use overlay
screens for note selection FDKs.
003 ‐ Language dependent, regardless of language
group size. Do not use overlay screens for note
selection FDKs
6 3 Amount Buffer This field determines which buffer the amount
(Range 000‐002) entered will be stored in, as follows:
000 ‐ Amount buffer
001 ‐ Buffer B
002 ‐ Buffer C
7 3 Note Mix Buffer This field determines which buffer the note mix
(Range 000‐002) entered will be stored in, as follows:
000 ‐ Not stored
001 ‐ Buffer B
002 ‐ Buffer C
See Table Note 94 and Table Note 95
8 3 Maximum Number of Notes This field determines the maximum number of
(Range 000‐200) notes that can be included in the note mix when the
note selection FDKs are used. This effectively
restricts the number of times the FDKs can be
pressed to add notes to the mix.
If this field is set to 000 or a value greater than the
device can support, the device capabilities define
the maximum number of notes that can be
dispensed in a single operation.
See Table Note 96
9 3 Must be 000 Reserved
Table Note 94: If Enhanced Configuration option 76 is set to 000,
the format of the note mix data is AAABBBCCCDDD. If Enhanced
Configuration option 76 is set to 001, the format of the note mix data
is AAABBBCCCDDDEEEFFFGGG. Each letter in these example formats
represents the number of notes required from that cassette type,
either 4 cassette types (A to D) or 7 cassette types (A to G). For
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-184 APTRA™ Advance NDC, Reference Manual
State Tables
z017- Note Mix Selection State
example, if the characters CCC were 012, this would indicate that 12
notes from cassette type 3 are required.
Table Note 95: If the same buffer is specified in both the Note Mix
Buffer field and the Amount Buffer field, the amount is stored in the
buffer specified in table entry 6 (the Amount buffer field) but the
note mix is not stored.
Table Note 96: In the Transaction Reply, only two digits are
available for each note type in the dispense function.
Table 2-99
Extension 3 to State z017
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 FDK A Depending on table entries 2 and 3 of “Extension 2
(Range 000‐ZZZ) to State z017”, contains either a next state number
or an NDC cassette type.
3 3 FDK B
(Range 000‐ZZZ) If the FDK specifies a next state, the range is as
follows:
4 3 FDK C Base 10 range 000‐254 or 256‐999
(Range 000‐ZZZ) Base 36 range 000‐254 or 256‐ZZZ
5 3 FDK D
(Range 000‐ZZZ) If the FDK specifies an NDC cassette type, the valid
range is 1‐7 and the following apply:
6 3 FDK F If the specified cassette type is not present in the
(Range 000‐ZZZ) dispenser or all cassettes of that type are in a fatal
7 3 FDK G condition, the FDK is not enabled
(Range 000‐ZZZ) If the cassette type is in the range 5‐7, Enhanced
Configuration option 76 must be set to 001
8 3 FDK H
If the cassette type is outside the valid range, the
(Range 000‐ZZZ)
FDK is not enabled.
9 3 FDK I
(Range 000‐ZZZ) The FDK is not enabled in the following situations:
It is not specified in either table entry 2 or 3 of
“Extension 2 to State z017”
It is specified in both table entry 2 and 3 of
“Extension 2 to State z017”
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-185
State Tables
z017- Note Mix Selection State
Table 2-100
Extension 4 to State z017
Table Number of
Contents Description
Entry Characters
1 1 State Type ‘Z’
2 3 FDK A Overlay Screen Specifies the overlay screen to display when table
(Range 000‐Z99) entry 3 of “Extension 2 to State z017” specifies the
FDK as a note selection FDK.
3 3 FDK B Overlay Screen
(Range 000‐Z99) The FDK is enabled if table entry 5 of “Extension 1
to State z017” is set to 000 or 001 (use overlay
4 3 FDK C Overlay Screen screens).
(Range 000‐Z99)
The FDK is not enabled and the overlay screen is
5 3 FDK D Overlay Screen not applied if table entry 5 of “Extension 1 to State
(Range 000‐Z99) z017” is 002 or 003 (do not use overlay screens). In
this situation, a textual representation of the
6 3 FDK F Overlay Screen selected amount is displayed next to the FDK in the
(Range 000‐Z99) current font. The displayed amount is the value of
7 3 FDK G Overlay Screen the note in the cassette type specified in “Extension
(Range 000‐Z99) 3 to State z017”.
8 3 FDK H Overlay Screen If the FDK is not a note selection FDK or the FDK is
(Range 000‐Z99) not enabled, no overlay screen or textual
representation of the amount is displayed.
9 3 FDK I Overlay Screen
(Range 000‐Z99) No overlay screen is applied in the following
situations:
The FDK is not specified in table entry 3 of
“Extension 2 to State z017”
The FDK is specified in both table entry 2 and 3
of “Extension 2 to State z017”
The amount entry screen is not adjusted for
language unless a language has been selected and
the language group size is equal to or greater than
1000. For more information on language screens,
see “Multi‐Language Screens” on page 3‐48.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-186 APTRA™ Advance NDC, Reference Manual
State Tables
z020 - FIT Search State
z020 ‐ FIT Search State 2
The FIT Search state is a generic state that is used to carry out a
search on financial institution tables. If the FIT matches, the Card
Inserted Customer Relationship Management (CRM) flow point is
invoked and the Good FIT match next state exit is taken, else it goes
to the No FIT Match next state. The FIT Search state supports
APTRA Promote and APPTRA Relate.
For more information on CRM, refer to the following in the APTRA
Advance NDC, Developer’s Guide:
Chapter 1, “Introducing Advance NDC”, section “Customer
Relationship Management”
Chapter 5, “Configuring Advance NDC and Associated
Components”.
Note: The K ‐ FIT Switch state also performs a search in financial
institution tables and is used when calling the CRM flow point is
not required. For more details, see the “K ‐ FIT Switch State” on
page 2‐52 and “Financial Institution Tables” on page 8‐1.
The FIT Search state exit depends on the outcome of the search, as
FIT Search State Exit 2
follows:
If the FIT search is successful, the Good FIT Match Next state
(state table entry 3) is taken. In this case, the Card Inserted CRM
flow point is invoked when APTRA Promote is enabled and its
CRM Flow Point flag (state table entry 5) is set to ‘001’. For more
information on flow points, refer to APTRA Promote, User’s
Guide, Appendix C, “Flow Points and Coupon Support”. This
publication is provided with the APTRA Promote software.
If the FIT search is not successful, the No FIT Match Next state
(state table entry 4) exit is taken and a CRM Cancelled event is
returned.
If the FIT search is not defined, the Good FIT Match Next state
(state table entry 3) exit is taken. In this case, the No FIT Match
Next state (state table entry 4) must be ‘000’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-187
State Tables
z020 - FIT Search State
Table 2-101
FITSearch State ‘z020’
Table
Length Contents Description
Entry
1 1 ‘z’ (7AH) Master Extension State
2 3 State subtype 020
3 3 Good FIT Match Next State State number to which the SST goes in either of the following
Number situations:
(Base 10 range 000‐254 or Following a good read of the card if FITs are not used
256‐999) (Table entry 4 = 000)
(Base 36 range 000‐254 or If the Financial Institution number on the track data
256‐ZZZ) matches a Financial Institution number in a FIT
4 3 No FIT Match Next State number to which the SST goes if the Financial Institution
State Number number on the card does not match any FIT.
(Base 10 range 000‐254 or If FITs are not used, this entry must be 000.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 CRM Flow Point flag Call to “Card Inserted” CRM flow point as follows:
‘000’ ‐ Do not call the CRM flow point
‘001’ ‐ Call the CRM flow point, when FIT search is success
6 3 Must be 000 Reserved
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-188 APTRA™ Advance NDC, Reference Manual
State Tables
z021 - CRM Flowpoint State
z021 ‐ CRM Flowpoint State 2
The CRM Flowpoint State is used to call the specified CRM
flowpoint based on the configuration defined in the
CRMFlowpoints.xml file. In this state, once the CRM flowpoint is
executed, either a campaign or package is displayed based on the
configuration in APTRA Promote or APTRA Relate respectively.
For more information on CRM, refer to the following in the APTRA
Advance NDC, Developer’s Guide:
Chapter 1, “Introducing Advance NDC”, section “Customer
Relationship Management”
Chapter 5, “Configuring Advance NDC and Associated
Components”.
When the Flowpoint Index (table entry 3) is in a range of 001 – 255
CRM Flowpoint State 2
and if it matches with any of the Flowpoint Index defined in the
CRMFlowpoints.xml file, then this state will execute as follows:
The corresponding CRM flowpoint defined in the
CRMFlowpoints.xml file is invoked.
If the property name is ConsumerID and a valid corresponding
StoreID is defined in the XML, the ConsumerID is overwritten
by a value in StoreID and it is used in campaign loading.
If the CRM configuration for APTRA Promote is enabled and a
campaign configured for the flowpoint index is available, the
corresponding campaign is displayed till time‐out or if the CRM
configuration for APTRA Relate is defined, the corresponding
package if available is displayed till time‐out. The relate package
can be interactive and allows user inputs as well.
Finally, the CRM flowpoint Next State (state table entry 4) is
taken.
When the Flowpoint Index (table entry 3) of CRM flowpoint state is
000 or if it does not match with any of the flowpoint index defined
in the CRMFlowpoints.xml file or if the defined flowpoint in
CRMFlowpoints.xml is an invalid flowpoint, then no CRM flowpoint is
called and CRM flowpoint Next State (state table entry 4) exit is
taken.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-189
State Tables
z021 - CRM Flowpoint State
Table 2-102
‘z021-CRM Flowpoint State’
Table
Length Contents Description
Entry
1 1 ‘z’ (7AH) Master Extension State
2 3 State subtype 021
3 3 Flow point Index Defines the identifier of the CRM flowpoint ID in the
(Range 001‐255) CRMFlowpoints.xml file that should be applied to call the
appropriate CRM flowpoint.
4 3 CRM Flowpoint Next State State number to which the SST goes.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Must be 000 Reserved
6 3 Must be 000 Reserved
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-190 APTRA™ Advance NDC, Reference Manual
State Tables
z024 - Prepare Dispense State
z024 ‐ Prepare Dispense State 2
The Prepare Dispense State is used when the host knows that a
dispense transaction is going to happen and prepares for the
dispense operation. Prepare Dispense can instead be issued as part
of Card Read State A and Card Read ‐ PIN Entry Initiation state T.
For further information refer to section “Carriage Sweep” in
Chapter 5, “Configuring Advance NDC and Associated
Components” of the APTRA Advance NDC, Developer’s Guide.
Table 2-103
‘z024-Prepare Dispense State’
Table
Length Contents Description
Entry
1 1 State Type ‘z’ ‐ Master Extension State
2 3 State subtype ‘024’ ‐ Prepare Dispense State
3 3 Complete Next State State number to which terminal goes after Prepare Dispense
is started
4 3 Must be 000 Reserved
5 3 Must be 000 Reserved
6 3 Must be 000 Reserved
7 3 Must be 000 Reserved
8 3 Must be 000 Reserved
9 3 Must be 000 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-191
State Tables
& - Barcode Read State
& ‐ Barcode Read State 2
The Barcode Read state allows an application to read a barcode.
Optionally a filter can be used to select an alternative flow, based on
the barcode content.
When this state is entered, the screen identified by table entry 1 is
displayed and the barcode reader is enabled.
The barcode filters are defined in the barcode reader configuration
file, which can be downloaded using the XML configuration
download described on page 10‐49. For details of the barcode reader
configuration file refer to the Advance NDC, Developer’s Guide.
The downloaded filters are compared to the barcode, starting in
sequence from filter index zero. If a barcode is successfully read,
and filter exit extension states are defined, the barcode is checked
against the barcode reader configuration file as follows:
If a barcode filter in the configuration file matches the barcode
read state, the exit defined in the extension states in the filter
index is taken.
If the state number for the matched barcode filter is set to ‘000’
or ‘255’, the Good Barcode Read exit is taken
If the barcode does not match any filter, there are no filters
defined, or there is no next state defined in the filter index, the
Good Barcode Read exit is taken.
Note Once the barcode is successfully read, and state table entry 7
has a valid value, the barcode data is copied to the corresponding
buffers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-192 APTRA™ Advance NDC, Reference Manual
State Tables
& - Barcode Read State
Table 2-104
& - Barcode Reader State
Table No. of
Contents Description
Entry Chars
1 1 ‘&’ (26H) State Type
2 3 Screen Number (Range Display screen prompting the consumer to scan a barcode.
000‐Z99)
3 3 Good barcode Read State State number the SST goes to if a barcode has successfully been
Number read and no Barcode Filter matches, or there is no exit defined
(Base 10 range 000‐254 or for the Barcode Filter Index in the Extension States.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Cancel Next State Number State number that the SST goes to if the barcode scan was
(Base 10 range 000‐254 or cancelled by the customer.
256‐999)
(Base 36 range 000‐254 or See Table Note 97
256‐ZZZ)
5 3 Error Next State Number State number that the SST goes to if there is a problem reading
(Base 10 range 000‐254 or the barcode, for example a barcode reader hardware or barcode
256‐999) reader configuration error.
(Base 36 range 000‐254 or
256‐ZZZ) See Table Note 98
6 3 Timeout Next State Number State number that the SST goes to if the barcode scan times out.
(Base 10 range 000‐254 or
256‐999) See Table Note 99
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-193
State Tables
& - Barcode Read State
Table No. of
Contents Description
Entry Chars
7 3 Barcode Data Destination Destination buffer for barcode data
(0‐7) 000 ‐ Track3 buffer (default — max 106 bytes)
001 ‐ Track1 buffer (max 78 bytes)
002 ‐ Track2 buffer (max 39 bytes)
003 ‐ General Purpose buffers A and B (max 64 bytes)
004 ‐ General Purpose buffers B and C (max 64 bytes)
005 ‐ General Purpose buffers C and A (max 64 bytes)
006 ‐ Barcode reader buffer identified by the character ‘e’ (max
size limited by message size)
007 ‐ Amount buffer (max 8 or 12 bytes, depending on
configuration).
See Table Note 100, Table Note 101, and Table Note 102.
8 3 Active Cancel FDK key mask The FDK keys(s) enabled to cancel the barcode scanning
(Range 0‐255) process. The Cancel key on the PINPad will always be enabled if
a Cancel exit is defined.
9 3 Extension State 1 Extension state 1 allows additional parameters to be added in
(Base 10 range 000‐254 or the future, as all parameters in extension states 2 to N contain
256‐999) the Barcode Filter exit values.
(Base 36 range 000‐254 or
256‐ZZZ) For more information about extension states, see “Extension
States” on page 2‐6.
Table Note 97: The Cancel key and associated FDK are enabled if a
Cancel next state exit is defined. If the consumer presses Cancel, the
device is disabled and the Cancel next state exit is taken.
Table Note 98: If a barcode cannot be read because of a technical
problem, or the barcode reader is not present, the Error next state is
taken. An unsolicited status message is sent to report the device
fault.
Table Note 99: If the time‐out defined by Timer 61 expires or a
hardware time‐out occurs, the internal Time‐Out state is taken to
request more time. If the request is successful the barcode reader is
enabled. If the request is denied, the time‐out next exit state is taken.
Table Note 100: If the scanned barcode data exceeds the fixed
length of the destination buffer size, it will be truncated to the
length of the buffer.
Table Note 101: If option 3, 4 or 5 is selected, and the length of the
scanned barcode data exceeds 32 bytes, it will be split across the two
buffers and truncated at 64 bytes.
Table Note 102: When a barcode is successfully read it is placed in
the buffer specified by Barcode Data Destination. If the specified
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-194 APTRA™ Advance NDC, Reference Manual
State Tables
& - Barcode Read State
destination buffer is unknown, the SST will go to Error Next State
Number.
Table Note 103: Table 2-105
Extension 1 to State &
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘Z’
2 3 RuleID In Advance NDC, defines the identifier of the barcode
(Range 000‐999) extraction rule in NDCBarcodeReader.xml
3 3 Reserved Must be ‘000’
4 3 Reserved Must be ‘000’
5 3 Reserved Must be ‘000’
6 3 Reserved Must be ‘000’
7 3 Reserved Must be ‘000’
8 3 Reserved Must be ‘000’
9 3 Extension State 2 Extension state, ‘000’ if there is no extension state.
(Base 10 range 000‐254 or
256‐999) For more information about extension states, see “Extension
(Base 36 range 000‐254 or States” on page 2‐6.
256‐ZZZ)
Barcode Read Extension states 2‐8 provide a mechanism for
selecting a state flow branch based on the content of the barcode
read. The barcode filters, downloaded using the XML configuration
download, are compared against the barcode. When a match is
found, the index of the matching filter is used to select an exit.
Barcode Read Extension state 2 defines the exits for a barcode filter
match with an index equal to 0, 1, 2, 3, 4, 5, or 6; Barcode Read
Extension state 3 defines the exits for a barcode filter match with an
index equal to 7, 8, 9, 10, 11, 12, or 13, and so on. Up to 49 filters can
be defined.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-195
State Tables
& - Barcode Read State
Table 2-106
Extensions 2—8 to State &
Table No. of
Contents Description
Entry Chars
1 1 State Type ‘Z’
2 3 Next State for a Barcode State number that the SST goes to if the barcode matches the
Filter match with index = Barcode Filter with index equal to ((Extension state n ‐ 2)*7). If
((Extension State n ‐ 2)*7). this value is ‘000’ the Good Barcode Read Next State Exit is
(Base 10 range 000‐254 or taken when the filter matches.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
3 3 Next State for a Barcode State number that the SST goes to if the barcode matches the
Filter match with index = Barcode Filter with index equal to
((Extension State n ‐ 2)*7)+1. ((Extension state n ‐ 2)*7)+1.
(Base 10 range 000‐254 or If this value is ‘000’ the Default Barcode Read Next State Exit is
256‐999) taken when the filter matches.
(Base 36 range 000‐254 or
256‐ZZZ)
4 3 Next State for a Barcode State number that the SST goes to if the barcode matches the
Filter match with index = Barcode Filter with index equal to
((Extension State n ‐ 2)*7)+2. ((Extension state n ‐ 2)*7)+2.
(Base 10 range 000‐254 or If this value is ‘000’ the Default Barcode Exit is taken when the
256‐999) filter matches.
(Base 36 range 000‐254 or
256‐ZZZ)
5 3 Next State for a Barcode State number that the SST goes to if the barcode matches the
Filter match with index = Barcode Filter with index equal to
((Extension State n ‐ 2)*7)+3. ((Extension state n ‐ 2)*7)+3.
(Base 10 range 000‐254 or If this value is ‘000’ the Good Barcode Exit is taken when the
256‐999) filter matches.
(Base 36 range 000‐254 or
256‐ZZZ)
6 3 Next State for a Barcode State number that the SST goes to if the barcode matches the
Filter match with index = Barcode Filter with index equal to ((Extension state n ‐ 2)*7)+4.
((Extension State n ‐ 2)*7)+4. If this value is ‘000’ the Good Barcode Exit is taken when the
(Base 10 range 000‐254 or filter matches.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-196 APTRA™ Advance NDC, Reference Manual
State Tables
& - Barcode Read State
Table No. of
Contents Description
Entry Chars
7 3 Next State for a Barcode State number that the SST goes to if the barcode matches the
Filter match with index = Barcode Filter with index equal to
((Extension State n ‐ 2)*7)+5. ((Extension state n ‐ 2)*7)+5.
(Base 10 range 000‐254 or If this value is ‘000’ the Good Barcode Exit is taken when the
256‐999) filter matches.
(Base 36 range 000‐254 or
256‐ZZZ)
8 3 Next State for a Barcode State number that the SST goes to if the barcode matches the
Filter match with index = Barcode Filter with index equal to ((Extension state n ‐ 2)*7)+6.
((Extension State n ‐ 2)*7)+6. If this value is ‘000’ the Good Barcode Exit is taken when the
(Base 10 range 000‐254 or filter matches.
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
9 3 Next Extension State Extension State, ‘000’ signifies there are no more extension
(Base 10 range 000‐254 or states.
256‐999)
(Base 36 range 000‐254 or For more information about extension states, see “Extension
256‐ZZZ) States” on page 2‐6.
The barcode extraction rules are defined for Advance NDC in the
Barcode Extraction Rules 2
NDCBarcodereader.xml file. The parameters for the extraction rules
are as follows:
Rule ID
Pattern
DestinationDataOffset
The Pattern attribute is defined using regular expressions. For
more information about defining valid string formats using regular
expressions, refer to the Microsoft Developer’s Network page at
http://msdn.microsoft.com/en‐us/library/2k3te2cs(VS.80).aspx.
For more information on these parameters, refer to section,
“Barcode Reader Filter & Extraction Rules Configuration” in
Chapter 5, “Configuring Advance NDC and Associated
Components” of the APTRA Advance NDC, Developer’s Guide.
The data is extracted from the barcode data according to the rule
pattern and copied to the buffer specified in state table entry 7,
overwriting any existing contents from the position specified by the
DestinationDataOffset parameter when the following conditions
are true:
State table entry 7 of the Barcode Read state is 002.
Primary extension state table entry 2 matches the Rule ID.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-197
State Tables
& - Barcode Read State
The buffer specified is the Track 2 data store, which allows a FIT
search to be performed if required, using the FIT Search state.
The following scenarios illustrate how the extraction rules are
applied when the barcode data is not within the limits of a rule
pattern; when the barcode data is within the limits of the extraction
rules and its length does not exceed the Track 2 store data length;
and when it exceeds the length.
Scenario 1: Barcode Data not within the Limits of Rule
Pattern 2
If the barcode data is not within the limits of the rule pattern, the
complete barcode data is copied to the Track 2 data store
overwriting the existing contents, as shown in the following
example:
XML configuration
<BarcodeExtractionRules>
<Rule ID="123">
<!-Date validation Rule -->
<Pattern>
(?<=b[a-zA-z]{10})[0-9d]{20}
</Pattern>
<DestinationDataOffset>1</DestinationDataOffset>
</Rule>
…
…
…
</BarcodeExtractionRules>
Barcode data from the barcode:
912345000690001251=0892101222765874
Track 2 data store currently containing data from the
consumer’s card and with the offset position underlined:
612345000000001251=0512101222000000
Track 2 data store updated with the barcode data underlined
912345000690001251=089210122276587
Scenario 2: Length of Extracted Data Does not Exceed Track
2 Data Length 2
If the length of the extracted barcode data does not exceed the
length of the data in the Track 2 data store, the extracted data
overwrites the Track 2 data from the position defined by
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-198 APTRA™ Advance NDC, Reference Manual
State Tables
& - Barcode Read State
DestinationDataOffset of the barcode data as shown in the
following example:
XML configuration
<BarcodeExtractionRules>
<Rule ID="123">
<!-Date validation Rule -->
<Pattern>
(?<=[0-9]{8}).{4}
</Pattern >
<DestinationDataOffset>8</DestinationDataOffset>
</Rule>
</BarcodeExtractionRules>
Barcode data with data specified by the rule pattern underlined:
612345006996001251=0512101222006754
Track 2 data store currently containing data from the
consumer’s card with the offset position underlined:
612345000000001251=0512101222000000
Track 2 data store updated with the barcode data underlined
612345006996001251=0512101222000000
Scenario 3: Extracted Data Length Exceeds Track 2 Data
Length 2
If the length of the extracted barcode data exceeds the length of the
Track 2 data from the position defined by
DestinationDataOffset, the extracted barcode data overwrites
the Track 2 data store to the length available, as shown in the
following example:
XML configuration
<BarcodeExtractionRules>
<Rule ID="123">
<!-Date validation Rule -->
<Pattern>
(?<=b[0-9]{10})[0-9a-z]{20}
</Pattern >
<DestinationDataOffset>20</DestinationDataOffset>
</Rule>
…
</BarcodeExtractionRules>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-199
State Tables
& - Barcode Read State
Barcode data with the data specified by the rule pattern
underlined:
b612345000000001251705121012d22000000654654675
Data in the Track 2 data store with the offset position
underlined:
612345000000001251=0512101222000000
Extracted barcode data with the length underlined
corresponding to the length of the Track 2 data store from the
specified offset position:
00001251705121012d22
Updated Track 2 data store with the barcode data underlined
612345000000001251=00001251705121012d2
(Track 2 data store maximum size is 39).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-200 APTRA™ Advance NDC, Reference Manual
State Tables
Time-Out State
Time‐Out State 2
The SST has a fixed Time‐Out state. This is entered under one of the
conditions described in the following table:
Table 2‐107 Entry
Description
Entry Conditions for the Time-Out State Condition
1 Timer 00 expires during a keyboard data entry state
2 Timer 04 expires during an envelope deposit
transaction (envelope not inserted)
3 Timer 08 expires during a night safe deposit
transaction
4 A screen timer from an Interactive Transaction
Response message expires while the numeric keypad
or the FDKs are active
5 Timer 61 expires during a barcode reader scan
6 The consumer fails to remove an envelope within the
period specified by timer 94
7 A time‐out occurs during a Cash Accept state
8 A time‐out occurs during a Cheque Accept state or
Bunch Cheque Accept state
For more details of timers, see “Timers” on page 7‐24 and
“Configuration Parameters Load” on page 10‐15.
On entry to the Time‐Out state, screen ‘C00’ is displayed, giving the
consumer the option of more time. Timer 01 and the fast beep are
started. For more details, see “Redefining Reserved Screens” on
page 3‐51.
You have to ensure that the Time‐Out state deals appropriately with
audio files if a foreign language has been selected in a multiple‐
language environment.
Depending on the key selected by the consumer and the entry
condition that caused the Time‐Out state to be entered, one of the
following exits can be taken from the state that entered the
Time‐Out state (the previous state):
The Time‐Out next state exit
The Cancel next state exit.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-201
State Tables
Time-Out State
If the consumer presses FDK ‘A’ (or FDK ‘I’ if the option that
enables the keys to the left of the screen is set) to select more time,
the SST returns to the previous state, the original timer is restarted,
and beeping stops for entry conditions 1, 4, 5 or 6, or a slow beep
returns for conditions 2 and 3.
If the consumer presses FDK ‘B’ (or FDK ‘H’) or timer 01 expires, the
beeping stops and the action described in the following table,
Table 2‐108, “Action Taken on Selection of FDK B for Each Entry
Condition”, is taken for the associated condition, described in
Table 2‐107, “Entry Conditions for the Time‐Out State” on
page 2‐201.
Table 2-108 Entry
Action
Action Taken on Selection of FDK B for Condition
Each Entry Condition
1 The Time‐Out next state exit from the previous state is taken
2 A time‐out status message is sent to Central
3 A time‐out status message is sent to Central
4 ‘T’ is placed in general purpose buffer B
5 The Time‐Out next state exit from the previous state is taken
6 A time‐out status message is sent to Central
7 For details of the situations and associated actions taken
when a time‐out occurs during a Cash Accept state, see “> ‐
Cash Accept State” on page 2‐105
8 For details of the situations and associated actions taken
when a time‐out occurs during a Cheque Accept state, see “w
‐ Cheque Accept State” on page 2‐125
For details of the situations and associated actions taken
when a time‐out occurs during a Bunch Cheque Accept state,
see “z001 – Bunch Cheque Accept State” on page 2‐133
Enhanced configuration parameter option 71 controls the number of
times the Time‐Out state can be entered. For details, see “Option 71
– Time‐Out State Entry” on page 7‐18.
If the consumer presses the Cancel key, the beeping stops and the
action described in the following table, Table 2‐109, “Action Taken
on Selection of the Cancel Key for Each Entry Condition”, is taken
for the associated condition described in Table 2‐107, “Entry
Conditions for the Time‐Out State” on page 2‐201.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-202 APTRA™ Advance NDC, Reference Manual
State Tables
Time-Out State
Table 2-109 Entry
Action
Action Taken on Selection of the Cancel Condition
Key for Each Entry Condition
1 The Cancel next state exit from the previous state is taken
2 A time‐out status message is sent to Central
3 A time‐out status message is sent to Central
4 ‘E’ is placed in general purpose buffer B
5 The Cancel next state exit from the previous state is taken
6 A time‐out status message is sent to Central
7 For details of the situations and associated actions taken
when a time‐out occurs during a Cash Accept state, see “> ‐
Cash Accept State” on page 2‐105
8 For details of the situations and associated actions taken
when a time‐out occurs during a Cheque Accept state, see “w
‐ Cheque Accept State” on page 2‐125
For details of the situations and associated actions taken
when a time‐out occurs during a Bunch Cheque Accept state,
see “z001 – Bunch Cheque Accept State” on page 2‐133
The SST may support touch‐screen FDK emulation instead of
regular FDKs. In this state, two of the eight possible fixed touch
areas are enabled on the screen and the consumer touches them
instead of pressing the corresponding FDK. The touch areas are
enabled and disabled in exactly the same way as the FDKs. For
details, see the “FDK Emulation” section in Chapter 4, “Keyboard
Data and Layouts”.
Alternatively, the SST may support full touch screen keyboards. In
this case, touch areas are defined on the screen for all the required
keys. The consumer touches these instead of pressing a key on the
keypad or an FDK. If the keyboard definition is not validated, the
keyboard layout is not changed, the keyboard is disabled and trace
message ‘T86’ is printed on the journal. For details, see Chapter 4,
“Keyboard Data and Layouts”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 2-203
State Tables
Time-Out State
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-204 APTRA™ Advance NDC, Reference Manual
Table of Contents
Screen Data
Chapter 3
Screen Data
Overview 3‐1
The Screen Interface 3‐2
Customer Screens 3‐2
Customer Screen Groups 3‐3
Reserved Screens 3‐4
Types of Reserved Screen 3‐5
C – Cardholder Display 3‐6
Screen ‘C00’ 3‐6
Screen ‘C01’ 3‐6
Screen ‘C02’ 3‐6
Screen ‘C03’ 3‐6
Screen ‘C04’ 3‐6
Screen ‘C05’ 3‐7
Screen ‘C06’ 3‐7
Screen ‘C07’ 3‐7
Screen ‘C20’ 3‐7
G – Graphic Pictures 3‐8
K – Extended Screen Controls 3‐8
Receipt: ‘K01’ 3‐9
Receipt: ‘K09’ 3‐10
Journal: ‘K02’ 3‐10
Journal: ‘K10’ 3‐10
Receipt and Journal: ‘K07’ 3‐11
Receipt and Journal: ‘K08’ 3‐11
Statement: ‘K03’ 3‐11
Control Sequences for Receipt, Journal and Statement
Printers 3‐11
L – Logos 3‐12
M – Supervisor Menus 3‐12
Editing the Contents of Reserved Screens 3‐13
Reserved Screen Constraints 3‐13
Formatting Rules for Cardholder Display Screens 3‐14
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Screen Data
Cardholder Screen: Display Characters 3‐14
Operator Interface Display Characters 3‐15
Control Characters 3‐16
Track 1 Name Display 3‐18
ISO Format Cards 3‐19
VISA Format Cards 3‐19
Auto Select Backwards Search 3‐19
Auto Select Forwards Search 3‐20
ABA Format Cards 3‐20
Name Display 3‐20
Control Codes for Special Features 3‐20
Voice 3‐21
Pre‐recorded Messages 3‐22
Digital Audio Control for Voice Guidance 3‐23
Screen Blinking and Colour Control 3‐27
Changing Display During the Idle Loop 3‐30
Select Primary Character Set 3‐31
Select Secondary Character Set 3‐31
Left Margin Control 3‐32
Set Display Mode Control 3‐32
Logo Control 3‐33
Picture Control 3‐33
Display Image Files Control 3‐34
Lift Cheque Image Control 3‐35
Bunch Cheque Image Display Control 3‐35
Bunch Cheque Codeline Display Control 3‐37
Bunch Cheque Amount Display Control 3‐37
Bunch Cheque Value Display Control 3‐38
Display Dynamic Text Dictionary Control Sequence 3‐39
Dynamic Button Control 3‐42
Syntax of Conditional Expressions 3‐43
Dynamic Text Control 3‐43
Animation and Digital Video 3‐44
International Currency Display Format 3‐45
Currency Echo Example 3‐46
Example of Default Echo Display Format 3‐46
Multi‐Language Screens 3‐48
Multi‐Language Screen Numbering 3‐48
Extended Screen Groups 3‐48
Example Screen Group Definitions 3‐49
Redefining Reserved Screens 3‐51
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Screen Data
Displaying Pictures 3‐52
Picture Resolution 3‐52
Guidelines for Pictures 3‐52
Screen Reset 3‐53
Supervisor Settlement Screens 3‐54
Using the Front or Rear Interface for Settlement 3‐54
Rear Settlement and International Security (DAPI‐7) 3‐54
Supervisor Settlement Transactions 3‐55
Valid Commands 3‐55
Transactions Parameter Screens (C09–C19) 3‐56
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Screen Data
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Screen Data
C
Overview
Overview 3
This chapter provides information on the following topics:
The screen interface
Types of reserved screen
Formatting rules for consumer display screens
Multi‐language screens
Picture display
Screen reset
The screens used for Supervisor settlement transactions.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-1
Screen Data
The Screen Interface
The Screen Interface 3
A screen is a string of characters, including control characters, that
defines what is to be displayed and where to display it (cardholder
screen, operator panel or printer). There are two types of screen:
Customer screens—defined by the user
Reserved screens—already defined within the terminal
software.
The programmatic screen layout for consumer screen and operator
panel is as follows:
Figure 3-1
Cardholder/EOP Screen Layout
@ A B C D E F G H I J K L M N O 0 1 2 3 4 5 6 7 8 9 : ; < = > ?
@ 0
A 1
B 2
C 3
D 4
E 5
F 6
G 7
H 8
I 9
J 10
K 11
L 12
M 13
N 14
O 15
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
A customer screen is a screen that you create. Advance NDC
Customer Screens 3
supports up to 9,999 customer screens. You decide on the text to be
included, and any pictures or logos to be used.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-2 APTRA™ Advance NDC, Reference Manual
Screen Data
The Screen Interface
The data is downloaded to the terminal in a screen data load
message. For details, see “Screen/Keyboard Data Load” on
page 10‐11.
All the screens that are accessed by the state tables are stored in the
Screen Table. Each screen in the table has a unique number from
0000 to 9999. It is this number that is referenced by parameters in the
state tables during transaction processing.
For further information on referencing screens from state tables, see
“Screen Numbers” on page 2‐5.
If you are implementing a multi‐language solution, see “Customer
Screen Groups” below and “Multi‐Language Screens” on page 3‐48.
Customer Screen Groups 3
Two screen groups are used, as follows:
Screen group ‘u’ for language‐independent screen numbers. The
screen numbers are accessed directly
Screen group ʹlʹ for language‐dependent screen numbers. The
screen numbers are accessed indirectly using language offsets.
The language offset is the number that is added to the
language‐independent screen to identify the actual screen to
display.
Screen group ʹuʹ This defines language‐independent numbers, for 3
example, u1234. This is a four‐digit screen group, so the full range of
user screens is 0000 to 9999. For multi‐language use, the screens can
be grouped into language‐specific screen groups. While the size of
each language group can be varied, the maximum screen group size
is 3599. A screen in group ʹuʹ can also be defined as a four‐digit
number in double quotes, without the prefix letter, for example
ʺ1234ʺ.
Screen group ʹlʹ This defines language‐dependent numbers, for 3
example, l1234. This is a four‐digit group with a full range of 0000 to
9999 although a smaller range is generally defined to suit the
number of available languages. The first group of screens when four
languages are to be used, for example, could use the range 0000 to
1000. Screen group ʹlʹ maps to the screens from group ʹuʹ using the
language offset. If the screen identified after applying a language
offset is not found, the screen identified before applying the
language offset is used.
For examples of screen mapping when multiple languages are
available, see “Example Screen Group Definitions” on page 3‐49.
For compatibility, the following apply:
Numeric screen numbers in the range 000 to 999 can still be
specified, for example ‘123’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-3
Screen Data
The Screen Interface
For state parameters, the screen numbers must be three
characters. The first character can be alphanumeric, the second
and third must be numeric digits.
Note: The full range of 0000 to 9999 screen numbers can be
accessed from state parameters using an initial alphanumeric
character and screen offsets. For details and examples, see
“Screen Numbers” on page 2‐5 and “Multi‐Language Screens”
on page 3‐48.
A reserved screen is a screen that is already defined in the resrvd.def
Reserved Screens 3
file. Reserved screens have fixed functions, such as displaying
Supervisor prompts and menus, and are only displayed at
predefined times, such as when the terminal is in Out‐of‐Service or
Off‐Line mode. Some reserved screens consist of control sequences
and are used to manage different aspects of the display, for
example, character sets and logos.
Note: Consumer screens must not be included in the resrvd.def file
as they may not be displayed correctly. To define consumer screens
locally, refer to section “Specifying Local Customisation Data” in
Chapter 5, “Configuring Advance NDC and Associated
Components”, of the APTRA Advance NDC, Developer’s Guide.
The numbering for reserved screens consists of an alpha character
that defines the screen type, followed by two numeric digits that
define the particular screen. The exceptions to this are the error
screens. These consist of an alpha character that defines the screen
type, followed by four numeric digits that define the particular
screen.
Note: For information about screen data on other vendors’ SSTs,
refer to the “Screen Data” topic in Chapter 3, “Configuring the
Multi‐Vendor Environment” of the APTRA Advance NDC,
Multi‐Vendor Support Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-4 APTRA™ Advance NDC, Reference Manual
Screen Data
Types of Reserved Screen
Types of Reserved Screen 3
The following screen types (also known as screen groups) are
defined for reserved screens:
‘A’ – Supervisor facia and Enhanced Operator Interface
Acknowledgements
‘C’ – Cardholder Display
‘d’ – Supervisor Diagnostic Screens
‘E or e’ – Error Screens
‘G’ – Graphic Pictures
‘I’ – Supervisor Information
‘i’ – Supervisor TCP/IP, Dialup, Bunch Note Acceptor (BNA)
and Settlement Screens
‘j’ ‐ Supervisor Miscellaneous Screens
‘K’ – Extended Screen Controls
‘L’ – Logos
‘M or m’ – Supervisor Menus
‘P or p’ – Supervisor CRT and Enhanced Operator Interface
Prompts
‘R’ – Simulated Receipt Pre‐print
‘S or s’ – Supervisor Information Lines
‘T or t’ – Journal Trace and Acknowledgements
‘U’ – Cheque, EMV Smart Card and BNA
‘X’ screens – pre‐recorded audio messages.
This section discusses the following screen types:
‘C’ – Cardholder Display
‘G’ – Graphic Pictures
‘K’ – Extended Screen Controls
‘L’ – Logos
‘M’ – Supervisor Menus.
For information about ‘R’ screens (Simulated Receipt Pre‐print), see
“Simulated Pre‐printed Receipt Messages” on page 5‐25.
For information about the reserved screens ‘C09’ to ‘C19’, see
“Supervisor Settlement Screens” on page 3‐54.
For details of the default pre‐recorded audio messages, see “Control
Codes for Special Features” on page 3‐20.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-5
Screen Data
Types of Reserved Screen
For details of the default text and layout for Supervisor menus and
the other screen types not discussed here, see Appendix A,
“Reserved Screens”.
Screen type ‘C’, with the exception of screens C09 and C10–C19, is
C – Cardholder Display 3
reserved for use during cardholder transactions. For details of
screens C09 and C10–C19, see “Supervisor Settlement Screens” on
page 3‐54.
The ‘C’ screen type provides the following screens that are
displayed at predefined times.
Screen ‘C00’ 3
Prompts a cardholder who has failed either to make a deposit or to
respond to a request for keyboard input. You must download the
screen to the terminal for this to take effect. The screen must
conform to the following requirements:
If the cardholder presses FDK ‘A’ (or FDK ‘I’, if the option that
enables the keys to the left of the cardholder screen is set), more
time is allowed.
If the terminal supports Touch Screen FDK Emulation instead of
regular FDKs, the cardholder touches the FDK ‘A’ (or FDK ‘I’)
touch area.
If the cardholder presses FDK ‘B’ (or FDK ‘H’), the time‐out next
state exit of the previous state is taken.
If the terminal supports Touch Screen FDK Emulation instead of
regular FDKs, the cardholder touches the FDK ‘B’ (or FDK ‘H’)
touch area.
For details, see the “Time‐Out State” section in Chapter 2, “State
Tables”.
Screen ‘C01’ 3
Displayed when the terminal is in Off‐Line mode.
Screen ‘C02’ 3
Displayed when the terminal is in Out‐of‐Service mode.
Screen ‘C03’ 3
Displayed when the terminal is in Supervisor mode.
Screen ‘C04’ 3
Displayed when the terminal captures a card as a result of a card
reader failure. When this occurs, the next state is executed, except in
a Card Before Cash Transaction reply, when the terminal waits for a
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-6 APTRA™ Advance NDC, Reference Manual
Screen Data
Types of Reserved Screen
new transaction reply from Central. For details, see the “Terminal
Functions for Transaction Completion” on page 10‐69. This screen is
displayed for the amount of time specified by Timer 02 (page 7‐25).
For the timer format in a message, see “Configuration Parameters
Load” on page 10‐15.
Note: Screen C04 is also displayed when the card is captured
because it has not been taken after being ejected before the PIN is
entered.
Screen ‘C05’ 3
Displayed when cardholder tampering is suspected and the
terminal enters Suspend mode.
Screen ‘C06’ 3
Displayed when the terminal is temporarily in Out‐of‐Service mode.
This screen is displayed during any of the following conditions:
When specified in a ‘go out‐of‐service’ terminal command sent
from Central.
On exit from Supply mode to Out‐of‐Service, if Supply mode
was entered from In Service, and the auto‐return to In‐Service
local configuration option is not set.
If Supply mode is entered from Out‐of‐Service while displaying
screen ‘C06’.
Screen ‘C07’ 3
When table entry 5 (Image Lift option) of the “w ‐ Cheque Accept
State” (see page 2‐125) is set, this screen is used to display the lifted
cheque image.
This screen contains the screen control sequence ‘PS’, which is used
to display the lifted cheque image as described in the “Lift Cheque
Image Control” section on page 3‐35.
If the image is required to be displayed in an “H ‐ Information Entry
State” (see page 2‐34), the image can be displayed by referencing
screen C07 to display the image as part of the Further Processing
Screen.
Screen ‘C20’ 3
This is a generic ‘Please Wait’ screen that can be displayed when
there is a delay in processing and there is not a more specific screen
defined. This screen should contain a single reference to a nested
screen. The nested screen should be defined in all languages
required at the correct offsets. By default, this screen is undefined. If
C20 is not defined, nothing is displayed. If it is defined, it is
displayed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-7
Screen Data
Types of Reserved Screen
Note: The cash‐in component (CIC) uses screen C20 in the Cash
Accept, Cheque Accept and the Close states, and for Retract in the
Refund transaction reply function.
Screen type ‘G’ is reserved for graphic pictures. For details, see
G – Graphic Pictures 3
Appendix C, “Cardholder Screen Graphics”. The screens provided
are as follows:
‘G00’ – standard Insert Card picture
‘G01’ – standard Press Key picture
‘G03’ – standard Make A Deposit picture
‘G04’ – standard Take Receipt picture
‘G05’ – standard Take Money picture
‘G06’ – standard Take Statement picture.
‘G10’ – standard Scan Barcode picture.
The graphic pictures can be invoked as nested screens, and will be
displayed with the top left hand corner at the current cursor
position.
Up to 10,000 pictures can be displayed using the Picture Control
command. For details, see the “Control Codes for Special Features”
section on page 3‐20.
Screen ‘K00’ contains the screen control sequence to display the
K – Extended Screen FIT‐dependent logo.
Controls 3
Screen ‘K00’ cannot be downloaded. However, the control sequence
SO ‘K00’ causes one of the logos ‘L00’ to ‘L15’ to be displayed. For
details of control sequences, see the “Control Characters” section on
page 3‐16. The logo selected for display is defined by the Indirect
Next State Index/Logo Number (PSTDX) parameter in the current
FIT entry.
Screens ‘K01’ – ‘K03’ reset the receipt, journal and statement
printers to their original settings.
Using the System Application within Supervisor, you can change
the settings of the printers, for example, character size or margins.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-8 APTRA™ Advance NDC, Reference Manual
Screen Data
Types of Reserved Screen
To make sure that the settings are restored after using these options,
screens are sent to each of the printers as follows:
Table 3-1
K – Extended Screen Controls: Restoring
Settings
Screen Optional Screen if Printer is Thermal Printer
K01 and K09 K07 and K08 Receipt
K02 and K10 K07 and K08 Journal
K03 — Statement
If you require the SST to maintain non‐default settings before and
after using the System Application, you must set screens ‘K01’ to
‘K03’ to the necessary non‐default values during download.
You may define your directory for the receipt/journal specific data
by editing screen ‘K07’ in the resrvd.def file or by downloading the
screen from Central.
Screen ‘K08’ may contain the control sequence which identifies the
file with the customisable data for code page 000. For details, see the
“Define Downloadable Character Set” on page 5‐15. By default,
screen ‘K08’ is not defined.
Screens ‘K09’ and ‘K10’ may be edited to include the control
sequence, “Define Downloadable Bit Image” on page 5‐16, which
identifies an image and downloads it to the printer memory for
processing when the command “Print Downloadable Bit Image” on
page 5‐10 is present in the Transaction Reply printer stream.
Note 1: Some of the parameters for screens ‘K01’–‘K03’ can be set
by hardware switches on the printers. If you decide to use these
switches, make sure that the screens are downloaded with the same
parameter values.
Note 2: Screens ‘K04’, ‘K05’ and ‘K06’ are not supported in APTRA
Advance NDC.
The default contents for screens ‘K01’– ‘K03’ and ‘K07’–‘K10’ are
defined in the following tables (all details are in hexadecimal).
Receipt: ‘K01’ 3
Table 3-2 1B 5B 31 36 33 75 Top margin 163/144 inch
Screen Contents ‘K01’
1B 5B 30 72 Line spacing 7.5 lpi
1B 28 31 G0 – set1 single size
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-9
Screen Data
Types of Reserved Screen
1B 29 32 G1 – set2 single size
1B 5B 30 30 30 70 Left margin zero
1B 5B 30 34 30 71 Right margin 40 characters
0F Select G0 set
Note: The top margin supplied by screen ‘K01’ will be overridden
by any valid value entered through option 92, Receipt Top Margin
on the Configure menu in Supervisor. For details, refer to Chapter 4,
“Configure Menu” of the APTRA Advance NDC Supervisor’s Guide.
Receipt: ‘K09’ 3
Table 3-3 1B 65 31 Print position of HRI barcode characters
Screen Contents ‘K09’
1B 77 33 Width of barcode
1B 68 31 36 32 Height of barcode
1B 2A 31 <image Define Downloadable Bit Image
filename> 1B 5C
Journal: ‘K02’ 3
Table 3-4 1B 5B 30 72 Line spacing 7.6 lpi
Screen Contents ‘K02’
1B 28 31 G0 – set1 single size
1B 29 32 G1 – set2 single size
1B 5B 30 30 30 70 Left margin zero
1B 5B 30 34 30 71 Right margin 40 characters
0F Select G0 set
Journal: ‘K10’ 3
Table 3-5 1B 65 31 Print Position of HRI barcode characters
Screen Contents ‘K010’
1B 77 33 Width of barcode
1B 68 31 36 32 Height of barcode
1B 2A 31 <image Define Downloadable Bit Image
filename> 1B 5C
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-10 APTRA™ Advance NDC, Reference Manual
Screen Data
Types of Reserved Screen
Receipt and Journal: ‘K07’ 3
Table 3-6 Path to the Financial Institution Receipt and
Screen Contents ‘K07’ Journal specific data, including image files,
graphic files and customer‐defined code
pages. Maximum length is 30. By default,
this is not defined as the driver will use its
own path of \40colfil
Receipt and Journal: ‘K08’ 3
Table 3-7 1B 26 <code page Define Custom Code Page. By default, this is
Screen Contents ‘K08’ filename> 1B 5C not defined.
Statement: ‘K03’ 3
Table 3-8 1B 5B 31 34 34 75 Top margin 144/144 inch
Screen Contents ‘K03’
1B 5B 30 72 Line spacing 18/144 inch = 8 lpi
1B 28 31 G0 – set1 10 cpi
1B 29 32 G1 – set2 10 cpi
1B 5B 30 30 30 70 Left margin zero
1B 5B 30 38 30 71 Right margin 80 characters
0F Select G0 set
Control Sequences for Receipt, Journal and Statement
Printers 3
The following control sequences apply to the receipt, journal and
statement printers. For details of control sequences for USB printers
refer to the APTRA on‐line documentation under APTRA XFS |
Programmer’s Reference| XFS UPTR Service Provider.
Set First Line Position 1B 5B P1 75 where P1 is a one, two or three 3
byte ASCII representation of numbers in the range 018‐288. The
bottom of the first line is P1/144 inch and sets the top margin.
Note: If you want to change the default value for the first line
position, ensure the value you specify is a multiple of 18, otherwise
the value is rounded to the nearest line position.
Line Spacing 1B 5B P1 72 where P1 is a one, two or three byte 3
ASCII representation of a number in the range 0‐7.
The following default settings apply for receipt and journal printers:
P1 = 0 or 1 selects 7.5 lpi
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-11
Screen Data
Types of Reserved Screen
P1 = 2 or 3 selects 6.0 lpi
P1 = 4 to 7 selects 5.0 lpi
The following default settings apply for the statement printer:
P1 = 0 or 1 selects 8 lpi
P1 = 2 or 3 selects 6 lpi
P1 = 4 to 7 are ignored
Note: The extra character ‘[‘ is not printed on USB printers when
invalid parameters are passed with escape sequences ‘ESC [ x r’ or
ESC [ xyz t’. The expected print will be 7.5 lines per inch when
invalid parameters are sent.
Character Sets 1B 28/29 G0/G1 where G0/G1 is one byte that 3
defines a particular character set in the range 31‐50 hex. For details,
see Appendix B, “Character Sets”. There are more character sets for
the statement printer than for the receipt or journal printer.
Set Left Margin 1B 5B P1 70 hex where P1 is a one, two or three 3
byte ASCII representation of numbers in the range 000‐038 for the
receipt and journal printers and 0‐(right margin – 4) for the
statement printer. This sets the column position of the left margin.
Set Right Margin 1B 5B P1 70 hex where P1 is a one, two or three 3
byte ASCII representation of numbers in the range 000‐040 for the
receipt and journal printers and (left margin + 4)‐137 for the
statement printer. This sets the column position of the right margin.
Screen type ‘L’ is reserved for logos. Screens ‘L00’ to ‘L15’ are
L – Logos 3
reserved for 16 predefined graphic pictures such as bank logos. You
can download these screens with alternative pictures or text if
required.
Up to 100 logos can be displayed using the Logo Control command.
For details, see “Control Codes for Special Features” on page 3‐20.
Screen type ‘M’ is reserved for Supervisor menus. They contain
M – Supervisor Menus 3
information on the following menus:
Select
Replenish
Configure
Access.
For the text and layout of these menus, see Appendix A, “Reserved
Screens”.
The following additional ‘M’ screens have been defined which
ensure that Advance NDC will operate in the same way as previous
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-12 APTRA™ Advance NDC, Reference Manual
Screen Data
Types of Reserved Screen
NDC+ releases if you choose not to use the touch‐screen keyboard
features. The actual screen display data contained in these screens is
never used.
‘M06’ – Transaction processing standard layout
‘M09’ – Transaction processing standard layout with
Clear/Cancel keys swapped.
You may edit these screens to customise the default layouts.
The reserved screens are defined in a plain ASCII text file named
Editing the Contents of resrvd.def, which you can edit. This file may be used as a source for
Reserved Screens 3
new screens and keyboard layouts. It may also be used to edit
screens and keyboards. It allows keyboard layouts to be defined
locally without any impact on Central.
Reserved Screen Constraints 3
The resrvd.def file has certain constraints on its use. Each screen
definition starts with the screen number inside single quotation
marks. There are then three spaces, followed by the first line of
screen data, which is also enclosed in single quotation marks. A
LF/CR must follow the trailing quotation mark.
As well as the screen text, the resrvd.def file contains placeholders,
indicated by the percent (%) character, where dynamic data is to be
included in a screen, for example, in screens I03, I04, T17, T18 and so
on. If you are editing or localising the text, these placeholder
characters must be left in place; only edit the preceding or
surrounding text. For example, in the following screen I08 line,
edit/localise only the words ‘CURRENT SCREEN’ and do not
remove the ‘%’ placeholder:
CURRENT SCREEN = %
Subsequent lines of the screen are added until the last line. This last
line terminates like the others but is followed by exactly one empty
line before the next screen definition.
Note: If you use an editor that adds control characters, ensure that
they are not added to the resrvd.def file.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-13
Screen Data
Formatting Rules for Cardholder Display Screens
Formatting Rules for Cardholder
Display Screens 3
The formatting rules for all screens that are displayed on the
cardholder screen during State Table processing include the
following:
Display characters
Control characters
Track 1 name display
Control codes for special features
International currency display format.
For general points to consider when you are preparing screens for
display, see “Displaying Pictures” on page 3‐52.
Note: Cardholder screens must not be defined in the resrvd.def file.
The cardholder screen can display any character contained in the
Cardholder Screen: following character sets:
Display Characters 3
Table 3-9 Character Set ID
Number of
Designator
Cardholder Screen: Character Sets Characters
Single Size Alphanumeric 1 96 ‘1’
Single Size Alphanumeric 2 96 ‘2’
Standard Graphics 1 64 ‘3’
Standard Graphics 2 64 ‘4’
Standard Graphics 3 64 ‘5’
Double Size Alphanumeric 1 96 ‘>’
Double Size Alphanumeric 2 96 ‘?’
Single Size Alphanumeric 1 96 ‘G’
Single Size Alphanumeric 1 is the standard character set. Other
character sets can be accessed through the Select Character Set
control sequence.
Standard Graphics 2 maps to Customer Graphics 2 (Arabic) and is a
display‐only font, reflecting the range and look of characters that
are required in an SST application. For more information about
character sets, see Appendix B, “Character Sets”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-14 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
The following character sets contain customer‐defined characters.
Table 3-10 Number of
Character Set ID Designator
Character Sets with Customer-Defined Characters
Characters
Customer graphics 2 (Arabic) 64 ‘7’
Chinese 1 64 ‘:’
Chinese 2 64 ‘;’
Double size character graphics 64 ‘B’
(Arabic)
Two character sets can be active at any one time. Normally
characters are displayed from the primary character set, but
individual characters can be displayed from the secondary set using
the ‘VT’ control.
For the default character sets provided on cardholder screens, and
printers, see Appendix B, “Character Sets”.
The enhanced operator interface can display any character
Operator Interface Display contained in the following character set:
Characters 3
Table 3-11 Number of
Character Set ID Designator
Enhanced Operator Interface: Character Characters
Set
Single size alphanumeric 1 96 ‘1’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-15
Screen Data
Formatting Rules for Cardholder Display Screens
The function of each control character for cardholder screen activity
Control Characters 3
is defined in the following table:
Table 3-12 ASCII Hex
Character Function
Cardholder Screen: Control Character Code
Functions
FF 0C Clears the screen and positions the cursor in the
top left hand corner of the screen. Sets blinking to
‘off’ and resets foreground and background
colours to their defaults. NCR recommends you
use the FF (form feed) control character at the
start of the screen following an idle screen. This
ensures the idle sequence is stopped before the
next screen is displayed.
SO 0E Inserts the screen called by the next 3, 5 or 6
characters. Screens can be ‘nested’ to 5 levels
using SO.
Note: A screen number specified as 3 decimal
digits is a language‐independent screen number
unless the group size is 1000 or greater, in which
case the screen is adjusted for language.
A screen number specified as 4 decimal digits
prefixed by ʹuʹ (u1234) or as 4 decimal digits in
double quotes (“1234”) is a language‐independent
screen number.
A screen number specified as 4 decimal digits
prefixed by ʹlʹ (l0234) is a language‐dependent
screen number and is adjusted for language.
If the language‐adjusted screen has not been
loaded, then the unadjusted screen will be used
instead. This enables logos and pictures to be
defined just once in the base language.
SI 0F Sets the cursor to the position indicated by the
next two characters (row selected first, column
selected second). Display data remains
unchanged.
The following characters are used to define rows
on the cardholder screen:
@,A,B,C,D,E,F,G,H,I,J,K,L,M,N,O
where ‘@’ is the top row and ‘O’ is the bottom
row.
The following characters are used to define
columns on the cardholder screen:
@,A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,0,1,2,
3,4,5,6,7,8,9,:,;,<,=,>,?
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-16 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
ASCII Hex
Character Function
Code
where ‘@’ is the left‐hand column and ‘?’ is the
right‐hand column. For a diagram showing the
cardholder screen layout and FDK alignment, see
“Cardholder/EOP Screen Layout” on page 3‐2.
For a diagram showing the Touch Screen FDK
Emulation area, see “FDK Emulation” on
page 4‐2.
The cursor position is automatically reset to
column ‘@’, row ‘@’ at the end of the outermost
screen or after an idle screen delay control
sequence.
HT 09 Causes the name encoded on Track 1 of the card
to be displayed, starting at the current cursor
position (32 characters maximum). Both ISO and
VISA display formats are supported.
DC1 11 Enable video. Shows the screen display.
DC2 12 Disable video. This command inhibits the screen
display so that the cardholder does not see the
display being built on screen. NCR recommends
that you send a ‘disable video’ as the first control
character in the screen, and an ‘enable video’ as
the last control character in the screen.
ESC 1B Control character which introduces
supplementary control codes for the following
features:
‐ Voice
‐ Screen blinking and colour control
‐ Changing display in idle
‐ Select character set
‐ Left margin control
‐ Logo control
‐ Picture control
‐ Set display mode control
‐ Display image files control
‐ Lift cheque image control
‐ Animation
For details, see “Control Codes for Special
Features” on page 3‐20.
CR 0D Causes the cursor to be moved to the character
position specified by the current left‐hand margin
on the following line.
VT 0B Causes the next character to be displayed from the
secondary character set.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-17
Screen Data
Formatting Rules for Cardholder Display Screens
Note: Use of the full range of control characters in reserved screens
is restricted. Only reserved screens in group ‘Y’ may contain any of
the above control characters. All other reserved screen groups are
limited to using SO (OE hex) and CR (OD hex).
For display purposes, Track 1 must contain the following data, in
Track 1 Name Display 3
one of two formats:
Table 3-13 Format A Format B
Track 1 Data Formats
Start Sentinel = ‘%’ Start Sentinel = ‘%’
Format Code = ‘A’ Format Code = ‘B’
Surname Account Number (optional up to
19 characters)
Surname Separator = ‘/’ Field Separator = ‘^’
First Name and Title Country Code (optional)
Field Separator = ʹ^ʹ Surname
Discretionary Data (optional) Surname Separator = ‘/’
End Sentinel = ʹ?ʹ First name and Title
LRC Field Separator = ‘^’
TOTAL: Maximum 79 chars. Discretionary Data (optional)
End Sentinel = ‘?’
LRC
TOTAL: Maximum 79 chars.
All the control characters defined above are mandatory and must be
encoded whether or not all the fields are used.
The combined length of the surname, first name and title (excluding
trailing spaces and surname separator) must be between 1 and 25
characters. If it exceeds this, the name field is ignored.
Four options are provided to control the extraction of the first name
and title fields:
ISO
VISA
Auto Select Backwards Search
Auto Select Forwards Search.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-18 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
ISO Format Cards 3
The separator between the first name and title is a space. This option
uses a backward search for the separator.
(first name, spaces allowed) (space) (title with no space) (space)
(first name, spaces allowed) (space) (title with no spaces)
(first name, spaces allowed) (two or more spaces)
(space) (title with no spaces) (space)
(first name with no spaces)‐
(first name with no spaces) (one or more spaces).
VISA Format Cards 3
The separator is a full stop. This option uses a backward search for
the separator.
(first name, full stops allowed) (full stop) (title with no full
stops)
(first name, full stops allowed) (full stop)
(full stop) (title with no full stops)
(first name with no full stops).
Auto Select Backwards Search 3
This option selects between ISO and VISA automatically, but places
restrictions on the permitted formats.
(first name, spaces allowed) (space) (title with no spaces) (space)
(first name, spaces allowed) (two or more spaces)
(space) (title with no spaces) (space)
(first name with no spaces) (one or more spaces)
(first name with full stops allowed) (full stop) (title with no full
stops)
(first name, full stops allowed) (full stop)
(full stop) (title with no full stops)
(first name with no full stops)
(name with spaces).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-19
Screen Data
Formatting Rules for Cardholder Display Screens
Auto Select Forwards Search 3
This option selects between ISO and VISA automatically, but places
restrictions on the permitted formats.
(first name with no spaces) (space) (title, spaces allowed) (space)
(space) (title, spaces allowed) (one or more spaces)
(first name with no spaces) (one or more spaces)
(first name with no full stops) (full stop) (title, full stops
allowed)
(first name with no full stops) (full stop)
(full stop) (title, full stops allowed)
(first name with no full stops)
(name with spaces).
ABA Format Cards 3
These are the same as VISA format, with an optional three‐digit
country code immediately before the surname. This code is not
displayed.
Name Display 3
When the name display is invoked at the current cursor position by
the HT screen control character, a space is inserted between the
fields. The name display is the same for both formats:
TITLE b FIRST NAME b SURNAME
TITLE b SURNAME
FIRST NAME b SURNAME
SURNAME
where b = space
Note: If an invalid control sequence is included in a screen, a ‘]’
character is displayed.
Special features can be accessed by using the ‘ESC’ character and
Control Codes for Special supplementary control codes. The following table provides links to
Features 3
details of the control code:
Table 3-14 Feature Introducer Identifier
Screen Display Special Features
Voice (see 3‐21) ESC ‘P’ ‘0’
Screen blinking and colour control (see 3‐27 ESC ‘[‘ ‘m’
Changing display in idle (see 3‐30) ESC ‘[‘ ‘z’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-20 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Feature Introducer Identifier
Select primary character set (see 3‐31) ESC ‘(‘
Select secondary character set (see 3‐31) ESC ‘)’
Left margin control (see 3‐32) ESC ‘[‘ ‘p’
Logo control (see 3‐33) ESC ‘P’ ‘1’
Picture control (see 3‐33) ESC ‘P’ ‘2’
Set display mode control (see 3‐32) ESC ‘P’ ‘i’
Display image files control (see 3‐34) ESC ‘P’ ‘E’
Lift cheque image control (see 3‐35) ESC ‘P’ ‘S’
Bunch cheque image display control ESC ‘P’ ‘t’
(see 3‐35)
Bunch cheque codeline display control ESC ‘P’ ‘u’
(see 3‐37)
Bunch cheque amount display control ESC ‘P’ ‘v’
(see 3‐37)
Bunch cheque value display control ESC ‘P’ ‘w’
(see 3‐38)
Display dynamic text dictionary control ESC ‘P’ ‘x’
(see 3‐39))
Dynamic button control (see 3‐42) ESC ‘b’
Dynamic text control (see 3‐43) ESC ‘q’
Animation (may use picture control or
display image files control) (see 3‐44)
MPEG (may use picture control or display
image files control)
Voice 3
If digital audio hardware is installed, the SST can provide three
types of spoken messages:
Auto‐voice pre‐recorded messages played at pre‐defined times
Audio controls embedded in screens to play pre‐recorded
messages
Voice guidance.
Note: If a voice‐guided session is active, the first two types are not
played during the voice‐guided session.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-21
Screen Data
Formatting Rules for Cardholder Display Screens
Pre‐recorded Messages 3
Make sure that the pre‐recorded message is brief enough to play
completely before the state is timed out. The terminal attempts to
play messages at the following times:
PIN Entry (Message 7) The message starts during a PIN Entry 3
state or Enhanced PIN Entry state when the card has been read and
recognised. If a Card Read – PIN Entry Initiation state is used, the
message starts as soon as the card is detected by the terminal.
Transaction Request (Message 1) The message starts when a 3
Transaction Request message is sent to Central.
Card Taken (Message 8) The message starts as soon as a card is 3
taken in the Close state. If the card has already been taken, the
message starts on entry to the Close state.
Digital Audio Control in Screen Display Audio control 3
sequences can be included in screen data to play any one of up to
999 audio messages. The format of an audio control sequence is as
follows:
Table 3-15 Number of
Character Description
Digital Audio Control in Screen Display Bytes
ESC ʹPʹ Device control string introducer 2
ʹ0ʹ Control string ID 1
Variable Message number, range 00 ‐ 999 Var (2 ‐ 3)
ʹ;ʹ Separator 1
Parameter Number of messages to be played (0‐3) 1
flag This parameter is included for migration
purposes only and is ignored. Only one
message can be played for each voice
control sequence.
ESC ʹ\ʹ String terminator 2
The auto‐voice messages occur, even if additional messages are
invoked, unless the auto‐voice feature is disabled by an Enhanced
Configuration Parameters Load message. For details, see “Enhanced
Configuration Parameters Load” on page 10‐17.
The following ten messages are supplied as defaults:
0 We regret that the terminal’s services are not available.
1 Please wait while your transaction is processing.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-22 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
2 Enter the amount when you are ready.
3 Your card and receipt are ready for removal.
4 Please select the service required and the account to be charged.
6 Please take your cash.
7 Welcome. Please enter your secret number.
8 Thank you for banking with us.
9 Please take an envelope from the dispenser and place your
deposit inside. Then enter the amount when ready. Place the
sealed envelope in the slot, where it will be checked and
credited to your account.
12 Tone.
Note: Messages 5, 10, 11 and 13‐998 are not provided. Message 999
is interpreted as a ‘stop’ command.
Digital Audio Control for Voice Guidance 3
Audio data can be included in field ‘n’ of the Transaction Reply
message. The referenced screen must have an Audio element with
Placeholder sub‐elements defined in the voice guidance XML
configuration file. If the Placeholder sub‐elements are not defined,
the dynamic audio data is ignored. For details of the Transaction
Reply message, see “Transaction Reply Command” on page 10‐52.
For details of the XML configuration file for voice guidance, refer to
Chapter 6, “Configuring Voice Guidance” in the APTRA Advance
NDC, Developer’s Guide.
Examples of audio data sent in Transaction Reply messages are
given on page 3‐25 to page 3‐26.
Digital audio for voice guidance is invoked by the following control
sequence:
Table 3-16 Character Description
Number of
Digital Audio Control for Voice Guidance Characters
ESC ʹPʹ Device control string introducer 2
ʹ0ʹ Control string ID 1
Variable Message number, range 00 ‐ 999 Var (2 ‐ 3)
See Table Note 1
ʹ;ʹ Separator 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-23
Screen Data
Formatting Rules for Cardholder Display Screens
Number of
Character Description
Characters
Parameter A digit if parameters follow (for example, 1
flag 1)
ʹ;ʹ Separator 1
See Table Note 2
Voice Audio placeholder data with a fixed or 1
guidance dynamic format
variable See Table Note 2, Table Note 3, Table Note
4 and Table Note 5
ESC ʹ\ʹ String terminator 2
Table Note 1: This parameter is included for compatibility, but is
ignored as the screen number is used to identify the Audio element
in the voice guidance configuration XML file.
Table Note 2: These parameters must be repeated as required to
identify the audio data.
Table Note 3: This parameter must not contain a semicolon (;) as
placeholders are separated by semicolons. Nested Audio IDs have
only one placeholder.
Table Note 4 Fixed format has no special formatting requirements
other than that specified in Table Note 3.
Dynamic format contains a reference to an audio element along
with text to be used as a placeholder within the referenced audio
element. The format is as follows:
<SO><Audio element ID><Placeholder data>
This is parsed as follows:
<SO> The shift out character (0x0E)
<Audio element ID> An audio element enclosed in double quotation
marks, for example, ʺ1234ʺ or “Welcome”. If the
audio element is numeric, the language screen offset
will be applied to the audio element identifier
<Placeholder data> A text fragment to replace any placeholder marker
in the referenced audio element.
Table Note 5 References to audio elements can only be specified at
the start of the voice guidance variable.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-24 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Example 1: Screen Update in a Transaction Reply with Fixed
Data 3
This message updates screen 129, which is the display screen for
Close state 027. The screen and control sequence are shown in bold.
The update data for screen 129 could include up to three
placeholder data fields and each would be spoken in turn.
The Transaction Reply is as follows:
4<fs><fs><fs>027<fs><fs>12345037129<FF><ESC>P0000;1;HAPPY
HOLIDAYS!<ESC>\<si>FKTHANK YOU!!!<fs>003ADVANCE NDC VG NEXT
STATE AND PRINT<lf>EXAMPLE 1<lf>UPDATE WITH ONE<lf>PLACEHOLDER
Audio ID 129 can be defined as the following:
<Audio audioID="0129" groupID="0000" repetitions="0">
<Text lang="en" state="private">
Thank you for banking with us.
<PlaceHolder/> <PlaceHolder/> <PlaceHolder/> </Text> </Audio>
Alternatively, it can be defined using an audio file, as follows:
<!-- file 0129.wav has recorded voice of the text
"Thank you for banking with us." -->
<Audio audioID="0129" groupID="0000" repetitions="0">
<Text lang="en" state="private">
<Recording file="0129.wav" state="private"/> <PlaceHolder/>
<PlaceHolder/> <PlaceHolder/> </Text> </Audio>
The outcome is that during the Close state, screen 129 is displayed
with the following spoken text:
Thank you for banking with us. HAPPY HOLIDAYS!
Example 2: Using a Nested Screen with Fixed Placeholder Data 3
Screen 129 is sent from the host and includes a call to nested screen
135, as follows:
<ff><si>FKTHANK YOU!!!<so>135
Audio ID 129 and Audio ID 135 are defined as follows:
<Audio audioID="0129" groupID="0000" repetitions="0">
<Text lang="en" state="private">
Thank you for banking with us. </Text></Audio>
<Audio audioID="0135" groupID="0000" repetitions="0">
<Text lang="en" state="private"> <PlaceHolder/> <PlaceHolder/>
<PlaceHolder/> </Text> </Audio>
Alternatively, they can be defined using an audio file, as follows:
<!-- file 0129.wav has recorded voice of the text "Thank you
for banking with us." -->
<Audio audioID="0129" groupID="0000" repetitions="0">
<Text lang="en" state="private">
<Recording file="0129.wav" state="private"/> </Text> </Audio>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-25
Screen Data
Formatting Rules for Cardholder Display Screens
<Audio audioID="0135" groupID="0000" repetitions="0">
<Text lang="en" state="private"> <PlaceHolder/> <PlaceHolder/>
<PlaceHolder/> </Text> </Audio>
The Transaction Reply is as follows, with screen and control
sequence shown in bold:
4<fs><fs><fs>027<fs><fs>12345037135<esc>P0000;1;Ask about our
loan rates.; Special deals on offer this month.
<esc>\<fs>003ADVANCE NDC VG NEXT STATE AND PRINT<lf>EXAMPLE
2<lf>UPDATE WITH TWO<lf>PLACEHOLDERS
The outcome is that during the Close state, screen 129 is displayed
with nested screen 135 and the following spoken text:
Thank you for banking with us.
Ask about our loan rates.
Special deals on offer this month.
In this example the update data for screen 135 has two placeholder
data fields spoken in turn; but it could have three.
Example 3: Using Dynamic Placeholder Data 3
Screen 1233 contains the following escape sequence:
<esc>P0;1;Welcome;<so>"1234"MasterCard;<so>"1235"VISA;
Remember you can top up your mobile phone here.<esc>\
Audio IDs are defined as follows:
<Audio audioId="1233"> // audio associated with base screen
<Text>Hello <PlaceHolder/>. Please select the application.
<PlaceHolder/> <PlaceHolder/> <PlaceHolder/> </Text> </Audio>
<Audio audioID="1234">
<Text>For <PlaceHolder/> Please press 1. </Text> </Audio>
<Audio audioId="1235">
<Text>for <PlaceHolder/> Please press 2. </Text> </Audio>
When screen ʺ1233ʺ is displayed, the spoken text will be constructed
by Advance NDC as follows:
Welcome. Please select the application.
For MasterCard please press 1.
For VISA please press 2.
Remember you can top up your mobile phone here.
Guidelines for Using Multiple Screens with Digital Audio 3
If you have two or more digital audio messages in the same screen,
only the last one is played. If a second screen is displayed before the
digital audio message playing on the first screen has finished, one of
the following occurs:
If the second screen does not contain any digital audio
messages, the first message continues to play while the second
screen is displayed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-26 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
If the second screen contains a digital audio message, the first
message is stopped and the second message begins to play.
The function that extracts and plays audio messages does so by
starting with the base screen and traversing through all nested
screens, playing any associated audio messages for the base screen
and all nested screens in the order they are encountered. Playing
audio messages is done by progressing the base screen number,
along with all nested screen numbers, as the audio identifiers, plus
any associated parameters, to speak the complete audio message.
It is possible for automatic messages to interfere with digital audio
messages defined in other screens. If a message is playing in one
screen and the application moves to a state where an automatic
message is to be played, the first message is stopped and the
automatic message is played. You can avoid this situation by
disabling the automatic voice feature. See Chapter 7, “Enhanced
Configuration Parameters Load Message” for details.
Screen Blinking and Colour Control 3
You can control the blinking of data and change the colour of data
displayed on the screen with the following control sequence. This
sequence is ignored by the enhanced operator interface.
Note: Blinking text on a transparent background is not supported
in Advance NDC.
Table 3-17 Character Description
Number of
Screen Blinking and Colour Control Characters
ESC ‘[‘ Control Sequence Introducer 2
Variable Screen blinking and colour control commands 2
; Field separator 1
The variable field, separated by field
separators, can be repeated up to three times.
There should not be a field separator after the
last parameter.
m Function‐defining character 1
The variable field is made up from the following commands:
Blinking Commands
Table 3-18 Resets colours to defaults and blinking off 00
Blinking Commands
Set blinking on 10
Set blinking off 11
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-27
Screen Data
Formatting Rules for Cardholder Display Screens
Foreground Colour Control Commands
Table 3-19 Intensity
Foreground Colour Commands
Low High
Black Foreground 20 B0
Red Foreground 21 B1
Green Foreground B2 22
Yellow Foreground B3 23
Blue Foreground 24 B4
Magenta Foreground 25 B5
Cyan Foreground 26 B6
White Foreground B7 27
These foreground (text) and background colour commands can also
be used with the Windows display set to High Color (16 bit) or
above.
Background Colour Control Commands
Table 3-20 Intensity
Background Colour Commands
Low High
Black Background 30 C0
Red Background 31 C1
Green Background C2 32
Yellow Background C3 33
Blue Background 34 C4
Magenta Background 35 C5
Cyan Background 36 C6
White Background C7 37
Transparent background (one code only) 80
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-28 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Default Foreground Colour Control Commands
Table 3-21 Intensity
Default Foreground Colour Commands
Low High
Black Default Foreground 60 F0
Red Default Foreground 61 F1
Green Default Foreground F2 62
Yellow Default Foreground F3 63
Blue Default Foreground 64 F4
Magenta Default Foreground 65 F5
Cyan Default Foreground 66 F6
White Default Foreground F7 67
Default Background Colour Control Commands
Table 3-22 Intensity
Default Background Colour Commands
Low High
Black Default Background 70 G0
Red Default Background 71 G1
Green Default Background G2 72
Yellow Default Background G3 73
Blue Default Background 74 G4
Magenta Default Background 75 G5
Cyan Default Background 76 G6
White Default Background G7 77
When a Blinking On control sequence appears in the screen data,
any display characters that follow are blinked until a Blinking Off
control sequence or the data delimiter at the end of the outermost
screen is reached, or an idle screen delay sequence occurs. Graphics
are not blinked, unless they are character‐based logos.
The colour change commands will have an effect on the levels of
grey displayed on a monochrome screen.
Note: To set up default foreground and background colours for a
screen, the control sequence should be placed before the clear screen
control character. The reset attributes command will cause the
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-29
Screen Data
Formatting Rules for Cardholder Display Screens
default foreground and background colours to be replaced by those
defined in resrvd.def. As attributes are reset each time a new screen
number is to be displayed, you should ensure that the required
default settings are applied each time a new screen is to be
displayed.
Changing Display During the Idle Loop 3
It is possible to have a changing screen display on the cardholder
screen while the terminal is idle, waiting for card entry. In this
situation, the terminal cycles through the specified display
sequence. If a delay control sequence occurs at the end of the idle
screen, the loop is repeated indefinitely until a card is entered.
You can use this feature on the cardholder screen for advertising,
preventing screen burn‐in or when the terminal is in Out‐of‐Service,
Off‐Line, Supervisor (when control is at the rear) or Suspend mode.
The feature is invoked by the following control sequence, which is
included in the idle screen referenced from the Card Read state:
Table 3-23 Character Description
Number of
Change Display While Idle Characters
ESC ‘[‘ Control Sequence Introducer 2
Variable Delay Time in 100 millisecond intervals 3
(000‐999)
‘z’ Function‐defining character 1
If this control sequence appears anywhere other than in the idle
screen, it is ignored. For example, idle screens in Out‐of‐Service
mode must be defined for reserved screen ‘C02’, not the default
display screen ‘002’. Nested screens can be invoked from the idle
screen to increase the amount of data that can be displayed during
the idle sequence.
For example, user‐defined screens 20 and 21 will be displayed
alternately for 10 and 15 seconds if the following idle screen is
defined:
S0 020 ESC [100z S0 021 ESC [150z
An idle screen delay sequence resets the following screen controls:
Cursor position reset to ‘@@’
Blink control off
Character set – single size alpha
Left margin set to left‐most column
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-30 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Foreground and background colours are reset to their defaults as
defined in resrvd.def.
If you are using rotating idle screen sequences for Out‐of‐Service or
Supervisor screens, NCR recommends that you send a screen
download containing the following information:
A non‐rotating idle screen at the start of the download
Any nested screens that are to be used in the idle sequence
A top‐level Out‐of‐Service/Supervisor screen at the end of the
download.
If you do not follow these guidelines, you may find that the idle
sequence jumps to its opening screen each time a screen download
message is sent.
Select Primary Character Set 3
ASCII codes in the range 20‐7F hex invoke display characters from
the single size alphanumeric 1 character set. Characters from
additional character sets including graphics can be invoked by the
following control sequence:
Table 3-24 Character Description
Number of
Select Primary Character Set Characters
ESC ‘(‘ Control Sequence Introducer 2
Variable Character Set Designator 1
When a Select Primary Character Set control sequence appears in
the screen data, the primary display characters that follow are
invoked using the specified character set, until the data delimiter at
the end of the outermost screen is reached, or until an idle screen
delay sequence occurs. If this happens, the character set defaults to
single size alphanumeric 1 until another Select Primary Character
Set control sequence appears.
Select Secondary Character Set 3
ASCII codes in the range 20‐7F hex, preceded by a ‘VT’ character,
invoke display characters from the customer graphics 1 character
set. Characters from additional character sets can be invoked for the
screen by the following control sequence:
Table 3-25 Character Description
Number of
Select Secondary Character Set Characters
ESC ‘)’ Control Sequence Introducer 2
Variable Character Set Designator 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-31
Screen Data
Formatting Rules for Cardholder Display Screens
When a Select Secondary Character Set control sequence appears in
the screen data, the secondary display characters that follow are
invoked using the specified character set, until the data delimiter at
the end of the outermost screen is reached, or until an idle screen
delay sequence occurs. If this happens, the character set defaults to
customer graphics 1 until another Select Secondary Character Set
control sequence appears, unless screen ‘M15’ has been changed.
Note: Customer graphics 1 is not supported by the basic or
enhanced operator interfaces.
Left Margin Control 3
The column position of the cursor following a CR control character
can be set by using the following control sequence. The default is
column 00.
Table 3-26 Character Description
Number of
Set Left Margin Position Characters
ESC ‘[‘ Control Sequence Introducer 2
Variable Column Number (00‐31) 2
‘p’ Function‐defining character 1
When a Left Margin control sequence appears in the screen data, all
subsequent CR control characters will return the cursor to the
column specified, until either the data delimiter at the end of the
outermost screen is reached or until an idle screen display sequence
occurs. The left margin control will then default to column 00.
Set Display Mode Control 3
Advance NDC supports display modes of 640 by 480 and above. If
the Set Display Mode control is sent, it is ignored as screen
resolution cannot be changed at runtime. For more information
about display resolution refer to the APTRA Advance NDC,
Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-32 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Logo Control 3
This command is used for the cardholder screen to display one of
100 logos stored on the system disk.
Table 3-27 Character Description
Number of
Select Logo Characters
ESC ‘P’ Device Control String Introducer 2
‘1’ Control String ID 1
Parameter The logo number to be displayed in the range 2
00‐99.
ESC ‘\’ String Terminator 2
A logo is the same as a picture. Logos are displayed from the current
cursor position. After displaying the logo, the cursor is at the same
column position as the start of the logo. The row position will be the
next free line after the logo.
The logo is displayed, but will be clipped if the difference between
the current row position and the maximum row position (15) is less
than the logo length, or if the difference between the current column
position and the maximum column position (31) is less than the
width of the logo.
If the logo files are large, the capacity of the system disk may be
reached before the limit of 100 logos.
Picture Control 3
This command is used for the cardholder screen to display one of
10,000 pictures stored on the system disk.
The six predefined lead‐through pictures (pic00<n>.png) are
numbered ‘000’, ‘001’, ‘003’ to ‘006’, and are also displayed by
reserved graphics screens G00–G01, G03–G06. The predefined
pictures are stored in C:\Program Files\NCR APTRA\Advance
NDC\Media on the SST. Screen G02 is not used and screens G07–
G09 are reserved.
Note 1: Various graphic formats are supported, including PNG,
JPEG, GIF, TIFF, and JIFF. NCR recommends that an uncompressed
bitmap format, for example BMP or PNG, is used if display
performance is critical. The use of highly compressed formats such
as JPEG may result in degradation of the display performance.
Note 2: As Advance NDC does not support the PCX file format, the
PCX extension is discarded and Advance NDC searches for a match
on the file name and extension of a supported format if a host
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-33
Screen Data
Formatting Rules for Cardholder Display Screens
download containing a reference to a PCX file in a screen definition.
For example, image.pcx can be resolved as image.png. If a match
cannot be found, a screen containing the image name is displayed.
Picture Control Command Pictures can be displayed with the 3
following control string:
Table 3-28 Character Description
Number of
Picture Control Command Characters
ESC ‘P’ Device Control String Introducer 2
‘2’ Control String ID 1
parameter The picture number to be displayed. Range Var (1‐3)
0‐9999.
ESC ‘\’ String Terminator 2
Pictures are displayed from the current row position. The picture is
displayed, but will be clipped if the difference between the current
row position and the maximum row position (15) is less than the
picture length, or if the difference between the current column
position and the maximum column position (31) is less than the
width of the picture.
If the picture files are large, the capacity of the system disk may be
reached before the limit of 10,000 pictures.
Display Image Files Control 3
This control code allows you to display pictures on the screen, using
the following control string:
Table 3-29 Character Description
Number of
Display Image File Command Characters
ESC ‘P’ Device Control String Introducer 2
‘E’ Control String ID 1
parameter The name of the image file to be displayed Var
ESC ‘\’ String Terminator 2
The filename is an ASCII string containing the filename and
optionally the path of the image file. The default path is C:\Program
Files\NCR APTRA\Advance NDC\Media.
Note: When an AVI file is defined in a download, Advance NDC
expects the filename to contain no more than eight characters
(<xxxxxxxx>.avi). If a longer name is used, anything after the eighth
character is ignored.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-34 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
When a screen containing this control sequence is displayed, the
image is drawn starting from the current cursor position.
Lift Cheque Image Control 3
This control code allows you to display a lifted cheque image on the
screen, using the following control string:
Table 3-30 Character Description
Number of
Display Lifted Cheque Image Command Characters
ESC ‘P’ Device Control String Introducer 2
‘S’ Control String ID 1
(x,y) x = Width Scaling Var
y = Height Scaling
as percentages of total width/height
Image Path Path to directory where image is stored. Var
Must be the same directory as specified
when the cheque processor was configured.
‘/’ Separates Image Path and Filename 1
Filename Name of Image File to be displayed Var
ESC ‘\’ String Terminator 2
The filename is an ASCII string containing the filename of the
cheque image file; for example, cheque.bmp.
When a screen containing this control sequence is displayed, the
cheque image is drawn starting from the current cursor position. A
half inch black stripe is drawn at the bottom of the cheque to mask
the codeline.
How cheque images are displayed on the screen can also be
controlled by local configuration parameters on the SST. For details,
refer to the APTRA Advance NDC Developer’s Guide.
Bunch Cheque Image Display Control 3
This displays the following as required during bunch cheque
acceptance:
A specific image for a specific cheque
A selected image from the available list during the Cheque
Summary Display state. For details, see “z004 – Display Cheque
Summary State” on page 2‐150
How cheque images are displayed on the screen can be controlled
by local configuration parameters on the SST. For details, refer to
the APTRA Advance NDC Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-35
Screen Data
Formatting Rules for Cardholder Display Screens
Table 3‐31 Number of
Character Description
Bunch Cheque Image Display Control Characters
ESC ‘P’ Device Control String Introducer 2
‘t’ Control String ID 1
Side The side of the cheque to display as follows: 1
0 ‐ the front
1 ‐ the back
‘;’ Separator 1
x Defines the scaling used for the width of the Var
image as a percentage of the display width
‘;’ Separator 1
y Defines the scaling used for the height of the Var
image as a percentage of the display height
‘;’ Text terminator 1
Image Identifies which of the multiple images of a 2
selector cheque to display using an index from the
list of images requested for each cheque
‘;’ Separator 1
Cheque ID Specifies the cheque to display 3
If this is set to 000, the state displaying the
image selects the cheque based on an
internal cheque display index
This ID is the identifier assigned to the
cheque by the bunch cheque acceptor and is
also used in the following message fields:
Bunch cheque deposit fields, Data ID ‘g’,
in the Transaction Request message
Cheque fields, Buffer Identifier ‘b’, in
the Transaction Reply
See Table Note 6
ESC ‘\’ String Terminator 2
Table Note 6: As a bunch cheque acceptor can hold more cheques
than can be listed on a single screen, the cardholder can navigate
between screens containing subsets of the available cheques. If this
occurs, only the state displaying the cheques can identify which
cheque is currently displayed and the Cheque ID parameter is set to
zero.
When a screen containing this control sequence is displayed, the
cheque image is drawn starting from the current cursor position. A
half inch black stripe is drawn at the bottom of the cheque to mask
the codeline.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-36 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Bunch Cheque Codeline Display Control 3
This displays the codeline for a cheque during bunch cheque
acceptance.
Note: If you are complying with the payment card industry (PCI)
guidelines, you must not use this control sequence.
Table 3-32 Character Description
Number of
Bunch Cheque Codeline Display Control Characters
ESC ‘P’ Device Control String Introducer 2
‘u’ Control String ID 1
Cheque ID Specifies the cheque to display 3
If this is set to 000, the state displaying the
image selects the cheque based on an
internal cheque display index
See Table Note 6
ESC ‘\’ String Terminator 2
Bunch Cheque Amount Display Control 3
This displays the amount for a cheque during bunch cheque
acceptance.
Table 3-33 Character Description
Number of
Bunch Cheque Amount Display Control Characters
ESC ‘P’ Device Control String Introducer 2
‘v’ Control String ID 1
Cheque ID Specifies the cheque to display 3
If this is set to 000, the state displaying the
image selects the cheque based on an
internal cheque display index
See Table Note 6
; Separator 1
Amount Selects the screen used to define the display 3
screen of the amount
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-37
Screen Data
Formatting Rules for Cardholder Display Screens
Number of
Character Description
Characters
; Separator 1
Amount Specifies whether to display the Courtesy 3
selector Amount Recognition/Legal Amount
Recognition (CAR/LAR) derived amount or
the amount entered by the cardholder, as
follows:
0 ‐ display the derived amount
1 ‐ display the amount entered by the
cardholder
2 ‐ display the derived amount, unless this
has been amended by the cardholder when
the amended amount is displayed
ESC ‘\’ String Terminator 2
Bunch Cheque Value Display Control 3
This is used to display values held in the Advance NDC buffers
during bunch cheque acceptance.
Table 3-34 Character Description
Number of
Bunch Cheque Value Display Control Characters
ESC ‘P’ Device Control String Introducer 2
‘w’ Control String ID 1
Value Specifies the value to display, as follows: 3
Selector 000 ‐ cheque index
001 ‐ total number of cheques inserted
002 ‐ total number of cheques that have been
added to the escrow
003 ‐ reserved
004 ‐ number of cheques to be returned to
the cardholder
005 ‐ total amount of the cheques to be
deposited. This is the sum of the individual
cheques
006 ‐ contents of the Amount Buffer
007 ‐ contents of general purpose buffer A
008 ‐ contents of general purpose buffer B
009 ‐ contents of general purpose buffer C
See Table Note 6
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-38 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Number of
Character Description
Characters
; Separator 1
Value Selects the overlay screen that defines how 3
Format the value is to be displayed
Screen If this is set to 000, no formatting is applied
ESC ‘\’ String Terminator 2
Displaying the Amount Buffer Value When the Value Selector is 3
006, the value of the Amount buffer will be displayed in the Cheque
Detail Display and Display Cheque Summary states according to
the screen definition specified by the Value Format Screen.
The Value Format overlay screen defines the alignment, positioning,
currency symbol and decimal point of the data in the Amount
buffer. The alignment of the data is determined by the position of
the asterisks and digits in the overlay screen. The number of
asterisks defined is variable. The currency symbol and decimal
point are variable and optional.
If the screen definition is ʹ$*****0.00ʹ, the Amount Buffer value will
be aligned to the right of the display area on the screen and it will
expand to the left
If the screen definition is ʹ$0.00*****ʹ, the Amount Buffer value will
be aligned to the left of the display area on the screen and it will
expand to the right.
Any other screen format definition is ignored. For example, if the
screen definition is $***0.00**, it is ignored and the Amount Buffer
value will be displayed aligned to the right of the display area.
Example of Amount Buffer Display Formatting If the If the 3
Bunch Cheque Value Display Control sequence is the following:
<ESC>Pw006;500<ESC>\
and the Amount Buffer has a value of 1100200300.45, the screen
definition can be ʹ$*********0.00ʹ or ʹ$0.00*********’.
If the screen definition is ʹ$*********0.00ʹ, the Amount Buffer is
aligned to the right and displayed as ‘$ 1100200300.45’.
If the screen definition is ʹ$0.00*********ʹ, the Amount Buffer value is
aligned to the left and displayed as ‘$1100200300.45 ‘.
Display Dynamic Text Dictionary Control Sequence 3
This control sequence defines and displays the text to be used to
communicate dynamic conditions to the cardholder, for example
the reason for an error. This control sequence associates text with an
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-39
Screen Data
Formatting Rules for Cardholder Display Screens
enumerated value that can be defined from a dynamic condition
within a state. This control sequence is only used in screens that are
displayed within state tables. The text is specific to the screen in
which the control is defined.
For example, this sequence can be used to define the text to explain
why cheques have been refused during the Bunch Cheque Accept
state. The state determines the reasons, converts the reasons to an
enumerated value, and uses the enumerated value to determine the
required text.
The text is displayed at the position on screen where the dictionary
is defined.
At run‐time, if a state determines that an enumerated value does not
exist in the dictionary, the text associated with a default value is
used. The state defines the default enumerated value and whether it
is mandatory. If the default enumerated value is mandatory, but not
provided in the download, the dictionary is ignored and is not used.
Table 3-35 Character Description
Number of
Display Dynamic Text Dictionary Control Characters
ESC ‘P’ Device Control String Introducer 2
‘x’ Control String ID 1
Dictionary Dictionary identifier 3
ID Range 000‐999
The meaning is defined by the state using
the data and the scope is limited to the
screen defining the dictionary, therefore the
same identifier can be used in multiple
screens to refer to different dictionaries
‘;’ Separator 1
Enumerated Defines one or more enumerated values to Var
value list 0 which the text following the next Separator
relates
This parameter consists of one or more
three‐character alphanumeric values with
characters in the range 0‐9 and A‐Z. When
multiple values are included each value is
separated by a comma. No comma is
required after the last entry in the list
For numeric values, for example error
reasons, the value is limited to a range of
000‐999
For text‐based values, for example currency
identifiers, alphabetic characters can be used
‘;’ Separator 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-40 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Number of
Character Description
Characters
Display text The text associated with the previous Var
0 enumerated value. The text is enclosed in
double quotation marks (0x22). If a
quotation mark is to be included, it must be
preceded by a backslash (0x5C)
Display formatting must be contained in the
screen that uses the dictionary value.
If the display character is only available in
specific character sets, for example currency
symbols, the text must contain the sequence
to ensure the correct display of the required
characters. Any modified display attributes
must be reset
See “Example Display Text” on page 3‐41
‘;’ Text terminator 1
Enumerated Defines one or more enumerated values to Var
value list 1 which the text following the next Separator
relates
‘;’ Separator 1
Display text The text associated with the previous Var
1 enumerated value.
‘;’ Text terminator 1
Enumerated Defines one or more enumerated values to Var
value list n which the text following the next Separator
relates
See Table Note 7
‘;’ Separator 1
Display text The text associated with the previous Var
n enumerated value
See Table Note 7
ESC ‘\’ String Terminator 2
Table Note 7: Enumerated values and related display text are
repeated until all required values have been defined.
Example Display Text Display formatting must be contained in 3
the screen that uses the dictionary value, as shown in the following
examples:
To display HELLO, enter the following:
“HELLO”
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-41
Screen Data
Formatting Rules for Cardholder Display Screens
To display I said “HELLO”, enter the following:
“I said \”HELLO\””
To display HELLO (and any subsequent text) in red, enter the
following:
“(ESC)[00;21mHELLO”
Note: In the downloaded text, (ESC) is replaced by 0x1B, and
the actual text is as follows:
0x22 0x1B 0x5B 0x30 0x30 0x3B
0x32 0x31 0x6D 0x48 0x46 0x4C
0x4C 0x4F 0x22
Dynamic Button Control 3
Advance NDC offers the capability of creating dynamic FDK menu
systems by enabling or disabling a button, depending on a defined
set of conditional expressions. This allows Central to build a menu
system accurately reflecting an available transaction set or
application configuration without taking the SST out of service to
update the screen data.
Note: Dynamic buttons are supported for NDC‐formatted screen
definitions only.
The following control code is available for the definition of a button
with a conditional expression parameter specifying the conditions
that must be true for the button to be enabled:
Table 3-36 Character Description
Number of
Dynamic Button Definition Characters
ESC P ‘b’ Device Control String Introducer 3
Fixed FDK identifier (F1 — F8) 2
‘;’ Separator 1
Variable Text to display on the button Var
‘;’ Separator 1
Variable Icon filename Var
‘;’ Separator 1
Variable Index to dynamic content hook Var
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-42 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Number of
Character Description
Characters
‘;’ Separator 1
Variable Conditional expression Var
If none is specified, the button is always
enabled
ESC ‘\’ String Terminator 2
An example of this control is as follows:
<ESC>PbF1;Cash Withdrawl;PICTURE1.PNG;002;TRUE<ESC>\
The dynamic content hook is defined in DisplayManagerConfig.xml.
For details of this file, refer to the APTRA Advance NDC Developer’s
Guide.
Syntax of Conditional Expressions 3
Conditional expressions can be simple or complex. You can query
multiple devices by using logical AND (&) and logical OR (|) with
DIGs and their sub‐components. A logical AND specifies that both
devices on either side of the operator must be available. A logical
OR specifies that one of the devices on either side of the operator
must be available. The syntax examples in the table show queries for
the cash handler (DIG ‘E’) and its cassettes and the receipt printer
(DIG ‘G’)
Table 3-37 Query Type Syntax
Syntax of Conditional Expressions
To check whether two devices Simple E&G
are both available
To check whether either the cash Simple E|G
handler or receipt printer is
available
To check that the cash handler is Simple E&!G
available but the receipt printer
is not available
To check whether cassette type 1 Complex E001&E002|E003
AND cassette type 2 are or
available OR cassette type 3 is (E001&E002)|E003
available
Dynamic Text Control 3
Advance NDC offers the capability of creating dynamic screen text
by enabling or disabling a string, depending on a defined set of
conditional expressions. This allows Central to build, for example, a
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-43
Screen Data
Formatting Rules for Cardholder Display Screens
dynamic idle sequence accurately reflecting the set of operations
available for a transaction without taking the SST out of service to
update the screen data.
Note: Dynamic text is supported for NDC‐formatted screen
definitions only.
The control code for the definition of dynamic text has a mandatory
data parameter, which specifies the devices that must be available
for the text to be displayed. The control code is defined in the
following table:
Table 3-38 Character Description
Number of
Dynamic Text Definition Characters
ESC ‘q’ Device Control String Introducer 2
Variable Text to display Var
‘;’ Separator 1
Variable Index to dynamic content hook Var
‘;’ Separator 1
Variable Conditional expression Var
ESC ‘\’ String Terminator 2
An example of this control is as follows:
<ESC>qTHIS IS DYNAMIC;002;FALSE<ESC>\
The dynamic content hook is defined in DisplayManagerConfig.xml.
For details, refer to the APTRA Advance NDC Developer’s Guide.
For more information about conditional expressions, see “Syntax of
Conditional Expressions” on page 3‐43.
Animation and Digital Video 3
This enables you to display a predefined animation or digital video
sequence on the screen. This sequence is a type of picture and is
displayed as a picture. For details, see “Picture Control” on
page 3‐33.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-44 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
The following table gives examples of the multi‐media formats that
are supported when the appropriate codecs are installed on the SST:
Table 3-39 Extension Description
Video and Animation File Formats
AVI Audio Video Interleave: a Microsoft container format for
audio and video files
MP4 For Windows Media Player from Microsoft
WMV Windows Media Video: a subset of the Advanced
Systems Format (ASF) container format from Microsoft
MPEG 1,2 Moving Pictures Experts Group: responsible for the
development of standards for the coded representation
of digital audio and video and related data
MOV QuickTime: a multi‐platform, multi‐media file format
from Apple
DIVX Compressed video format from DivX, Incorporated
XVID Open‐source video format following the MPEG‐4
standard
Supported Codecs The codecs which are supplied with Windows 3
7 and enabled by default are only supported. If you wish to use a
third party codec or enable a codec, which is supplied with
Windows 7 but not enabled by default, please contact NCR FSE
Product Management.
An animation or digital video sequence may alternatively be
defined as a file. In this case, it is displayed as an image file. For
details, see “Display Image Files Control” on page 3‐34.
The Amount Display screen is an overlay screen which you assign
International Currency and which is referenced from an amount entry state. This feature
Display Format 3
allows you to display an amount entry field, relating to the specific
currency, and an entry echo field. This is used on screens that
prompt for amount entry.
The cardholder screen cursor is set to the left of the echo field for
amounts entered by the cardholder. You can also define an echo
field format for amount entry. This is a simple text string that is
displayed at the cursor position on entry into an amount entry state.
The maximum length of the echo field is 32 characters. This includes
up to 12 data entry characters (*), a character defining the decimal
point position, zero prefill characters and leading currency
characters.
The only screen control characters that can appear in this screen are
the ‘set cursor position’ character, and the ‘secondary character set
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-45
Screen Data
Formatting Rules for Cardholder Display Screens
introducer’ (VT) character. All other characters are ignored. If you
need to use some other attribute for the amount display screen, you
must include it in the screen on which the amount screen is
superimposed (the screen called from state table entry 2 of an
amount entry state).
The decimal point character can be ‘.’ or ‘,’.
The following example shows the echo field for eight‐digit fields,
and then the extensions for twelve digits.
Currency Echo Example 3
If the screen contains SI’@@LIRA ***0,000’, the following is
displayed at the top left corner of the cardholder screen:
Table 3-40 LIRA 0,000 Initial display before amount entry by cardholder
Currency Echo Example
LIRA 0,001 First entry cardholder types 1
LIRA 0,012 Second entry cardholder types 2
LIRA 0,123 .
LIRA 1,234 .
LIRA 12,345 .
LIRA 123,456 .
LIRA 1234,567 .
LIRA 2345,678 Eighth entry cardholder types 8.
If no echo field format is defined, for example SI ‘@@’, a default
screen is used, ‘$ *****0.00’.
When configured by option 01 in the Enhanced Configuration
Parameters Load message, the amount entry buffer can contain up
to twelve digits. For details, see “Configuration Parameters Load”
on page 10‐15. This affects the amount echo field in the following
ways:
Up to 12 data entry characters (*) can be used
the default is ‘$ *********0.00’ if no echo field format is defined.
Example of Default Echo Display Format 3
In the following example, ‘b’ = space:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-46 APTRA™ Advance NDC, Reference Manual
Screen Data
Formatting Rules for Cardholder Display Screens
Table 3-41 bbbbb$b0.00 Initial default display before amount entry by
Default Echo Display Format cardholder
$b0.01 First entry cardholder types 1
$b0.12 Second entry cardholder types 2
$b1.23 Third entry cardholder types 3
$b12.34 Fourth entry cardholder types 4
. .
. .
$b123456.78 Eighth entry cardholder types 8
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-47
Screen Data
Multi-Language Screens
Multi‐Language Screens 3
You can create up to 9,999 multi‐language cardholder screens to be
displayed as requested from one of the language select states. You
do this by defining a group of screens for each language (screen
group). The first screen in each screen group is defined by the screen
base.
The following rules must be applied when creating the screen
groups:
All the screens that can be displayed in multiple languages must
be defined in each screen group.
The equivalent screen for each language must occupy the same
relative position within the screen groups. This ensures that the
correct screen is selected when the language offset is applied.
Nested screens must have absolute positions.
If a language has been selected and the group size is 1000 or
greater, then a nested screen specified as a three digit decimal
number is adjusted for language. If the language adjusted screen
has not been loaded then the unadjusted screen is used instead.
Thus permitting logos and pictures to be defined only once in
the base language. This is as per the US NDC+ implementation.
The first group must start at ‘000’ or ‘0000’, and contain those
Multi‐Language Screen screens for which language selection is not possible, that is, screens
Numbering 3
displayed from the Card Read state and Language Select From Card
state. Screens normally associated with not‐in‐service conditions,
such as Out‐of‐Service, Supply and Off‐Line, should also be in this
group if the default cardholder display screens (page 3‐6) are used.
To allow language selection, you do not need to change the state
tables but you must include a language‐selection state such as the
following:
“Y ‐ Eight FDK Selection Function State” (page 2‐88)
“V ‐ Language Select From Card State” (page 2‐82)
“m ‐ PIN & Language Select State” (page 2‐98)
Extended Screen Groups 3
The extended screen group configuration changes the way that the
language offset is defined in the language selection states as follows:
If extended screen groups are not enabled, the screen offset that
can be applied to screens with a screen number over 1000 is
incremented in multiples of 1000 because the screen base
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-48 APTRA™ Advance NDC, Reference Manual
Screen Data
Multi-Language Screens
definitions must be in the range 001 to 009. For example, you
could specify 001, 002, 004 and 006 to define four languages with
screen bases of 1000, 2000, 4000 and 6000.
If extended screen groups are enabled, the screen offset that can
be applied to screens with a screen number over 1000 can be
incremented in multiples of 100 because the screen base
definitions must be in the range 010 to 099. This increases the
number of available screens. For example, you could specify
010, 025, 050 and 075 to define four languages with screen bases
of 1000, 2500, 5000 and 7500.
For information on configuring extended screen groups, refer to
Chapter 5, “Configuring Advance NDC and Associated
Components” in the APTRA Advance NDC, Developer’s Guide.
For further examples of the definition of screen groups, see
“Example Screen Group Definitions” below.
Example Screen Group Definitions 3
The following sections provide example screen group definitions.
Four Languages With Three‐Digit Screen Numbers For example, 3
if four languages are required and three digits are used for the
screen numbers, the screen group bases defined in either state ‘Y’ or
state ‘m’ could be as follows:
Language A – ‘000’
Language B – ‘100’
Language C – ‘200’
Language D – ‘300’
The screen group size defined in state ‘V’ would be ‘100’.
If screen ‘025’ is defined from a state table, the screen is displayed as
follows:
‘025’ for language A
‘125’ for language B
‘225’ for language C
‘325’ for language D
Four Languages with Extended Screen Groups Enabled If four 3
languages are required and extended screen groups are enabled, the
screen group bases defined in either state ‘Y’ or state ‘m’ could be
the following:
Language A ‐ ‘0000’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-49
Screen Data
Multi-Language Screens
Language B – ‘2500’
Language C – ‘5000’
Language D – ‘7500’
The screen group size defined in state ‘V’ would be ‘025’,
representing ‘2500’.
If screen ‘025’ is defined from a state table, the screen is displayed as
follows:
‘0025’ for language A
‘2525’ for language B
‘5025’ for language C
‘7525’ for language D
If screen ‘B25’ is defined from a state table, the screen is displayed as
follows:
‘1125’ for language A
‘3625’ for language B
‘6125’ for language C
‘8625’ for language D
Four languages with Extended Screen Groups Disabled If four 3
languages are required, four digits are used for the screen numbers
and extended screen groups are disabled, the screen group bases
defined in either state ‘Y’ or state ‘m’ could be as follows:
Language A – ‘0000’
Language B – ‘1000’
Language C – ‘2000’
Language D – ‘3000’
The screen group size defined in state ‘V’ would be ‘001’,
representing ‘1000’.
If screen ‘025’ is defined from a state table, the screen is displayed as
follows:
‘0025’ for language A
‘1025’ for language B
‘2025’ for language C
‘3025’ for language D
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-50 APTRA™ Advance NDC, Reference Manual
Screen Data
Multi-Language Screens
When multi‐language screens are supported, you must redefine the
Redefining Reserved reserved screens used during cardholder transactions as follows:
Screens 3
‘C00’ – must contain an insert screen with the control sequence
SO l0000.
The first screen (‘0000’) in each language group must contain the
time‐out screen. If a control sequence other than SO l000 is in
screen ‘C00’, the same screen will be displayed for all languages.
‘C01’, ‘C02’, ‘C03’ – No change in definition.
‘C04’ – Contains a null value if not used.
Contains an insert screen for the relative screen number to be
displayed for each language; for example, the control sequence
SO xxx, where xxx is the offset in the screen group.
Contains screen data if the same screen is to be displayed for all
languages.
‘C05’ – No change in definition.
‘C06’ – No change in definition.
‘C07’ – No change in definition.
The usage of each screen does not change.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-51
Screen Data
Displaying Pictures
Displaying Pictures 3
This section discusses some points to consider when you are
preparing pictures for display on the terminal.
The following image formats are supported:
JPEG
GIF (including animated and transparent GIFs)
PNG (including transparent PNGs)
TIFF
SWF.
Note 1: The use of SWF files on SSTs requires a licence. A licence ID
can be purchased from NCR.
Note 2: The PCX file format is not supported by Advance NDC. If a
host download contains a reference to a PCX file, Advance NDC
discards the extension and searches for a file with the same name
and a supported extension.
The first picture displayed determines the amount of stretching that
Picture Resolution 3
is applied to all pictures. For example, if the desktop resolution is set
to 1024 x 768 and the first picture displayed is 800 x 600, the picture
is scaled up to 1024 x 768. All subsequent pictures will be scaled by
the same amount.
The following points should be considered when you are preparing
Guidelines for Pictures 3
pictures for screen display:
To avoid display flicker with a full‐screen file, include a form
feed at the start of the screen definition.
The supply mode screen, C03, is a cardholder display used
when the terminal is in Supervisor mode. It must be of the same
resolution as those used during the rest of Supervisor mode if
switching from back to front displays.
Screens used during an idle sequence should be constructed
using the same resolution.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-52 APTRA™ Advance NDC, Reference Manual
Screen Data
Screen Reset
Screen Reset 3
A screen reset sequence is included as a reserved screen, ‘M15’, in
the resrvd.def file. This screen sets the left margin and the primary
and secondary character sets. It is sent when Advance NDC
displays a primary screen (that is, one that is not part of a nested
sequence).
A second screen reset sequence, ‘M16’, is also included in the
resrvd.def file. This screen can contain sequences to be sent to the
display when the form feed character (0C hex) is received from
Central. The default sequence clears the screen and sets the cursor to
the top left‐hand corner, sets screen blinking off, sets the colours to
default and resets the display mode to the Advance NDC default.
The default data for these two screens is as follows:
‘M15’ ESC[00p ESC(1 ESC)6
‘M16’ DC2 ESC[00m ESCPi0 ESC\ FF
Note: As the FF control clears the screen, any modification to
screen M16 must take this into account. For example, to make the
background transparent, M16 must be updated as follows:
DC2 FF ESC[00;80m ESCPi0 ESC\
For more information about FF and control codes, see “Control
Characters” on page 3‐16 and “Control Codes for Special Features”
on page 3‐20.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-53
Screen Data
Supervisor Settlement Screens
Supervisor Settlement Screens 3
Supervisor settlement transactions are designed to allow a set of
SST‐related transactions (such as settlement of cash in the SST) to be
performed using the operator keyboard, and without a Supervisor
card. This avoids having to use a Supervisor card to activate a set of
transaction flows in a download.
As well as screen C09, a set of transactions parameter screens (C10–
C19) can be used for this purpose. When present, screens C10–C19
override screen C09. Supervisor settlement transactions can only be
carried out if the information relating to the transactions to be
performed has been downloaded in one of these reserved screens.
Selecting the Supervisor transactions function (menu item 15 SUPV
TRANS) on the Supervisor Replenish menu enables Supervisor
settlement transactions. This indicates that on the next entry to
In‐Service mode, the operator panel is to be enabled for one or more
predefined settlement transactions to be performed prior to the
cardholder interface being enabled.
If more than one of the screens between C10–C19 are present and
valid, the operator is asked to choose which one to use for the
settlement transaction. If only one is present and valid, it is used
and the operator does not have to make any selections. If none is
present, screen C09 is used.
On a front‐access SST, the cardholder display and keyboard or the
Using the Front or Rear front operator keyboard can be used to perform the transactions. On
Interface for Settlement 3
a rear‐access SST, the cardholder display shows the In Supervisor
screen (003) throughout the duration of the Supervisor settlement
transactions.
Rear Settlement and International Security (DAPI‐7) 3
If International Security is configured, rear settlement is not always
possible. If an EPP is configured and PIN entry is required, PIN
entry at the rear interface is not possible owing to a restriction in
CEN‐XFS. The interface for PIN entry can be controlled through the
registry and Supervisor Message Mode.
For the registry setting, refer to the APTRA Advance NDC,
Developer’s Guide. For the Supervisor Message Mode option digit
(6A), refer to the APTRA Advance NDC, Supervisor’s Guide.
For information about Security configuration, refer to the APTRA
on‐line documentation under APTRA XFS | Programmer’s
Reference.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-54 APTRA™ Advance NDC, Reference Manual
Screen Data
Supervisor Settlement Screens
When the operator selects the Supervisor Transactions function at
Supervisor Settlement the SST, screens C09–C19 are checked for valid Supervisor
Transactions 3
settlement transaction data.
Valid screens contain a definition of the card track data that would
be on the supervisor card, and definitions for all the data required to
be collected by the transaction flows. For each transaction, the
Operation Code buffer that would have been created by the
transaction flow is also defined. The format of the screens is defined
in “Transactions Parameter Screens (C09–C19)” on page 3‐56.
During settlement, the operator may be presented with the
following prompts for data entry:
PIN-, FUNC-, CASH-, BUFFER B-, BUFFER C-
For more information about the prompts for data entry, refer to the
APTRA Advance NDC, Supervisor’s Guide, chapter 3, “Replenish
Menu”, section “15 SPVR TRANS (Supervisor Transactions)”.
The screens for all functions, and the PLEASE WAIT screen shown
during processing, are provided in resrvd.def. The screens may be
customised to show more clearly what functions are offered and
what values are to be entered. For example, the BUFFER C- prompt
could be changed to display ENTER NO OF NOTES as the prompt.
For the default settlement screens in resrvd.def, see “‘i’ Supervisor
Settlement Screens” on page A‐92.
On completion of data entry, the Transaction Request message is
created using the specified Transaction Request state, file and
entered data, and sent to Central (the Host). For details of the
Transaction Request state, see “I ‐ Transaction Request State” on
page 2‐39.
If the host does not respond within the transaction time‐out period,
the Central Response Timeout Next State Number exit from the
Transaction Request state is used to check against the next
state/action table from the data file, and the appropriate action is
taken.
Valid Commands 3
Only ‘Print Immediate’ and ‘Next State and Print’ commands are
acceptable; any other commands are acted on as a ‘Next State and
Print’ command. Only the next state field and print fields for the
receipt/journal are used; other fields in the message are ignored.
Therefore, care needs to be taken when deciding how Central
should respond to these transaction requests.
All printing associated with the receipt and journal is performed,
and a status sent. A print immediate with no next state will wait for
a further command. For any other command, the next state is
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-55
Screen Data
Supervisor Settlement Screens
checked against the next state/action table in the data file. A match
in the Next State Number table will cause the equivalent next state
action value to be checked for one of the following actions to be
taken:
Prompt for next transaction
Indicate transaction failure and prompt for next transaction
Exit to normal In‐Service mode
Indicate transaction failure and then exit to normal In‐Service
mode.
If no match in the table is found, the first action is performed.
The following fields are defined for screens C09 and C10–C19. You
Transactions Parameter must ensure that the field data is correct and within the permitted
Screens (C09–C19) 3
values.
If a failure is indicated, the message ʹFAILnʹ is displayed, where n is
the next state offset number in the transaction data next state table.
Table 3-42 Field Length (Bytes) Content/Meaning
Field Definitions for Screens C09–C19
a 1 ʹ0‐9ʹ, ʹ:ʹ ‐ Number of Active Transactions
(: = 10)
b Var (1‐78) Track 1 data, including start and end sentinels. If
there is no Track 1 data, insert end sentinel only.
c Var (1‐39) Track 2 data, including start and end sentinels. If
there is no Track 2 data, insert end sentinel only.
d Var (1‐106) Track 3 data, including start and end sentinels. If
there is no Track 3 data, insert end sentinel only.
e 1 PIN Flag.
0 ‐ No PIN collect.
1 ‐ PIN collect.
f 3 Transaction Request State Number. Used to
create Transaction Request message.
g 30 Next State Number Table. 10 entries (3 bytes
each). Used for comparison to next state in
transaction reply.
Not used entries = 255.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-56 APTRA™ Advance NDC, Reference Manual
Screen Data
Supervisor Settlement Screens
Field Length (Bytes) Content/Meaning
h 10 Next State Action Table. 10 entries (1 byte each);
one for each of the Next state values defined
above.
Values 0‐3:
0 ‐ Function complete, prompt for next
transaction.
1 ‐ Function failed, prompt for next transaction.
2 ‐ Function complete, return to normal
operation.
3 ‐ Function failed, return to normal operation.
i 8 Operation Code Buffer transaction n
Values ‘A’ ‐ ‘I’ or space.
j 1 Length of Buffer B transaction n
Values 0‐8 or ‘?’
‘?’ ‐ Buffer entry required.
k Var (0‐8) Data for Buffer B, length as specified by field ‘j’
(0‐8). Not present if field ‘j’ = ‘?’.
Values 0‐9.
l 1 Length of Buffer C transaction n
Values 0‐8 or ‘?’.
‘?’ ‐ Buffer entry required.
m Var (0‐8) Data for Buffer C, length as specified by field ‘1’
(0‐8). Not present if field ‘1’ = ‘?’.
Values 0‐9.
: Fields ‘i’ ‐ ‘m’ are repeated for the number of
: transactions specified by field ‘a’.
n Var (0‐10) Amount Buffer Flags ‐ length is that of the
number of transactions specified by field ‘a’.
1 byte for each transaction specified
0 ‐ Amount entry not required
1 ‐ Amount entry required.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 3-57
Screen Data
Supervisor Settlement Screens
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
3-58 APTRA™ Advance NDC, Reference Manual
Table of Contents
Keyboard Data and Layouts
Chapter 4
Keyboard Data and Layouts
Overview 4‐1
The Keyboard Interface 4‐2
Physical Keyboards 4‐2
Touch Screen Keyboards 4‐2
FDK Emulation 4‐2
Full Touch Screen 4‐4
Associating Screens and Keyboards for FDKs 4‐4
Keyboard Mapping Examples 4‐6
Time‐Out State Example 4‐6
Information Entry State Example 4‐7
States and Keyboards 4‐8
Associated Keyboards for FDKs 4‐9
Secure PIN Entry and Keyboards 4‐9
Keyboards in Operation 4‐9
Standard Keyboard Layouts 4‐10
Transaction Processing 4‐10
Front Interface: Supervisor Mode 4‐12
Encryption Key Entry 4‐13
Secure Key Entry 4‐13
Rear Interface: Operator Keyboard Layout 4‐14
Defining Full Touch Screens 4‐16
Touch Areas 4‐16
Generic Keyboard Example 4‐16
Calculating Full Touch‐Screen Positions 4‐17
The Unary Co‐Ordinate System 4‐17
Co‐ordinate Format 4‐18
Conversion to IEEE Example 4‐18
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Keyboard Data and Layouts
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
D
Overview
Overview 4
This chapter provides information about the following:
? The keyboard interface
? States and keyboards
? Standard keyboard layouts
? Defining full touch‐screen keyboards
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-1
Keyboard Data and Layouts
The Keyboard Interface
The Keyboard Interface 4
The keyboard is part of the interface between the cardholder or
operator and the terminal. Keyboards can be physical devices, or
emulated on screen (touch‐screen keyboards).
For the front interface, SMS‐style alphanumeric data entry is
supported. On Branch Assist 18 terminals, PC‐keyboard data entry
is also supported.
The keyboard layout for the rear interface is fixed and cannot be
customised. Keyboard layouts for the front interface can be
customised. The following restrictions apply:
? Nested keyboards are not supported
? Except for FDKs, screen and keyboard associations are
ignored as keyboard layouts are defined at the platform and
service provider level.
? The Clear and Cancel key positions cannot be swapped.
For details of screen and keyboard associations for FDKs, see
“Associating Screens and Keyboards for FDKs” on page 4‐4.
A physical keyboard consists of the keypad and FDKs. It is
Physical Keyboards 4
configured using the PIN and TTU service providers. For more
information, refer to the APTRA Advance NDC, Developer’s Guide.
For terminals supporting touch screens, touch‐screen keyboards can
Touch Screen Keyboards 4
be used in either of the following modes:
? FDK emulation
? Full touch screen.
In order for Central to download the correct screens, it requests
information from the terminal as to whether FDKs or a touch screen
is configured. The terminal responds to this request by sending a
solicited configuration information status message to Central. For
details, see the “Device Status Information” section in Chapter 9,
“Terminal to Central Messages”.
FDK Emulation 4
A touch screen contains eight fixed touch areas which are touched
instead of pressing the corresponding FDKs. You can change the
screens that are displayed when the cardholder is required to make
a selection, but the number and position of the touch areas are fixed
and cannot be changed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-2 APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
The Keyboard Interface
The screens are changed using a Screen Data Load command from
Central, For details of the command, see “Screen/Keyboard Data
Load” on page 10‐11.
You can configure Advance NDC to sound a beep when an
emulated FDK is selected. For configuration details, refer to Chapter
5, “Configuring Advance NDC and Associated Component” in the
APTRA Advance NDC, Developer’s Guide.
The following diagram shows the location of the emulated FDK
touch areas.
Figure 4-1
Emulated FDKs: Touch Areas
A
B FDK I Touch Area FDK A Touch Area
C
FDK H Touch Area FDK B Touch Area
FDK G Touch Area FDK C Touch Area
FDK F Touch Area FDK D Touch Area
D E
The heights and widths used are given in the following table. The
heights and widths correspond to the rows and columns if the touch
screen is calibrated correctly.
Table 4-1 Measurement Fraction/Screen Fraction/Screen Corresponding Corresponding
Emulated FDKs: Touch Area Reference Height Width Row Column
Measurements
A 5/16ths 5
B 2/16ths 2
C 1/16th 1
D 15/32nds 15
E 2/32nds 2
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-3
Keyboard Data and Layouts
The Keyboard Interface
Full Touch Screen 4
You can design full touch‐screen keyboards that are easier to use
than the physical keyboard. This is particularly helpful for
cardholders with physical disabilities. Up to 200 rectangular areas
can be defined on the screen. For more information, see “Defining
Full Touch Screens” on page 4‐16.
Associated keyboards and downloadable keyboard definitions are
Associating Screens and supported for physical and emulated FDKs only.
Keyboards for FDKs 4
Associated keyboards are supported by the following states:
? Four FDK Selection Function (‘E’)
? Amount Entry (‘F’)
? Information Entry (‘H’)
? Enhanced Amount Entry (‘R’)
? FDK Information Entry (‘X’)
? Eight FDK Selection Function (‘Y’)
? Time‐Out
Associated keyboards are not supported by the following states:
? PIN Entry (‘B’)
? PIN & Language Select (‘m’)
? Enhanced PIN Entry (‘M’)
? Card Read ‐ PIN Entry Initiation (‘T’)
? Cheque Accept (‘w’)
? Cash Accept (‘>’)
? Barcode Read (‘&’)
Associations between screens and keyboards for FDKs can be
created using the Screen/Keyboard Data Load command. For
details, see “Customisation Data Commands” on page 10‐7.
The table below shows each FDK key with its key position code,
default key code, and the associated CEN‐XFS key literal.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-4 APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
The Keyboard Interface
Table 4-2
FDKs, Key Codes and CEN-XFS
equivalents
FDK FDK
Key Position Code Key Position Code
Default Key Code Default Key Code
CEN-XFS Code CEN-XFS Code
I A
17 18
FA F6
WFS_PIN_FK_FDK01 WFS_PIN_FK_FDK05
H B
19 20
F9 F5
WFS_PIN_FK_FDK02 WFS_PIN_FK_FDK06
G C
21 22
F8 F4
WFS_PIN_FK_FDK03 WFS_PIN_FK_FDK07
F D
23 24
F7 F3
WFS_PIN_FK_FDK04 WFS_PIN_FK_FDK08
Due to CEN‐XFS limitations, Advance NDC can only allow
remapping of logical CEN‐XFS keys and the key codes returned; for
example, pressing WFS_PIN_FK_FDK04 is interpreted as key code
F5.
A keyboard data field in the Screen/Keyboard Data Load message
data (see field “j1” on page 10‐12) contains pairs of data in the
following form, allowing CEN‐XFS keys to be mapped:
Table 4-3 Supported
Number of
Mapping CEN-XFS Keys Data
Characters
Range in Description
Advance NDC
Key 2 17 ‐ 24 Identifies the CEN‐XFS key
position to map from; this is the key
position that will be enabled.
Key code 2 F3 ‐ FA Identifies the CEN‐XFS key
to map to; this is the key code
to return, which will affect
the application behaviour.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-5
Keyboard Data and Layouts
The Keyboard Interface
If a value is not within the supported range or the data downloaded
from Central is incomplete, that key definition is ignored. If the
same key position is specified more than once in the data, the last
definition is used.
Note: Advance NDC only recognises the mapping of FDKs; invalid
mappings are ignored.
Any keys that are not specified in the Screen/Keyboard Data Load
message are not enabled. If no keyboard definition is specified or
the keyboard definition does not enable the required number of
keys, the default keyboard layout is used. To further reduce the
number of enabled FDKs, FDK keyboard masks can be specified if
supported by the state table for the keyboard input operation.
The following examples illustrate keyboard mapping in the
Keyboard Mapping Time‐Out and Information Entry states.
Examples 4
Time‐Out State Example 4
This example shows a Screen/Keyboard Data Load message for a
sample screen layout with an associated keyboard definition. Two
messages are shown; the second message modifies the text positions
and FDKs enabled. The same key codes are returned so the
application does not need to be changed.
Screen/Keyboard Data Load message 4
The message for a sample screen and default keyboard layout is as
follows:
3<fs><fs><fs>11<fs>000<FF><SI>BCWOULD YOU LIKE MORE TIME?<SI>FHPRESS
IF YES‐‐‐‐‐‐‐‐‐‐‐><SI>IHPRESS IF NO‐‐‐‐‐‐‐‐‐‐‐‐><GS>00518F620F5
To update the text positions and enable FDK D and FDK F, send the
following message:
3<fs><fs><fs>11<fs>000<FF><SI>BCWOULD YOU LIKE MORE TIME?<SI>O2PRESS
IF YES‐><SI>O@<‐‐ PRESS IF NO<GS>00524F623F5
In the keyboard definition for the Time‐Out state above, Advance
NDC will enable CEN‐XFS keys WFS_PIN_FK_FDK_08 (key
position 24) and WFS_PIN_FK_FDK_04 (key position 23).
If WFS_PIN_FK_FDK_08 is pressed, the application will behave as if
WFS_PIN_FK_FDK_05 had been pressed (key code F6).
If WFS_PIN_FK_FDK_04 is pressed, the application will behave as if
WFS_PIN_FK_FDK_06 (key code F5) had been pressed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-6 APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
The Keyboard Interface
Information Entry State Example 4
This example shows the message for downloading a sample state
definition and the message for an associated screen and keyboard
definition. The Screen/Keyboard Data Load message updates the
screen displayed on entry to the Information Entry state (see “H ‐
Information Entry State” on page 2‐34) to use repositioned function
keys.
In this example, the State Tables Load message does the following:
? Downloads state 015 as an Information Entry state
? Specifies screen number 25 to be displayed on entry to the state
? Does not specify a Time‐Out Next State Number
? Specifies 026 as the Cancel Next State Number
? Specifies 017 as the FDK ʹAʹ Next State Number
? Specifies 015 as the FDK ʹBʹ Next State Number
? Does not specify a Next State Number for any other FDKs
? Specifies data to be displayed as it is keyed in.
State Tables Load message The message is as follows: 4
3<fs><fs><fs>12<fs>015H025255026017015255255001
If the Information Entry state is defined to enable FDKs A and B, but
no keyboard is defined for the screen displayed on entry to the
Information Entry state, WFS_PIN_FK_FDK_05 and
WFS_PIN_FK_FDK_06 are enabled. When WFS_PIN_FK_FDK_05 is
pressed, the application will recognise the F6 key code. When
WFS_PIN_FK_FDK_06 is pressed, the application will recognise the
F5 key code.
The following Screen/Keyboard Data Load Message enables
WFS_PIN_FK_FDK_01 (FDK I) and WFS_PIN_FK_FDK_02 (FDK
H).
Screen/Keyboard Data Load Message 4
3<fs><fs><fs>11<fs>000<FF><SI>BIPLEASE KEY IN <SI>CGTHE ACCOUNT
NUMBER<SI>DDYOU WISH TO TRANSFER TO<GS>00517F619F5
In this case, when WFS_PIN_FK_FDK_01 is pressed, the application
will behave as if WFS_PIN_FK_FDK_05 had been pressed. If
WFS_PIN_FK_FDK_02 is pressed, the application will behave as if
WFS_PIN_FK_FDK_06 had been pressed:
Table 4-4 Key Enabled (Key position, Default Key Code) Mapped to...
Mapping CEN-XFS Example
WFS_PIN_FK_FDK_01 (17, FA) WFS_PIN_FK_FDK_05
WFS_PIN_FK_FDK_02 (19, F9) WFS_PIN_FK_FDK_06
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-7
Keyboard Data and Layouts
States and Keyboards
States and Keyboards 4
Both physical and touch‐screen keyboards can be enabled in the
following state types:
? Four FDK Selection Function (‘E‘)
? Amount Entry (‘F‘)
? Information Entry (‘H‘)
? Transaction Request (‘I‘)
? Enhanced PIN Entry (‘M‘)
? Enhanced Amount Entry (‘R‘)
? Card Read ‐ PIN Entry Initiation (‘T‘)
? FDK Information Entry (‘X‘)
? Eight FDK Selection Function (‘Y‘)
? Customer Selectable PIN Entry (‘b‘)
? Exit States (‘d’...’g‘ and ‘z900’ to ‘z999’)
? PIN & Language Select (‘m’)
? Cash Accept (‘>‘)
? Cheque Accept (‘w‘)
? Barcode Read (‘&’)
? Time‐Out.
Keyboards can also be used by the cardholder during an interactive
transaction response.
Downloadable keyboard definitions (associated keyboards) are
supported only for physical and emulated FDKs. The following
state types do not support downloadable keyboard definitions:
? PIN Entry (ʹBʹ)
? Enhanced PIN Entry (ʹMʹ)
? Card Read PIN Entry Initiation State (ʹTʹ)
? PIN & Language Select (ʹmʹ)
? Cheque Accept State (ʹwʹ)
? Cash Accept State (ʹ>ʹ)
? Barcode State (ʹ&ʹ)
Cardless transaction initiation does not support associated
keyboards.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-8 APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
States and Keyboards
If a screen number referenced in one of these state tables is
Associated Keyboards for associated with a keyboard layout, the layout is set up. Options such
FDKs 4
as swapping left and right FDKs or swapping the Clear and Enter keys
are ignored. If a keyboard is not associated with the screen, a default
layout is used.
Advance NDC uses secure PIN entry. Because the touch screen is
Secure PIN Entry and not secure, any keyboard layout specified for secure PIN entry must
Keyboards 4
use the physical keyboard for PIN entry. Therefore, only the
physical keyboard can be enabled in the following states:
? PIN Entry
? Card Read ‐ PIN Entry Initiation
? Language Select PIN Entry
The touch screen can only be used in FDK emulation mode during
secure PIN entry.
If, during a transaction, a user‐defined keyboard is about to be used
Keyboards in Operation 4
but there is an error with the definition, the invalid keyboard is
ignored and a standard layout used.
Exit States are responsible for their own keyboard use.
If a layout contains touch‐screen definitions but no touch screen is
available, that data will be ignored but the rest of the layout will be
used. This allows global configuration of a network where not all
the SSTs have touch screens.
For touch screens, if the data supplied by the keyboard layout
definition contains out‐of‐range values, the set of data will be
ignored. If the resultant layout is incomplete for use by a state, the
transaction flow may go to the Close state. For physical keyboards,
the data is ignored.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-9
Keyboard Data and Layouts
Standard Keyboard Layouts
Standard Keyboard Layouts 4
The following keyboard layouts are provided Advance NDC:
? Transaction processing
? Supervisor mode
? Encryption key entry
? Secure key entry
? Operator.
In CEN‐XFS, key positions are managed by the service providers
(SPs); therefore the return codes provided by Advance NDC are
based on the CEN‐XFS key values. For more information about the
CEN‐XFS specifications, see “CEN‐XFS Documentation” on
page G‐7.
For information about SP keyboard configuration, refer to the
on‐line documentation for NCR APTRA under “XFS PIN Service
Provider” and “XFS TTU Service Provider”.
For more information about keyboard configuration in Advance
NDC on NCR SSTs, refer to the APTRA Advance NDC, Developer’s
Guide; for other vendors’ SSTs, refer to the APTRA Advance NDC,
Multi‐Vendor Support Reference Manual.
The following illustration shows the layout of the standard
Transaction Processing 4
cardholder keyboard during transaction processing, defined by
screen M06:
Figure 4-2
Standard Keyboard Layout for Cardholder FDK ‘I’ 1 2 3 CLR FDK ‘A’
Transactions
FDK ‘H’ 4 5 6 CNL FDK ‘B’
FDK ‘G’ 7 8 9 ENT FDK ‘C’
FDK ‘F’ 0 FDK ‘D’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-10 APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
Standard Keyboard Layouts
The following table shows how the autoactivator values are
assigned to the numeric keys with the corresponding CEN‐XFS
function key definitions:
Table 4-5 1 2 3
Numeric Autoactivators (PIN) WFS_PIN_FK_1 WFS_PIN_FK_2 WFS_PIN_FK_3
4 5 6
WFS_PIN_FK_4 WFS_PIN_FK_5 WFS_PIN_FK_6
7 8 9
WFS_PIN_FK_7 WFS_PIN_FK_8 WFS_PIN_FK_9
0
WFS_PIN_FK_0
Note: The autoactivator values for numeric keys apply to all
cardholder keyboard layouts.
The following table shows how the autoactivator values are
assigned for non‐numeric keys, with the corresponding CEN‐XFS
function key definitions:
Table 4-6
Non-Numeric Autoactivators (PIN)
FA (FDK ‘I’) FF (Clear) F6 (FDK ‘A’ )
WFS_PIN_FK_FDK01 WFS_PIN_FK_CLEAR WFS_PIN_FK_FDK05
F9 (FDK ‘H’ ) F2 (Cancel) F5 (FDK ‘B’ )
WFS_PIN_FK_FDK02 WFS_PIN_FK_CANCEL WFS_PIN_FK_FDK06
F8 (FDK ‘G’ ) F1 (Enter) F4 (FDK ‘C’ )
WFS_PIN_FK_FDK03 WFS_PIN_FK_ENTER WFS_PIN_FK_FDK07
F7 (FDK ‘F’ ) F3 (FDK ‘D’ )
WFS_PIN_FK_FDK04 WFS_PIN_FK_FDK08
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-11
Keyboard Data and Layouts
Standard Keyboard Layouts
The layout of the cardholder keyboard during Supervisor mode is
Front Interface: Supervisor shown in the following illustration. If you define an invalid
Mode 4
keyboard for Supervisor mode, it is ignored and this keyboard is
enabled.
Figure 4-3
Supervisor Mode: Keyboard Layout 1 2 3 CLR
4 5 6 CNL
7 8 9 ENT
FDK ‘F’ 0 FDK ‘D’
The following table shows how the autoactivator values for
non‐numeric keys are associated with the corresponding CEN‐XFS
key code definitions:
Table 4-7
Supervisor Mode Autoactivators (PIN)
FF (Clear)
WFS_PIN_FK_CLEAR
F2 (Cancel)
WFS_PIN_FK_CANCEL
F1 (Enter)
WFS_PIN_FK_ENTER
FF (Clear) F1 (Enter)
WFS_PIN_FK_CLEAR WFS_PIN_FK_ENTER
If you are using a touch screen, FDK emulation is the default.
Note: Redefining touch areas is not supported in Supervisor mode.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-12 APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
Standard Keyboard Layouts
The cardholder keyboard layout for encryption key entry is shown
Encryption Key Entry 4
in the following illustration. If you define an invalid keyboard for
encryption key entry, it is ignored and this keyboard is enabled.
Figure 4-4
Encryption Key Entry Keyboard Layout A 1 2 3 B
C 4 5 6 D
E 7 8 9 ENT F
CLR 0 ENT
The autoactivator values for non‐numeric keys are assigned as
follows, with the corresponding CEN‐XFS definitions for PIN and
TTU:
Table 4-8 F1 (Enter)
Encryption Key Entry Autoactivators (PIN) WFS_PIN_FK_ENTER
FF (Clear) F1 (Enter)
WFS_PIN_FK_CLEAR WFS_PIN_FK_ENTER
Table 4-9 F1 (Enter)
Encryption Key Entry Autoactivators (TTU) WFS_TTU_CK_ENTER
FF (Clear) F1 (Enter)
WFS_TTU_CK_CLEAR WFS_TTU_CK_ENTER
The following layout shows the positions for the cardholder
Secure Key Entry 4
keyboard during secure key entry on NCR SSTs. As well as
standard compliance, secure key entry offers enhanced security in
which the application never sees the key value. The decision to use
secure key entry is the responsibility of the financial institution.
Figure 4-5 1 2 3 A
Cardholder Keyboard: Secure Key Entry
Layout
4 5 6 B
7 8 9 C
D 0 E F
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-13
Keyboard Data and Layouts
Standard Keyboard Layouts
The layout in Figure 4‐5 “Cardholder Keyboard: Secure Key Entry
Layout,” is the default one. Different keyboard layouts for secure
key entry are supported. If the keyboard configured through the
platform is different from the default layout, screen I30 must be
updated in resrvd.def to match the keyboard layout in use.
Key entry cannot be cancelled until all the digits are entered, when
the option to confirm the key is given.
Note: As the application and service providers never see what keys
are pressed in secure key entry, mapping to CEN‐XFS codes is not
required.
For details of how the keyboard is mapped for secure key entry,
refer to the APTRA on‐line documentation under APTRA XFS |
Programmers Reference |XFS Service Providers|XFS PIN Service
Provider |Conformance Matrix – Commands
The operator keyboard layout for the rear interface is as follows:
Rear Interface: Operator
Keyboard Layout 4
Figure 4-6
Operator Keyboard Layout 1 2 3 CLR
4 5 6 CNL
7 8 9 ENT
Clear 0 Enter
No corresponding CEN‐XFS definitions for numeric keys are
provided as the numbers are returned.
The following table shows how the autoactivator values are
assigned for non‐numeric keys, with the corresponding CEN‐XFS
command keys definition for the Text Terminal Unit (TTU).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-14 APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
Standard Keyboard Layouts
Table 4-10 FF (Clear)
Non-Numeric Autoactivators (TTU) WFS_TTU_CK_CLEAR
F2 (Cancel)
WFS_TTU_CK_CANCEL
F1 (Enter)
WFS_PIN_FK_ENTER
FF (Clear) F1 (Enter)
WFS_TTU_CK_CLEAR WFS_TTU_CK_ENTER
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-15
Keyboard Data and Layouts
Defining Full Touch Screens
Defining Full Touch Screens 4
To define a touch‐screen keyboard, each touch area is defined by the
X and Y co‐ordinates for two diagonally opposite corners, followed
by the code which is returned to the terminal when the area is
touched. Touch areas can only be rectangular in shape.
Up to 200 areas can be defined as hexadecimal strings and enabled
on the touch screen at the same time. Each touch area can be any
size and in any position. If any areas overlap, the first defined takes
priority.
Each touch area is defined as follows:
Touch Areas 4
Table 4-11 No. Of
Label Range Description
Touch Area Definition Chars
TPx1 8 00000000‐FFFFFFFF X co‐ordinate of first corner
TPy1 8 00000000‐FFFFFFFF Y co‐ordinate of first corner
TPx2 8 00000000‐FFFFFFFF X co‐ordinate of second corner
TPy2 8 00000000‐FFFFFFFF Y co‐ordinate of second corner
TC 2 00‐FF The return code for the area
When this data is downloaded from Central, the range of the return
code is checked but the range of the position characters is not.
Therefore, you must ensure that valid values are used. If an illegal
position value is used, the touch area that it belongs to is ignored. If
the range check fails or insufficient characters are provided to define
a touch area, the data for that area will be ignored.
Note: The return code range is limited to the designated keyboard
values as determined by the application state.
Generic Keyboard Example 4
A generic keyboard can be set up with numeric keys 0‐9, Cancel,
Clear and FDKs ‘A’, ‘B’. A state that requires only FDKs ‘A’, ‘B’ and
Cancel will ignore the numeric keys and Clear. A state that requires
only the numeric keys 0‐9, Cancel and Clear will ignore the FDKs.
However, both states can reference this keyboard as long as their
minimum requirements are met.
Note: This example can also be applied to physical keyboards.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-16 APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
Defining Full Touch Screens
Touch screen definitions are supported for legacy definitions. If you
Calculating Full want to define new ones, this section explains the format of the
Touch‐Screen Positions 4
co‐ordinates that are used to define touch areas on the screen and
how to calculate them.
The Unary Co‐Ordinate System 4
The unary co‐ordinate system is based on a two‐dimensional
cartesian space with normalised co‐ordinates. This allows you to
specify positions that do not depend on the physical screen
dimensions or resolution.
The co‐ordinates are the horizontal and vertical displacements, X
and Y, from an origin in the top left‐hand corner of the screen. The
range of values for each is from zero (inclusive) to one
(non‐inclusive), 0 X Y 1 . Thus each co‐ordinate is defined as
decimal fractions of the width and height of the physical screen.
Figure 4-7
Unary Co-ordinates
Screen
(X1,Y1)
Touch
Area
(X2,Y2)
Co‐ordinates are defined as IEEE floating point numbers, with a
limit of E+21. A floating point number is stored in memory as 32 bits
in the following format:
Figure 4-8
Format for Floating Point Numbers
Sign Exponent Mantissa
31 30 24 23 16 15 8 7 0
byte 0 byte 1 byte 2 byte 3
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-17
Keyboard Data and Layouts
Defining Full Touch Screens
A co‐ordinate is calculated using the following formula:
exp – 127 – 23
N = 2 1 + mant 2
where:
exp is a value in the range 0-255
23
mant is a value in the range 0-2
Co‐ordinate Format 4
A co‐ordinate may be expressed as either four bytes of packed data
or eight bytes of unpacked data. A co‐ordinate in packed format is
obtained by reversing the four bytes representing the floating point
number. Unpacked format is obtained by taking each hex digit in
the packed format and adding 30 hex to it to produce eight bytes in
the range 30‐3F hex. The equivalent ASCII string is used in field ‘j2’
of the Screen/Keyboard Data Load message.
To convert a number to IEEE format, you should write it in the
following form:
A
N= 2 1 + B
where:
A = exp – 127
– 23
B = mant 2
Note: A is the highest whole‐number power of 2 that gives a value
less than or equal to the number, N.
Conversion to IEEE Example 4
In this example, the number 0.635 is converted to IEEE format.
N = 0.635
A
0.635 = 2 1 + B
1 To calculate A:
The highest power of 2 that gives a value less than or equal to
0.635 is ‐1. (2‐1 = 0.5)
A = –1
2 To calculate B:
–1
0.635 = 2 1 + B
1 + B = 0.635 2 = 1.27
B = 0.27
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-18 APTRA™ Advance NDC, Reference Manual
Keyboard Data and Layouts
Defining Full Touch Screens
3 To calculate the exponent (exp):
A = exp – 127 = – 1
exp = 126 = 7E hex
exp = 01111110 bin
Figure 4-9
Calculate Exponent
Sign Exponent Mantissa
0 1 1 1 1 1 1 0
31 24 23 0
byte 0
4 To calculate the mantissa (mant):
– 23
B = mant 2 = 0.27
23
mant = 0.27 2 = 2264924 = 228F5C hex
mant = 0100010 10001111 01011100 bin
Figure 4-10
Calculate Mantissa
Sign Exponent Mantissa
0 1 0 0 0 1 0 1 0 0 0 1 1 1 1 0 1 0 1 1 1 0 0
31 24 23 16 15 8 7 0
byte 1 byte 2 byte 3
5 The co‐ordinate is always positive, so the sign is always zero.
sign = 0
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 4-19
Keyboard Data and Layouts
Defining Full Touch Screens
Figure 4-11
Calculate Sign
Sign Exponent Mantissa
0
31 24 23 0
byte 0
6 Putting all these together gives the following:
Figure 4-12
Calculate Co-ordinate
Sign Exponent Mantissa
31 30 24 23 16 15 8 7 0
byte 0 byte 1 byte 2 byte 3
The most significant bit of byte 1 is determined by the least
significant bit of the exponent. In this case, this is 0.
Byte 0 00111111 bin 3F hex
Byte 1 00100010 bin 22 hex
Byte 2 10001111 bin 8F hex
Byte 3 01011100 bin 5C hex
Therefore, 0.635 becomes 3F 22 8F 5C.
7 The co‐ordinate in packed format is 5C 8F 22 3F.
8 The co‐ordinate in unpacked format is 35 3C 38 3F 32 32 33 3F.
The equivalent ASCII string is 5<8?223?.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-20 APTRA™ Advance NDC, Reference Manual
Table of Contents
Printer Data
Chapter 5
Printer Data
Overview 5‐1
Printer Types Supported by Advance NDC 5‐2
PPD Default Print 5‐4
Eight‐Character Amount Buffer 5‐4
Twelve‐Character Amount Buffer 5‐5
Printer Control Characters 5‐6
Enhanced Printer Control Codes 5‐7
Set Left Margin 5‐7
Set Right Margin 5‐8
Printer‐Independent Margin Control 5‐9
Select OS/2 Code Page 5‐9
Select International Character Sets 5‐9
Select Arabic Character Sets 5‐10
Print Downloadable Bit Image 5‐10
Print Barcode 5‐12
Print Graphics 5‐13
Print Cheque Image 5‐14
Define Downloadable Character Set 5‐15
Define Downloadable Bit Image 5‐16
Select Printing Position of HRI Characters 5‐17
Select Width of Barcode 5‐17
Select Horizontal Height of Barcode 5‐18
Select Dual‐sided Printing 5‐18
Character Sets 5‐20
Primary Print Page 5‐22
Secondary Print Page 5‐22
Statement Printer Controls 5‐23
Left Margin Control 5‐23
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Printer Data
Right Margin Control 5‐23
Margin Control Use 5‐24
Lines Per Inch Control 5‐24
Simulated Pre‐printed Receipt Messages 5‐25
Printing Images Using Screens ‘R00’ and ‘R01’ 5‐25
Screen ‘R00’ 5‐25
Screen ‘R01’ 5‐25
Other Uses of Screens ‘R00’ and ‘R01’ 5‐26
Sideways Printing on Receipt 5‐29
Unsupported Functions 5‐29
Printer Control Sequences and Registry Settings 5‐30
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Printer Data
E
Overview
Overview 5
This chapter provides information on the following topics:
Printer types supported by Advance NDC
Default prints for Programmable Printing Depository (PPD)
Printer control characters
Character sets
Statement printer controls
Simulated pre‐printed receipt messages
Sideways printing on receipt printers
Printer control registry settings.
Note: This chapter provides information for NCR printers. For
differences that might be experienced with printers from other
vendors, refer to the APTRA Advance NDC, Multi‐Vendor Support
Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-1
Printer Data
Printer Types Supported by Advance NDC
Printer Types Supported by Advance
NDC 5
The Advance NDC software supports printing on the following
devices on NCR SSTs:
Receipt printer (SDC, RS232, USB)
Journal printer (SDC, RS232, USB)
Statement printer (SDC, Parallel, USB)
Programmable Printing Depository (PPD)
Cheque processor endorse cheque
Note: All the devices listed above are supported using the
CEN‐XFS interface. For more information, refer to the APTRA
Advance NDC, Developer’s Guide. For details of multi‐vendor printer
support and control code mapping, refer to Appendix C, “Printer
Data ‐ Control Codes” in the APTRA Advance NDC, Multi‐Vendor
Support Reference Manual.
The default printing method for USB printers is forms‐based
printing, but they can be configured to print raw data. The other
printer types use raw data for printing. In raw data printing,
printer‐specific control codes are sent directly to the printer.
Forms‐based printing utilises the Windows printing environment,
removing the need to know details of the printer. This is
implemented in Advance NDC using XFS forms, which are
generated dynamically by the application.
The USB printers are supported on the SelfServ range of SSTs from
NCR. Two‐sided printing is supported for the USB receipt and
statement printers.
Sideways printing is supported with the SDC and RS232 receipt
printer. For more information, see “Sideways Printing on Receipt”
on page 5‐29.
When printing in sideways mode on the SDC or RS232 receipt
printer the form length is not configurable. A receipt with a
maximum of 20 lines containing up to 80 columns can be printed in
sideways mode on the receipt before a cut.
The data to be printed on a particular printer, or printers, must be
placed in a printer data field contained in a Transaction Reply
Command message. For details, see “Transaction Reply Command
Actions” on page 10‐111.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-2 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Types Supported by Advance NDC
The length of the printer data field is variable, and depends on the
amount of data and data compression performed, the printer
characteristics, and the overall message length limitation. There are
13 printer data fields.
On the SDC and RS232 receipt and journal printers, the
uncompressed data length is restricted to 500 characters per printer
data field. Therefore the uncompressed data length can be up to
6500 characters, although not all comms protocols may support user
messages of this length.
Printing to the statement printer is restricted by the compressed
data field length. An option on the Configure menu in Supervisor
allows the setting of a maximum number of lines to print before a
cut on printers where the black mark is not used. For details, refer to
“45 MAX STATEMENT LENGTH” in chapter 4, “Configure Menu”,
of the APTRA Advance NDC, Supervisor’s Guide.
The PPD can print up to 80 characters.
The printer flag field specifies on which printer(s) the information is
printed. Double‐width characters can be printed on certain printers.
A receipt length is set at power‐up time on a terminal that
implements a cut after the following:
24 or 49 lines on a non‐thermal receipt printer
24 lines or greater on a thermal printer, the maximum length is
specified by the printer vendor.
Printing of chained transactions on one receipt forces an automatic
cut if an attempt is made to print on the line after that specified as
the default setting.
An alternative Supervisor option is available that allows receipts of
up to 49 lines to be printed on the terminal without a cut; for details,
refer to the APTRA Advance NDC, Supervisor’s Guide. This is not
supported in sideways printing mode on the receipt printer.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-3
Printer Data
PPD Default Print
PPD Default Print 5
If a deposit is requested in a Transaction Reply command, but none
of the printer flag fields contains a value of ‘4’ or ‘5’, the following
information is printed, depending on whether the amount buffer
length is eight or twelve characters:
The following is printed for this buffer:
Eight‐Character Amount
Transaction serial number
Buffer 5
This four character number is printed in print columns 1 to 4
and repeated in columns 16 to 19.
Amount buffer
The contents of the Amount buffer are printed in print columns
6 to 14. Leading zeros are suppressed and the decimal character
(‘,’ or ‘.’) is displayed in its true position. For details, see the “F ‐
Amount Entry State” section in Chapter 2, “State Tables”.
Card data
The first 30 characters from Track 2 of the card are printed in
columns 21 to 50, with a leading ‘*’ in column 20. The Start/End
sentinels are not printed. The field separator is printed as ‘=’.
Printing is truncated if an end sentinel is encountered. If the
Track 2 data does not contain 30 characters, the trailing
characters are blanked.
Machine number
The machine number is entered using the Supervisor function
‘MACHINE NO’. For details, refer to the APTRA Advance NDC,
Supervisor’s Guide.
Six characters are reserved for this field. If there is no machine
number, the field remains blank. The machine number appears
in columns 72 to 77.
Date and time
The date is displayed in columns 53 to 62, and the time in
columns 64 to 71. In Advance NDC, the date is displayed in one
of two formats: MM/DD/YYYY or DD/MM/YYYY. The date format is
set by the option set in the Enhanced Configuration Parameters
Load message. For details, see “Enhanced Configuration
Parameters Load” on page 10‐17. The time is displayed as
hh:mm:ss, using the 24 hours convention. Eight characters are
reserved for this field, and it is always displayed in the format
hh:mm:ss.
A typical print line is:
1234 250.00 1234*012345678901234567890123456789 20/11/2009 15:30:29 000000
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-4 APTRA™ Advance NDC, Reference Manual
Printer Data
PPD Default Print
The following is printed for this buffer:
Twelve‐Character Amount
Transaction serial number ‐ this four‐character number is
Buffer 5
printed in print columns 1 to 4
Amount buffer ‐ the contents of the Amount buffer are printed
in print columns 6 to 18. For details, see the “F ‐ Amount Entry
State” section in Chapter 2, “State Tables”. Leading zeros are
suppressed and the decimal character (‘,’ or ‘.’) is displayed in its
true position
Card data ‐ the first 30 characters from Track 2 of the card are
printed in columns 21 to 50, with a leading ‘*’ in column 20. The
Start/End sentinels are not printed. The field separator is printed
as ‘=’. Printing is truncated if an end sentinel is encountered
Date and time ‐ the date is displayed in columns 53 to 60, and
the time in columns 64 to 71. Advance NDC supports two date
formats: MM/DD/YYYY and DD/MM/YYYY. The date format is set by
the option set in the Enhanced Configuration Parameters Load
message. The time is always displayed in the format hh:mm:ss,
using the 24 hours convention. Eight characters are reserved for
this field.
A typical print line is as follows:
1234 250.00 *012345678901234567890123456789 20/11/2009 15:30:29 000000
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-5
Printer Data
Printer Control Characters
Printer Control Characters 5
These characters allow data to be formatted for printing. The
printers vary in the control characters they support.
The control characters are shown in the following table, with any
special printer characteristics noted, otherwise they refer to all
printers:
Table 5-1
Printer Control Characters
Character ASCII Code Function
LF 0A hex Causes the next graphic character to be printed on the next line at the column
defined by the left margin.
Journal Subsequent LF controls with no intervening graphic
characters are ignored.
PPD Envelope All ignored.
FF 0C hex Receipt Causes a feed of 24 lines in normal printing mode, or a
feed to the length of the longest print line in sideways
printing mode up to a maximum of 80 columns, cut and
deliver to customer.
Journal Causes a line feed.
Statement Causes a feed to black mark, cut and deliver to customer.
PPD Envelope Ignored.
SO 0E hex Fills an area of the printer form with spaces. This ‘SO’ command is followed
by a single graphic character indicating the desired number of spaces to be
inserted as follows:
Character No. of spaces
1‐9 1‐9
: 10
; 11
< 12
= 13
> 14
? 15
PPD Envelope Ignored.
Statement International alphanumeric set 3 (designator 7, B or E)
does not contain a space character. In this case the area
will be filled with ‘space’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-6 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Characters
Character ASCII Code Function
ESC 1B hex Control character introducing supplementary control codes. For more
information, see “Character Sets” on page 5‐20 and “Statement Printer
Controls” on page 5‐23.
PPD Envelope Ignored.
HT 09 hex Statement Positions the next graphic character in the next tab
column. Tabs are defined to be in every eighth column
from the left margin. A tab past the right margin
positions the character in the first position of the next
line. Multiple tabs are permitted.
PPD Envelope Ignored.
Others Not defined for Advance NDC. Causes print‐head
movement and misalignment of data.
Note: For the statement printer, NCR recommends that print data
has a line feed inserted at the end of each line and a form feed
inserted at the end of each statement.
Using the default top margin of one inch, the following maximum
number of lines can be printed:
Table 5-2 Size of Media Lines Per Inch Maximum Lines
Maximum Printed Lines
101.6 mm/4 inch 6 17
101.6 mm/4 inch 8 23
152.4 mm/6 inch 6 29
152.4 mm/6 inch 8 39
For different values of top margin/line feed, we recommend that no
printing takes place within 5 mm/0.2 inch of the bottom of the
statement.
These codes are all introduced into the control sequence by the
Enhanced Printer Control control code 1BH (ESC) and are used for the SDC and RS232 receipt
Codes 5
and journal printers.
Note: Differences, including differences in use or application of
control codes for USB receipt and journal printers, are given in
“Printer Control Sequences and Registry Settings” on page 5‐30.
Set Left Margin 5
You can set the indentation of print columns from the left edge of
the paper to the value given by the variable field with the following
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-7
Printer Data
Printer Control Characters
control sequence. The format of the variable field is a one, two or
three byte ASCII value in the range 000‐078.
Table 5-3 Number of
Character Description
Set Left Margin Position Characters
1BH 5BH Control Sequence Introducer 2
(ESC) ‘[‘
Variable Position of the left‐most print column from 3
the left edge of the paper
70H ‘p’ Escape Sequence ID 1
The left margin setting must be at least two less than the current
right margin setting or a square bracket will be printed.
The setting of the left margin remains until it is either changed by
this control sequence, the power supply to the printer is turned off
or a reset of the terminal is carried out.
This is supported on the statement printer and the receipt printer in
sideways printing mode. The default value is 0.
Set Right Margin 5
The right margin for the print data is set with the following control
sequence. The format of the variable field is a one‐, two‐ or
three‐byte ASCII representation of the print column with valid
values in the range 002‐080.
Table 5-4 Number of
Character Description
Set Right Margin Position Characters
1BH 5BH Control Sequence Introducer 2
(ESC) ‘[‘
Variable Position of the right‐most print column from 3
column 2
71H ‘q’ Escape Sequence ID 1
An attempt to print beyond the right margin will result in the extra
characters printing from the left margin.
The right margin setting must be at least two greater than the
current left margin setting or a square bracket will be printed.
The setting of the right margin remains until it is either changed by
this control sequence, the power supply to the printer is turned off
or a reset of the terminal is carried out.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-8 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Characters
This is supported on the statement printer and on the receipt printer
in sideways printing mode. The default value is 40 for receipt and
journal printers and 80 for the statement printer.
Printer‐Independent Margin Control 5
Some printers express margin values as dots, meaning that the
actual margin is dependent on the resolution of the printer.
Advance NDC provides a solution that is applicable to all printers
and is not dependent on the printer resolution.
The left margin control is set using the space character of the
standard font size, regardless of the currently selected font size.
The right margin is set by inserting a line feed character at the point
specified by the right margin control.
Select OS/2 Code Page 5
With this control sequence, you can select one of the supported OS/2
code pages (for details, see “Code Pages” on page B‐7). Once the
OS/2 code page is selected, print data in the range 20H to FFH will
be accepted and printed.
Table 5-5 Number of
Character Description
Select OS/2 Code Page Characters
1BH (ESC) Escape Sequence Indicator 1
25H ‘%’ Escape Sequence ID 1
3xH 3yH OS/2 Code Page Identifier 3
3zH
Valid values for OS/2 code page identifiers are 000, 437, 850, 851,
852, 855, 857, 860, 861, 862, 863, 864 and 866. If an invalid code page
is sent to the printer, a square bracket will be printed. Code page 000
is a user defined downloadable character set code page. For details,
see the “Define Downloadable Character Set” section.
To return to standard character set mode, use the Select Character
Set control sequence.
This is supported on the thermal receipt and journal printers only.
Select International Character Sets 5
The printer hardware supports both International and Arabic
character sets and an application can make use of the International
set with this control sequence which overrides the customisation
switch setting.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-9
Printer Data
Printer Control Characters
Table 5-6 Number of
Character Description
Select International Character Sets Characters
1BH (ESC) Private use Escape Sequence Indicator 1
32H ‘2’ Escape Sequence ID 1
This is not supported in code page mode on the thermal printer.
Note 1: When this control sequence is included in the Transaction
Reply printer data stream, the printer defaults to International
Character Set 1. If printing using another character set is required
the Select Character Set control sequence must also be present in the
printer data stream.
Note 2: This control sequence should not be included in
Transaction Reply printer data which is to be interlaced with
reserved screen ‘R01’. For details, see the “Simulated Pre‐printed
Receipt Messages” section.
Select Arabic Character Sets 5
An application can make use of the Arabic character set with this
control sequence which overrides the customisation switch setting.
Table 5-7 Number of
Character Description
Select Arabic Character Sets Characters
1BH (ESC) Private use Escape Sequence Indicator 1
33H ‘3’ Escape Sequence ID 1
This is not supported in code page mode on the thermal printer.
Note 1: When this control sequence is included in the Transaction
Reply printer data stream, the printer defaults to Arabic Character
Set 1. If printing using another character set is required the Select
Character Set control sequence must also be present in the printer
data stream.
Note 2: This control sequence should not be included in
Transaction Reply printer data which is to be interlaced with
reserved screen ‘R01’. For details, see the “Simulated Pre‐printed
Receipt Messages” section.
Print Downloadable Bit Image 5
Printing downloadable bit images is supported using either forms
or raw data on USB printers, and raw data on thermal receipt and
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-10 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Characters
journal printers (SDC) only. The control sequence allows a
predefined bit image to be printed in one of four formats, as follows:
Table 5-8 Number of
Character Description
Print Downloadable Bit Image Characters
1BH (ESC) Private use Escape Sequence Indicator 1
2FH ‘/’ Escape Sequence ID 1
3xH ‘1’ ‐ print bit image one 1
‘2’ ‐ print bit image two
3yH ‘0’ ‐ normal width, normal height 1
‘1’ ‐ normal width, double height
‘2’ ‐ double width, normal height
‘3’ ‐ double width, double height
For details of defining the image prior to printing, see “Define
Downloadable Bit Image” on page 5‐16.
If the size of the image to be printed exceeds the width of the line,
truncation will be used. Text and image(s) cannot be mixed on the
same line.
When data is present in the printer buffer this command is ignored.
It is therefore recommended that a line feed is sent before
attempting to print images.
The control sequence should not be included in Transaction Reply
printer data which is to be interlaced with reserved screen ‘R01’. For
details, see the “Simulated Pre‐printed Receipt Messages” section.
Raw Data For USB printers if there is no image file, the path and 5
filename are printed, for example:
C:\Program Files\NCR APTRA\Advance
NDC\Media\LOGO1.LGO
If there is no definition file, nothing is printed.
For SDC printers, if there is no image file, the path and filename
alone are printed, with a right square bracket ʹ]ʹ before and after, for
example:
]C:\Program Files\NCR APTRA\Advance
NDC\Media\LOGO1.LGO]
If there is no definition, just a right square bracket is printed
Forms The bitmap image is registered by ANDC using the Define 5
Downloadable Bit Image and printed using Print Downloadable Bit
Image by printing a form with the graphic. If there is no file, the
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-11
Printer Data
Printer Control Characters
path and filename are printed with a right square bracket ʹ]ʹ before
and after, for example:
]C:\Program Files\NCR APTRA\Advance
NDC\Media\LOGO1.LGO]
If there is no definition, only a right square bracket is printed
Print Barcode 5
Barcode printing is supported using raw data only. You can print a
barcode for the ASCII characters present in the string with the
control sequence shown in Table 5‐9 on page 5‐12.
Table 5-9 Number of
Character Description
Print Barcode Characters
1BH (ESC) Private use Escape Sequence Indicator 1
6BH ‘k’ Escape Sequence ID 1
3xH Type of Barcode 1
‘0’ ‐ UPC‐A
‘1’ ‐ UPC‐E
‘2’ ‐ JAN13(EAN)
‘3’ ‐ JAN8(EAN)
‘4’ ‐ Code 39
‘5’ ‐ Interleaved 2 of 5
‘6’ ‐ Codabar
<ASCII ASCII characters to be printed as barcodes Variable
data>
1BH 5CH Control Sequence Terminator 2
(ESC) ‘\’
The printer service software will calculate the check digit for the
UPC and JAN(EAN) codes if it is not sent from the host. It will also
generate six character zero‐suppressed UPC‐E tags from full 11 or
12 characters sent from the host according to standard UPC‐E rules.
When data is present in the printer buffer this command is ignored.
It is therefore recommended that a line feed is sent before
attempting to print barcodes.
This control sequence should not be included in Transaction Reply
printer data which is to be interlaced with reserved screen ‘R00’ or
‘R01’. For details, see the “Simulated Pre‐printed Receipt Messages”
section.
If the horizontal size exceeds one line, the excess data is not printed.
Barcode positional information, for example, the printing position
of human readable interface (HRI) characters and the width and
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-12 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Characters
height of the barcode must be defined in the downloadable reserved
K screens prior to attempting to print.
Print Graphics 5
Bitmaps can be printed using forms or raw data on USB printers,
and raw data on thermal printers.
The control sequence lets you print a preloaded Epson printer
graphics file. Epson printer graphics files are standard Epson
graphics data files formatted for the Epson LQ‐950 printer. The
printer resolution should be set at 120180 dots per inch.
The following control sequence is used to print this type of file:
Table 5-10 Number of
Character Description
Print Graphics Characters
1BH ESC Private use Escape Sequence 1
Indicator
47H ‘G’ Escape Sequence ID 1
<filename> Name of file with graphics data Variable
1BH 5CH ESC ‘\’ Control Sequence Terminator 2
The format for the Epson graphics file is described in the
Programmer’s Manual for the 40 Column Printer (B006‐4612).
When data is present in the printer buffer, this command is ignored.
Therefore, NCR recommends that a line feed is sent before
attempting to print graphics.
The graphics file can be generated using any software package
which supports the Epson printer driver. The default pathname for
the file defined in the control sequence should be defined in the
downloadable reserved K07 screen.
This control sequence should not be included in Transaction Reply
printer data which is to be interlaced with reserved screen ‘R01’. For
details, see “Simulated Pre‐printed Receipt Messages” on page 5‐25.
Raw Data If the graphics file is missing, the file name and path are 5
printed, for example,
C:\Program Files\NCR APTRA\Advance
NDC\Media\GRAPHIC.PRN
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-13
Printer Data
Printer Control Characters
Forms For forms‐based printing, any predefined extension, such 5
as .prn, is converted to .bmp. The extension is defined in the
following registry entry:
HKLM\SOFTWARE\NCR\Advance
NDC\PRINTING\FORMS_GRAPHICS_EXT
If the file is missing, the file name and path are printed with a .bmp
extension, for example:
C:\Program Files\NCR APTRA\Advance
NDC\Media\GRAPHIC.BMP
If no extension is set, the original extension is printed, for example:
C:\Program Files\NCR APTRA\Advance
NDC\Media\GRAPHIC.PRN
Print Cheque Image 5
Cheque images can be sized and rotated, and the codeline can be
masked if the cheque is to be printed on the receipt.
Cheque images are printed on thermal receipt printers using either
forms and bitmaps for USB printers or, for printing from raw data,
the Epson Graphics format. For details, see “Print Graphics” on
page 5‐13.
Printing can be used to process and print the required cheque image
on the receipt printer using the control sequence described in
Table 5‐11.
Table 5-11 Number of
Character Description
Print Cheque Image Characters
1BH (ESC) Private use Escape Sequence Indicator 1
70H ‘p’ Escape Sequence ID 1
<side> Whether to print the front or back of the 1
cheque
‘0’ ‐ front
‘1’ ‐ back
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-14 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Characters
Number of
Character Description
Characters
<codeline How the codeline is printed 1
control> ‘0’ ‐ Print the image of the cheque with no
alterations. This must be used when printing
the back of the cheque
‘1’ ‐ Print an image of the cheque with the
codeline blackened
‘2’ ‐ Print an image of the cheque with the
codeline removed.
Note: For PA‐DSS compliance, the codeline
control variable must be set to 1 or 2 if
<side> is set to 0
<image Index identifying the image to print. This is 3
selector> an index within the list of images requested
for each cheque
If this field is not present, only the first (or
the only) image is printed
<cheque The cheque identifier. This is the same 3
ID> cheque identifier used in the ‘cgx’ fields of
the Transaction Request and the ‘bbx’ fields
of the Transaction Reply
If this field is not present, the image of the
last cheque processed is printed
1BH 5CH Control Sequence Terminator 2
(ESC) ’\’
Define Downloadable Character Set 5
This command defines and enters characters into the memory area
of the printer. Two modes of operation are available, standard and
compressed. Standard mode consists of characters represented by a
character cell size of 11 horizontal bits by 16 vertical bits (a total of
22 bytes per character). Compressed mode consists of characters
stored as a character cell of 8 horizontal bits by 16 vertical bits (a
total of 16 bytes per character). NCR recommends using standard
mode only.
Table 5-12 Number of
Define Downloadable Character Set Character Description Character
s
1BH (ESC) Private use Escape Sequence Indicator 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-15
Printer Data
Printer Control Characters
Number of
Character Description Character
s
26H ‘&’ Escape Sequence ID 1
<filename> Name of file with the data for the selected Variable
character set
1BH 5CH Control Sequence Terminator 2
(ESC) ’\’
The format for the filename is described in the Programmer’s Manual
for the 40 Column Printer (B006‐4612).
This command can be used to overwrite single characters. The user
defined characters are available until power to the printer is turned
off or a reset of the terminal is carried out. This control sequence is
defined in K Reserved Screen ‘K08’.
This control sequence is supported on thermal receipt and journal
printers only.
Define Downloadable Bit Image 5
You can use this control sequence to define and download a bit
image to the printer. The image can then be printed using the Print
Downloadable Bit Image control sequence without resending the data.
Table 5-13 Number of
Character Description
Define Downloadable Bit Image Characters
1BH (ESC) Private use Escape Sequence Indicator 1
2AH ‘*’ Escape Sequence ID 1
Var ‘1’ ‐ Define bit image one 1
‘2’ ‐ Define bit image two
<ASCII Name of file with the data for the selected bit Variable
filename> image
1BH 5CH Control Sequence Terminator 2
(ESC) ’\’
This control sequence is supported on thermal receipt and journal
printers only and is defined in K Reserved Screens ‘K09’ and ‘K10’.
The format for the filename is described in the Programmer’s Manual
for the 40 Column Printer (B006‐4612).
One large bit image can be defined and printed or two smaller bit
images can be defined and printed. If one bit image is required then
the maximum bit image data length that can be sent is 17920 bytes,
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-16 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Characters
that is bit image 1. If two bit images are required then the maximum
bit image data length of each is 8960 bytes, that is a combined total
of 17920 bytes.
Defining a new bit image erases the previous one. The downloaded
image is available to the application until it is overwritten or power
to the printer is turned off, unless the printer is a USB thermal
printer. A USB printer retains bit images when powered off. A reset
of the terminal does not erase the image.
Select Printing Position of HRI Characters 5
This control sequence defines the location of human readable
interface (HRI) characters in ASCII character format with respect to
the barcode they represent. The setting remains until either it is
changed by this control sequence, power to the printer is turned off
or a reset of the terminal is carried out.
The barcode can be printed using the Print Barcode control sequence
without resending the positional information.
This control sequence is defined in K Reserved Screens ‘K09’ and
‘K10’.
Table 5-14 Number of
Character Description
Select HRI Character Printing Position Characters
1BH (ESC) Private use Escape Sequence Indicator 1
65H ‘e’ Escape Sequence ID 1
Var Printing position 1
‘1’ ‐ not printed (default)
‘2’ ‐ above the barcode
‘3’ ‐ below the barcode
‘4’ ‐ both above and below the barcode
This is supported on thermal receipt and journal printers only.
Select Width of Barcode 5
This defines the barcode minimum width in ASCII format to ‘n’ dots
or ‘n’/150” with valid values of n being ‘2’, ‘3’ and ‘4’.
Table 5-15 Number of
Character Description
Select Barcode Width Characters
1BH (ESC) Private use Escape Sequence Indicator 1
77H ‘w’ Escape Sequence ID 1
Var Barcode minimum width 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-17
Printer Data
Printer Control Characters
The setting remains until either it is changed by this control
sequence, power to the printer is turned off or a reset of the terminal
is carried out. The default setting is ‘3’.
The barcode can be printed using the Print Barcode control sequence
without resending the positional information.
This control sequence is defined in K Reserved Screens ‘K09’ and
‘K10’.
This is supported on thermal receipt and journal printers only.
Select Horizontal Height of Barcode 5
This control defines the barcode height, as three ASCII characters, in
dots or ‘n’/150” with valid values of n in the range ‘001’ ‐ ‘255’. The
control is supported only on thermal receipt and journal printers.
For forms‐based printing, this control sequence is ignored as the
height of the barcode is fixed.
Table 5-16 Number of
Character Description
Select Barcode Horizontal Height Characters
1BH (ESC) Private use Escape Sequence Indicator 1
68H ‘h’ Escape Sequence ID 1
Var Barcode Height 3
The setting remains until either it is changed by this control
sequence, power to the printer is turned off or a reset of the terminal
is carried out. The default setting is ‘162’.
The barcode can be printed using the Print Barcode control sequence
without resending the positional information.
This control sequence is defined in K Reserved Screens ‘K09’ and
‘K10’.
Select Dual‐sided Printing 5
On SelfServ SSTs, this control sequence can be used to print on
two‐sided paper.
Table 5-17 Number of
Character Description
Select Dual-sided Printing Characters
1BH (ESC) Private use Escape Sequence Indicator 1
71H ‘q’ Escape Sequence ID 1
Var ‘0’ ‐ Print on front of paper 1
‘1’ ‐ Print on back of paper
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-18 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Characters
This printer control is supported only on USB receipt and statement
printers. If the printer does not support double‐sided printing, or
two‐sided paper is not loaded, this setting is ignored. At start of
day, printing defaults to the front of the paper.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-19
Printer Data
Character Sets
Character Sets 5
For forms‐based printing on USB printers, Advance NDC supports
the Alpha 1 to Alpha 6 and Arabic 1 to Arabic 6 character sets with
provided Windows font files. If you need to create your own fonts,
NCR recommends you create Windows font files. If you require
support for this, contact the NCR Product Manager.
For printing raw data, the USB receipt and USB journal printers
support the same characters as the receipt and journal printers.
However, this is achieved using a mapping file, as the USB Receipt
and Journal printers use code pages to define the characters. For
details of the mapping file, see “Mapping Files” on page B‐8.
The SDC and RS232 receipt and journal printers support as
standard the first 96 characters from the single‐ and double‐size
alphanumeric 1 character set.
The PPD envelope printer supports the single‐size alphanumeric 1
character set (96 characters).
The statement printer supports as standard the full single, double
and condensed alphanumeric sets 1, 2, 4 and 5, plus a single, double
and condensed alphanumeric set 3 comprising the last 32 characters
of both alphanumeric sets 1 and 2, plus the last 32 characters from
set 5. It also supports the full 12 cpi alphanumeric sets 1 to 5.
The following character set designators are available:
Table 5-18 Characters
Designator Character Set
Character Set Designators Per Inch
‘1’ 10 Single size alphanumeric 1
‘2’ 10 Single size alphanumeric 2
‘7’ 10 Single size alphanumeric 3
‘>’ 5 Double size alphanumeric 1.
See Table Note 1.
‘?’ 5 Double size alphanumeric 2.
See Table Note 1.
‘B’ 5 Double size alphanumeric 3.
See Table Note 1.
‘C’ 17 Condensed alphanumeric set 1 (statement,
thermal receipt in sideways print only)
‘D’ 17 Condensed alphanumeric set 2 (statement,
thermal receipt in sideways print only)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-20 APTRA™ Advance NDC, Reference Manual
Printer Data
Character Sets
Characters
Designator Character Set
Per Inch
‘E’ 17 Condensed alphanumeric set 3 (statement,
thermal receipt in sideways print only)
‘F’ 12 12 cpi size alphanumeric 1 (statement only)
‘G’ 12 12 cpi size alphanumeric 2 (statement only)
‘H’ 12 12 cpi size alphanumeric 3 (statement only)
‘I’ 10 Single size alphanumeric 4
‘J’ 10 Single size alphanumeric 5
‘K’ 5 Double size alphanumeric 4
See Table Note 1
‘L’ 5 Double size alphanumeric 5
See Table Note 1
‘M’ 17 Condensed alphanumeric set 4 (statement,
thermal receipt in sideways print only)
‘N’ 17 Condensed alphanumeric set 5 (statement,
thermal receipt in sideways print only)
‘O’ 12 12 cpi size alphanumeric 4 (statement only)
‘P’ 12 12 cpi size alphanumeric 5 (statement only)
‘Q’ 10 Single‐size alphanumeric 6 (euro)
‘R’ 5 Double‐size alphanumeric 6 (euro)
See Table Note 1
‘S’ 17 Condensed alphanumeric 6 (euro)
(statement, thermal receipt in sideways print
only)
Table Note 1: Double‐size sets are not supported by the receipt
printer in sideways printing mode, and receipt of these designators
will not change the current selected code set.
The statement printer contains a set of Arabic character sets that can
be selected instead of the standard sets by a hardware switch on the
printer. Refer to the relevant printer manual for the hardware
switch settings, or contact your local NCR representative.
When a Select Character Set control sequence appears in the printer
data, the characters that follow are invoked using the specified data
character set until a subsequent select character set control sequence
appears.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-21
Printer Data
Character Sets
For receipt and journal printers, the character set defaults to single
size alphanumeric 1 at the end of the printer data field, until another
Select Character Set control sequence appears.
For the statement printer, the character set selected is used until
another Select Character Set sequence appears, although the
character set may be changed by diagnostic operations. NCR
recommends that the character set is selected at the start of each
statement.
For the default character sets provided on cardholder screens and
printers, see Appendix B, “Character Sets”.
Primary Print Page 5
The default character set for all printers is the single size
alphanumeric 1 set. ASCII characters in the range 20‐7F hex invoke
characters from a set. Alternative character sets are selected using
the following sequence:
Table 5-19 Number of
Character Description
Select Primary Print Page Characters
1BH (ESC) Private Use Escape Sequence Introducer 1
‘(‘ Escape Sequence ID 1
Variable Character Set Designator 1
Secondary Print Page 5
The default character set is the single size alphanumeric 1 set. ASCII
characters in the range 20‐7F hex invoke characters from a set.
Alternative character sets are selected using the following sequence:
Table 5-20 Number of
Character Description
Select Secondary Print Page Characters
1BH (ESC) Private Use Escape Sequence Introducer 1
‘)‘ Escape Sequence ID 1
Variable Character Set Designator 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-22 APTRA™ Advance NDC, Reference Manual
Printer Data
Statement Printer Controls
Statement Printer Controls 5
The following control sequences apply to the statement printer
specifically:
Left margin control
Right margin control
Margin control use
Lines/inch control.
This control sequence gives the column where the print head is
Left Margin Control 5
positioned following an LF character. The default value is 0.
Table 5-21 Number of
Character Description
Set Left Margin (Statement Printer) Characters
1BH 5BH Control Sequence Introducer 2
(ESC) ‘[‘
<ASCII DATA> Column number range Var (1‐3)
From 000 to (right margin ‐ 4)
70H ‘p’ Function‐defining character 1
When a Set Left Margin control sequence appears in the printer
data, all the subsequent LF control characters return the print head
to the column specified, until the next Set Left Margin control
sequence is received. When the control is received, the specified
column is defined for the character set.
This control sequence gives the column position for the right
Right Margin Control 5
margin. This is the column at which an automatic LF is performed.
The default value is 80.
Table 5-22 Number of
Character Description
Set Right Margin (Statement Printer) Characters
1BH 5BH Control Sequence Introducer 2
(ESC) ‘[‘
<ASCII DATA> Column number range Var (1‐3)
From (left margin + 4) to 132
71H ‘q’ Function‐defining character 1
When a Right Margin Control sequence appears in the printer data,
all subsequent printing causes an automatic LF if printing is
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-23
Printer Data
Statement Printer Controls
attempted beyond the specified column number. The control stays
in effect until the next Right Margin Control sequence is received.
When the control is received, the position is defined for the
character set. Excessive values of the column number are ignored,
and the previous setting remains operative.
The margins are under the control of Central. When left and right
Margin Control Use 5
margin controls are used, they must be included in the data for the
statement printer before any printable characters on the current line.
If they are not, the new margin does not take effect until the next
line. They should be sent for each statement printed, as the margins
can be changed by Supervisor diagnostic functions.
When the controls are received, the margins are set to the column
position in the selected character set. They are not affected by
subsequent character set changes. The right margin setting must
remain within the paper width, or print head damage may occur.
This control sequence provides you with the capability of switching
Lines Per Inch Control 5
between six and eight lines per inch. The default value is eight.
Table 5-23 Number of
Character Description
Switch Lines Per Inch (6/8) Characters
1BH 5BH Control Sequence Introducer 2
(ESC) ‘[‘
<ASCII DATA> Lines per inch selector range (from 00 2
to 03)
72H ‘r’ Function‐defining character 1
When a lines per inch control sequence is received, line spacing on
the next explicit or automatic LF character assumes the specified
value. This continues until the next lines per inch control sequence
is received. Legal values are as follows:
Table 5-24 Spacing
Value
Line Spacing Values (Lines/Inch)
00 8
01 8
02 6
03 6
Other values are ignored.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-24 APTRA™ Advance NDC, Reference Manual
Printer Data
Simulated Pre-printed Receipt Messages
Simulated Pre‐printed Receipt
Messages 5
Screen numbers ‘R00’ ‐ ‘R01’ are reserved for simulated pre‐printed
receipt messages. The simulated pre‐print data can be downloaded
as a set of reserved screens. These can be interlaced with receipt
printer text sent in a Transaction Reply Command message.
When screen ‘R00’ is used to define images to be printed on the
Printing Images Using thermal receipt printer, the application is not aware of the size of the
Screens ‘R00’ and ‘R01’ 5
image or the number of print lines. Printing of ‘R01’ and/or
Transaction Reply print data will begin on the line after the image
defined in ‘R00’. Therefore, if the number of lines of data plus the
number of lines used by the image exceeds the configured form
length, the data will be printed on two or more receipts.
Screen ‘R00’ 5
Screen ‘R00’ contains the receipt header. This can take the form of
text to be printed or can contain the control sequence which
instructs the thermal receipt printer to print the image defined in the
control sequence. The control sequence is defined in “Print
Downloadable Bit Image” on page 5‐10.
This text or image is printed at the top of the receipt, before any
print text. Printing starts on the first available print line. Subsequent
printing occurs on the first blank line after the pre‐print header. If a
receipt is cut at the end of a transaction the header is printed before
authorisation of the next transaction to speed up transaction time.
Therefore the reserved screen ‘R00’ is not supported in sideways
printing mode and should not be downloaded to a terminal which
will be used for sideways printing on the receipt.
Screen ‘R01’ 5
Screen ‘R01’ contains the pre‐print text to be interlaced with print
text from Central. The print text is effectively overlaid line by line
on the pre‐print text to produce the final print (print text takes
priority).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-25
Printer Data
Simulated Pre-printed Receipt Messages
The following control sequences should not be included in the
printer data to be interlaced with screen ‘R01’ sent in the
Transaction Reply:
Table 5-25 Character Description
Invalid Control Sequences for Screen R01
1BH 32H Select International Character Sets
1BH 33H Select Arabic Character Sets
1BH 2FH 3xH 3yH Print Downloadable Bit Image
1BH 6BH 3xH <ASCII Print Barcode
Data> 1BH 5CH
1BH 47H <filename> Print Graphics
1BH 5CH
Screen ‘R01’ is not supported in sideways printing mode.
This feature allows blank stationery to be used with a Central
Other Uses of Screens ‘R00’ application program that was originally designed to operate with
and ‘R01’ 5
pre‐printed stationery. Another use of these screens is to align the
first print line with pre‐printed headers. This is done by building
screen ‘R00’ with the required number of LF (line feed) controls.
These reserved screens must be constructed with normal printer
message characters and controls.
The following example shows the interlacing of the simulated
pre‐print text screens and the text received from Central in a
Transaction Reply Command message.
Figure 5-1
Screen Text Interlacing
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-26 APTRA™ Advance NDC, Reference Manual
Printer Data
Simulated Pre-printed Receipt Messages
The following example shows the data coding for the screens.
Table 5-26 Screen R00 Data Print Line
Screen R00 Data
(SO) 4 FIRST FINANCIAL (LF) 1
(LF) 2
(LF) 3
DATE (SO) 6 TIME (SO) 6 MACHINE (LF) 4
Table 5-27
Screen R01 Data and Interlaced Data from
Central
Screen R01 Data Interlaced Data from Central Print Line
(LF) 25‐01‐91 12:00 001 (LF) 5
(LF) (LF) 6
(LF) (LF) 7
ACCOUNT NUMBER (LF) (LF) 8
(LF) 12345678 (LF) 9
(LF) (LF) 10
(LF) (LF) 11
CODE SERIAL AMOUNT (LF) (LF) 12
(LF) 10 (SO) 61233 (SO) 6$ 20.00 (LF) 13
(LF) (LF) 14
CODE SERIAL AMOUNT (LF) (LF) 15
(LF) 11 (SO) 61234 (SO) 6$150.00 (LF) 16
(LF) (LF) 17
THANK YOU (LF) 18
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-27
Printer Data
Simulated Pre-printed Receipt Messages
The following diagram shows an example of the final receipt
produced.
Note:
Lines 1‐4 contain data from Screen R00
Lines 8, 12, 15 and 18 contain data from screen R01
Lines 5, 9, 13 and 16 contain data from Central
Figure 5-2
Final Simulated Pre-printed Receipt
Line 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Note: If form feed controls are used, the following will occur:
If the host data contains a form‐feed control, any remaining
data in the R01 screen is added before the page break. Screen
R00 is printed on the second and subsequent receipts when
produced by the same print command.
If screen R00 contains any form‐feed characters, these are
converted to spaces before the screen data is prefixed to the
host data.
If screen R01 contains any form‐feed characters, any
remaining host data is added before the form feed. Any
remaining data from the R01 screen occurring after the form
feed character is not printed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-28 APTRA™ Advance NDC, Reference Manual
Printer Data
Sideways Printing on Receipt
Sideways Printing on Receipt 5
Sideways printing on the receipt printer is controlled through the
use of function identifiers ‘P’ (Print Statement and Wait) and ‘Q’
(Print Statement and Set Next State) in conjunction with the printer
flag ‘=’ in the Transaction Reply message sent from Central. For
details, see “Transaction Reply Command” on page 10‐52.
You can set the left and right margins of printer data to be printed
sideways on the receipt printer by using the Set Left Margin and Set
Right Margin control sequences described in this chapter. See
“Enhanced Printer Control Codes” on page 5‐7.
When printing in sideways mode on the receipt printer, the
maximum configuration of a customer receipt is 80 columns by 20
lines. Where the data sent from Central causes this line count to be
exceeded, the sideways statement is cut after 20 lines and the
remaining data printed on the next statement(s).
The following are not supported in sideways printing mode:
Unsupported Functions 5
Printing of images, graphics and double size characters
Printing on the receipt printer in Supervisor mode
Printing on the USB Receipt printer
Reserved screens ‘R00’ and ‘R01’; these screens should not be
downloaded to an SST that will be used for sideways printing
on the receipt printer.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-29
Printer Data
Printer Control Sequences and Registry Settings
Printer Control Sequences and
Registry Settings 5
The following table provides the printer control and related registry
settings for receipt and journal printers on Personas SSTs with
equivalent registry settings for USB printers on SelfServ SSTs.
The printer control codes received from the host are the same as the
registry values specified for printers on Personas SSTs.
Details are given for receipt printers. A dash (—) means the value is
not set. Differences for other printers are indicated under the control
code as follows:
A dollar sign ($) = the value is not set for the journal printer
A value in brackets = a different value for the journal printer
An asterisk (*) = the value is not set for dot‐matrix receipt
printers
An ampersand (&) = the value is not set for dot‐matrix journal
printers
Table 5-28
Printer Control Sequences and Registry
Settings
NDC Control Code USB Control Code
Control Registry Name Variable Description
(Hex) (Hex)
Header — HEADER — Sequence added
before any print data.
The sequence is not
processed by
Advance NDC, and
must therefore use
the printer’s native
escape sequences
Footer — FOOTER — Sequence added after
any print data.
The sequence is not
processed by
Advance NDC, and
must therefore use
the printer’s native
escape sequences
Line‐feed character 0D LINE_FEED 0A —
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-30 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Sequences and Registry Settings
NDC Control Code USB Control Code
Control Registry Name Variable Description
(Hex) (Hex)
Form‐feed 0C FORM_FEED 1D 54 19 1B 46 —
character
See Table Note 2
Carriage return 0D CR 0A —
character
Horizontal tab 09 HT 09 —
character
Set left margin 1B 5B var 70 LEFT_MARGIN 1D 4C bvar Column position of
the left margin in
See Table Note 3 See Table Note 4 standard characters,
typically between 1
and 39
For the USB Receipt
and Journal printers,
this is the column
position of left
margin in dots
Set right margin 1B 5B var 71 RIGHT_MARGIN — Column position of
the right margin in
standard characters,
typically between 1
and 39
Select OS2 code 1B 25 var OS2_CODE_PAGE 1B 25 bvar Code page number
page
Copy code page to 1B 3A var COPY_CODE_PAGE 1B 3A 30 bvar 30 Code page number
RAM
Select international 1B var INTR_CHAR_SET — —
character set
See Table Note 3
Select Arabic 1B var ARAB_CHAR_SET — —
character set
See Table Note 3
Print downloaded 1B 2F var & BIT_IMAGE 1D 2F bvar Bit image identifier /
bit image bit image size
See Table Note 5
For the USB Receipt
and Journal printers,
this is bit image size
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-31
Printer Data
Printer Control Sequences and Registry Settings
NDC Control Code USB Control Code
Control Registry Name Variable Description
(Hex) (Hex)
Print barcode 1B 6B var 1B 5C & BARCODE 1D 6B bvar Barcode type and
barcode data
For the USB Receipt
and Journal printers,
this is barcode type
(tvar), length (lvar),
and data (dvar). See
Table 5‐30 on
page 5‐36 for details
Print graphics file 1B 47 var 1B 5C * GRAPHICS bvar Path and name of
& graphics file.
See Table Note 8
Print last image 1B 47 var 1B 5C CHEQUE bvar Side of cheque to
processed $ * & $ print and how the
See Table Note 6 codeline is printed
and Table Note 7
Select primary 0F SHIFT_IN — —
character set G0
Select secondary 0E SHIFT_OUT — —
character set G1
Select character set 1B 28 var CHAR_SET1 — Character set number
as active set G0
Select character set 1B 29 var CHAR_SET2 — Character set number
as active set G1
Define character set 1B 26 var 1B 5C DEF_CHAR_SET var Path/filename
containing the
See Table Note 13 character set
definition
Define bit image 1B 2A var 1B 5C DEF_BIT_IMAGE 1D 23 bvar Bit image ID and the
& path/filename
See Table Note 5 containing the
definition
Position of 1B 65 var * & POS_HRI_CHAR 1D 48 bvar Position of characters
human‐readable
characters See Table Note 11 See Table Note 12
(for barcode)
See Table Note 9
and Table Note 10
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-32 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Sequences and Registry Settings
NDC Control Code USB Control Code
Control Registry Name Variable Description
(Hex) (Hex)
Height of barcode 1B 68 var * & HZ_HGHT_BARCO 1D 68 bvar Height in dots
DE
See Table Note 13
Width of barcode 1B 77 var * & WIDTH_BARCODE 1D 77 bvar Width in dots
See Table Note 13
Form length 1B 5B var 73 SET_FORM_LEN 1B 62 bvar Length of form in
rows
See Table Note 14
Cut 11 CUT 1D 54 19 1B —
(and feed on some 46
printers)
Sideways mode on 1D SW_ON — —
Sideways mode off 1E SW_OFF — —
Vertical tab 0B var VERT_TAB 14 bvar Number of lines to
advance
Set extra dot rows 1B 5B var 72 EXTRA_DOT_ROW 16 bvar Number of extra rows
See Table Note 15
Set line spacing 1B 5B var 74 LINE_SPACE 1B 33 bvar Line spacing
See Table Note 16
Set first line 1B 5B var 75 FIRST_LINE_POS 1B 65 bvar First line position
position
See Table Note 18
Select print mode — PRNT_MODE 1B 21 var Print mode value
Select logo — SELECT_LOGO 1D 23 bvar Bit map identifier
Table Note 2: This form feed control combines the form feed (1D
54), the cut (19) and the present (1B 46) control codes so that it
provides the same functionality as the original form feed control
(0C).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-33
Printer Data
Printer Control Sequences and Registry Settings
Table Note 3: This is supported at application level for all printers.
The USB Receipt and Journal printers support code pages that differ
from those used by other printers, but contain the same characters.
Advance NDC provides a mapping file so that each code is correctly
mapped and applied. For details of the mapping file, see “Mapping
Files” on page B‐8.
Whether a mapping file is checked for a corresponding section is set
using the registry. When the host requests an Arabic or
International character set and a mapping file is to be checked, the
corresponding section is located in the mapping file. If found, the
specified character set is used, otherwise the control sequence is sent
directly to the printer.
Table Note 4: This is used only for positioning bit images for the
USB Receipt and Journal printers, the NDC Code is used for setting
the left margin for printable data.
Table Note 5: For USB receipt and journal printers, monochrome
bitmap (.bmp) files for both forms‐based and raw data printing are
supported. The monochrome bitmap is registered or downloaded
using the Define Downloadable Bit Image control sequence. It can
then be printed using the Print Downloadable Bit Image control
sequence. If the file is not found in the specified location, the path
and file name are printed as described in“Print Downloadable Bit
Image” on page 5‐10.
Table Note 6: This registry setting is used even when the host
downloads the 1B 5C var 1B 5C code. This is because the Print
Graphics control sequence is used to print cheque image graphics
regardless of the type of printer in use.
Table Note 7: The variable data for the print cheque image contains
the following information. For the receipt printer, the printer control
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-34 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Sequences and Registry Settings
sequence must be placed within the Printer Data field, not at the
beginning or end.
Table 5-29 Variable Description Chars
Print Cheque Image Variable Data
<side> Selects the front or back of the cheque to be 1
printed.
Values can be as follows:
‘0’ for front image
‘1’ for back image
<codeline Defines how the codeline is printed. Values 1
control> can be as follows:
‘0’ to print the normal image of the
cheque; this must be used if side is set to
‘1’
‘1’ to print an image of the cheque with
the codeline blacked out
‘2’ to print an image of the cheque with
the codeline removed
Note: For PA‐DSS compliance, the codeline
control variable must be set to 1 or 2 if
<side> is set to 0
Table Note 8: Bitmaps are supported for forms‐based printing on
USB receipt and journal printers For printing raw data on USB
receipt or journal printers, the graphic must be converted to a .prn
file. For further information, refer to the APTRA Advance NDC,
Developer’s Guide.
Table Note 9: The default setting is empty so it is not processed
Table Note 10: Because of resolution differences, the barcode will
be a different size on the USB Receipt printer.
Table Note 11: If the barcode does not fit on the line, a partial
barcode is printed
Table Note 12: If the barcode does not fit on the line, the barcode is
not printed
Table Note 13: The USB Receipt and Journal printers use a
resolution of 203 dpi rather than 150 dpi. To adjust your existing
character sets for this change, see “USB Printers and Downloadable
Character Sets” on page B‐4. If more than 188 dots are specified, the
USB Receipt and Journal printers will not be able to reproduce a
barcode of the same size as other thermal journal or receipt printers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 5-35
Printer Data
Printer Control Sequences and Registry Settings
Table Note 14: The receipt length is the number of lines to be
printed. Maximum and minimum lengths are stated in inches. The
default range is a minimum of either 4.4 inches or 3 inches and a
maximum of 7.5 inches. USB Receipt and Journal printers ignore
anything outside the set range. Other printers reset the form length
appropriately.
Table Note 15: The EXTRA_DOT_ROW control sequence depends
on printer resolution. To produce a consistent space between lines,
NCR recommends using the LINE_SPACE control sequence
instead.
Table Note 16: Advance NDC sets the line spacing in steps of n/144
inch to ensure that line spacing is not affected by differences in
resolution.
Table Note 17: Resolution differences are managed by Advance
NDC. If, however, a USB receipt and journal printer is used, the
input value should not be greater than 90 due to the input boundary
constraints of the printer hardware.
Table 5-30 tvar Type Name lvar dvar
USB Receipt and Journal Printer: Barcode
Types, Length, and Data ‘65’ UPC‐A 48‐57 (ASCII numerals) Fixed Length: 11, 12
‘66’ UPC‐E 48‐57 Fixed Length: 11,12
‘67’ JAN‐13 48‐57 Fixed Length: 12,13
(EAN13)
‘68’ JAN‐8 48‐57 Fixed Length: 7,8
(EAN8)
‘69’ CODE39 48‐57 Variable
65‐90 (ASCII alphabet)
32, 36, 37, 43, 45, 47
(ASCII special
characters)
dl=dk=42 (start/stop
code is supplied by
printer if necessary)
‘70’ Interleave 48‐57 Variable
d 2 of 5 Even number
(ITF)
‘71’ CODABA 65‐68 (start code) Variable
R (NW‐7) 48‐57
36, 43, 45, 46, 47, 58
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-36 APTRA™ Advance NDC, Reference Manual
Printer Data
Printer Control Sequences and Registry Settings
tvar Type Name lvar dvar
‘72’ Code 93 0‐127 Variable
‘73’ Code 128 0‐105 Variable
dl=103‐105 (must be a
start code)
d2=0‐102 (data bytes)
Stop code is provided
by the printer
‘10’ PDF417 0‐255 Variable
Table Note 18 The first line position will be overridden by any
valid value entered through option 92, Receipt Top Margin on the
Configure menu in Supervisor. For details, refer to Chapter 4,
“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, Reference Manual 5-37
Printer Data
Printer Control Sequences and Registry Settings
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-38 APTRA™ Advance NDC, Reference Manual
Table of Contents
Supervisor Messages
Chapter 6
Supervisor Messages
Overview 6‐1
Supervisor Messages 6‐2
Character Sets 6‐2
Control Codes 6‐2
Screen Size Limitations 6‐3
Cardholder Screen /Enhanced Operator Interface Layout 6‐3
Printer Layout 6‐4
Automatic Screen Editing 6‐4
Media Status Messages 6‐4
Test Cash Report 6‐4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Supervisor Messages
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Supervisor Messages
F
Overview
Overview 6
This chapter describes the formatting rules for Supervisor messages
that are output to the consumer screen (when the Supervisor
interface has been transferred to the front), the operator panel, and
the receipt and journal printers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 6-1
Supervisor Messages
Supervisor Messages
Supervisor Messages 6
Formatting rules apply to the following:
? Character sets
? Control codes
? Screen size limitations
? Cardholder screen/Enhanced operator interface layout
? Printer layout
? Automatic screen editing
? Media status messages
? Test cash report.
The text for these messages is contained in reserved screens. If these
screens are not downloaded, standard English language text is
displayed or printed. If you want to use alternative text, you can do
so by either of the following:
? Editing resrvd.def to translate the English text
? Downloading the alternative text with the reserved screen
number.
For a list of all Supervisor reserved screens, showing the function
for which each one is used and the default text, see Appendix A,
“Reserved Screens”.
Note: For details of how the Supervisor messages are sized for
another vendor’s hardware, refer to section “Supervisor Messages”
in Chapter 3 of the APTRA Advance NDC, Multi‐Vendor Support
Reference Manual.
All display/print characters are obtained from the Single Size
Character Sets 6
Alphanumeric 1 character set.
The following control codes are supported:
Control Codes 6
? CR — causes the next character to be displayed at the beginning
of the next line. CR must appear on each line
? SO — the same as printer control (multiple spaces).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-2 APTRA™ Advance NDC, Reference Manual
Supervisor Messages
Supervisor Messages
The following table shows the maximum number of columns and
Screen Size Limitations 6
rows for each type of screen:
Table 6-1 Screen No. Of No. Of
Usage
Screen Size Limits Type Rows Columns
‘A’ Cardholder/Enhanced Operator 1 32
Interface Acknowledgement Lines
‘E/e’ Error Messages 1 32
‘I’ Cardholder/Enhanced Operator 14 32
Interface/Printer Information Output
‘M/m’ Cardholder/Enhanced Operator 13 32
Interface/Printer Menus
‘P/p’ Cardholder/Enhanced Operator 1 27
Interface Data Entry Prompts
‘S/s’ Media Status Lines 1 32
‘T/t’ Journal Trace 15 32
Supervisor TCP/IP Screens 15 32
‘i’ Supervisor Bunch Note Acceptor 14 32
(BNA) Screens
Supervisor VISA 2 screens 15 32
If Supervisor functions are selected from the facia keyboard or the
Cardholder Screen enhanced operator interface, all screens are displayed from the
/Enhanced Operator left‐most column. The following table shows the display positions.
Interface Layout 6
Table 6-2 Screen Row Column
Usage
Display Positions Type Position Position
‘A’ Acknowledgement Line 14 1‐32
‘A’ Last Supervisor Control Key 16 7‐26
‘E/e’ Error Messages 14 1‐32
‘I/i’ Information Display 1‐2 1‐32
‘M/m’ Menus 1‐13 1‐32
‘P/p’ Prompt Line 1‐15 1‐27
‘P/p’ Enter and Clear Keys 16 1‐5,
28‐32
‐ Keyboard Echo 15 28‐32
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 6-3
Supervisor Messages
Supervisor Messages
Row 16 is used to display key legends for FDKs ‘D’ and ‘F’. As these
act as Enter and Clear keys in Supervisor mode, columns 1 to 6 and 27
to 32 of ‘Last Supervisor Control Key’ screens must not contain
significant text. You should also take care if you are designing a new
screen to be downloaded for touch display when an enhanced
operator interface is also present, as your design will have to
incorporate both touch and FDKs.
Rows 1 to 14 can contain either the Current Menu and
Acknowledgement line for the last function or the Information
Display from the last function.
During encryption key entry, columns 1 to 3 and 29 to 32 contain
legends for the six FDKs that are used as hex keys A‐F. These hex
keys supplement numeric keys 0‐9 for entry of hexadecimal digits.
The encryption key entry assistance screen must not contain
significant text in these positions.
All printing of reserved screens starts at column 6 and extends as far
Printer Layout 6
as column 37. The fixed format security trace header starts at
column 1. Note that you cannot use sideways printing in Supervisor
mode.
Certain reserved screens are edited by the terminal prior to display
Automatic Screen Editing 6
or print in order to include information held by the terminal. These
screens contain a percent (%) character as a placeholder to indicate
the start location of the generated data. For details of the screens in
reservd.def, see Appendix A, “Reserved Screens”. For information
about editing the screens, see “Editing the Contents of Reserved
Screens” on page 3‐13.
The Media Status message is built by the terminal from the Media
Media Status Messages 6
Status header (screen ‘I05’) and Media Status lines (‘S’ or ‘s’ screens).
Screen ‘I05’ is overlaid from line 3 onwards with Media Status lines.
If a media exception condition exists, the appropriate message is
displayed. Otherwise, nothing is displayed. If no exception
condition exists or if the reserved screen contains no data, screen
‘S00’ is displayed on line 3 to indicate that all supplies are adequate.
This ensures that if you only use two cassette types, messages
relating to cassettes 3 and 4 are never displayed.
This report is built by the terminal from the Cash Test Header
Test Cash Report 6
(screen ‘I07’) and Cassette Operational lines (screens ‘S15’ ‐ ‘S18’).
Screen ‘I07’ is overlaid from line 3 onwards with Cassette
Operational lines. If a cassette is operational, for example, a note has
been successfully picked and purged, the appropriate line is
displayed. If it is not operational, nothing is displayed. If no
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-4 APTRA™ Advance NDC, Reference Manual
Supervisor Messages
Supervisor Messages
cassettes are operational, screen ‘S14’ is displayed on line 3, with the
message:
NO GOOD CASSETTES
A typical report is as follows:
*CASH TEST* } Screen ‘I07’
}
TOP CASSETTE GOOD
SECOND CASSETTE GOOD
If an exit shutter fault is detected, screen ‘S25’ is displayed on the
CRT after screen ‘I07’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 6-5
Supervisor Messages
Supervisor Messages
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
6-6 APTRA™ Advance NDC, Reference Manual
Table of Contents
Configuration Parameters
Chapter 7
Configuration Parameters
Overview 7‐1
Configuration Parameters Load Message 7‐2
Camera Control (Field ‘h’) 7‐2
Supply Mode, Ready Status & Amount Buffer
Length (Field ‘m’) 7‐2
Logical Unit Number – LUNO (Field ‘o’) 7‐3
Timer Number (Field ‘p’) 7‐3
Millisecond Ticks per Timer Field (Field ‘q’) 7‐4
Unsupported Parameters 7‐5
Reserved Parameters 7‐5
Enhanced Configuration Parameters Load Message 7‐6
Option 00 – Camera Control 7‐6
Option 01 – Supply Mode, Ready Status, & Amount Buffer
Length 7‐6
Option 02 – Auto Voice 7‐7
Option 03 – Date Format 7‐7
Option 04 – Roll Width 7‐7
Option 05 – Left Print Column 7‐7
Option 07 – Track 1 Format 7‐8
Option 12 – Specific Command Reject 7‐8
Option 15 – Transaction Status Information 7‐8
Option 16 – Journal Printer Backup Time 7‐8
Option 17 – Journal Printer Backup Print Operations 7‐8
Option 23 – Envelope Dispenser Status 7‐9
Option 24 – Enhanced/TI Sensor Status Unsolicited Message 7‐9
Option 25 – Media Entry/Exit Indicators Flash Rate 7‐10
Option 27 – Remote Relay 7‐10
Option 30 – Include PAN in DCS Data 7‐10
Option 32 – Unsolicited Reporting Control 7‐10
Option 33 – Simulate Supervisor Mode Entry/Exit 7‐11
Option 34 – MCN Range 7‐11
Example Values for MCN 7‐12
Option 35 – Report Dual Mode EJ & Hardcopy B/U Unsolicited
Messages 7‐13
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Configuration Parameters
Option 36 – Enhanced EJ Backup 7‐13
Option 37 – Print Track 2 to Journal 7‐13
Option 41 – Send Track Details on Card Retract 7‐14
Option 44 – BNA Journal Notes Count 7‐14
Option 45 – BNA Settings 7‐15
Option 46 – MCRW Enhanced Card Device Security Jitter 7‐17
Option 48 – Barcode Reader 7‐18
Option 69 – EMV Smart Card Extended Status 7‐18
Option 70 – EMV Smart Card 7‐18
Option 71 – Time‐Out State Entry 7‐18
Option 74 – Destination for Cash Deposit Retract 7‐18
Option 76 – Cash Handlers 7‐19
Option 77 – Next State Number 7‐19
Option 78 – GBRU M‐Status Reporting 7‐20
Option 79 – Coin Dispenser 7‐21
Option 80 – Alphanumeric State Entry 7‐21
Option 83 – Cheque Processor 7‐21
Timer Number 7‐22
Number of Seconds per Timer Field 7‐22
Unsupported Parameters 7‐22
Timers 7‐24
Time Units for Timers 7‐24
Timer Descriptions 7‐24
Timer Adjustment For Voice Guidance 7‐24
Timer 00 * 7‐24
Timer 01 * 7‐24
Timer 02 7‐25
Timer 03 7‐25
Timer 04 * 7‐25
Timer 05 * 7‐25
Timer 06 7‐26
Timer 07 * 7‐26
Timer 08 * 7‐26
Timer 09 * 7‐27
Timer 10 7‐27
Timer 60 7‐27
Timer 61 * 7‐27
Timer 63 7‐27
Timer 68 7‐28
Timer 69 7‐28
Timer 72 7‐28
Timer 77 * 7‐28
Timer 78 * 7‐28
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Configuration Parameters
Timer 87 * 7‐28
Timer 92 7‐29
Timer 94 * 7‐29
Timer 95 * 7‐29
Timer 96 * 7‐29
Reserved Timers 7‐29
Unsupported Timers 7‐30
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Configuration Parameters
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Configuration Parameters
G
Overview
Overview 7
The host can download either a configuration parameter message,
or an enhanced configuration parameter message.
This chapter describes the parameters available in these two
configuration message formats.
Note: The SST can be further configured locally by the use of
message mode options, which are accessed through the Supervisor
Configure menu. For more information, 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, Reference Manual 7-1
Configuration Parameters
Configuration Parameters Load Message
Configuration Parameters Load
Message 7
This message contains the parameters used in NDC+ for Diebold
emulation. The message format is supported in Advance NDC
although Diebold emulation mode is not supported.
Not all the parameters in this message are supported in Advance
NDC. Details of unsupported and reserved parameters are given in
“Unsupported Parameters” on page 7‐5.
For details of the message format, see “Configuration Parameters
Load” on page 10‐15.
For details of other parameters that can be used in Advance NDC,
see “Enhanced Configuration Parameters Load Message” on
page 7‐6.
If the SST is fitted with a camera, this parameter sets automatic
Camera Control (Field ‘h’) 7
picture taking on or off. Possible values are as follows:
Table 7-1 Value Description
Values for Camera Control
0 Yes
1 Yes
2 No
3 No
Note: Camera control can also be configured with enhanced
configuration option 00. For details, see “Option 00 – Camera
Control” on page 7‐6.
This single parameter is used to set three configuration options and
Supply Mode, Ready the value to be downloaded is formed by adding the values for the
Status & Amount Buffer three options together. The values for the three options are as
Length (Field ‘m’) 7 follows:
Table 7-2 Value Description
Values for Supply Mode, Ready Status and
Amount Buffer Length 000 No option selected (default)
001 Ready Status
Send a separate Ready ‘B’ status message to the host in
response to a Transaction Reply message.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-2 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Configuration Parameters Load Message
Value Description
002 Supply Mode
Return the SST automatically to the previous mode
when it leaves Supply mode.
008 Amount Buffer Length
Set the amount buffer length to twelve digits. The
default is eight digits.
016 Include Transaction Status Data
Include the transaction status information in the Ready
‘B’ message. (Ready ‘B’ must also be enabled or the
value is ignored.)
For example, to send a separate Ready ‘B’ status message to the
host, leave Supply Mode unselected, set the Amount Buffer Length
to 12, and exclude the transaction status data, the value to download
is 001+008 = 009.
Note: In Enhanced Configuration Parameters Load, this parameter
is Option Code 01 of field ‘j’.
This parameter determines whether the logical unit number, LUNO,
Logical Unit Number – will be transmitted in Transaction Request, Solicited and
LUNO (Field ‘o’) 7
Unsolicited Status messages.
The number tells the host which SST transmitted the message. If this
field is not present, the LUNO defaults to 000, or to a previously
downloaded value held by the SST. If the data security feature is
configured, an additional six characters are present containing the
security SST number.
Note: In the Enhanced Configuration Parameters Load message,
this parameter is field ‘h’.
This parameter sets the time‐out value for each of the timers that the
Timer Number (Field ‘p’) 7
SST application uses. The timers available are the same for both
configuration load and enhanced configuration load.
The following table summarises the timers. For detailed
descriptions, see “Timers” on page 7‐24.
For the list of reserved timers, see “Reserved Timers” on page 7‐29.
Note: In Enhanced Configuration Parameters Load, this parameter
is field ‘k’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-3
Configuration Parameters
Configuration Parameters Load Message
Table 7-3 Timer Number Function
Summary of Timers
‘00’ Cardholder keyboard entry time‐out
‘01’ Cardholder response to time‐out screen time‐out
‘02’ Close state or eject failure cardholder screen time‐out
‘03’ Communications response time‐out
‘04’ Cheque/envelope/card insertion time‐out
‘05’ Cash retract time‐out
‘06’ Communications connection sample interval
‘07’ Present time‐out
‘08’ Night safe deposit time‐out
‘09’ Card removal time‐out
‘10’ Additional present time‐out
‘60’ EJ acknowledgement time‐out
‘61’ Barcode reader scan time‐out
‘63’ Hardware failure screen time‐out
‘68’ Statement MEI duration time‐out
‘69’ Receipt MEI duration time‐out
‘72’ DASH card removal time‐out
‘77’ BNA/GBXX cash acceptance time‐out
‘78’ GBXX cash rejection time‐out
‘87’ Cheque capture screen time‐out
‘91’ EJ inspection time‐out (not supported).
‘92’ Fault display time‐out
‘94’ Cheque/envelope removal time‐out
‘95’ Statement retract time‐out
‘96’ Statement present time‐out
‘97’ Door access open time‐out (not supported)
This parameter sets the time‐out interval for the timers in 800
Millisecond Ticks per millisecond ticks. The valid range is 000—255, providing a time‐out
Timer Field (Field ‘q’) 7
range of 0‐204 seconds.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-4 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Configuration Parameters Load Message
The following parameters are not supported in Advance NDC but
Unsupported Parameters 7
are reserved in the message:
Card Read Error Threshold (Field ‘i’)
Card Write Error Threshold (Field ‘l’)
The following parameters are reserved for future use:
Reserved Parameters 7
Field ‘j’
Field ‘k’
Field ‘n’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-5
Configuration Parameters
Enhanced Configuration Parameters Load Message
Enhanced Configuration Parameters
Load Message 7
The Enhanced Configuration Parameters Load message format
contains all the options available in Advance NDC.
Most enhanced configuration parameters are defined by an option
number in field ‘i’ of the message, with field ‘j’ holding the option
code. This section describes the options and codes.
The following parameters are common to both Configuration
Parameters Load and Enhanced Configuration Parameters Load
message formats, and have the same values:
Supply Mode, Ready Status, Amount Buffer Length and
Transaction Status Data (Option 01)
Logical Unit Number – LUNO
Timer Number
These parameters are described on page 7‐2 to page 7‐3.
For details of the message format, see “Enhanced Configuration
Parameters Load” on page 10‐17.
For a list of unsupported parameters see “Unsupported
Parameters” on page 7‐22.
If the SST is fitted with a camera, this parameter sets automatic
Option 00 – Camera picture taking on or off. Possible values are as follows:
Control 7
Option Code Description
001 Security Camera is switched on (default). The
flowpoints at which pictures are taken depend on the
configuration of NDCSecurityCamera.xml.
002 Security Camera is switched off
Note: Camera control can also be configured in the configuration
parameters load message. For details, see “Camera Control (Field
‘h’)” on page 7‐2.
This is the same as option ‘m’ in the Configuration Parameters Load
Option 01 – Supply Mode, message. For details, see “Supply Mode, Ready Status & Amount
Ready Status, & Amount Buffer Length (Field ‘m’)” on page 7‐2.
Buffer Length 7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-6 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Enhanced Configuration Parameters Load Message
If the SST is fitted with an automatic voice feature, this parameter
Option 02 – Auto Voice 7
sets auto voice on or off. Possible values are as follows:
Table 7-4 Option Code Description
Option 02: Auto Voice Values
001 Auto voice on (default)
002 Auto voice off.
Note: If the cardholder selects a voice‐guided session, this option is
ignored and auto‐voice messages are not played during the session.
This parameter sets the date format. Values are as follows:
Option 03 – Date Format 7
Table 7-5 Option Code Description
Option 03: Date Formats
001 MMDDYY (default)
002 DDMMYY
003 Not supported
004 Not supported
This parameter defines the number of columns used in receipt print
Option 04 – Roll Width 7
screens in messages sent from Central. An automatic new line
occurs if this limit is exceeded. The valid range is 001‐040, and the
default is 025. This option applies when used in normal print mode
(not sideways printing mode).
This parameter defines the left‐most column used in receipt print
Option 05 – Left Print screens in messages from Central. The range is 001 to 040, and the
Column 7
default value is 008. This option applies when used in normal print
mode (not sideways printing mode).
Note: It is the responsibility of the Central application to ensure
that the sum of the values for roll width (option 04) and left column
(option 05) do not exceed 041. NCR recommends that you define
both options in the same message.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-7
Configuration Parameters
Enhanced Configuration Parameters Load Message
This parameter sets the method of extracting the name and title
Option 07 – Track 1 from Track 1 data on the card. Possible values are as follows:
Format 7
Table 7-6 Option Code Description
Option 07: Track 1 Format Values
001 ISO format (default)
002 VISA format
003 Autosearch backwards
004 Autosearch forwards.
This parameter determines whether the SST transmits Specific
Option 12 – Specific Command Reject options. Possible values are as follows:
Command Reject 7
Table 7-7 Option Code Description
Option 12: Specific Command Reject
Values 000 Do not transmit specific command reject statuses, except
MAC (default)
001 Transmit specific command reject statuses.
This parameter determines whether the transaction status
Option 15 – Transaction information from the last command is appended to Transaction
Status Information 7
Request messages. Possible values are as follows:
Table 7-8 Option Code Description
Option 15: Transaction Status Information
Values 000 Do not append last transaction status information
(default)
001 Append last transaction status information.
This parameter sets the maximum time in hours that journal printer
Option 16 – Journal Printer backup is allowed before all journalling is discontinued. It is not
Backup Time 7
supported when dual mode journal printing is active.
The valid range is 000‐255. The default setting is 000.
Note: If options 16 and 17 are both non‐zero, whichever limit is
reached first will be executed.
This parameter sets the maximum number of print operations (in
Option 17 – Journal Printer hundreds) to be buffered while the journal printer is fatal. It is not
Backup Print Operations 7
supported when dual‐mode journal printing is active.
The valid range is 000–225. The default setting is 000.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-8 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Enhanced Configuration Parameters Load Message
Note: If options 16 and 17 are both non‐zero, whichever limit is
reached first will be executed.
This option determines whether envelope dispenser status
Option 23 – Envelope messages are sent. Possible values are as follows:
Dispenser Status 7
Table 7‐9 Option Code Description
Option 23: Envelope Dispenser Status
Values 000 Do not send envelope dispenser status messages
(default)
001 Send envelope dispenser status messages
002 Not supported
003 Send envelope dispenser status messages
This option determines whether the Enhanced TI/Sensor Status
Option 24 – Enhanced/TI unsolicited message is sent from the SST when tampering is
Sensor Status Unsolicited suspected on devices not supported in the existing TI/Sensor Status
Message 7 unsolicited message. Possible values are as follows:
Table 7-10 Option Code Description
Option 24: Enhanced/TI Sensor Status
Unsolicited Message Values 000 Do not send the Enhanced TI/Sensor Status
unsolicited message; continue to send the existing
TI/Sensor Status unsolicited message (default)
001 Send the Enhanced TI/Sensor Status unsolicited
message when appropriate; do not send the existing
TI/Sensor Status unsolicited message.
002 Send the Flexible TI/Sensor Status unsolicited
message in all circumstances; do not send any other
version.
Note: Setting the value to 002 also causes buffer C to be included in
the solicited TI/Sensor Status message in addition to buffers A and B.
For details of the solicited TI/Sensor Status message, see “Tamper
and Sensor Status Data” on page 9‐56.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-9
Configuration Parameters
Enhanced Configuration Parameters Load Message
This parameter sets the flash rate for the Media Entry/Exit
Option 25 – Media Indicators. The flash rate can range from 4.0 Hz to continuously on
Entry/Exit Indicators Flash as follows:
Rate 7
Table 7-11 Option Code Description
Option 24: Media Entry/Exit Indicators
Flash Rate 000 4.0 Hz (fast) (default)
001 1.0 Hz (medium)
002 1.0 Hz
003 0.25 Hz (slow)
004 0.25 Hz
005 Continuously on.
The flash rate for media entry indicators can also be set using the
message mode option on the Configure menu in Supervisor mode.
On exit from Diagnostics, the flash rate is reset according to the
value in the enhanced configuration parameter 25 or message mode
option 8, whichever has been more recently set. For details, refer to
the APTRA Advance NDC, Supervisor’s Guide.
This parameter determines when the remote relay is active. Possible
Option 27 – Remote Relay 7
values are as follows:
Table 7-12 Option Code Description
Option 27: Remote Relay
000 Remote relay is active when a device condition that
needs operator intervention occurs and during off‐line
mode (default)
001 Remote relay is active only when the SST is in service.
Enhanced configuration parameter option 30 is supported
Option 30 – Include PAN depending on hardware capability. It is used to superimpose the
in DCS Data 7
PAN on the image. Values are as follows:
Table 7-13 Option Code Description
Option 30: Include PAN in DCS data
000 Include PAN in DCS data (default)
001 Do not include PAN in DCS data
This option controls reporting of faults with voice guidance and
Option 32 – Unsolicited camera. It also controls the reporting of state changes
Reporting Control 7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-10 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Enhanced Configuration Parameters Load Message
(active/inactive) in the cardholder display sensor. The possible
values are as follows:
Table 7-14 Option Code Description
Option 32: Unsolicited Reporting Control
000 Do not send messages for voice guidance, security
camera or cardholder display alarm.
001 Send voice guidance errors only.
002 Send camera errors only.
003 Send both voice guidance and camera errors.
004 Send cardholder display changes only.
005 Send voice guidance errors and cardholder display
changes.
006 Send camera errors and cardholder display changes.
007 Send voice guidance errors, camera errors and
cardholder display changes.
This option simulates entry to or exit from Supervisor mode after
Option 33 – Simulate safe door activity. Possible values are as follows:
Supervisor Mode
Entry/Exit 7
Table 7‐15 Option Code Description
Option 33: Simulate Supervisor Mode
Entry/Exit Values 000 Simulate Supervisor mode entry/exit: the cash dispenser
is cleared when the safe door is closed, and again when
the SST is switched to In Service mode (default)
001 Do not simulate Supervisor mode entry/exit: the cash
dispenser is only cleared when the SST is switched to
in‐service mode. No clear is issued when the safe door is
closed.
This option defines the range of the Message Coordination Number
Option 34 – MCN Range 7
(MCN) and whether Transaction Replies and Interactive
Transaction Responses (ITRs) are rejected or ignored. The option
consists of a bit field combined from the following values:
Table 7-16 Bit Description
Option 34: MCN Range Values
0 Defines the MCN range
0 = 31H to 3FH (default)
1 = 31H to 7EH
1 Reserved and must be 0
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-11
Configuration Parameters
Enhanced Configuration Parameters Load Message
Bit Description
2 Defines Transaction Reply and ITR handling
0 = reject any message with an incorrect MCN (default).
1 = ignore any message with an incorrect MCN
3 Reserved and must be 0
4 Reserved and must be 0
5 Reserved and must be 0
6 Reserved and must be 0
7 Reserved and must be 0
Example Values for MCN 7
The following table shows the values for the MCN Range option:
Table 7-17 Option Code Description
Option 34: MCN Range Option Code
Examples 000 Range is 31H to 3FH; reject the Transaction Reply or ITR if
its MCN does not match the MCN in the last transmitted
Transaction Request or is not ʹ0ʹ
001 Range is 31H to 7EH; reject the Transaction Reply or ITR if
its MCN does not match the MCN in the last transmitted
Transaction Request or is not ʹ0ʹ
004 Range is 31H to 3FH; ignore Transaction Replies and ITRs
with incorrect MCNs
005 Range is 31H to 7EH; ignore Transaction Replies and ITRs
with incorrect MCNs
For more information about the MCN in Transaction Requests and
Interactive Transaction Responses, see the following:
Field g on page 9‐3
“Message Coordination Number (MCN)” on page 10‐92.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-12 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Enhanced Configuration Parameters Load Message
This option controls the reporting to Central of unsolicited device
Option 35 – Report Dual status messages for dual mode EJ and hardcopy backup. Possible
Mode EJ & Hardcopy B/U values are as follows:
Unsolicited Messages 7
Table 7-18 Option Code Description
Option 35: Report Dual Mode & Hardcopy
B/U Unsolicited Message Values 000 Do not report either dual mode EJ or hardcopy backup
unsolicited error messages (default)
001 Report only dual mode EJ unsolicited error messages
002 Report both dual mode EJ and hardcopy backup
unsolicited error messages.
For information about the message sequences returned by the SST,
see Table 9‐53, “Unsolicited Message Sequences for Option 35 (EJ
Dual Mode)” on page 9‐110.
This option determines whether multiple or standard EJ backups
Option 36 – Enhanced EJ are allowed. Possible values are as follows:
Backup 7
Table 7-19 Option Code Description
Option 36: Enhanced EJ Backup Values
000 Allow standard EJ backup (default)
001 Allow multiple EJ backup.
Note: Changes to option 36 can be disabled through Supervisor.
For further information, refer to the APTRA Advance NDC,
Supervisor’s Guide.
This option determines whether the characters of data from card
Option 37 – Print Track 2 track 2 are automatically journaled when a card is read. Possible
to Journal 7
values are as follows:
Table 7‐20 Option Code Description
Option 37: Print Track 2 to Journal
000 Do not print data on the journal (default)
001 Print data on the journal (As per PA DSS compliance)
For information on PA DSS compliance, refer to the APTRA Advance
NDC, Payment Application Data Security Standard Implementation
Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-13
Configuration Parameters
Enhanced Configuration Parameters Load Message
The print format is defined using reserved screen t15, and by default
is as follows:
CARD: ;XXXXXXXXXXXX1251=09
DATE DD-MM-YY TIME HH:MM:SS
This option determines whether data from the card is included in
Option 41 – Send Track Card Reader/Writer status messages sent following a card retract
Details on Card Retract 7
operation. Possible values are as follows:
Table 7-21 Option Code Description
Option 41: Send Track Details on Card
Retract 000 Do not include card data in message (default)
001 Include all data read from the card in a Card
Reader/Writer status message following a card retract
operation
Note: The host may be unable to associate the captured card with a
transaction if EMV Exits are configured to send the track 2
equivalent data in the standard track 2 buffer. This is because the
data sent in the Transaction Request could differ from the data in
the Card Reader/Writer status message.
If a Bunch Note Acceptor (BNA) is present, this option determines
Option 44 – BNA Journal whether vaulted and refunded note counts are automatically
Notes Count 7
printed to the journal printer following a transaction reply.
NCR recommends that you set this option if implementing the ECB
6 regulations. If this option is not set and notes are re‐categorised
during second bill validation, ECB 6 counts may be omitted from
the journal.
Possible values are as follows:
Table 7-22 Option Code Description
Option 44: BNA Journal Notes
Count Values 000 Do not journal vaulted notes (default)
001 Journal all vaulted notes.
002 Journal all returned counts
003 Journal all vaulted and returned counts
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-14 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Enhanced Configuration Parameters Load Message
Note: Note counts are always printed to the journal printer in the
Close state.
If a BNA is present, this parameter sets the following:
Option 45 – BNA Settings 7
Inclusion of the BNA counts for the last transaction status in the
Transaction Request message sent to the host.
Number of notes to accept
Retract option configuration
Extended message format option
Note: When Central sends a terminal command to check the
supplies and fitness of the device, for example, on exit from
Supervisor, the response can be used to track the insertion and
removal of cassettes when extended messages are enabled.
Supplies reporting when bit 3 is not set
Recycling option configuration.
Due to the complexity and number of settings controlled by this
parameter, information is provided on the bit settings rather than
the available option codes. The option code is a decimal value of
between 000 and 255. Each bit can be set as described in the
following table:
Table 7-23 Bit Number Description
Option 45: BNA Settings Bit Values
0 Inclusion of BNA last transaction status counts in the
Transaction Request message sent to the host.
Valid values are:
0 ‐ Do not include transaction status counts
1 ‐ Include transaction status counts
1 Number of notes to accept
This must be set if bit 3 or bit 6 is set or if direct deposit is
configured
Valid values are:
0 ‐ Accept up to 90 notes
1 ‐ Accept more than 90 notes
Note: If the SST is configured for direct deposit mode or
ECB 6 is enabled, you must set the number of notes that
can be accepted to more than 90 (Enhanced Configuration
option 45).
2 Retract option configuration
Valid values are:
0 ‐ Do not retract notes
1 ‐ Retract notes
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-15
Configuration Parameters
Enhanced Configuration Parameters Load Message
Bit Number Description
3 Extended message format option
Bit 1 must be set if this is set
This must be set if bit 6 is set
Bit 4 is ignored if this is set
Valid values are:
0 ‐ Do not use extended message format
1 ‐ Use extended message format
For details of the affected messages, see the following:
“Supplies Data” on page 9‐52
“Fitness Data” on page 9‐54
“Extended Send Supply Counters” on page 9‐67
“Note Acceptor (Solicited/Unsolicited)” on page 9‐122
4 Supplies reporting when bit 3 is not set
Bit 3 must not be set if this is set
Valid values are:
0 ‐ Report when first cassette is full or almost full
1 ‐ Report when all cash‐in cassettes are full
Whichever value is used, a retract bin is reported when full
or almost full.
5 Enhanced Cash Deposit Mode
Not supported by Advance NDC
6 Recycling option configuration
Bit 3 must be set if this is set
Value = 0:
Do not use recycling cassettes during deposit
transactions
Do not report NDC cassettes types that have accepted
notes during the last deposit
Value = 1:
Use recycling cassettes during deposit transactions
Report NDC cassette types that have accepted notes
during the last deposit
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-16 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Enhanced Configuration Parameters Load Message
The following table provides some example option codes:
Table 7-24 Option Code Description
Example Option 45: BNA Settings Values
000 Do not include last transaction status counts
Accept up to 90 notes
Do not retract notes
Do not use extended message format
Report when first cassette is full or nearly full
(default)
001 Include last transaction status counts
Accept up to 90 notes
Do not retract notes
Do not use extended message format
Report when first cassette is full or nearly full
015 Include last transaction status counts
Accept more than 90 notes
Retract notes
Use extended message format
Ignore note report settings
023 Include last transaction status counts
Accept more than 90 notes
Retract notes
Do not use extended message format
Report when one retract bin or all cash‐in cassettes are full
or nearly full
074 Do not include last transaction status counts
Accept more than 90 notes
Do not retract notes
Use extended message format
Ignore note report settings
Use recycling cassettes
If the Enhanced Card Device (ECD) is present, this parameter sets
Option 46 – MCRW the level of ECD Jitter to be applied during card entry/exit. The
Enhanced Card Device default value is 000.
Security Jitter 7
Note: A reboot is required if this parameter is changed, to allow the
new setting to take effect at device level.
Table 7-25 Option Code Description
Option 46: MCRW Enhanced Card Device
Security Jitter Values 000 No ECD Jitter, or ECD Jitter not required (default)
001 Standard ECD Jitter
002 Maximum ECD Jitter (but slower card read/write)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-17
Configuration Parameters
Enhanced Configuration Parameters Load Message
If the barcode reader is present, this option defines whether the
Option 48 – Barcode barcode reader‐specific fields are included in the messages sent to
Reader 7
the host.
Table 7-26 Option Code Description
Option 48: Barcode Reader Values
000 DIG ‘f’ is not reported in any message sent to the host.
Transaction Request buffer ‘e’ is still used if selected in
the Transaction Request state (default)
001 DIG ‘f’ is reported
This option is reserved for use with EMV/CAM2 Exits.
Option 69 – EMV Smart
Card Extended Status 7
For details, refer to the EMV Integrated Circuit Card (ICC) Reference
Manual.
This option is reserved for use with EMV/CAM2 Exits and is not
Option 70 – EMV Smart supported in Advance NDC.
Card 7
For details, refer to the EMV Integrated Circuit Card (ICC) Reference
Manual.
This option controls entry to the Time‐Out state and how many
Option 71 – Time‐Out State times the Time‐Out state can be entered for each cardholder action.
Entry 7
Once the specified limit is reached, the time‐out action is performed.
Valid values are as follows:
Table 7-27 Option Code Description
Option 71: Time-Out State Entry
000 The Time‐Out state is never entered (the more time
screen is never displayed)
001 to 009 The Time‐Out state can be entered up to the specified
number of times
255 The number of times the Time‐Out state can be entered
is unlimited (default)
This option specifies the destination for notes retracted during a
Option 74 – Destination for cash deposit transaction as follows:
Cash Deposit Retract 7
Table 7-28 Option Code Description
Option 74: Destination Values for
Retracted Notes During Cash Deposit 000 Retract the notes to a retract bin (default)
001 Retract the notes to the cash‐in cassette defined by the
service provider settings.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-18 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Enhanced Configuration Parameters Load Message
This option specifies the cassette type support and message format
Option 76 – Cash Handlers 7
for single or dual cash handler systems as follows:
Table 7-29 Option Code Description
Option 76: Cash Handlers
000 If dual cash handlers are used, emulate a single cash
handler and support all existing messages.
Only cassette types 1, 2, 3, and 4 are supported.
DIG ‘E’ is used to report the combined status of the
emulated device. (default)
001 If a single cash handler is used, DIG ‘E’ reports the
device in all messages.
If dual cash handlers are used, emulate a single cash
handler, and support extended messages for up to
seven cassette types.
Cassette types 1, 2, 3, 4, 5, 6 and 7 are supported.
If dual cash handlers are used, DIG ‘E’ reports the
emulated device in all messages, while DIG ‘d’ reports
cash handler 0 and DIG ‘e’ reports cash handler 1 in
Terminal Command responses only.
In all cases, the Hardware Configuration message also
reports the maximum number of items that can be
dispensed in a single transaction.
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.
When Advance NDC is installed, the next state number is not set
Option 77 – Next State and cardless transactions are disabled. The next state number can be
Number 7
downloaded remotely using this option or set locally through the
Configure menu in Supervisor. If the next state number is set to 000,
cardless transactions are disabled.
If the SST is capable of accepting cardless transactions and option 77
is used, downloading a valid Next State Number enables cardless
transaction and defines the next state to go to from the initial Card
Read state for cardless transactions. Any change to the next state
number is effective immediately and the SST does not need to be
restarted.
Possible values are as follows:
Table 7-30 Option Code Description
Option 77: Next State Number Values
000 Cardless transactions not allowed (default)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-19
Configuration Parameters
Enhanced Configuration Parameters Load Message
Option Code Description
001‐254 or State number to go to from the Card Read state when
256‐999 cardless transactions are enabled and when Enhanced
Configuration Parameter option 80 is set to 0
001‐254 or State number to go to from the Card Read state when
256‐ZZZ cardless transactions are enabled and Enhanced
Configuration Parameter option 80 is set to 1
Note: Key masks must be configured for cardless transactions. For
details of the configuration required, refer to the “Cardless
Transactions” section in Chapter 5, “Configuring Advance NDC
and Associated Components” of the APTRA Advance NDC
Developer’s Guide.
This option controls the reporting of the M‐Status for a GBRU used
Option 78 – GBRU as a dispenser in the following cases:
M‐Status Reporting 7
In a status message, all fields are the same as for a four‐cassette
stacking dispenser (standard cash handler), with the possible
exception of the M‐Status. For details, see “GBRU to CDM
M‐Status Mapping” on page 9‐81
In response to a Terminal Command, all fields are the same as a
standard cash handler.
Note: The M‐Data is always GBRU‐specific regardless of the setting
of this option.
Possible values are as follows:
Table 7‐31 Option Code Description
Option 78: GBRU M-Status Reporting
000 Report a CDM M‐Status.
001 Report a GBRU M‐Status.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-20 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Enhanced Configuration Parameters Load Message
This option allows the modification of the message format to
Option 79 – Coin support up to eight coin hopper types. Possible values are as
Dispenser 7
follows:
Table 7-32 Option Code Description
Option 79: Coin Dispenser
000 Coin dispenser supports four coin hopper types using
NDC+ compatible message formats (default)
001 Coin dispenser can support more than four hopper
types using extended message formats. Advance NDC
supports up to eight hopper types
This option controls which number system is used to interpret state
Option 80 – Alphanumeric number fields. Possible values are as follows:
State Entry 7
Table 7-33 Option Code Description
Option 80: Alphanumeric State Entry
000 State numbers are interpreted as base 10 (decimal)
numbers. Each character is in the range ‘0’ to ‘9’. State
number range is ‘000’ to ‘999’. There are 1000 state
numbers available. This is the default value.
001 State numbers are interpreted as base 36 numbers. Each
character is in the range ‘0’ to ‘9’ or ‘A’ to ‘Z’. ‘A’
represents 10 and ‘Z’ represents 35. Both uppercase and
lowercase letters are valid (‘A’ is the same as ‘a’). State
number range is ‘000’ to ‘ZZZ’. There are 46655 state
numbers available.
Example ‐ ‘ZD4’ is (35*(36^2)) + (13*36) + 4 = 45832.
Note: To avoid errors in state transitions, the Enhanced
Configuration Parameters Load message containing option 80 must
be sent before the State Tables Load message.
This option allows the modification of the message format to
Option 83 – Cheque support the reporting of bins in the cheque processor and further
Processor 7
support for bunch cheque acceptors. Possible values are as follows:
Table 7-34 Option Code Description
Option 83: Cheque Processor
000 Cheque processor supports the reporting of three bins
using NDC+ compatible message formats (default)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-21
Configuration Parameters
Enhanced Configuration Parameters Load Message
Option Code Description
001 Cheque processor supports the reporting of all bins that
are present, using the extended message format.
At least three bins are reported for a cheque processor.
The number of bins reported depends on the hardware
configuration.
002 On bunch cheque acceptors only, in addition to the
information reported by Option Code 001, the device
status message also includes the location of the
deposited cheques.
004 Scans cheques after endorsement when supported by
the hardware.
The back of the cheque is scanned
If a rear image was requested when the cheque was
accepted, the image from the scan after endorsement
replaces this image
If the cheque is not endorsed, the image is not scanned
The timers are the same as those included in the Configuration
Timer Number 7
Parameters Load message. For details, see “Timer Number (Field
‘p’)” on page 7‐3.
This parameter sets the time‐out value in seconds for the timer
Number of Seconds per number specified in field ‘k’. The maximum number of seconds is
Timer Field 7
255.
For a description of this field, field ‘l’, see “Enhanced Configuration
Parameters Load” on page 10‐17.
The following table lists the enhanced configuration load
Unsupported Parameters 7
parameters that are not supported in Advance NDC. The option
numbers are reserved in the message format.
Table 7-35 Option Number Configuration Parameter Description
Unsupported Parameters
09 Diebold status reporting for vandal guard.
This parameter is retained for NDC compatibility
only. Diebold is not supported by Advance NDC, so
vandal guard errors are never reported.
10 Tamper indication status reporting
11 Extended status control
13 Card reader error threshold
14 Track 3 write error threshold
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-22 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Enhanced Configuration Parameters Load Message
Option Number Configuration Parameter Description
21 Optical sensor
22 Journal printer backup log tamper
26 Touch screen error reporting
28 Transaction processing application informed of SM
activity
31 Enable audible echo of keyboard
39 MCRW non‐magnetic card accept
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-23
Configuration Parameters
Timers
Timers 7
The same timers are available in both configuration load messages
and enhanced configuration load messages.
When a configuration load message is sent, the timer values are in
Time Units for Timers 7
ticks. A tick is 800 milliseconds. When an enhanced configuration
message is sent, the values are in seconds. A value of 30 ticks in a
configuration load message is the equivalent of 24 seconds in an
enhanced configuration load message. The values are given in
seconds in both configuration load and enhanced configuration load
messages, unless otherwise stated.
Timers that are reserved for future use or currently unsupported in
Timer Descriptions 7
Advance NDC are all marked as reserved in the message format.
For details of these timers, see page 7‐29.
Timer Adjustment For Voice Guidance 7
Timers marked with an asterisk (*) in the following list can be
adjusted for a voice‐guided session using the timersAdjust
sub‐element of the XML configuration file for voice guidance, which
is described in Chapter 6, “Configuring Voice Guidance” in the
APTRA Advance NDC, Developer’s Guide. If two timers are adjusted,
such as timersAdjust for voice guidance and Timer0Multiplier
for SMS‐style data entry in the Information State, this doubles the
timer adjustment.
Note: For SMS‐style data entry, it is not necessary for the host to
increase the time specified in the Timer field of this message, unless
even more time is required than is gained by adding the
timersAdjust parameter.
Timer 00 * 7
Cardholder keyboard response time. When a screen is displayed
which prompts the cardholder to make a keyboard entry, the
cardholder must respond within the time‐out interval specified for
timer 00. Otherwise, the SST will exit its present state and enter the
Time‐Out state.
Timer 01 * 7
Cardholder time‐out response. This timer is started on entry to the
Time‐Out state, to give more time for keyboard input, form
insertion or envelope insertion.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-24 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Timers
Timer 02 7
Close state or eject failure cardholder screen display time‐out
interval. This timer is started in the Close state after the card has
been ejected. It is also started during a Close or Card Read state if an
eject cannot be successfully performed (screen ‘C04’ is displayed).
At the end of this interval, the SST proceeds to the next state number
specified in the state table data, provided the card has been taken or
captured. If the card is still accessible to the cardholder when the
timer expires, the Close state exit is delayed until timer 09 expires
(inducing a capture) or until the card is taken. A time‐out interval of
zero is not permitted for timer 02.
This timer must also be used for cardless transactions to provide a
minimum time for display of the screen set up prior to card eject
processing.
Timer 03 7
Communications message time‐out interval. When the SST is ready
to transmit a Transaction Request to the host, the SST starts timer 03.
If the SST does not receive a Transaction Reply command before
timer 03 expires, the following occur:
The SST exits the Transaction Request state through the Central
Response Timeout Next State entry specified in the Transaction
Request state table
A host transaction time‐out message is journaled
The message is defined in reserved screen t68
Timer 04 * 7
Cheque/envelope/card insertion response time‐out. When a screen
is displayed prompting the cardholder to insert a cheque or
envelope into the depository, or insert a card, the cardholder must
respond within the time‐out interval specified by timer 04,
otherwise the SST enters the Time‐Out Next state.
The keyboard beeper sounds while this timer is active. The default
duration is 30 ticks. If this timer is set to greater than one minute for
the cheque processor, the cheque processor firmware will time‐out.
Timer 05 * 7
Cash retract time‐out. When cash is presented to a consumer, this
timer identifies the length of time it remains accessible to the
cardholder before a retract is attempted. If the cardholder takes his
money before expiry, the timer is cancelled. If the timer expires, a
retract operation is attempted. A value of zero is not permitted for
timer 05. If the SST is configured to sound the beeper during cash
present, this timer gives the maximum length of time the beeper will
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-25
Configuration Parameters
Timers
sound. This timer is used in Card Before Cash transactions to allow
beeping when the SST is configured not to retract cash.
Timer 06 7
Communications connection sample interval. This timer defines the
sample interval used by the application to monitor the
communications connection. This timer is not used in a dial‐up
environment. Its default value is 204 seconds.
Note: For TCP/IP communications, you can reduce this interval (for
example, to 1 second) as the time it takes for the TCP/IP
communications to detect loss of a connection can be controlled via
the Supervisor TCP/IP Configuration menu. For more information,
refer to the APTRA Advance NDC, Supervisor’s Guide.
Timer 07 * 7
Present time‐out. This timer is started when cash has been
dispensed and the Transaction Reply screen “Take Cash” is
displayed. When the timer expires, the next state specified in the
Transaction Reply command is entered. A time‐out interval of zero
is not permitted. The default value is 24 seconds.
Note 1: This timer is not used for Parallel Dispense/Print and Eject
transactions on an SST configured to stop cash retract.
Note 2: Timer 07 is combined with timer 05 in the following:
Parallel Eject/Dispense and Print ‐ Fast Cash
(see Table 10‐24 on page 10‐75)
Card Before Parallel Dispense and Print
(see Table 10‐25 on page 10‐76)
The timer is started after notes are taken in the following:
Dispense and Print
(see Table 10‐18 on page 10‐71)
Card Before Cash
(see Table 10‐23 on page 10‐74).
Note 3: In card before cash transactions when the no retract option
is set, the recommended minimum value of this timer is 5.
Timer 08 * 7
Night safe deposit time‐out. This timer is started when the night
safe door is unlocked to accept a night safe deposit. If no bag is
detected and this timer expires, the SST enters the time‐out state. If
the bag detection mechanism is faulty, this time‐out is allowed to
expire in order to give the cardholder time to perform a deposit.
However, the Time‐Out state is not entered.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-26 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Timers
Timer 09 * 7
Cardholder time‐out interval before card capture attempt. If the
card is presented to the cardholder and not removed within this
time period, an attempt is made to capture the card. To reduce the
possibility of a card not being completely ejected at the first attempt,
the card is re‐ejected after half the timer value has expired, and
captured at the full timer expiry. The default value for timer 09 is 24
seconds. A time‐out interval of zero is not permitted.
Timer 10 7
Additional present time‐out. This timer, if configured, is added to
Timer 07 to allow an additional time‐out in the following functions:
Dispense and Print. For details, see “Dispense and Print
(Function ID ‘2’ or ‘8’)” on page 10‐71
Display and Print. For details, see “Display and Print (Function
ID ‘3’ or ‘9’)” on page 10‐72.
If a time‐out interval of zero is configured, Timer 07 is not affected.
Timer 60 7
EJ acknowledgement timer. This is used in the EJ Options and
Timers command (described in “EJ Options and Timers.” on page
10‐96) to specify the maximum time to wait for an upload block
acknowledgment from the host before re‐sending the block. A value
of 000 is infinite. The default is 255.
Timer 61 * 7
Barcode reader scan timer. Defines the length of time a barcode
reader is enabled to scan for a barcode. The default value for timer
61 is 60 seconds.
Note: On some devices the time‐out is also supported by hardware,
in these cases the time that the device is enabled will be the shorter
of the two values.
Timer 63 7
Hardware failure screen time‐out. Defines the length of time the
hardware failure screen is displayed in the Cash Accept, Bunch
Cheque Accept and Bunch Cheque Handling states. The default
value for timer 63 is 15 seconds. If a value of 0 is specified, the
default value is used, otherwise, the specified value in seconds is
used.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-27
Configuration Parameters
Timers
Timer 68 7
Statement MEI duration timer. The length of time the MEI flashes
after the statement is presented to the cardholder. The MEI starts to
flash as soon as the data starts to print; that is, total MEI flashing
duration = printing duration + cut and eject duration + timer 68. The
default value for timer 68 is 2 seconds; the range is 2–10.
Timer 69 7
Receipt MEI duration timer. The length of time the MEI flashes after
the receipt is presented to the cardholder. The MEI starts to flash as
soon as the data starts to print; that is, Total MEI flashing duration =
Printing Duration + Cut and Eject Duration + Timer 69. The default
value for timer 69 is 6 seconds; the range is 2–10.
Timer 72 7
DASH card remove timer. This timer defines the time to wait for the
cardholder to take the card, if the card reader is a DASH reader. If
the timer expires before the consumer takes the card, the SST
displays an “Error Misread” screen and restarts the timer. If the
timer expires again, the DASH card reader enters a Suspend state.
The minimum time‐out value is 1 second and the maximum is 255;
the default is 20. If a value is sent outside the range, it defaults to 20
(25 ticks).
Note: If using a DASH reader and Card Read State A, or Card Read
State T with no chip connect bit set, the DASH reader will not enter
a Suspend state.
Timer 77 * 7
BNA/GBXX cash acceptance timer. This timer defines the time‐out
value for note entry to the BNA or GBXX. The minimum time‐out
value is 10 seconds, the default is 30 and the maximum is 255. If
enabled, the keyboard beeper sounds while this timer is active.
Timer 78 * 7
GBXX cash rejection timer. This timer defines the time‐out value for
note removal from the GBXX. The minimum time‐out value is 10
seconds, the default is 24 and the maximum is 255. If enabled, the
keyboard beeper sounds while this timer is active. With the retract
option selected, any notes that are not removed are retracted.
Timer 87 * 7
Cheque capture screen time‐out. This timer defines the duration for
which the Cheque Captured screen is displayed, typically after a
returned cheque has not been taken by the cardholder. The
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-28 APTRA™ Advance NDC, Reference Manual
Configuration Parameters
Timers
minimum time‐out value is 1 second, the default is 24 and the
maximum is 255.
Timer 92 7
Fault display time‐out. This timer defines the amount of time for
which each fault message is displayed. The minimum time‐out
value is 1 second, the maximum is 255 and the default is 4 (5 ticks).
Note: If this value is set to zero, the EOP display will never be
refreshed.
Timer 94 * 7
Cheque/envelope removal response time. This timer defines the
duration for which a cheque or envelope is presented for removal
by the cardholder. The minimum time‐out value is 10 seconds
(values less than 10 are set to 10), the default is 30. Any downloaded
value greater than 120 is set to 120.
Timer 95 * 7
Statement retract time‐out. This timer is used during Close State
processing. It determines when to retract a statement that has not
been taken by the cardholder. The default is 30 seconds, and is used
if you supply a value of zero.
Timer 96 * 7
Statement present time‐out. This timer is used only in the statement
and continue function and is started regardless of whether or not a
statement is being delivered. When the timer expires, the next state
specified by the Transaction Reply command is entered. A value of
zero for this timer means ‘do not wait’.
The following timers are reserved for future use:
Reserved Timers 7
11 ‐ 59
62
64 ‐ 67
70 ‐ 71
73 ‐ 76
79 ‐ 81
84 ‐ 86
88 ‐ 90
93
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 7-29
Configuration Parameters
Timers
98 ‐ 99
The following timers are for functions that are not supported in
Unsupported Timers 7
Advance NDC:
82 ‐ Camera delay period (see Note:)
83 ‐ Digital Camera Service (DCS) file expiry time‐out (see Note:)
91 ‐ EJ log inspection time‐out
97 ‐ Door access open time‐out.
Note: For the security camera, Advance NDC uses an XML
configuration file to control the number of images, when they are to
be taken and the storage capacity to be used for them. For details,
refer to Chapter 5, “Configuring Advance NDC and Support
Applications” in the APTRA Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-30 APTRA™ Advance NDC, Reference Manual
Table of Contents
Financial Institution Tables
Chapter 8
Financial Institution Tables
Overview 8‐1
FIT Data 8‐2
FIT Message Fields 8‐2
FIT Field Descriptions 8‐3
PIDDX (Institution ID Index) 8‐4
PFIID (Institution ID) 8‐4
PSTDX (Indirect Next State Index) 8‐4
PAGDX (Algorithm/Bank ID Index) 8‐4
PMXPN (Maximum PIN Digits Entered) 8‐4
PCKLN (Maximum PIN Digits Checked) 8‐5
PINPD (PIN Pad) 8‐6
PANDX (PAN Data Index) 8‐7
PANLN (PAN Data Length) 8‐7
PANPD (PAN Pad) 8‐8
PRCNT (Track 3 PIN) 8‐8
POFDX (PIN Offset Data) 8‐9
PDCTB (Decimalisation Table) 8‐9
PEKEY (Encrypted PIN Key) 8‐9
PINDX (Index Reference Point) 8‐9
PLNDX (Language Code Index) 8‐11
PMMSR (MM Sensor Flag) 8‐11
PBFMT (PIN Block Format) 8‐11
Linked FITs 8‐12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Financial Institution Tables
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Financial Institution Tables
H
Overview
Overview 8
The Financial Institution Table (FIT) is an important part of the
customisation data for an Advance NDC system. FITs may also be
downloaded to the SST by a message from the host. The FIT
contains specific information about how a particular institution’s
transactions should be processed.
The SST must have a FIT for every institution that it supports.
Institutions that have more than one type of card must have a FIT
for each card type.
When a card is read, the FIT is searched to find the FIT entry which
matches the Financial Institution Identification number (FIID) on
the card. Parameters in this FIT entry and following linked FITs are
then used for all subsequent PIN and transaction processing.
This chapter describes the FIT data and linked FITs. For details of
the FIT message format, see “FIT Data Load” on page 10‐22.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 8-1
Financial Institution Tables
FIT Data
FIT Data 8
Each FIT contains the fields described here, and each field defaults
to zero if not specified. Some fields hold information on how
transactions will be processed for that institution. Other fields
contain an offset to where information required for transaction
processing is stored on the card.
For details of the FIT message format, see “FIT Data Load” on
page 10‐22.
Each entry in the FIT Data load message has a value in the range
FIT Message Fields 8
00‐FF hexadecimal (hex), and for the purposes of this description is
considered as two digits, each having possible values in the range
0‐F hex. However, the FIT data is sent to the terminal in decimal, so
to construct the FIT Data load message, each digit pair must be
converted from hex to decimal, producing a three‐character string
in the range 000‐255.
The following table defines the fields in the FIT and indicates those
fields that are offsets to data on the card.
Table 8-1
FIT Fields
No of
Field Contents Acronym Definition Offset
Digits
a Institution ID Index PIDDX Index for Financial Institution ID number on 2 Yes
card
b Institution ID PFIID Financial Institution ID number 10 No
c Indirect next state index PSTDX Index for entries in the Indirect next state table 2 No
d Algorithm/ Bank ID PAGDX Algorithm index for Diebold 2 Yes
index Not supported as local Diebold PIN verification
is not supported.
e Maximum PIN digits PMXPN Maximum number of PIN digits allowed for the 2 No
entered cardholder to enter
f Maximum PIN digits PCKLN Number of digits used for local PIN check 2 No
checked
g PIN pad PINPD Character used to pad PIN for transmission to 2 No
the host and the encryption method used
h PAN data index PANDX Index for location of PAN (Personal Account 2 Yes
Number) on card
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
8-2 APTRA™ Advance NDC, Reference Manual
Financial Institution Tables
FIT Data
No of
Field Contents Acronym Definition Offset
Digits
i PAN data length PANLN PAN data field length 2 No
j PAN pad PANPD Character used to pad PAN field for encryption 2 No
k Track 3 PIN retry count PRCNT Index for PIN retry count field on card 2 Yes
index
l PIN offset index POFDX Index for PIN offset field on card 2 Yes
m Decimalisation table PDCTB Decimalisation table used in encryption process 16 No
n Encrypted PIN key PEKEY DES ‐ Encrypted PIN key 16 No
o Index reference point PINDX Track and index reference point information for 6 Yes
all card‐related entries in FIT
p Language code index PLNDX Index for language code on card 2 Yes
q CIM86 sensor flag PMMSR Flag to identify the location of the CIM86 2 No
sensor in the FIT
Not supported by Advance NDC
r Reserved ‐ ‐ 6 No
s PIN Block format PBFMT Selects PIN block format for remote PIN 2 No
verification
Note: For the two‐digit fields, the terms ‘digit 1’ and ‘digit 2’ refer
to the high and low nibbles respectively.
The FIT references data on the card using six fields in the FIT which
are offsets to where information is stored on the card. These fields
are:
PIDDX
PAGDX
PANDX
POFDX
PLNDX
PRCNT
Another field, PINDX, identifies the track, the delimiter and the
direction of counting for each offset.
Some of the entries in the FIT are not supported and this is indicated
FIT Field Descriptions 8
in the following text. These entries are ignored.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 8-3
Financial Institution Tables
FIT Data
PIDDX (Institution ID Index) 8
Each card contains an ID number to identify the financial institution
it belongs to. This ID number gives the offset for the FIID on the
card. The range is 00‐7F hex.
You should add 80 hex to this ID number if it is required to modify
the index delimiters in table entry PINDX. For details, see section
“PINDX (Index Reference Point)” on page 8‐9. You can have a value
of FF hex in this field if the Financial Institution identification
number only contains ‘F’.
PFIID (Institution ID) 8
The Financial Institution Identification number. The terminal checks
whether the Financial Institution Identification number found using
PIDDX matches this field. If it does, it uses this FIT. If it does not, it
checks the next FIT. The range of each digit in this field is 0‐9 or F
hex. If F hex is used, the corresponding position of the identification
number on the card is not compared.
PSTDX (Indirect Next State Index) 8
Each digit of this two‐digit field has a separate purpose.
The first digit specifies a logo identifier, 0‐15. The logo identifier
identifies the logo that is to be used if a screen containing a
FIT‐dependent logo control code is displayed.
The second digit is used to identify an entry in a FIT Switch State
table (state ‘K’ or ‘_’ ). The entry identifies the number of the next
state that control will go to. The range of indirect next states is 0‐7
for state ‘K’ and 0‐14 for state ‘_’ . This field used in association with
a FIT Switch State enables you to select different parts of the state
flow for different Financial Institutions.
PAGDX (Algorithm/Bank ID Index) 8
The use of this field depends on the type of PIN verification used for
this Financial Institution, as follows:.
DES verification—the field is not used and must be zero.
Diebold verification—the field gives the offset of the Algorithm
Number on the card. The range is 00‐7F hex. If the value in the
field is FF hex, the Algorithm Number is not on the card, but is
the PANPD field content, which is not supported as local
Diebold PIN verification is not supported.
PMXPN (Maximum PIN Digits Entered) 8
This field is a two‐digit number that specifies the maximum number
of digits the cardholder can enter as his personal identification
number (PIN). The range is 04‐10 hex.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
8-4 APTRA™ Advance NDC, Reference Manual
Financial Institution Tables
FIT Data
The type of PIN block that is transmitted in the Transaction Request
message is specified by the highest‐order two bits, as shown in the
following table:
Table 8-2 Bits PIN Block to be used
PIN Block Type Selection
7 6
0 0 Diebold
1 0 ISO Format 0 (ANSI)
0 1 Specified by PBFMT (PIN Block Format)
1 1 BANKSYS
PCKLN (Maximum PIN Digits Checked) 8
This field identifies:
The type of PIN verification used for this card
If local or remote verification is required
The number of PIN digits to be checked
The length of the offset number.
There are only three supported methods of PIN verification, as
follows:
Remote DES
Local DES
Local VISA
The PCKLN field is one byte split into two fields, consisting of three
bits and five bits. The high order three‐bit field specifies the type of
local PIN verification to use:
000 ‐ DES (Local or Remote)
001 ‐ VISA (Local only)
010 ‐ DIEBOLD (Not supported in Advance NDC)
011, 100, 101, 110, 111 ‐ Reserved
For Local VISA PIN verification (high order 3 bits 001), the lower
five‐bit field specifies the number of entered PIN digits to check. It
must be in the range 04‐10 hex and less than or equal to PMXPN.
The value also specifies the length of the offset number. For DES
PIN verification (high order 3 bits 000), the lower five‐bit field
specifies if local or remote verification is to be performed, and the
number of entered PIN digits to check. Local verification is
performed when the lower five‐bit field is non‐zero, in which case it
must be in the range 04‐10 hex and less than or equal to PMXPN.
The value also specifies the length of the offset number.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 8-5
Financial Institution Tables
FIT Data
If PCKLN is zero, remote DES PIN verification is performed and the
only significant FIT entries are a, b, c, e, g, n and o.
PINPD (PIN Pad) 8
This field applies only to financial institutions that use DES
encryption for remote verification. The field contains two digits, and
the range is 00‐CF hex.
The first digit specifies the method of encryption, the encryption
key and whether the message co‐ordination number should be
included in the PIN block.
The second digit is the digit used to pad the PIN.
The first digit is binary encoded. The significance of each bit is as
follows:
Table 8-3 Bit 0 (1 hex) = double encryption sequence:
PINPD Bit Encoding Significance 0 ‐ MAST‐COM
1 ‐ PEKEY‐COM
Bit 1 (2 hex) = double/single designator:
0 ‐ single
1 ‐ double
Bit 2 (4 hex) = encryption/no‐encryption:
0 ‐ encrypt
1 ‐ no encrypt
Bit 3 (8 hex) = co‐ordination number/no co‐ordination number:
0 ‐ no co‐ordination number
1 ‐ co‐ordination number included.
This bit has no effect if the PIN block format is
specified using the PBFMT field.
Table 8-4 First Digit
PINPD First Digit Coding
Type of
Hex Value Encryption Key and Sequence
Encryption
First Second
0 Single COM ‐
See Table Note 4
2 Double MASTER COM
See Table Note 2 and
Table Note 3.
3 Double PEKEY COM
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
8-6 APTRA™ Advance NDC, Reference Manual
Financial Institution Tables
FIT Data
First Digit
4 None ‐ ‐
See Table Note 1 and
Table Note 3.
8 Single COM ‐
See Table Note 4
A Double MASTER COM
See Table Note 3.
B Double PEKEY COM
C None ‐ ‐
See Table Note 1 and
Table Note 3.
Table Note 1: The encryption commands 4 and C hex which call for
transmitting an unencrypted PIN are not secure and are not
supported by Advance NDC.
Table Note 2: Double encryption involves encrypting the PIN field
using the first encryption key, then encrypting the encrypted PIN
field, using the second encryption key.
(Triple DES encryption involves encrypting a value using the first
half of the encryption key, decrypting using the second half, and
then encrypting with the first half again.)
Table Note 3: When the key entry mode is set to double length
restricted, PIN block encryption modes 2, 4, A and C are not
permitted. No PIN block will be sent.
For details of PIN block formats, see Chapter 11, “Security
Features”.
Table Note 4: When using TR31 Symmetric Key Management, only
Single encryption is supported.
PANDX (PAN Data Index) 8
This field gives the offset of the Primary Account Number on the
card. PANDX specifies this location as the offset from a delimiter
specified in PINDX. The range of PANDX is 00‐7F hex.
PANLN (PAN Data Length) 8
This field specifies the number of digits from the offset, specified by
PANDX, that the terminal will use in PIN verification. The
permitted value depends on the type of PIN verification being used:
DES ‐ two digits in the range 00‐10 hex
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 8-7
Financial Institution Tables
FIT Data
VISA ‐ two digits with values 0D or 10 hex
PANLN must be equal to or greater than the PIN check length
specified in PCKLN. If PANLN is 1F hex, all the digits of the PAN
are used, starting from the offset position given by PANDX to the
field separator following the PAN.
When remote PIN verification is used, the top three bits of this field
can be used to specify if local PIN checking is performed on a short
PIN entry. If the value of the top three bits equals zero or is greater
than the maximum PIN entry length, PMXPN, or if PANLN equals
FF hex, no local PIN checking takes place. To support secure PIN
encryption, a check for the minimum four digits is always
performed locally, regardless of the PANLN setting. For details. see
Chapter 2, “State Tables”.
If the value of the top three bits is not equal to zero and is less than
or equal to the maximum PIN entry length, PMXPN, local PIN
checking takes place. If the PIN is less than specified, a local PIN
entry error is indicated. For details, see “B ‐ PIN Entry State” on
page 2‐16.
PANPD (PAN Pad) 8
This is a two‐digit field. The use depends on the type of PIN
verification used.
DES Digit 1 specifies whether the encryption process uses the 8
Master key or the PEKEY entry in the FIT for PIN verification. This
digit must be 0 or 8:
0 ‐ use the PEKEY for encryption
8 ‐ use the Master key for encryption.
The range of PANPD is 00‐0F hex and 80‐8F hex. PANPD only
applies to local PIN verification.
Digit 2 is the digit used to pad the PAN. This must be the same as
the one specified in PINPD for encrypting PINs.
VISA Not used. 8
PRCNT (Track 3 PIN) 8
This field gives the offset for the PIN retry count field on the card.
The PIN retry count field is a two‐digit field, with values in the
range 00‐7E hex.
There are two different methods of counting retries:
ISO ‐ each try is decremented from an initial value, until the
value reaches zero. If this method is used, 80 hex is added to the
number.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
8-8 APTRA™ Advance NDC, Reference Manual
Financial Institution Tables
FIT Data
MINTS ‐ each try increments a value until it reaches the retry
value.
The range of PRCNT is 00‐7E hex for MINTS and 80‐FE hex for ISO.
If you use the Enhanced PIN Entry state, but do not require Track 3
retries, this field should contain a value of FF hex.
POFDX (PIN Offset Data) 8
This field gives the offset for the Offset data field on the card. The
length of the Offset data from POFDX is given by PCKLN. The
Offset data is used to validate the PIN. If the Offset data is not used,
then set POFDX to FF hex.
When VISA PIN verification is being used, this field contains the
five‐digit PIN verification key indicator, PVKI, followed by the
four‐digit PIN verification value, PVV.
The range of the Offset data is 00‐7F hex and FF hex. The offset data
is added (modulo 10) to the left‐most digits of the generated PIN.
PDCTB (Decimalisation Table) 8
This field is used for DES PIN verification only. It is a table of 16
decimal digits which the terminal uses to convert hexadecimal
digits generated during DES PIN verification into decimal for
comparison with the PIN entered by the cardholder. This must be
identical to the table used for PIN generation.
PEKEY (Encrypted PIN Key) 8
This field is used for DES local and remote PIN verification only. It
is 16 hexadecimal digits long and is created by encrypting the
encryption key used by the Financial Institution identified in this
table. You can elect to use the PEKEY in the PINPD and PANPD
fields. The terminal decrypts the PEKEY using the Master key.
Note: PEKEY is not supported when using TR31 Symmetric Key
Management.
PINDX (Index Reference Point) 8
This six‐digit field is the key to starting points for all of the other
card fields referenced in the FIT ‐ PIDDX, PAGDX, PANDX,
POFDX, PLNDX, and PRCNT.
PIDDX locates the Financial Institution Identification Number
PAGDX locates the Algorithm Number/Bank ID. Not supported
by Advance NDC as local Diebold PIN verification is not
supported
PANDX locates the PAN
POFDX locates the PIN Offset Data
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 8-9
Financial Institution Tables
FIT Data
PLNDX locates the Language Code
PRCNT locates the PIN Retry Count.
PINDX identifies the track, the starting point and the direction to
count in to find the data. PAGDX and the other fields identify how
far to count to the beginning of the data.
If the value of PIDDX is greater than or equal to 80 hex, the PINDX
value is ignored and all index referencing is carried out on track 3 in
a forward direction from the start sentinel.
For example, if PINDX contains all zeros or it is omitted from the
FIT data, index referencing is carried out as follows:
If PIDDX is less than 80 hex, all index referencing is carried out
on track 2 in a forward direction from the start sentinel
If PIDDX is greater than 7F hex, all index referencing is carried
out on track 3 in a forward direction from the start sentinel.
The following table gives the digit corresponding to each valid
combination of track number, delimiter and direction. The delimiter
is not included in the offset count.
Table 8-5 Hex Value Track No. Delimiter Direction
PINDX Index Reference Point
0 2 Start Sentinel Forwards
1 3 Start Sentinel Forwards
2 1 Start Sentinel Forwards
4 2 1st Field Separator Forwards
5 3 1st Field Separator Forwards
6 1 1st Field Separator Forwards
8 2 End Sentinel Backwards
9 3 End Sentinel Backwards
A 1 End Sentinel Backwards
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
8-10 APTRA™ Advance NDC, Reference Manual
Financial Institution Tables
FIT Data
Each digit in PINDX specifies track and index reference points for
one of the index entries in the FIT. The following table shows how
these digits are assigned:
Table 8-6 PINDX Digit Related Index Related Card Data
PINDX Digit Assignment
1 PAGDX Algorithm number (Diebold)
Not supported as local Diebold PIN
verification is not supported
2 PIDDX Financial Institution ID number
3 PRCNT PIN retry count
4 PANDX PAN
5 PLNDX Language code
6 POFDX PIN offset data
PLNDX (Language Code Index) 8
The field gives the offset for the language code on the card. This
field can be used with a Language Select From Card state, described
on page 2‐82, to set the screen group to be displayed. The language
code is used to display multi‐lingual screens during a transaction.
PLNDX is in the range 01‐7F hex. A value of 00 hex is not allowed if
the language code is used. A value of 7F hex means zero if the
language code is used and the search is backwards from an end
sentinel only.
PMMSR (MM Sensor Flag) 8
The field describes the MM sensor with CIM86 MCRW usage.
The CIM86 MCRW is not supported.
PBFMT (PIN Block Format) 8
This field specifies the format of the PIN block to be generated for
remote PIN verification, as follows:
0 ‐ Diebold without co‐ordination number.
1 ‐ Diebold with co‐ordination number (Not supported)
2 ‐ ISO format 0 (ANSI)
3 ‐ ISO format 1
4 ‐ ISO format 3
5 ‐ BANKSYS.
This field is used only when selected by PMXPN having bit 7 = 0
and bit 6 = 1.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 8-11
Financial Institution Tables
Linked FITs
Linked FITs 8
This section explains how to use linked Financial Institution Tables.
This feature only applies to local PIN verification.
Data relating to PIN verification can appear in different locations,
depending on the type of card used. For this reason, if a financial
institution allows more than one position to be used, the
customisation data must include one FIT for each variation. These
FITs are known as linked FITs. The first FIT in a group of linked
FITs is known as the base FIT.
A linked FIT is identified by the following FIT entries:
PIDDX
PFIID
The PIN verification algorithm bits in PCKLN
The track designator parameters of PINDX.
You must ensure that these entries are identical to the
corresponding entries in the base FIT, and that the base FIT and
associated linked FITs have consecutive FIT numbers.
The following FIT entries are used for local PIN verification:
PCKLN
PANDX
PANLN
PANPD
POFDX
PDCTB
PEKEY
PRCNT ‐ only valid in the base FIT
The index reference points in PINDX.
NCR recommends that the PSTDX values in linked FITs have the
same values as the base FIT. The logo number is always obtained
from the base FIT. The indirect next state index is obtained from the
currently active FIT, which means that it can be obtained from a
linked FIT if the FIT Switch state follows a PIN Entry state.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
8-12 APTRA™ Advance NDC, Reference Manual
Table of Contents
Terminal to Central Messages
Chapter 9
Terminal to Central Messages
Overview 9‐1
Transaction Request Messages 9‐2
Transaction Request Message Format 9‐2
SST Reply to Interactive Transaction Response 9‐19
Message Format for Field bd2 in Transaction Request 9‐19
CAM Flags 9‐21
Solicited Status Messages 9‐22
Content of Solicited Status Messages 9‐22
Status Descriptor Field 9‐22
Status Information Field 9‐22
Status Information 9‐24
Reporting of CIM NDC Cassette Types 9‐24
Ready (‘B’) Status 9‐26
Cash Deposit Recycle Data ‐ Sub‐field ‘g3’ 9‐26
Recycle Cassette Dispense Data ‐ Sub‐field ‘g3’ 9‐27
Specific Command Reject 9‐28
Terminal State 9‐32
Send Configuration Information 9‐34
Hardware Fitness—Sub‐field ‘g3’ 9‐35
Hardware Configuration Data—Sub‐Field ‘g4’ 9‐38
Supplies Status—Sub‐field ‘g5’ 9‐46
Hardware Configuration Data Only 9‐48
Note Acceptor Capabilities 9‐51
Supplies Data 9‐52
Fitness Data 9‐54
Tamper and Sensor Status Data 9‐56
Software ID and Release Number Data 9‐58
Enhanced Configuration Data 9‐58
Local Configuration Option Digits 9‐59
Report Cash Deposit Definition 9‐59
Send Supply Counters 9‐61
Basic Send Supply Counters 9‐62
Example Message Analysis 9‐65
Extended Send Supply Counters 9‐67
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Terminal to Central Messages
Send Tally Information 9‐74
Send Error Log Information 9‐75
Send Date/Time Information 9‐76
Send Configuration ID 9‐77
Solicited Device Fault Status 9‐78
Device Fault Status Responses 9‐78
Device Fault Status Information Field 9‐79
GBRU to CDM M‐Status Mapping 9‐81
Other Solicited Messages 9‐82
Encryptor Initialisation Data 9‐82
Upload EJ Data Message 9‐90
Unsolicited Status Messages 9‐93
Conditions for Sending Unsolicited Messages 9‐93
Unsolicited Status Information Field 9‐94
Device Status Information 9‐96
Time‐Of‐Day Clock (Unsolicited) 9‐96
Power Failure (Unsolicited) 9‐96
Card Reader/Writer (Solicited/Unsolicited) 9‐97
Cash Handler (Solicited/Unsolicited) 9‐99
Cassette Re‐enabled During Deposit Transactions 9‐103
Depository (Solicited/Unsolicited) 9‐104
Receipt Printer (Solicited/Unsolicited) 9‐104
Journal Printer (Unsolicited) 9‐106
Electronic Journal Printer (Unsolicited) 9‐108
Night Safe Depository (Solicited/Unsolicited) 9‐111
Encryptor (Unsolicited) 9‐112
Camera (Unsolicited) 9‐113
Sensors (Unsolicited) 9‐114
Touch Screen Keyboard (Unsolicited) 9‐116
Supervisor Keys (Unsolicited) 9‐117
Cardholder Display Alarm (Unsolicited) 9‐119
Statement Printer (Solicited/Unsolicited) 9‐119
Voice Guidance (Unsolicited) 9‐121
Note Acceptor (Solicited/Unsolicited) 9‐122
Reporting of CIM NDC Cassette Types 9‐123
Counts in ECB 6 Unsolicited Messages 9‐123
Envelope Dispenser (Unsolicited) 9‐129
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Terminal to Central Messages
Cheque Processor (Solicited/Unsolicited) 9‐131
Coin Dispenser (Solicited/Unsolicited) 9‐135
Barcode Reader (Unsolicited) 9‐137
Secondary Card Reader (Unsolicited) 9‐138
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Terminal to Central Messages
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
I
Overview
Overview 9
This chapter describes the messages sent from the terminal to
Central, as follows:
Transaction request messages
Solicited status messages, including encryptor initialisation and
EJ upload data
Unsolicited status messages
Status information about devices and device faults
For any differences on other vendors’ SSTs, refer to the APTRA
Advance NDC, Multi‐Vendor Support Reference Manual.
For information on clearing persistent storage, refer to section
“Clearing Persistent Memory (NVRAM)” in Chapter 11, “Interactive
Installation of Advance NDC” of the APTRA Advance NDC,
Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-1
Terminal to Central Messages
Transaction Request Messages
Transaction Request Messages 9
Transaction Request messages are sent from the SST and contain the
data that the host requires to authorise a consumer transaction at
the SST. The message is sent during a consumer transaction, either
on entry to the Transaction Request state or as part of an Interactive
Transaction message sequence.
The format of the Transaction Request message is given in the
Transaction Request following table:
Message Format 9
Table 9-1
Transaction Request Message Format
Number of
Field Mandatory/Optional Description
Characters
a Var M Header ‐ Protocol‐dependent.
b 1 M Message Class. The message class is:
‘1’ ‐ Unsolicited message.
c 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Transaction Request message.
FS 1 M Field Separator
d 3 or 9 M Logical Unit Number (LUNO). This number is defined in a field
transmitted to the SST in a Configuration Parameters Load message. The
default value is 000. If the data security feature is configured, an
additional six characters are present which contain the machine number.
FS 1 M Field Separator
FS 1 M Field Separator
e 8 See Table Note 3 Time Variant Number. This field can contain an eight‐digit number
derived from the time of day by the SST for each transaction request. The
digits can contain the characters 0‐9, A‐F.
FS 1 M Field Separator
f 1 M Top of Receipt Transaction Flag. Informs the host if receipt data for this
transaction will print at the top of the receipt as follows:
‘0’ ‐ will not print data for this transaction at the top of the receipt
‘1’ ‐ will print data for this transaction at the top of the receipt.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-2 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
g 1 M Message Coordination Number. Contains a character assigned by the
SST to each Transaction Request message. The SST assigns a different
coordination number to each successive Transaction Request on a
rotating basis. The valid range of the coordination number is 31 hex to 3F
hex, or if Enhanced Configuration Parameter option 34 (MCN Range) is
set to 001, from 31 hex to 7E hex. The host must include the
corresponding coordination number when responding with a
Transaction Reply command and can optionally include it in an
Interactive Transaction Response.
This ensures that the Transaction Reply or Interactive Transaction
Response (TREP/ITR) corresponds to the Transaction Request. If the
coordination numbers do not match, by default the SST sends a solicited
status message with a Command Reject status.
The host can override this verification by sending a Message
Coordination Number of ‘0’ in a TREP/ITR. Then the SST will not verify
that the coordination number matches the one sent in the last
Transaction Request message.
Option 34 can also be set such that the TREP/ITR is not rejected when the
coordination number does not match. Instead, the message is ignored
and the SST continues waiting for a TREP/ITR with the correct
coordination number. If the message from Central is ignored, the
response timer is reset as if a Command Reject had been sent.
FS 1 M Field Separator
h Var (39) See Table Note 1 Track 2 Data. Contains up to 39 characters of Track 2 data from the start
sentinel to the end sentinel inclusive. Characters are in the range 30‐3F
hex.
FS 1 M Field Separator
i Var See Table Note 1 Track 3 Data. Contains up to 106 characters of Track 3 data from the start
(106) sentinel to the end sentinel inclusive. Characters are in the range 30‐3F
hex.
FS 1 M Field Separator
j 8 See Table Note 1 Operation Code Data.
Contains the data collected in the Operation Code buffer as a result of
function display keys pressed.
States “D ‐ Pre‐Set Operation Code Buffer State”, “E ‐ Four FDK
Selection Function State” and “Y ‐ Eight FDK Selection Function State”
determine the contents of this field, which identifies the transaction
selected by the consumer.
FS 1 M Field Separator
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-3
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
k 8 or 12 See Amount Entry Field. Identifies the amount entry made at the keyboard.
Table Note 1 The content of this field is determined by the Amount Entry, Enhanced
Table Note 4 Amount Entry and Note Mix Selection states. The data is right‐justified
with leading zeros to the left. This field, if requested in the transaction
request state, is either eight or twelve bytes long. It will be zero‐filled if
no amount entry has been made since the last Card Read state was
executed. The length is selected in the Configuration Parameters Load
message or the Enhanced Configuration Parameters Load message.
FS 1 M Field Separator
l Var (32) See Table Note 1 PIN Buffer (Buffer A). Contains a 16‐character PIN, encrypted as
specified in the FIT, for remote PIN verification.
FS 1 M Field Separator
m Var (32) See Table Note 1 General Purpose Buffer B. Contains the keyboard data entered during
the Information Entry state, or after receiving an Interactive Transaction
Response. The last character in this buffer is a graphic ‘T’ if the SST times
out waiting for the cardholder to respond (using the keyboard) to an
Interactive Transaction Response, or a graphic ‘E’ if the cardholder
presses the Cancel key.
Minimum data length is 3 characters. Maximum data length is 32
characters.
May contain:
An amount value entered during the Enhanced Amount Entry state;
in this case, the buffer length will be the same as the Amount Entry
Field
An amount value or a note mix specified during the Note Mix Selection
state.
FS 1 M Field Separator
n Var (32) See Table Note 1 General Purpose Buffer C. Contains keyboard data as specified by the
Information Entry state.
Data length cannot exceed 32 characters.
May contain:
An amount value entered during the Enhanced Amount Entry state; in
this case, the buffer length will be the same as the Amount Entry Field.
An amount value or a note mix specified during the Note Mix Selection
state.
FS 1 See Field Separator
Table Note 2
Table Note 9
o 1 O Track 1 Identifier. Identifies data in the next field as Track 1 data:
‘1’ ‐ Track 1 data.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-4 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
p Var (78) O Track 1 Data. Contains up to 78 characters of Track 1 data from the start
sentinel to the end sentinel inclusive. The character range is 20‐5F hex.
FS 1 See Field Separator
Table Note 5 &
Table Note 9
q 1 See Table Note 5 Transaction Status Data Identifier. Identifies the data that follows in the
next field as Transaction Status data:
‘2’ ‐ status data.
r Var (71) See Table Note 5, Last Transaction Status contains status data relating to the previous
Table Note 6 & transaction performed by the SST, as follows:
Table Note 7
Last Transaction Serial Number ‐ 4 bytes
Last Status Issued ‐ 1 byte. See Table Note 22.
Last Transaction Notes Dispensed Data ‐ 20 bytes or Var bytes. See Table
Note 11.
Last Transaction Coinage Amount Dispensed ‐ 5 bytes (always 00000)
Last Transaction Coins Dispensed Data ‐ 20 bytes
Last Transaction Cash Deposit Data ‐ 21 or Var bytes
Last Transaction Serial Number contains the four‐digit serial number of
the last transaction partially processed by the SST. If this does not match
the last transaction serial number sent by the host, the transaction was
not initiated.
Last Status Issued contains one byte identifying what the last known
status message sent from the SST was (other than download‐type
messages). It does not necessarily relate to the Transaction Serial
Number. The value will be one of the following:
‘0’ ‐ none sent
‘1’ ‐ good termination sent
‘2’ ‐ error status sent
‘3’ ‐ transaction reply rejected.
If option 76 is set to 000 (four cassette types), Last Transaction Notes
Dispensed Data contains four five‐digit decimal counts defining the
notes dispensed on the last transaction if the last function command
received and processed was a dispense command. These counts will be
zero if the last function command received and processed was not a
dispense command.
If option 76 is set to 001 (seven cassette types), Last Transaction Notes
Dispensed Data contains seven five‐digit decimal counts defining the
notes dispensed on the last transaction if the last function command
received and processed was a dispense command. These counts will be
zero if the last function command received and processed was not a
dispense command.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-5
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
If a Coin Dispenser is present and option 79 is set to 000 (four hopper
types), the Last Transaction Coins Dispensed Data contains four
five‐digit decimal counts defining the coins dispensed from each hopper
on the last dispense transaction. These coin counts (20 bytes) will be zero
if the last function command was not a coin dispense type function, or if
this is the first transaction after installation.
If a Coin Dispenser is present and option 79 is set to 001 (more than four
hopper types), the 25 bytes of coin data in field ‘r’ are all set to zeros, and
the Last Transaction Coins Dispensed Data is provided in fields ‘cf1’ to
‘cf <n+1>’ (data ID ʹfʹ) rather than field ʹrʹ. If a Coin Dispenser is not
present, all 25 bytes are zero.
The Last Cash Deposit Transaction Direction is present if a BNA or
GBXX is present and contains 1 byte as follows:
‘0’ ‐ last transaction was not a cash deposit
‘1’ ‐ vault direction
‘2’ ‐ refund direction.
Where bit 0 of option 45 (BNA Settings) is set, the following data will also
be included:
Number of Notes Refunded during last transaction ‐ 5 bytes
Number of Notes Rejected during last transaction ‐ 5 bytes
Number of Notes Encashed during last transaction ‐ 5 bytes
Number of Notes Escrowed during last transaction ‐ 5 bytes
If the ECB 6 regulations are enforced and level 3 is configured, all suspect
notes are encashed even if the Last Cash Deposit Transaction Direction is
reported as ‘2’, refund direction.
Counterfeit notes are not reported in these fields.
Where bits 1, 3 and 6 of option 45 (BNA Settings) are set, the following
data will also be included:
Number of recycle cassettes reported ‐ 2 bytes
NDC Cassette Type ‐ 3 bytes
Number of Notes ‐ 3 bytes
Number of Recycle Cassettes Reported. Consists of a two‐digit decimal
count in the range 00 to 99
If no recycle cassette has accepted notes, this field contains 00 and the
NDC Cassette Type and Number of Notes fields are not be included. If
this is non‐zero, it indicates how many times the NDC Cassette Type and
Number of Notes pair are repeated.
NDC Cassette Type. Consists of one three‐digit decimal identifier. The
identifier can be between 001 and 007 depending on the cash handler
configuration. This field is repeated the same number of times as the
number of recycle cassettes reported.
If no recycle cassette has accepted notes, this field is omitted.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-6 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
Number of Notes. Consists of a three‐digit decimal count of the number
of notes moved to the recycle cassette, in the range 001 to 999. This field
is repeated the same number of times as the number of recycle cassettes
reported.
If no recycle cassette has accepted notes, this field is omitted.
FS 1 See Field Separator
Table Note 8
Table Note 9
av1 1 See CSP Data ID ‘U’. A value of ‘U’ (55H, ASCII) in this field identifies the
Table Note 8 following field as the first Customer Selected PIN data. If this field is
Table Note 9 selected in the “I ‐ Transaction Request State” table (see Chapter 2, “State
Tables”) and no CSP has been requested, only this field will be present.
av2 Var(16) See CSP Data. This field contains an encrypted 16 character PIN. See the “FIT
Table Note 8 Data” table in Chapter 8, “Financial Institution Tables”.
Table Note 9
FS 1 See Field Separator
Table Note 8
Table Note 9
aw1 1 See Confirmation CSP Data ID ‘V’. A value of ‘V’ (56H, ASCII) in this field
Table Note 8 identifies the following field as the second Customer Selected PIN data.
Table Note 9 If this field is selected in the “I ‐ Transaction Request State” table (see
Chapter 2, “State Tables”) and no CSP has been requested, only this field
will be present. If the CSP state indicates that local verification of the two
Customer Selectable PINs is to be carried out, only the identifier will be
sent if requested by the Transaction Request State.
aw2 Var(16) See Confirmation CSP Data. This field contains an encrypted 16 character
Table Note 8 PIN. For details, see the “FIT Data” table in Chapter 8, “Financial
Table Note 9 Institution Tables”.
FS 1 See Field Separator
Table Note 8
Table Note 9
Table Note 10
ax1 1 See VC Data ID ‘W’. The value ‘W’ in this field identifies the following field
Table Note 8 as containing data inserted by Exits.
Table Note 9
Table Note 10
ax2 Var See This field is available for use by Exits.
Table Note 8
Table Note 9
Table Note 10
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-7
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
FS 1 See Field Separator
Table Note 8
Table Note 9
Table Note 10
ay1 1 See VC Data ID ‘X’. The value ‘X’ in this field identifies the following field as
Table Note 8 containing data inserted by Exits.
Table Note 9
Table Note 10
ay2 Var See This field is available for use by Exits.
Table Note 8
Table Note 9
Table Note 10
FS 1 See Field Separator
Table Note 8
Table Note 9
Table Note 10
az1 1 See VC Data ID ‘Y’. The value ‘Y’ in this field identifies the following field as
Table Note 8 containing data inserted by Exits.
Table Note 9
Table Note 10
az2 Var See This field is available for use by Exits.
Table Note 8
Table Note 9
Table Note 10
FS 1 See Field Separator
Table Note 8
Table Note 9
Table Note 10
ba1 1 See VC Data ID ‘Z’. The value ‘Z’ in this field identifies the following field as
Table Note 8 containing data inserted by Exits.
Table Note 9
Table Note 10
ba2 Var See This field is available for use by Exits.
Table Note 8
Table Note 9
Table Note 10
FS 1 See Field Separator
Table Note 8
Table Note 9
Table Note 10
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-8 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
bb1 1 See VC Data ID ‘[’. The value ‘[’ in this field identifies the following field as
Table Note 8 containing data inserted by Exits.
Table Note 9
Table Note 10
bb2 Var See This field is available for use by Exits.
Table Note 8
Table Note 9
Table Note 10
FS 1 See Field Separator
Table Note 8
Table Note 9
Table Note 10
bc1 1 See VC Data ID ‘\’. The value ‘\’ in this field identifies the following field as
Table Note 8 containing data inserted by Exits.
Table Note 9
Table Note 10
bc2 Var See This field is available for use by Exits.
Table Note 8
Table Note 9
Table Note 10
FS 1 See Field Separator
Table Note 8
Table Note 9
Table Note 10
bd1 1 See Smart Card Data ID ‘5’. The value ‘5’ in this field identifies the following
Table Note 8 field as containing data inserted by EMV/CAM2 Exits.
Table Note 9
Table Note 10
bd2 Var See Smart Card Data. This field is available for use by EMV/CAM2 Exits.
Table Note 8 For more information on this field when a contactless card is used for
Table Note 9 transaction, see “Message Format for Field bd2 in Transaction Request”
Table Note 10 on page 9‐20 and “CAM Flags” on page 9‐21.
FS 1 See Field Separator
Table Note 12
ca1 1 See Device ID ‘w’. The value ‘w’ in this field identifies the following two
Table Note 12 fields as containing cash acceptor data.
and Table Note
17
ca2 2 See Two‐digit hexadecimal number (01 ‐ 32) representing a note type,
Table Note 12 allowing up to 50 note types to be represented.
and Table Note
17
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-9
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
ca3 2 or 3 See Number of notes in the escrow, or vaulted if using direct deposit to
Table Note 12 cassettes, for the note type defined in ca2.
Table Note 13 This field has either 2 or 3 digits, depending on whether option 45 is set
and Table Note to report more than 90 notes or not.
17 If option 45 is not set to report more than 90 notes, this is a two‐digit
number (01 ‐ 90).
If option 45 is set to report more than 90 notes, this is a three‐digit
number (000‐999).
For details of the settings for option 45, see page 10‐17 in the table
“Enhanced Configuration Parameters Load”.
FS 1 See Field Separator
Table Note 14
Table Note 16
cb1 1 See Document Data ID ‘a’. The value ‘a’ in this field identifies the following
Table Note 14 field as containing single cheque deposit data.
Table Note 16
cb2 1 See Codeline detected.
Table Note 14 A value of ‘1’ indicates that a minimum number of codeline characters
Table Note 15 has been detected,
Table Note 16 A value of ‘0’ indicates that a codeline has not been detected after all
Table Note 21 allowed retries.
cb3 Var(256) See Codeline value. This field is present only if field cb2 has a value of ‘1’,
Table Note 14 and contains the codeline read from the cheque.
Table Note 16
FS See Field Separator
Table Note 8
cc1 1 See Data ID ‘c’ for notes regarded as suspect under the ECB 6 regulations.
Table Note 17
cc2 2 The number of note types with notes identified as suspect; the note type
count is a decimal number in the range ‘00’ to ‘99’.
If no note types are identified, this field is ‘00’and fields ‘cc3’ and ‘cc4’ are
omitted
cc3 4 See Note type identifier as a hexadecimal number in the range ‘0001’ to
Table Note 18 ‘00FF’
cc4 3 See Number of suspect notes of the note type identified in field ‘cc3’, as a
Table Note 18 decimal number in the range ‘001’ to ‘999’
FS Field Separator
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-10 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
cd1 1 Data ID ‘d’ for notes regarded as counterfeit under the ECB 6
regulations.
cd2 2 The number of note types with notes identified as counterfeit; the note
type count is a decimal number in the range ‘00’ to ‘99’.
If no note types are identified, this field is ‘00’and fields ‘cd3’ and ‘cd4’
are omitted
cd3 4 See Note type identifier. The hexadecimal identifier of the note type in the
Table Note 19 range ‘0001’ to ‘00FF’
cd4 3 See Number of counterfeit notes of the note type identified in field ‘cd3’, as a
Table Note 19 decimal number in the range ‘001’ to ‘999’
FS 1 Field Separator
ce1 1 O Data ID ‘e’. The value ‘e’ in this field shows that barcode data is being
See reported.
Table Note 20
ce2 4 O ASCII hexadecimal representation of the Barcode Format identifier. The
list of barcode format values is based on the CEN‐XFS barcode reader
device class, or the value ‘0000’ if the barcode format is not known.
ce3 2 O Reserved
ce4 Var O The scanned barcode data. The length is defined by the barcode format
and the length of the scanned barcode. The length of the whole message,
including this field, must not exceed the maximum message length, as
defined by the COMMS protocol.
FS 1 Field Separator
cf1 1 Data ID ‘f’. The value ‘f’ in this field shows that more than four coin
hopper types are being reported.
cf2 2 Number of coins dispensed from hopper type 1.
cf3 2 Number of coins dispensed from hopper type 2.
cf4 2 Number of coins dispensed from hopper type 3.
cf5 2 Number of coins dispensed from hopper type 4.
If a coin dispenser is present and option 79 is set to 001, the Last Transaction Coinage Amount Dispensed is
reported in fields cf1 to cf<n+1> instead of field r as described on page 9‐5.
Depending on the number of hopper types present, n is a number between 5 and 8.
cf< 2 Number of coins dispensed from hopper type n.
n+1
>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-11
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
FS 1 See Field Separator
Table Note 8
Table Note 9
cg1 1 See Data ID ‘g’. The value ‘g’ in this field shows that a bunch cheque deposit
Table Note 8 is being reported
Table Note 9
Table Note 23
Table Note 24
cg2 3 See Table Note Total Cheques to Return. This field contains a count of the cheques
23 inserted into the bunch cheque acceptor, but not included in the deposit
transaction
These cheques have either failed the quality assessment or the
cardholder has requested their return. They are returned to the
cardholder when the remaining cheques are processed during a
Transaction Reply
This field is ‘000’ if no cheques are returned
The following fields only contain details of the cheques that are not going
to be returned
cg3 4 Must be ‘0000’
cg4 3 See Table Note Deposit Currency. This field contains the three‐character ISO 4217
23 currency code for the deposited cheques
If multiple currencies are deposited, fields cg4 to cg16 are repeated for
each deposited currency
cg5 1 Amount Exponent Sign. This field contains the amount exponent sign,
which is either ‘+’ or ‘‐’
cg6 2 Amount Exponent Value. This field contains the exponent value for all
cheque amounts reported in the bunch cheque deposit buffer
The actual cheque amount relates to the amount reported as follows:
<cheque_amount> =
<cheque_amount_reported> * 10^<Exponent>
This field together with the Amount Exponent Sign field defines the
<Exponent> value
For example, if the exponent is ‐2 and the cheque amount reported is
1234, the cheque amount is 12.34
cg7 12 Total Customer Amount. This field contains the sum of all amounts
entered or corrected by the cardholder for cheques to be deposited. If the
cardholder has not entered or corrected an amount for a cheque, the
derived amount is used to calculate the total customer amount
This field contains a decimal number padded to the left with zeros
cg8 12 Total Derived Amount. This field contains the sum of all amounts for
cheque to be deposited derived from image processing technologies
This field contains a decimal number padded to the left with zeros
This field is always zero.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-12 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
cg9 4 Must be ‘0000’
cg1 3 See Cheque Identifier. This field contains a three‐digit number in the range
0 Table Note 25 ‘001’‐’999’ that identifies a specific cheque in the deposit request
The value starts at ‘001’ for each new transaction
cg1 12 See Customer Cheque Amount. This field contains the value of the cheque
1 Table Note 25 identified in field cg10 as entered or corrected by the cardholder. If the
cardholder has not entered or corrected the amount, this field is set to
zero
This field supplies the <cheque_amount_reported> value used in
calculating the cheque amount as described in field cg6
This field contains a decimal number padded to the left with zeros
cg1 12 See Derived Cheque Amount. This field contains the value of the cheque
2 Table Note 25 identified in field cg10 as derived from image processing technologies. If
there is no derived value, this field is set to zero
This field supplies the <cheque_amount_reported> value used in
calculating the cheque amount as described in field cg6
This field contains a decimal number padded to the left with zeros
This field is always zero
cg1 3 See Codeline Length. This field contains the length of the data reported in
3 Table Note 25 field cg14 for the cheque identified in field cg10
This field contains a decimal number in the range ‘000’‐’999’
cg1 var See Codeline Data. This field contains the codeline read from the cheque
4 Table Note 26
Table Note 27
Table Note 25
Table Note 28
Table Note 29
cg1 1 See Cheque Group separator
5 Table Note 25
cg1 1 See Currency Group separator
6 Table Note 24
FS 1 See Field Separator
Table Note 8
Table Note 9
ci1 1 See Data ID ‘<’. The value ‘<’ in this field shows that voice guidance data is
Table Note 8 being reported.
Table Note 9
Table Note 30
ci2 2 See Voice guidance language identifier.
Table Note 8
Table Note 9
Table Note 30
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-13
Terminal to Central Messages
Transaction Request Messages
Number of
Field Mandatory/Optional Description
Characters
w 1 O Field Separator
1 O Optional data fields. These fields will be used for future expansion.
Var O Data.
FS 1 See Field Separator
Table Note 8 &
Table Note 9
x 8 See Message Authentication Code Data. This field contains the calculated
Table Note 3 value for authentication of this message.
Table Note 1: Fields ‘h’ to ‘n’ are optional, and the fields to be
included in the message are specified in the Transaction Request
state. If no keys have been loaded into the encryptor, field ‘l’ is not
sent.
Table Note 2: A field separator and optional fields ‘o’ and ‘p’
comprise a group. When included in the message, all the fields of
this group must be present. The field separator must also be present
if any of the succeeding fields are present.
Table Note 3: Fields ‘e’ and ‘x’ and the preceding field separator are
present only if the Data security feature is selected and the security
flags settings require their inclusion. For details, refer to the APTRA
Advance NDC, Supervisor’s Guide.
Table Note 4: The standard field length is eight digits, but it can be
configured for twelve digits. For details, see the “Configuration
Parameters Load” section in Chapter 10, “Central to Terminal
Messages”.
Table Note 5: Fields ‘q’ and ‘r’ and the preceding field separator are
present only if specified by Enhanced Configuration Option 15. For
details, see the “Enhanced Configuration Parameters Load
Message” section in Chapter 7 and “Enhanced Configuration
Parameters Load” section in Chapter 10. The field separator must
also be present if any of the succeeding fields are present.
Table Note 6: If notes with an unknown presented status are
detected following a power failure, counts are reported as
“00000000000000000000” in the next message. On Diebold’s SSTs, if
notes with an unknown presented status following a power failure
are to be treated as presented, the counts are reported in the next
message. For information about configuring the presented status,
refer to Chapter 6, “Advance NDC on Specific Vendors’ SSTs” of the
APTRA Advance NDC Multi‐Vendor Support Reference.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-14 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
Table Note 7 Coin counts are reported only if one of the following is
true:
A coin dispenser is present
No coin dispenser is present but a note acceptor is present, in
which case the coin counts are initialised to zero.
Table Note 8: The optional fields from ‘av1’ onwards with the
preceding field separator form field groups. The name of each field
is given by two alphabetic characters with each sub‐field element
identified by a numeric character. These fields are used for general
expansion of the transaction request message. Each field is
identified by an ID field. Each field is only included in the message
if the corresponding flag is set in the Transaction Request state. If
the Transaction Request state specifies that a field will be included,
at least the data identifier will be present. If the flag for a field is not
set, the entire field and its preceding field separator are not
included.
Table Note 9: If any of the fields from ‘av1’ onwards are included in
the message, the field separators preceding fields ‘o’–‘p’ and ‘q’–‘r’
will be present even if the associated data is not.
Table Note 10: Fields ‘ax*’ to ‘bd*’ are available for use by Exits.
They may contain any seven‐bit ASCII data subject to length limits
imposed by the communication protocol in use, except that they
must not contain Group Separator (1DH) or Field Separator (1CH)
characters.
Table Note 11: The Last Transaction Notes Dispensed data consists
of 4 or 7 five‐digit decimal counts, defining the notes dispensed in
the last dispense transaction. If the last received command was not a
dispense command, these counts will be zero.
Table Note 12: If a cash acceptor is present, the preceding field
separator and optional cash acceptor fields ‘ca1’, ‘ca2’ and ‘ca3’ are
included as a group. When multiple note types are reported in the
transaction request message, the sequence of these fields is ‘ca1 ca2
ca3 ca2 ca3 ....’, where ‘ca2’ and ‘ca3’ are repeated for the types that
are present, up to 50 note types.
Table Note 13: If you use ECB 6, this field includes notes identified
as suspect or authentic, but not notes identified as counterfeit.
Suspect notes are treated as authentic notes.
Table Note 14: If a cheque processor is present, the preceding field
separator and optional cheque processor fields ‘cb1’, ‘cb2’ and ‘cb3’
are included as a group. The cheque processor fields are only
included in the message if the corresponding flag is set in the
Transaction Request state, in which case at least the Buffer Identifier
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-15
Terminal to Central Messages
Transaction Request Messages
will be present. When a flag for a field is not set, the entire field and
its preceding field separator are not included.
Table Note 15: If the corresponding flag is set in the Transaction
Request state and the optional cheque processor fields ‘cb1’, ‘cb2’
and ‘cb3’ are used to report a bunch cheque deposit, field ‘cb2’ is set
to 0.
Table Note 16: When any of the fields ‘cb1’, ‘cb2’ or ‘cb3’ are to be
included in the message, the field separators preceding fields ‘o’
and ‘p’, and ‘q’ and ‘r’ will be present even if the associated data is
not.
Table Note 17: The suspect note counts are also included in the ‘ca1’,
‘ca2’ and ‘ca3’ fields as they are treated as authentic.
Table Note 18: Fields ‘cc3’ and ‘cc4’ are reported for each note type
with suspect notes.
Table Note 19: Fields ‘cd3’ and ‘cd4’ are reported for each note type
with counterfeit notes.
Table Note 20: If a barcode reader is present, the preceding field
separator and optional barcode reader fields ‘ce1’, ‘ce2’ and ‘ce4’ are
included as a group. The barcode reader fields are only included in
the message if the corresponding flag is set in the Transaction
Request state, in which case at least the Buffer Identifier will be
present. When a flag for a field is not set, the entire field and its
preceding field separator are not included.
Table Note 21: If the codeline is not detected after all allowed retries,
it may not be present on the cheque. In case the cheque can be
endorsed without a codeline, the cheque details are still sent to the
host.
Table Note 22: The Last Status Issued byte applies only to solicited
status messages; unsolicited messages are not part of the transaction
status.
Table Note 23: If the field group with Data ID ʹgʹ is present and all
cheques are to be returned, only field ‘cg2’ is included. If any field
from cg4 onwards is also present, fields ‘cg2’ to ‘cg9’ are mandatory.
Table Note 24: To support cheque deposits of more than one
currency, fields ‘cg4’ to ‘cg16’ are repeated for every currency
except for the last currency in the message when field ‘cg16’ is
omitted. The totals in fields ‘cg7’ and ‘cg8’ contain the totals for the
first currency and are followed by the details for the cheques in the
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-16 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
first currency. This grouping is repeated for each additional
currency.
Table Note 25: The details for each cheque to be deposited must be
provided in the field group with Data ID ’g’, with fields ‘cg10’ to
‘cg14’ repeated to report every cheque to be deposited in this
transaction. The details for each cheque are separated from the
previous cheque details by a group separator (field ‘cg15’) and even
the last cheque has a trailing group separator.
Table Note 26: The characters read from the codeline in E13B format
will have the following encoding:
Table 9-2 E13B
NDC Character Hex Value E13B Meaning
E13B Codeline Encoding Character
0‐9 0x30 to 0‐9 0‐9
0x39
b 0x62 Amount
c 0x63 On us
d 0x64 Transit
‐ 0x2D Dash
space 0x20 space Space
! 0x41 N/A Reject/Unreadable
Table Note 27: The characters read from the codeline in CMC7
format will have the following encoding:
Table 9-3 CMC7
NDC Character Hex Value CMC7 Meaning
CMC7 Codeline Encoding Character
0‐9 0x30 to 0‐9 0‐9
0x39
b 0x62 S2 ‐ Start of the Amount
field
c 0x61 S1 ‐ Start of Bank Account
d 0x65 S5 ‐ Transit/Routing
e 0x64 S4 ‐ Unused in normal
cheques
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-17
Terminal to Central Messages
Transaction Request Messages
CMC7
NDC Character Hex Value CMC7 Meaning
Character
‐ 0x2D S3 ‐ Terminate routing
space 0x20 space Space
! 0x41 N/A Reject/Unreadable
Table Note 28: The codeline field in the field group with Data ID ‘g’
is empty if it cannot be read.
Table Note 29: If the field with Data ID ‘a’ is used to deposit a bunch
of cheques (that is, using the single cheque Transaction Request
buffer), no codeline data is provided and field ‘cb2’ in buffer ‘a’ is
set to ‘0’.
Table Note 30: The voice guidance bytes are only present if the
transaction is a voice‐guided transaction and the buffer is defined in
the XML configuration file. If the voice guidance buffer is not used,
the Operation Code field (field ‘j’) can be used to identify
voice‐guided transactions and the language used.
Advance NDC always sends a solicited status (error or ready) in
response to a transaction reply. The Last Status Issued byte value of
0 will only be seen if the SST is reset while processing a transaction
reply, or on the very first transaction after persistent memory is
cleared.
This field is present to guard against the previous response being
lost due to a communications failure, and indicates what status
Advance NDC previously attempted to send to Central. This is so
that a communications failure will not cause the value to be set to 0.
If you have problems reconciling the unsolicited E5 message
(unknown number of notes retracted) with the transaction, then
message mode Option Digit 4A should be used to send a delayed
dispenser status message.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-18 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
The host can request further information during a transaction using
SST Reply to Interactive an Interactive Transaction Response (ITR). If this occurs, a sub‐set of
Transaction Response 9
the Transaction Request message is used to reply to the request.
When the Transaction Request message is sent in reply to an ITR, it
differs from the previous description in that it consists only of the
following fields.
Table 9-4 b Message Class
Transaction Request in Reply to an
Interactive Transaction Response c Message Sub‐Class
Field Separator
d Logical Unit Number
2 Field Separators
e Time Variant Number
Field Separator
f Top of Receipt Transaction Flag
g Message Coordination Number
6 Field Separators
m General Purpose Buffer B. Minimum data length is 1 character
1 or 2 Field Separators
See Table Note 31
v MAC Data
Table Note 31: If the amount entered exceeds the limit of 32 bytes,
the next key press clears the buffer, resetting the value to 0 and
restarting the entry from the beginning.
Message Format for Field This section defines the format of the additional smart card ‘bd2’
data contained in the Transaction Request message when a
bd2 in Transaction Request 9
contactless card (EMV‐Like or Magnetic Stripe‐Like card with EMV
data) is used to perform the transaction. This message also contains
the smart card data that the Central needs in order to authorise a
smart card transaction at the terminal.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-19
Terminal to Central Messages
Transaction Request Messages
Table 9-5
Message Format for Field bd2 in
Transaction Request
Number of Mandatory/
Field Description
Characters Optional
bd2 ‐ ‐ Smart card data ‐ see sub‐fields:
bd2a 3 See Table Note 32 Smart card data identifier.
CAM ‐ data in buffer is for CAM
bd2b 4 See Table Note 32 CAM Flags.
For values, see “CAM Flags” on page 9‐21.
bd2c Var See Table Note 32, EMV data objects for authorisation.
Table Note 33 and As an example with the following data:
Table Note 34 Application Identifier (AID) 0x9F06
Track 2 Equivalent Data 0x57
Application PAN 0x5A
Application PAN Sequence Number 0x5F34
Cryptogram Information Data 0x9F27
Application Cryptogram 0x9F26
Issuer Application Data 0x9F10
Application Interchange Profile (AIP) 0x82
Application Transaction Counter (ATC) 0x9F36
CDOL1 0x8C
PIN Retry Count 0x9F17
This field would contain the following (actual values will
vary):
ʹ9F 06 07 A0 00 00 00 08 00 01 57 12 12 34 56 78 90 12 34 56 78
90 D9 90 10 81 23 45 67 89 5A 0A 12 34 56 78 90 12 34 56 78 90
5F 34 01 00 9F 27 01 00 9F 26 08 12 34 56 78 90 12 34 56 9F 10 07
06 01 01 03 A0 00 00 82 02 7C 00 9F 36 02 01 23 8C 15 9F 02 06
9F 03 06 9F 1A 02 95 05 5F 2A 02 9A 03 9C 01 9F 37 04 9F 17 01
03ʹ
Table Note 32: These fields are only included in the Transaction
Request if the following are true:
The Transaction Request State indicates that EMV\CAM buffers
needs to be added. For information about Transaction Request
State, see “I ‐ Transaction Request State” on page 2‐39.
A contactless card has been tapped and the outcome was
successful.
Table Note 33: If no data objects are identified, none are present and
effectively this field is absent.
Table Note 34: If a data object held in ʹbd2cʹ field is not available, the
data object is not present.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-20 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Transaction Request Messages
There are 16 available CAM flags. These are encoded as the bits in
CAM Flags 9
two bytes and are converted to ASCII hex (four bytes) for
transmission. Each can have the value 0 or 1 with the following
meanings:
Table 9-6
CAM Flags
Byte Bit Value Description
1 8 0 See Table Note 35
7 0 See Table Note 35
6 0 See Table Note 35
5 0 See Table Note 35
4 0 See Table Note 35
3 0 See Table Note 35
2 0 See Table Note 35
1 0 See Table Note 35
2 8 0 See Table Note 35
7 0 See Table Note 35
6 0 See Table Note 35
5 0 See Table Note 35
4 0 See Table Note 35
3 1 Contactless smart card processing was initiated
2 0 or 1 0 – Mode of contactless transaction is Magnetic
Stripe‐Like.
1 – Mode of contactless transaction is EMV‐Like.
1 0 or 1 0 – Transaction is performed using a contact card
reader.
1 – Transaction is performed using a contactless card
reader.
Table Note 35: These bits will always be zero when transaction is
performed using a contactless card.
For more information about general purpose buffers, refer to the
APTRA Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-21
Terminal to Central Messages
Solicited Status Messages
Solicited Status Messages 9
The SST responds to a command from the host by sending a
solicited status message. This section gives information about the
format and content of solicited status messages.
The information in the status message depends on the command
Content of Solicited Status received and whether or not the SST can perform the command. The
Messages 9
following fields in the status message contain this information:
Status Descriptor
Status Information.
Note: Exits can also send solicited status messages. These have the
same format as standard solicited status messages, but the content
of the Status Descriptor and Status Information fields depends on
the Exit. For more information, refer to APTRA Advance NDC,
Extending the Product.
Status Descriptor Field 9
The status descriptor field identifies which of the following
conditions is being reported:
Ready. The command has been performed successfully
Device Fault. A device fault has occurred.
Command Reject/Specific Command Reject. The command has
been rejected
Terminal State. The values of supply counters or SST
configuration are included in the message.
Status Information Field 9
The status information field contains additional information when a
Device Fault, Specific Command Reject or Terminal State descriptor
is used. For more details, see “Status Information” on page 9‐24.
Table 9-7
Solicited Status Message Format
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘2’ ‐ Solicited message.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-22 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
c 1 M Message Sub‐Class. The message sub‐class is:
‘2’ ‐ Status message.
FS 1 M Field Separator
d 3 or 9 M Logical Unit Number (LUNO). This number is defined in a field
transmitted to the SST in a Configuration Parameters Load message.
The default number is 000. If the data security feature is configured,
an additional six characters are present which contain the machine
number. For details, refer to the APTRA Advance NDC, Supervisor’s
Guide.
FS 1 M Field Separator
FS 1 M Field Separator
e 8 See Time Variant Number. Contains an eight‐digit number derived from
Table Note 36 the time of day by the SST for each status message. The digits can be
Table Note 37 0‐9, A‐F.
FS 1 See Field Separator
Table Note 36
f 1 M Status Descriptor. Describes the status message as follows:
‘8’ Device Fault ‐ This indicates that an SST device is reporting
abnormal status. This value is also used in a configuration ID
status message.
‘9’ Ready ‐ This indicates that the instruction was completed
successfully.
‘A’ Command Reject ‐ This is inserted into the status descriptor
field under the following conditions:
1. SST receives an illegal command.
2. SST receives illegal data from the host.
3. SST receives data while not in the correct mode.
For more information, see the “Message Validation” section
in Chapter 10, “Central to Terminal Messages”.
‘B’ Ready ‐ This indicates that the Transaction Reply was
successfully completed. (When separate ‘Ready’ for
Transaction Reply commands option has been selected as a
configuration parameter.)
‘C’ Specific Command Reject ‐ This is sent to indicate a rejection
of the message for authentication failure, or if the specific
command reject option is set and a message is rejected that
would otherwise generate a command reject ‘A’. The status
information field identifies the reason for rejection.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-23
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
‘F’ Terminal State ‐ This is sent in response to Terminal
Commands requesting supply counters, SST configuration
information, or the date and time.
FS 1 See Field Separator
Table Note 38
g Var See Status Information. Additional status information is sent only
Table Note 38 when the status descriptor contains ‘8’, ‘C’ or ‘F’.
FS 1 See Field Separator
Table Note 36
Table Note 37
h 8 See Message Authentication Code (MAC) Data. Contains the
Table Note 36 calculated value for authentication of this message. The
Table Note 37 characters are in the range 0‐9 and A‐F.
i Var M Trailer. Protocol‐dependent.
Table Note 36: This is not sent unless Message Authentication is in
use, and has been selected for solicited status messages. For details,
see the “Message Authentication Field Selection Load” section in
Chapter 10, “Central to Terminal Messages”.
Table Note 37: This is not sent if the Status Descriptor field contains
‘9’ or ‘B’.
Table Note 38: This is not sent unless the Status Descriptor field
contains ‘8’, ‘C’ or ‘F’.
Additional information can optionally be contained in the Status
Status Information 9
Information field when the ‘B’ ‐ Ready status descriptor is used.
Additional information is always contained in the Status
Information field when the following status descriptors are used:
‘C’ ‐ Specific Command Reject
‘F’ ‐ Terminal State
‘8’ ‐ Device Fault.
Reporting of CIM NDC Cassette Types 9
Cash In Module (CIM) NDC cassette types are reported in Ready B,
terminal command and device status messages. The number of CIM
NDC cassette types and the order in which they are reported to the
host depends on the reporting of the XFS logical cash units by the
platform.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-24 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
On a GBXX system, CIM NDC cassette type reporting depends on
the initial position of the cassettes following installation. If new XFS
logical cash units are inserted, these are appended to the existing
reporting order. A fixed mapping can be configured to match the
deposit and dispense cassette IDs. For further details about cassette
type reporting, refer to Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC, Developer’s
Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-25
Terminal to Central Messages
Solicited Status Messages
Ready (‘B’) Status 9
When the Status Descriptor is ‘B’ and the Ready status is set to
include transaction status data, the following information is present
in the Status Information field. For details of setting the Ready
status to include transaction status data, see “Supply Mode, Ready
Status & Amount Buffer Length (Field ‘m’)” on page 7‐2.
Table 9-8
Ready (‘B’) - Status Information
Number of
Field Mandatory/Optional Description
Characters
g1 4 M Transaction Serial Number (TSN). Contains the TSN of the last
transaction processed by the SST.
FS 1 M Field Separator
See Table Note 39
g2 1 O Data Identifier. Identifies the data that follows in the next field as
follows:
1 ‐ Recycle Cassette Deposit Data
2 ‐ Recycle Cassette Dispense Data
g3 Var O Transaction Data. Contains the transaction data as follows:
For a deposit using recycle cassettes, see “Cash Deposit Recycle Data ‐
Sub‐field ‘g3’” on page 9‐26
For a dispense using recycle cassettes, see “Recycle Cassette Dispense
Data ‐ Sub‐field ‘g3’” on page 9‐27.
See Table Note 40
Table Note 39: If no additional data is present, the field separator is
omitted. New data groups may be included in the future.
Table Note 40: A group separator follows each reported cassette,
except the last.
Cash Deposit Recycle Data ‐ Sub‐field ‘g3’ If the transaction is 9
identified as a deposit using recycling cassettes or has caused the
status of the recycling cassettes to change, the data shown in
Table 9‐9 is returned in the Ready ‘B’ message.
Note: For recycling cassettes, the mappings between the physical
cassette units, the XFS logical cash units and the NDC cassette types
can be configured using the registry. For more information, refer to
section “Configuring Cash Handlers” in Chapter 5 of the APTRA
Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-26 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Table 9-9 Field Description
Cash Deposit: Recycle Data
g3‐1 Number of Cash Dispenser Module (CDM)
Recycle NDC Cassette Types Reported. This is in
the range 01 to 99.
g3‐2 CDM Recycle NDC Cassette Type. Consists of
one three‐digit identifier for the cassette type
being reported. The identifier can be between
001 and 007.
This is repeated for each CDM recycle cassette
that has accepted notes. See Table Note 41
g3‐3 Number of Notes Stored or Retained. Consists of
a three‐digit decimal count of the number of
notes deposited. This is in the range 001 to 999.
This is repeated for each CDM recycle cassette
that has accepted notes. See Table Note 41
g3‐4 Current Fitness Status. For details, see “Fitness
Data” on page E‐20.
This is repeated for each CDM recycle cassette
that has accepted notes. See Table Note 41
g3‐5 Current Supplies Status. For details, see
“Supplies Data” on page E‐12. This field does
not report no change.
This is repeated for each CDM recycle cassette
that has accepted notes. See Table Note 41
GS. See Table Note 41
Table Note 41: If the number of CDM NDC recycle cassette types is
greater than 1, fields g3‐2 to g3‐5 and the GS inclusive are repeated
for every CDM cassette that has taken notes. The GS for the last
cassette reported is omitted.
Recycle Cassette Dispense Data ‐ Sub‐field ‘g3’ If the 9
transaction data is identified as a dispense using recycle cassettes or
has caused the status of recycle cassettes to change, the data in
Table 9‐10 is returned in the Ready ‘B’ message.
Note: The initial position occupied by a cassette is used to map the
cash‐in NDC cassette type to the XFS logical cash unit. When
recycling is enabled on a GBXX, fixed mapping must be used to
report fixed cassette types in a Ready ‘B’ and other status messages.
For further information, refer to section “Fixed Cassette Mapping
for Recycling” in Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC, Developer’s
Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-27
Terminal to Central Messages
Solicited Status Messages
Table 9-10 Field Description
Recycle Cassette: Dispense Data
g3‐1 Number of CIM NDC Recycle Cassette Types
Reported. This is in the range 01 to 99.
g3‐2 CIM Recycle NDC Cassette Type. Consists of
one three‐digit identifier for the cassette type
being reported. The identifier can be between
000 and 255. This is repeated for each CIM
recycle cassette that has dispensed notes. See
Table Note 41
g3‐3 Number of Notes Dispensed. Consists of a
three‐digit decimal count of the number of notes
dispensed. This is in the range 001 to 999.
This is repeated for each CIM recycle cassette
that has dispensed notes. Rejected notes are
moved to the reject bin from the cassette and are
included in the total number of dispensed notes
returned in the Ready ʹBʹ message.
See Table Note 41
g3‐4 Current Fitness Status. For details, see “Cash
Acceptor Fitness (DIG ‘w’)” on page E‐25.
This is repeated for each CIM recycle cassette
that has dispensed notes. See Table Note 41
g3‐5 Current Supplies Status. For details, see “Cash
Acceptor Supplies (DIG ‘w’)” on page E‐17. This
field does not report no change.
This is repeated for each CIM recycle cassette
that has dispensed notes. See Table Note 41
1 GS. See Table Note 41
Table Note 42: If the number of CIM recycle NDC cassette types is
greater than 1, fields ‘g3‐2’ to ‘g3‐5’ and the GS are repeated for
every CIM recycle cassette that has taken notes. The GS for the last
cassette reported is omitted.
Specific Command Reject 9
When the Status Descriptor is ‘C’ ‐ Specific Command Reject, the
following information is present in the Status Information field. For
details of the conditions under which individual status values are
generated, see “Message Validation” on page 10‐102.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-28 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Table 9-11
Specific Command Reject - Status
Information
Number of Mandatory/
Field Description
Characters Optional
g1 1 M Status Value. Gives the reason for rejecting the command. Values are:
‘1’ ‐ MAC Failure. Result of MAC verification did not equal the MAC field in
the message.
‘2’ ‐ Time Variant Number Failure. The time variant number received in the
last Transaction Reply message is not the same as the last transmitted value.
‘3’ ‐ Security Terminal Number Mismatch. The number received in the last
transaction reply security terminal number is not the same as the number
held in the SST.
‘A’ ‐ Message Format error.
(g2) Status Qualifier:
01 Message length error.
02 Field Separator missing/unexpectedly found.
03 Transaction Reply message has too many print groups.
04 Group Separator missing/unexpectedly found.
05 Reserved
06 Invalid dispense message, wrong format for current mode or a
request has been made to dispense from multiple dispensers. Not
supported
07 Malformed XML.
08 XML does not conform to XML schema.
09 Inconsistent XML Configuration download. Not supported
‘B’ ‐ Field Value error.
(g2) Status Qualifier:
01 Illegal Message Class.
02 Illegal Message Sub‐Class or Identifier.
03 Illegal Encryption Key Change or Extended Encryption Key Change
Message Modifier.
04 Illegal Terminal Command Code.
05 Illegal Terminal Command Modifier.
06 Illegal Transaction Reply Function Identifier.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-29
Terminal to Central Messages
Solicited Status Messages
Number of Mandatory/
Field Description
Characters Optional
07 Data field contains non‐decimal digit.
08 Data field value out of range.
09 Invalid Message Coordination number.
10 Illegal FIT number.
11 Invalid dispense mix specified. No notes or coins were specified or
too many notes or coins were specified in a dispense function.
12 Reserved
13 Unrecognised Document Destination.
14 Reserved
15 Unrecognised Buffer Identifier.
16 Reserved
17 Document Name Error.
18 The screen identifier is out of range.
19 Reserved
20 No data supplied to endorse cheque
21 Reserved
22 Invalid Encryption Key Size.
23 RSA Signature Verification Failed.
24 Signature or Encryption Key PKCS#1 Packing Failed.
25 Signature or Encryption Key PKCS#1 Unpacking Failed.
26 Invalid Signature or Encryption Key PKCS#1 Pad Block Type.
27 Fixed Header Decryption Failed.
28 Null Byte After Padding Missing.
29 Invalid Pad Byte Count.
33 Invalid Cassette Type. Not supported
34 Invalid/Incomplete Cheque Identifier(s).
35 Passbook update not supported in specified Transaction Reply
Function.
36 Encryption key not found. A key referenced in the Encryption Key
Exchange or Extended Encryption Key Change command not found.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-30 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of Mandatory/
Field Description
Characters Optional
37 Encryption function failed. The Encryption Key Exchange or
Extended Encryption Key Change command failed.
38 Authentication not supported/required for command identified. The
command identified in the Start Authentication is not supported or
authentication is not required to execute the command.
‘C’ ‐ Illegal Message type for current mode.
(g2) Status Qualifier:
01 Message type only accepted while SST is In‐Service and expecting a
Transaction Reply
02 Message not accepted while diagnostics is in progress. This is
returned when the application has passed control to VDM
03 Message not accepted while in Out‐of‐Service or Supply mode
04 Message not accepted while in In‐Service mode
05 Message not allowed while configured for NCR status message
mode
06 Message not allowed while SST is configured for Diebold status
message mode. Not supported
07‐09 Reserved
10 Message not accepted while processing a Transaction Reply.
11 Cheque not present in cheque processor transport while processing a
Transaction Reply
12‐14 Reserved
15 Encryption Key Change or Extended Encryption Key Change
message not accepted during a cardholder transaction, or while the
SST is in suspend mode, or while the operator is initiating the
execution of supervisory/ settlement transactions.
16 Reserved
17 Key change operation cannot be accepted in restricted encryption
mode. This applies when an Extended Encryption Key Change
message with modifier ‘3’, ‘4’, ‘6’ or ‘7’ is received in restricted mode.
18 Key entry mode not authorised.
‘D’ ‐ Hardware Failure.
(g2) Status Qualifier:
01 Encryption failure during Encryption Key Change or Extended
Encryption Key Change message.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-31
Terminal to Central Messages
Solicited Status Messages
Number of Mandatory/
Field Description
Characters Optional
02 Time‐of‐Day Clock failure or invalid data sent during Date/Time Set
command
03‐05 Reserved
06 Insufficient disk space.
07 File IO error.
08 File not found.
‘E’ ‐ Function Not Supported.
(g2) Status Qualifier:
01 Function not supported by software.
For example, a DLL required to complete the transaction reply
processing is missing.
02 Required device not configured. Also, sideways print on the receipt
is requested, but either the printer does not have the capability or has
not been configured for sideways printing.
03 Reserved
04 Reserved
05 Journal printer backup inactive.
06 The data requested is not compatible with the required response
message. Not supported
g2 2 O Status Qualifier. Present for status values ‘A’ ‐ E’. (See preceding text)
Terminal State 9
This section describes what information can be contained in field ‘g’,
the Status Information field, when the Status Descriptor is ‘F’ ‐
Terminal State.
Field ‘g’ is made up of a number of sub‐fields named ‘g1’, ‘g2’, ‘g3’
and so on. Sub‐field ‘g1’ identifies which terminal command has
been received, as shown in the following table. The remaining
sub‐fields contain the status information requested by that
command, as shown in the subsequent tables.
Table 9-12 Terminal Command Sub-Field ‘g1’
Terminal State - Status Information
Sub-Field ‘g1’ Send configuration information 1
Send supply counters 2
Send tally information. Not Supported 3
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-32 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Terminal Command Sub-Field ‘g1’
Send error log information. Not supported 4
Send date/time information 5
Send configuration ID 6
EKC retrieve hallmark key. Not supported F
Hardware configuration data H
Supplies data I
Fitness data J
Tamper and sensor status data K
Software ID and release number data L
Local configuration option digits M
Report cash deposit definition N
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-33
Terminal to Central Messages
Solicited Status Messages
Send Configuration Information 9
This solicited status message is sent to the host in response to a Send
Configuration Information Terminal Command message (a
command code of ‘7’ with no command modifier, or a command
modifier of 6 to include enhanced configuration information). The
response returns all the configuration information available.
If a message with a command code of ‘7’ also has a command
modifier, the response returns the configuration information
specified by the command modifier. For details of the terminal
command code, see “Configuration Information (Command Code =
7)” on page 10‐5.
For the configuration responses when a modifier other than 6 is
included, see sections “Hardware Configuration Data Only” on
page 9‐48 to “Report Cash Deposit Definition” on page 9‐59.
Table 9-13
Send Configuration Information Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message is sent to the host in response to a
Send Configuration Information Terminal Command message and has
identifier ‘1’
g2 4 M Configuration ID. Contains the last four‐digit configuration ID
numbers (0000–9999) sent to the SST from the host
FS 1 M Field Separator
g3 22 or 38 M Hardware Fitness. Contains one byte for each device or major device
resource. The position of the byte identifies the device; the byte
indicates the fitness status. For details, see “Hardware Fitness—
Sub‐field ‘g3’” on page 9‐35
FS 1 M Field Separator
g4 44 or 76 M Hardware Configuration. Contains information for each device
indicating whether or not it is configured. If configured, it gives details
of which option, if any, is configured. For details, see “Hardware
Configuration Data—Sub‐Field ‘g4’” on page 9‐38.
Note: As the byte size for this field is limited, some new device
configurations cannot be sent, for example barcode reader.
FS 1 M Field Separator
g5 23 or 26 M Supplies Status. Contains one byte per type of media container or
resource. The position of the byte identifies the media resource; the
byte indicates the supplies status. For details, see “Supplies Status—
Sub‐field ‘g5’” on page 9‐46
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-34 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
FS 1 M Field Separator
g6 5 or 12 M Sensor Status. Contains one byte per sensor and is identical to the
information reported in characters 2‐13 of “Sensors (Unsolicited)” on
page 9‐114.
As in the status messages, TI sensors are reported only if the TI feature
is configured.
The number of characters is always twelve if fields ‘g7’ and ‘g8’ are
present. The last seven bytes are blank if no TI is present
FS 1 O Field Separator
g7 6 O Advance NDC Release Number.
Contains a six‐digit decimal number. The first pair of digits represents
the release number. The second pair of digits represents the point
release number. The third pair of digits represents the patch release
number. See Table Note 43.
FS 1 O Field Separator
g8 9 O Advance NDC Software ID. Contains the Advance NDC Software ID.
The field takes the following values:
G531‐0283 (Advance NDC package)
If the Advance NDC software ID is unavailable, this field contains
nine blanks. See Table Note 43.
Table Note 43: Fields ‘g7’ and ‘g8’ are included only if the
appropriate message mode option digit 6C is set. For details of this
option digit (6C, add the Advance NDC Release Number and
Software ID fields to the Configuration Terminal State Message),
refer to the APTRA Advance NDC, Supervisor’s Guide.
Hardware Fitness—Sub‐field ‘g3’ The device is identified by the 9
position of the byte, as shown in the following table. The field
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-35
Terminal to Central Messages
Solicited Status Messages
returns the fitness of most devices and modules for an overall view
of the state of the SST.
Table 9-14 Byte position Device indicated
Hardware Fitness Sub-Field ‘g3’
0 Time‐of‐Day Clock, see Table Note 44
1 High Order Communications
2 System Disk
3 Magnetic Card Reader/Writer, see Table Note 44
4 Cash Handler, see Table Note 44
5 Depository, see Table Note 44
6 Receipt Printer, see Table Note 44
7 Journal Printer, see Table Note 44 and Table Note 45
8 Reserved
9 Reserved
10 Night Safe Depository, see Table Note 44
11 Encryptor, see Table Note 44
12 Security Camera
13 Door Access. (Not supported)
14 Flex Disk
15 Cassette type 1
16 Cassette type 2
17 Cassette type 3
18 Cassette type 4
19‐20 Reserved for new devices (= 0)
21 Statement Printer, see Table Note 44
22 Signage Display, see Table Note 46
23‐24 Reserved, see Table Note 46
25 System Display, see Table Note 46
26 Media Entry Indicators, see Table Note 46
27 Envelope Dispenser, see Table Note 44 and Table
Note 46
28 Document Processing Module. Not supported
See Table Note 46
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-36 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Byte position Device indicated
29 Coin Dispensing Module Tamper Indication
See Table Note 46
30 Document Processing Module, Module Tamper
Indication. Not supported
See Table Note 46
31 Reserved, see Table Note 46
32 Voice Guidance System
See Table Note 46
33 Reserved, see Table Note 46
34 Bunch Note Acceptor
See Table Note 46
35 Cheque Processor
See Table Note 46
36 Biometric Capture Device (Not supported)
See Table Note 46
37 Reserved
See Table Note 46
Table Note 44: The relationship between the Device Identifier
Graphic (DIG) in the status message and the offset in the Fitness
table is: offset = DIG - 41 hex
Table Note 45: When dual mode is configured using Enhanced
Configuration Parameter option 35, only the status of the physical
device is reported. For details of option 35, see “Option 35 – Report
Dual Mode EJ & Hardcopy B/U Unsolicited Messages” on
page 7‐13.
Table Note 46: These fields are returned only if command modifier
‘6’, “Send enhanced configuration data”, is used. For details, see
“Configuration Information (Command Code = 7)” on page 10‐5 in
table “Terminal Commands” on page 10‐3.
Fitness Severity Each byte indicates the current fitness of the 9
device by a severity value, as shown in the following table. Routine,
warning and fatal conditions (severity values 1, 2 and 4) can only be
cleared by local supervisor functions.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-37
Terminal to Central Messages
Solicited Status Messages
Table 9-15 Severity Value Meaning
Hardware Fitness Severity Values
0 No error
1 Routine errors have occurred
2 Warning conditions have occurred ‐
investigation required
3 Suspend. Terminal is currently in suspend state
due to suspected tampering with this device
4 Fatal error condition exists
Hardware Configuration Data—Sub‐Field ‘g4’ The configuration 9
data for each device is reported as two hexadecimal characters
representing a byte of configuration information. The following
table gives details of the byte position for each device and the value
or bit significance of each byte as appropriate.
Table 9-16 Byte Device
Hardware Configuration Data: Sub-Field
‘g4’ 0 Product Class
0E 5663
0F 5674
10 5675
11 5684
12 5685
13 5688
14 5665
15 5670
16 Personas 75
17 Personas 88
18 Personas 40
19 Personas 70
1A Personas 74
1B Personas 84
1C Personas 85
1D Personas 90
1E EasyPoint 55 or EasyPoint 57
1F Personas 86
20 5588
21 Personas 73
22 Personas 72
23 Personas 77
24 6674
25 6676
26 5879
27 5887
28 5362
29 Personas 71
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-38 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Byte Device
2A 5867
30 6622
31 6624
32 6626
33 6628
34 6631
35 6632
36 6634
37 6638
38 6625
39 6618
3A 6636
3B 2012 (SelfServ 22e)
3C 2016 (SelfServ 16)
3D 6642 (SelfServ 42)
3E 2004 (SelfServ 4)
3F 2008 (SelfServ 8)
40 2014 (SelfServ 14)
41 6691
42 6623
43 6627
44 6683
45 6687
Note: This list does not imply Advance NDC
support for all these product classes.
1 7F No configuration
2 System Disk
00 Hard disk present
01 Reserved
02 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-39
Terminal to Central Messages
Solicited Status Messages
Byte Device
3 Magnetic Card Reader/Writer. See Table Note 47.
00 No card reader attached
01 Track 2 (read only)
02 Reserved
03 Track 1/2/3 MCRW (write on track 3 only).
(Also returned if card reader cannot be identified)
04 Reserved
05 PC Dip Reader
06 Reserved
07 3 Track Write MCRW
08 Track 2 Smart Card Reader
09 Track 1/2/3 Smart Card Reader
0A 3 Track Write Smart Card Reader
0B Track 1/2 and Track 2/3 Dip MSR
0C Track 1/2/3 CIM86 MCRW
10 Track 1/2 Dip MSR
11 Track 1/2 Swipe Reader
1D Dip and Smart Hardware (DASH) Reader
1E Track 1/2/3 with MM
1F Track 1/2/3 Smart with MM
20 Track 3 Smart with MM
47 Card Reader that only supports Magnetic Stripe Data
(MSD). See Table Note 48
48 Contactless Card Reader that supports Magnetic Stripe
Data (MSD) and Contactless EMV Transactions. See
Table Note 48
4 Cash Handler. See Table Note 47, Table Note 52 and Table Note
53
00 Not configured
01 Stacking cash handler
02 Spray cash dispenser
03 Stacking cash handler with recycle capabilities.
See Table Note 49
04 Stacking cash handler capable of recycling with recycle
capabilities disabled
See Table Note 49
5 Envelope Depository
See Table Note 47.
00 Not configured
01 Reserved
02 Programmable Printing Depository (PPD)
03 Reserved
04 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-40 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Byte Device
6 Receipt Printer. See Table Note 47.
00 Not configured
01 Plain paper
02 Black dot paper
03 Sideways printing, no black mark
04 Sideways printing, black mark
05 Thermal printer ‐ no black mark
06 Thermal printer ‐ black mark
07 Thermal printer ‐ sideways printing, no black mark
08 Thermal printer ‐ sideways printing, black mark
7 Journal Printer. See Table Note 47.
00 Not configured
01 Integral journal printer
02 Reserved
03 Thermal printer
80 Electronic journal
81 Electronic journal and integral journal printer.
82 Reserved
83 Electronic journal and thermal printer.
8 Reserved
00 Not configured
9 Reserved
00 Not configured
10 Night Safe Depository. See Table Note 47.
00 Not configured
01 Configured
02 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-41
Terminal to Central Messages
Solicited Status Messages
Byte Device
11 Encryptor. See Table Note 47.
?0 Not configured
?1 BAPE encryptor.
02 Reserved
03 Reserved
04 Reserved
05 Reserved
06 Reserved
?7 EPP encryptor
? = SST key entry mode (0, B, C or D) where:
0 = single‐length keys without XOR key entry
B = single‐length keys with XOR key entry
C = double‐length keys
D = double‐length keys, restricted mode. See Table
Note 50
For example, C7 = double‐length key entry with an EPP
encryptor.
12 Security Camera
00 Not configured
01 Fixed format
02 Variable format
03 Reserved
04 Digital
13 Door Access (Not supported)
00 Not configured
14 Flex Disk
00 Not configured
01 1.44 MB flex disk connected.
02 2.88 MB flex disk connected
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-42 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Byte Device
15 Tamper Indicating (TI) Bins. See Table Note 47.
Not coin dispenser
00 Not configured
01 Secure cash and insecure cards, and either insecure
deposit bin or no envelope depository (PPD). This
value is always set to 01 as Advance NDC cannot
determine if TI exists in a multi‐vendor environment as
this capability is not supported in CEN XFS.
02 Secure cash, insecure cards and secure deposits. Not
supported
03 Secure cash and cards, and either insecure deposit bin
or no envelope depository (PPD).
(Not supported)
16 Cardholder Keyboard
00 Reserved
01 Standard (BAPE) keyboard
02 EPP keyboard
17 Operator Keyboard
00 Not configured
01 Standard keyboard (basic)
02 Keyboard plus FDKs (enhanced).
18 Cardholder Display/Voice
Bit 0 0 ‐ (always)
Bit 1 0 ‐ (always)
Bit 2 0 ‐ Voice not supported
Bit 2 1 ‐ Voice supported if digital audio present.
Bit 3 0 ‐ Standard FDKs
Bit 3 1 ‐ Touch screen
Bit 4 0 ‐ (always)
Bit 5 0 ‐ (always)
Bit 6 0 ‐ (always)
Bit 7 0 ‐ (always)
19 7F No configuration
20 7F No configuration
21 Statement Printer See Table Note 47.
00 Not configured
01 Standard statement printer
02 Reserved
03 Reserved
09 Enhanced thermal statement printer (SDC+)
22‐23 Reserved See Table Note 51.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-43
Terminal to Central Messages
Solicited Status Messages
Byte Device
24 Coin Dispenser
00 Not Configured
01 Reserved
02 Coin Dispenser with four hopper types
03 Coin Dispenser with more than four hopper types
25 System Display.
See Table Note 51.
00 Not configured
01 Reserved
02 Configured
26 Media Entry Indicators.
00 Not configured
01 Configured
27 Envelope Dispenser.
See Table Note 47 and Table Note 51.
00 Not configured
01 Configured
02 Reserved
03 Reserved
28 Document Processing Module (Not supported)
See Table Note 51.
00 Not configured
29 Coin Dispensing Module Tamper Indication.
See Table Note 51.
00 Not configured
01 Configured
30 Document Processing Module Tamper Indication. Not
supported.
See Table Note 51.
00 Not configured
31 Reserved. See Table Note 51.
32 Voice Guidance
See Table Note 51
00 Not configured
01 Standard Audio present
02 Enhanced Audio present
33 Reserved. See Table Note 51.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-44 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Byte Device
34 Note Acceptor
See Table Note 47 and Table Note 51
00 Not configured
01 Reserved
02 Reserved
03 Bunch note acceptor
04 Bunch note acceptor with recycle capabilities, also
known as a recycling unit. On NCR SSTs, this is either
a GBRU or BRM. See Table Note 49.
05 Bunch note acceptor. On NCR SSTs, this is called a
GBNA but it can also be reported when a GBRU or
BRM with recycling disabled is present. See Table Note
49
06
Bunch note acceptor that can accept either cash or
cheques but not both in a single transaction.
See Table Note 53
07
Bunch note acceptor that can accept notes and cheques
separately or together in a single transaction.
(Not supported)
08
Single note acceptor
35 Cheque Processor
See Table Note 47 and Table Note 51
00 Not configured
01 Single cheque accept module (CPM)
02 Bunch cheque acceptor
03 Bunch cheque acceptor that can also accept
cash. The device can accept either cash or cheques but
not both in a single transaction. See Table Note 53
04 Bunch cheque acceptor that can also accept
cash. The device can accept both cash and cheques
separately or together in a single transaction.
(Not supported)
36‐37 Reserved. See Table Note 51.
Table Note 47: The relationship between the DIG and the
configuration table offset is: offset = 2 x (DIG - 41 hex).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-45
Terminal to Central Messages
Solicited Status Messages
Table Note 48 The variant of contactless card reader is reported to
host as:
47 in Advance NDC 4.03 and supports only the Magnetic Stripe
Data.
48 from Advance NDC 4.04 and supports both Magnetic Stripe
Data and contactless EMV.
Table Note 49 The M‐Status values reported in device status
messages are specific to the device.
Table Note 50 If an attempt is made to import a key with the same
value as the currently loaded key, the import is rejected with
encryption failure reason ‘D01’.
Table Note 51: These fields are returned only if command modifier
‘6’, “Send enhanced configuration data”, is used. For details, see
“Configuration Information (Command Code = 7)” on page 10‐5 in
table “Terminal Commands” on page 10‐3.
Table Note 52: When dual cash handlers are used, either both cash
handlers must be standard cash handlers or one cash handler must
be a standard cash handler and the other a GBRU. If a GBRU is
used, it must be configured as the primary cash handler.
Table Note 53: An NCR scalable deposit module (SDM) can be
configured as a cheque processor that can accept cash and cheques
or as a cash acceptor that can accept cash and cheques.
Supplies Status—Sub‐field ‘g5’ The media container or resource 9
is identified by the byte position, as shown in the following table:
Table 9-17 Byte position Device indicated
Supplies Status Sub-Field ‘g5’
0 Reserved
1 Reserved
2 Not used (= 0)
3 Card Capture Bin
4 Cash Handler Reject Bin
5 Deposit Bin
6 Receipt Paper
7 Journal Paper
8 Not used (= 0)
9 Not used (= 0)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-46 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Byte position Device indicated
10 Night Safe
11 Not used (= 0)
12 Not used (= 0)
13 Not used (= 0)
14 Not used (= 0)
15 Type 1 Currency Cassettes
16 Type 2 Currency Cassettes
17 Type 3 Currency Cassettes
18 Type 4 Currency Cassettes
19 Not used (= 0)
20 Not used (= 0)
21 Statement Paper
22 Statement Ribbon
23 Reserved, see Table Note 54
24 Reserved, see Table Note 54
25 Envelope Dispenser, see Table Note 54
Table Note 54: These fields are returned only if command modifier
‘6’, “Send enhanced configuration data”, is used. For details, see
“Configuration Information (Command Code = 7)” on page 10‐5.
Supplies Values Each byte indicates the current status of the 9
supples by a numeric value, as shown in the following table, which
gives generic values. A status of ‘0’ ‐ Not configured’ for currency
bins indicates that no cassettes of that type were installed on the last
exit from Supervisor, and no subsequent attempt has been made to
dispense from that type. If attempts are made to dispense from a
cassette type that is not installed, the status changes to ‘3’ ‐ Media
out.
For details of differences for specific devices, see “Supplies Data” on
page E‐12.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-47
Terminal to Central Messages
Solicited Status Messages
Table 9-18 Supplies Value Meaning
Supplies Status Values
0 Not configured
1 Good state
2 Media low
3 Media out
4 Overfill
Hardware Configuration Data Only 9
This solicited status message is sent to the host in response to a Send
Configuration Information terminal command with a command
code of ‘7’ and a command modifier of ‘1’.
The message contains all the available information relating to the
hardware configuration of the SST and must be used where devices
other than those returned in a Configuration Message are present or
thought to be present in the SST.
The following table describes the format and contents of field ‘g’ for
this message:
Table 9‐19
Hardware Configuration Data Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘H’.
g2 1 M Configuration ID Identifier ‘A’.
Var (4) M Configuration ID. This four‐character field contains the last
four‐digit configuration ID number, in the range 0000‐9999, sent to
the terminal from the host.
FS 1 M Field Separator
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-48 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
g3 1 M Product Class Identifier ‘B’.
Var (2) M Product Class. This two‐character field contains the Product Class
of the SST. The following entries are possible, but this does not
mean that Advance NDC supports all these classes:
‘0E’ ‐ 5663
‘0F’ ‐ 5674
‘10’ ‐ 5675
‘11’ ‐ 5684
‘12’ ‐ 5685
‘13’ ‐ 5688
‘14’ ‐ 5665
‘15’ ‐ 5670
‘16’ ‐ Personas 75
‘17’ ‐ Personas 88
‘18’ ‐ Personas 40
‘19’ ‐ Personas 70
‘1A’ ‐ Personas 74
‘1B’ ‐ Personas 84
‘1C’ ‐ Personas 85
‘1D’ ‐ Personas 90
‘1E’ ‐ EasyPoint 55 or EasyPoint 57
‘1F’ ‐ Personas 86
‘20’ ‐ 5588
‘21’ ‐ Personas 73
‘22’ ‐ Personas 72
‘23’ ‐ Personas 77
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-49
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
‘24’ ‐ 6674
‘25’ ‐ 6676
‘26’ ‐ 5879
‘27’ ‐ 5887
‘28’ ‐ 5362
‘29’ ‐ Personas 71
‘2A’ ‐ 5867
‘30’ ‐ 6622
‘31’ ‐ 6624
‘32’ ‐ 6626
‘33’ ‐ 6628
‘34’ ‐ 6631
‘35’ ‐ 6632
‘36’ ‐ 6634
‘37’ ‐ 6638
‘38’ ‐ 6625
‘39’ ‐ 6618
‘3A’ ‐ 6636
‘3B’‐ 2012 (SelfServ 22e)
‘3C’ ‐ 2016 (SelfServ 16)
‘3D’ ‐ 6642 (SelfServ 42)
‘3E’ ‐ 2004 (SelfServ 4)
‘3F’ ‐ 2008 (SelfServ 8)
‘40’ ‐ 2014 (SelfServ 14)
‘41’ ‐ 6691
‘42’ ‐ 6623
‘43’ ‐ 6627
‘44’ ‐ 6683
‘45’ ‐ 6687
FS 1 M Field Separator
g4 1 M Hardware Configuration Identifier ‘C’.
This field contains hardware configuration information for each of
the devices present in the SST. It is divided into a series of subfields
separated by group separators.
If a device is not present, there will be no corresponding DIG in the
field.
1 O Device Identifier Graphic (DIG). This identifies the device to which
See Table Note 55 the following hardware configuration data applies. For details, see
“Hardware Configuration Data” on page E‐2.
Var O Hardware Configuration. This contains information for each device
See Table Note 55 indicating which variant of the device is configured and any other
configuration data available. For details, see “Hardware
Configuration Data” on page E‐2.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-50 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
1 O Group Separator.
See Table Note 56
1 O Device Identifier Graphic (DIG).
See Table Note 56
Var O Hardware Configuration.
See Table Note 56
g5 1 O Field Separator.
See Table Note 57
1 O Device Identifier Graphic (DIG).
See Table Note 57
Var O Data.
See Table Note 57
Table Note 55: The DIG and its associated data form a group. When
the DIG is present, all elements of this group must be present.
Table Note 56: The DIG and its associated data, together with the
preceding group separator form a group. When the DIG is present,
all elements of this group must be present. Such groups are repeated
as often as necessary to ensure that the data relating to all devices
present in the SST is reported.
Table Note 57: These fields are reserved for future expansion.
Note Acceptor Capabilities Advance NDC can additionally 9
report the capabilities of the hardware device variant identified in
characters 1 and 2. If configured to do so, characters 3 to 6 are used
to report the capabilities and are an ASCII representation of a
hexadecimal number (in the range 0000 to FFFF). Each bit reports
whether a capability is supported or not. The following capabilities
can be reported:
Table 9‐20 Bit Value Description
Note Acceptor Capabilities
0 (Escrow capabilities) 0 The device has no escrow
1 The device has an escrow
1 (Direct deposit 0 The device does not support direct
capabilities) deposit
1 The device supports direct deposit
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-51
Terminal to Central Messages
Solicited Status Messages
Examples of the data returned are shown in the following table:
Table 9-21 Value Description
Note Acceptor Capabilities: Example Data
050003 GBNA supporting direct deposit
030001 BNA with an escrow but not supporting direct deposit
080002 SNA without an escrow and supporting only direct deposit
The additional data is reported only if the
ReportExtendedHardwareConfiguration property on
CashInStatusHandler is set to true (the default) in
CashInCustom.accfg. For details, refer to section “Configuring Note
Acceptors” in Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC Developer’s
Guide.
The host application must be able to support both SSTs that return
the additional data and those that do not. Devices that do not have
an escrow and therefore can only be used in Direct Deposit mode
require an application flow designed to accommodate the fact that
notes cannot be refunded.
If the network supports SSTs that have devices with escrows and
devices without escrows, different state flows may have to be
downloaded to the different SSTs. Identification of devices that
support direct deposit can only be achieved if the NDC application
reports characters 3 to 6 and the host can interpret the content of
these characters.
Supplies Data 9
This solicited status message is sent to the host in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘2’). For details,
see “Terminal Commands” on page 10‐3.
For more information about the reporting of CIM NDC cassette
types, see “Reporting of CIM NDC Cassette Types” on page 9‐24.
Note: If enhanced configuration option 83, described on page 7‐21,
is set to ‘000’, no supplies data is sent to the host for the cheque
processor.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-52 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Table 9-22
Supplies Data Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘I’.
g2 1 M Supplies Status Identifier ‘A’.
This field contains supplies information for each of the devices
present in the SST. It is divided into a series of sub‐fields separated
by group separators.
If a device is not present or has no associated replenishables, then
there will be no supporting Device Identifier Graphic (DIG) in the
field.
1 O Device Identifier Graphic (DIG). This identifies the device to which
See Table Note 58 the following supplies status data applies. For details, see Chapter E,
“Device Identifiers”.
Var O Supplies Status. This contains information for each device indicating
See Table Note 58 the condition of the device’s replenishables. For details, see
“Supplies Data” on page E‐12.
Except for cash acceptors—see “Cash Acceptor Supplies (DIG ‘w’)”
on page E‐17— each element of the supplies status data will take one
of the following values:
Value Description
‘0’ Not configured/reserved
‘1’ Good state
‘2’ Media low
‘3’ Media out
‘4’ Overfill
1 O Group Separator.
See Table Note 59
1 O Device Identifier Graphic (DIG).
See Table Note 59
Var O Supplies Status.
See Table Note 59
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-53
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
g3 1 O Field Separator
See Table Note 60
1 O Data Identifier.
See Table Note 60
Var O Data.
See Table Note 60
Table Note 58: The DIG and its associated data, together with the
preceding group separator form a group. When the DIG is present,
all elements of this group must be present.
Table Note 59: The DIG and its associated data, together with the
preceding group separator form a group. When the DIG is present,
all elements of this group must be present. Such groups are repeated
as often as necessary to ensure that the data relating to all devices
present in the SST is reported.
Table Note 60: These fields are reserved for future expansion.
Fitness Data 9
This solicited status message is sent to the host in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘3’). For details,
see “Terminal Commands” on page 10‐3.
For more information about the reporting of CIM NDC cassette
types, see “Reporting of CIM NDC Cassette Types” on page 9‐24.
Table 9-23
Fitness Data Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘J’.
g2 1 M Hardware Fitness Identifier ‘A’.
This field contains fitness information for each of the devices present
in the SST. It is divided into a series of sub‐fields separated by group
separators.
1 O Device Identifier Graphic (DIG). This identifies the device to which
See Table Note 61 the following fitness data applies. For details, see Appendix E,
“Device Identifiers”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-54 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
Var O Fitness. Each fitness character is encoded with one of the following
See Table Note 61 error severity values, indicating the current fitness of the device:
Char Severity
‘0’ No error/not supported
‘1’ Routine errors have occurred
‘2’ Warning conditions have occurred ‐ investigation is
required
‘3’ Suspend. The SST is currently in the suspend state due to
suspected tampering with this device
‘4’ Fatal error condition exists on this device
Routine, warning and fatal errors can only be cleared by local
Supervisor functions.
For details, see “Fitness Data” on page E‐20.
1 O Group Separator.
See Table Note 62
1 O Device Identifier Graphic (DIG).
See Table Note 62
Var O Fitness
See Table Note 62
g3 1 O Field Separator
(Present for future expansion)
1 O Data Identifier
(Present for future expansion)
Var O Data ‐ present for future expansion
(Present for future expansion)
Table Note 61: The DIG and its associated data, together with the
preceding group separator form a group. When the DIG is present,
all elements of this group must be present.
Table Note 62: The DIG and its associated data, together with the
preceding group separator form a group. When the DIG is present,
all elements of this group must be present. Such groups are repeated
as often as necessary to ensure that the data relating to all devices
present in the SST is reported.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-55
Terminal to Central Messages
Solicited Status Messages
Tamper and Sensor Status Data 9
This solicited status message is sent to the host in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘4’). For details,
see “Terminal Commands” on page 10‐3 . This status message
reports physical cassettes, including cassettes other than cash‐in
cassettes when the device is a combined cash‐in/cash‐out device.
Table 9-24
Tamper and Sensor Data Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘K’.
g2 1 M Sensor Status Identifier ‘A’.
Var (5) M Sensor Status. This five‐character field contains one byte per sensor
and is identical to the information reported in bytes 2‐6 of the Sensors
Status message. For details, see the “Sensors (Unsolicited)” section.
1 M Field Separator
g3 1 M Tamper Indicator Identifier ‘B’.
Var M Tamper Status. This field contains the status of the TI sensors. If the TI
feature is not configured, this field, with the buffer identifier, will not
be present.
The contents of the tamper status data field are as follows:
Char Code
1‐7 Identical to bytes 7‐13 of the Sensors Status message,
described in the “Sensors (Unsolicited)” section.
8 ‘0’ Coin Dispenser out.
‘1’ Coin Dispenser in.
9 ‘0’ Coin Dispenser Hopper 1 out.
‘1’ Coin Dispenser Hopper 1 in.
10 ‘0’ Coin Dispenser Hopper 2 out.
‘1’ Coin Dispenser Hopper 2 in.
11 ‘0’ Coin Dispenser Hopper 3 out.
‘1’ Coin Dispenser Hopper 3 in.
12 ‘0’ Coin Dispenser Hopper 4 out.
‘1’ Coin Dispenser Hopper 4 in.
13 Not supported
If a device is not configured, any associated TI byte will take the value
‘0’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-56 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
g4 1 O Extended Tamper Indicator Identifier ‘C’. See Table Note 63
1 See Table Note Device Identifier Graphic (DIG). This field contains data on each
64 and Table device present in the SST.
Note 65
Var See Table Note Tamper Status.
64 and Table This field contains the condition of the TI sensors. If the TI feature is
Note 65 not configured, this field, with the buffer identifier, will not be present.
The length of the configuration data varies depending on the device
being reported.
For details, see Tamper Indicator Identifier ‘B’.
1 O Group Separator
1 O Device Identifier Graphic (DIG). This field contains data on each
device present in the SST.
For details, see “Tamper Data” on page E‐27.
Var O Tamper Status. This field contains the condition of the TI sensors. If
the TI feature is not configured, this field, with the buffer identifier,
will not be present.
For details, see Tamper Indicator Identifier ‘B’.
g5 1 See Table Note Field Separator.
66
1 See Table Note Data Identifier.
66
Var See Table Note Data.
66
Table Note 63: The setting of Enhanced Configuration option 24
determines whether the extended tamper information is sent. For
details of option 24, see “Option 24 – Enhanced/TI Sensor Status
Unsolicited Message” on page 7‐9.
Table Note 64: The DIG and associated data are a group. If the DIG
is present, all the elements of the group must also be present.
Table Note 65: A DIG and associated data are included as often as
required to report on all devices.
Table Note 66: These fields are present for future expansion.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-57
Terminal to Central Messages
Solicited Status Messages
Software ID and Release Number Data 9
This solicited status message is sent to the host in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘5’). For details,
see “Terminal Commands” on page 10‐3.
Table 9-25
Software ID and Release Number Data
Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘L’
g2 1 M Buffer Identifier ‘A’
NDC Release Number
Var (6) M Contains a six‐digit decimal number. The first pair of digits represent
the release number. The second pair of digits represent the point
release number. The third pair of digits represent the patch release
number.
For example, 040300 is release 4.03
FS 1 M Field Separator
g3 1 M Buffer Identifier ‘B’
Var (9) M NDC Software ID.
Contains the software ID of the Advance NDC product currently
running on the SST, as follows:
G531‐0283 (for the Advance NDC package)
If the Advance NDC software ID is unavailable, this field contains
nine blanks.
g4 1 O Field Separator. This field is present for future expansion.
1 O Data Identifier. This field is present for future expansion.
Var O Data. This field is present for future expansion.
Enhanced Configuration Data 9
This solicited status message is sent to the host in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘6’). It returns all
the configuration information available.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-58 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
For details of this message, see “Send Configuration Information”
on page 9‐34. Enhanced information is included in sub‐fields ‘g3’,
‘g4’ and ‘g5’ as described in the following sections:
“Hardware Fitness—Sub‐field ‘g3’” on page 9‐35
“Hardware Configuration Data—Sub‐Field ‘g4’” on page 9‐38
“Supplies Status—Sub‐field ‘g5’” on page 9‐46.
Local Configuration Option Digits 9
This solicited status message is sent to the host in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘7’).
In Advance NDC, the option digits settings are automatically saved
to persistent storage, and hence are used on power failure recovery.
Some options are not supported. For details, refer to the APTRA
Advance NDC, Developer’s Guide.
Table 9-26
Local Configuration Option Digits
Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘M’.
g2 1 M Local Options Identifier ‘A’.
Var (16) M Local Option Digits. These characters represent the values of the Local
Option Digits, entered using the MSG MODE option on the Configure
menu in Supervisor mode. For details, refer to the APTRA Advance
NDC, Supervisor’s Guide.
Each character is an ASCII representation of the associated Option
Digit.
g3 1 O Field Separator. Reserved for future expansion.
1 O Data Identifier. Reserved for future expansion.
Var O Data. Reserved for future expansion.
Report Cash Deposit Definition 9
This solicited status message is sent to the host in response to a Send
Cash Deposit Definition terminal command message (a command
code of ‘7’ with a command modifier of ‘8’).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-59
Terminal to Central Messages
Solicited Status Messages
Table 9-27
Note Definitions (BNA) Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier (‘N’)
g2 1 M Accepted Cash Items Identifier (‘A’)
Var (11) O Cash type information, 11 characters for each type up to a maximum
of 50 cash types.
See Table Note 67 and Table Note 68.
FS 1 O See Table Note 69
g3 1 O ECB 6 Note Retention Mode ID (ʹDʹ)
3 O ECB 6 Note Retention Mode
FS 1 O See Table Note 69
1 O Data Identifier. Reserved for future expansion
Var O Data. Reserved for future expansion
Table Note 67: This field is repeated for each item type recognized
by the deposit module. For note acceptors, NDC note type mapping
is performed when Advance NDC is started. For more information,
refer to the APTRA Advance NDC, Developer’s Guide.
Table Note 68: Each cash item type consists of 11 bytes with the
following format:
# B B I S O V A L U E
which is interpreted as follows:
Byte Meaning
# Active indicator (! = inactive)
If the note is identified as active, it can be accepted by the
BNA. If the note is identified as inactive it is rejected.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-60 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Byte Meaning
BB Cash item identifier
Bit positions (01H ‐ 32H)
ISO Three‐character ISO 4217 Country Code (for example, USD =
US dollar)
VALUE The value of the item, padded right with spaces. To allow
values that require more than 5 characters to represent the
value a multiplier is appended to the value as follows:
One thousand is represented as 1K
Ten thousand is represented as 10K
One hundred thousand is represented as 100K
One hundredth of the currency unit is represented as 1c.
The multiplier character must be contained within the 5
available characters for the value.
The following multipliers are defined:
c = 10-2
K = 103
M = 106
G = 109
T = 1012
X = Value cannot be represented
Table Note 69: The field separators must be present if any other
fields follow.
Table Note 70: If the following message is returned, use INIT BNA
to clear the device and populate the Cash Item type message, as
follows:
22<fs>000<fs><fs>F<fs>NA
The “NA” at the end of the message is returned as the device is in a
bad state and an attempt has been made to initialise the device.
Send Supply Counters 9
This Solicited Status message is sent to the host in response to a
Send Counters Terminal Command message. Depending on the
modifier used with the command code of ‘4’, the basic or extended
message is used. For details of the Terminal Command message, see
“Terminal Commands” on page 10‐3.
For the basic message format, see the next heading and for the
extended message format, see “Extended Send Supply Counters” on
page 9‐67.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-61
Terminal to Central Messages
Solicited Status Messages
Basic Send Supply Counters The basic message format can report 9
the following:
Four cassette types. In a dual cash handler system it reports the
combined number of notes for each cassette type.
Four coin hopper types.
Table 9-28
Send Supply Counters Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘2’.
g2 4 M Transaction Serial Number (TSN). Contains the TSN of the last
transaction processed by the SST. If this does not correspond to
the last TSN sent by the host, it means that the transaction has
not been initiated and the counters have not been updated.
g3 7 M Accumulated Transaction Count. Defines the total number of
detected transaction attempts since the SST was installed or the
non‐volatile SST memory was last corrupted. The count is reset
to 0 after 9,999,999 transactions.
A transaction attempt is detected when it is recognised that the
TSN received from the host is different from the previously
received TSN.
g4 20 M Notes In Cassettes. Consists of four five‐digit decimal counts of
the total number of notes remaining in cassette types 1, 2, 3 and
4. The counts are set by supervisor functions and are
decremented on each dispense transaction. These counts are
zero if not set by an ‘Add Cash’ or ‘Set Standard Cash’
supervisor function. The count contains 65535 (the decimal
equivalent of 0FFFF hex) if more notes have been dispensed
from a cassette than it has been set to contain, or if notes are
dispensed from a cassette type that has not been set.
If dual cash handlers are used, the combined number of notes
for the cassette type is reported. Only four cassette types are
reported, regardless of the setting of the Enhanced
Configuration option 76.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-62 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
g5 20 M Notes Rejected. Consists of four five‐digit decimal counts of the
total number of notes moved to the reject bin from cassette
types 1, 2, 3 and 4.
If dual cash handlers are used, the combined number of notes
for the cassette type is reported. Only four cassette types are
reported, regardless of the setting of the Enhanced
Configuration option 76.
Although fields ‘g4’ and ‘g5’ may not be totally accurate, the
sum of these counts for a particular cassette type does
accurately represent the difference between the original
number of notes added and the number of notes dispensed.
g6 20 M Notes Dispensed. Consists of four five‐digit decimal counts of
the total number of notes dispensed from cassette types 1, 2, 3
and 4. These counts are consistent with note counts reported
since the counts were last cleared by a supervisor transaction.
If dual cash handlers are used, the combined number of notes
for the cassette type is reported. Only four cassette types are
reported, regardless of the setting of the Enhanced
Configuration option 76.
If a transaction is prematurely stopped by a power failure,
these counts are updated to reflect the number of notes
dispensed up to the time of power failure.
g7 20 M Last Transaction Notes Dispensed. Consists of four five‐digit
decimal counts of the number of notes dispensed on the last
transaction processed by the SST. This field allows the host to
recover note counts after power failure, even if the power
failure occurred in the middle of a dispense operation.
g8 5 M Cards Captured. Consists of one five‐digit decimal count of the
number of cards captured since the count was cleared by a
supervisor transaction. The count includes cards captured up to
and including the transaction defined in field ‘g2’.
See Table Note 72
g9 5 M Envelopes Deposited. Consists of one five‐digit decimal count
of the number of envelopes deposited since the count was last
cleared by a Supervisor transaction. The count includes
envelopes deposited up to and including the transaction
defined in field ‘g2’.
g10 5 M Camera Film Remaining. The camera film remaining is always
00000.
g11 5 M Last Envelope Serial Number. This is always 00000.
g12 1 O Reserved.
GS 1 See Table Note 71 Group Separator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-63
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
g20‐g22 Var(15) O Reserved.
GS 1 See Table Note 71 Group Separator.
g30‐g32 Var(15) O Reserved.
GS 1 See Table Note 71 Group Separator.
g40‐g4x Var(x) O Reserved.
GS 1 See Table Note 71 Group Separator.
g50‐g53 Var(20) O Reserved.
GS 1 See Table Note 71 Group Separator.
g60 Var(20) O Coins remaining
See Table Note 73
g61 Var(20) O Coins dispensed
See Table Note 73
g62 Var(20) O Last transaction coins dispensed
See Table Note 73
GS 1 See Table Note 71 Group Separator.
g70 5 O Total notes refunded
See Table Note 74
g71 5 O Total notes rejected
See Table Note 74
g72 5 O Total notes encashed
See Table Note 74
g73 5 O Total notes escrowed
See Table Note 74
GS 1 See Table Note 71 Group Separator.
g80‐g89 5 O Reserved.
GS 1 See Table Note 71 Group Separator.
g90‐g99 5 O Reserved.
GS 1 See Table Note 71 Group Separator.
g100‐ 5 O Reserved.
g109
GS 1 See Table Note 71 Group Separator.
g110‐ 5 O Reserved.
g119
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-64 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
GS 1 See Table Note 71 Group Separator.
g120 5 O Cheque processor cheques deposited into BIN1
g121 5 O Cheque processor cheques deposited into reject/retain BIN2
g122 5 O Cheque processor cheques deposited into BIN3
g12n 5 O Cheque processor cheques deposited into BINn‐1
GS 1 See Table Note 71 Group Separator.
g130‐ 5 O Reserved.
g139
GS 1 See Table Note 71 Group Separator.
g140 5 O Reserved.
GS 1 See Table Note 71 Group Separator.
g150‐ 5 O Reserved.
g154
GS 1 See Table Note 71 Group Separator.
g160 5 O Number of passbooks captured.
Table Note 71: If any optional group is present, all of the group
separators preceding it will be included, enabling the host to
identify the group field by its position. (This applies to the basic
message format only; the handling of group separators in the
extended message format is described in “Extended Send Supply
Counters” on page 9‐67.)
Table Note 72: Cards Captured field is reported as zero when the
contactless card reader is the primary card reader.
Table Note 73: Fields ‘g60’ ‐ ‘g62’ form a group and will only be
present if a coin dispenser is present.
Table Note 74: Fields ‘g70’ ‐ ‘g73’ form a group and will only be
present if a BNA is present.:
Fields ‘g120’ ‐ ‘g129’ form a group and will only be present if a
cheque processor is present.
Example Message Analysis The following example shows a 9
message sent from an SST in response to a basic Send Supply
Counters command from the host. The SST has four cassette types
but no coin, cheque or passbook capabilities:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-65
Terminal to Central Messages
Solicited Status Messages
22<FS>000<FS><FS>F<FS>202730000267012670168101629007780000300052000020000200194001330113100
2800000000005000000000000000000000000000000
The content of this message is described in the following table:
Table 9-29
Status Message Description
Message Content Field Description
2 b A solicited message
2 c A status message
000 d LUNO
F f Sent in response to a Terminal Command requesting supply
counters, terminal configuration information, or the date and time
2 g1 The Terminal Command has requested supply counters
0273 g2 Transaction Serial Number
0000267 g3 Accumulated transaction count
01267 g4 Number of notes in cassette 1
01681 Number of notes in cassette 2
01629 Number of notes in cassette 3
00778 Number of notes in cassette 4
00003 g5 Number of rejected notes in cassette 1
00052 Number of rejected notes in cassette 2
00002 Number of rejected notes in cassette 3
00002 Number of rejected notes in cassette 4
00194 g6 Number of notes dispensed from cassette 1
00133 Number of notes dispensed from cassette 2
01131 Number of notes dispensed from cassette 3
00280 Number of notes dispensed from cassette 4
00000 g7 Number of notes dispensed from cassette 1 in the last transaction
00005 Number of notes dispensed from cassette 2 in the last transaction
00000 Number of notes dispensed from cassette 3 in the last transaction
00000 Number of notes dispensed from cassette 4 in the last transaction
00000 g8 Number of captured cards
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-66 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Message Content Field Description
00000 g9 Number of deposited envelopes
00000 g10 Amount of remaining camera film. This is always 00000
00000 g11 Last Envelope Serial Number. This is always 00000
Extended Send Supply Counters The extended message format 9
supports the reporting of up to eight coin hoppers. The counts are
grouped and separated by group separators.
Table 9-30
Send Supply Counters: Extended
Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘7’.
g2 1 Transaction group id ‘A’.
g3 4 M Transaction Serial Number (TSN). Contains the TSN of the last
transaction processed by the SST. If this does not correspond to the
last TSN sent by the host, it means that the transaction has not been
initiated and the counters have not been updated.
g4 7 M Accumulated Transaction Count. Defines the total number of
detected transaction attempts since the SST was installed or the
non‐volatile SST memory was last corrupted. The count is reset to 0
after 9,999,999 transactions.
A transaction attempt is detected when it is recognised that the TSN
received from the host is different from the previously received
TSN.
GS 1 See Table Note 75 Group Separator.
g5 1 See Table Note 75 Card Reader data group ID ‘B’
g6 5 M Cards Captured. Consists of one five‐digit decimal count of the
number of cards captured since the count was cleared by a
supervisor transaction. The count includes cards captured up to and
including the transaction defined in field ‘g3’.
See Table Note 76
GS 1 See Table Note 75 Group Separator.
g7 1 See Table Note 75 Cash Handler 0 data group ID ‘C’
g8 3 See Table Note 75 Cassette Type. Consists of one three‐digit identifier of the cassette
and Table Note 78 type being reported on. The identifier can be between 000 and 007
depending on the cash handler configuration.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-67
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
g9 5 See Table Note 75 Notes In Cassettes. Consists of a five‐digit decimal count of the
and Table Note 78 number of notes in the cassette.
g10 5 See Table Note 75 Notes Rejected. Consists of a five‐digit decimal count of the number
and Table Note 78 of reject notes.
Although fields ‘g9’ and ‘g10’ may not be totally accurate, the sum
of these counts accurately represents the difference between the
original number of notes added and the number of notes dispensed.
g11 5 See Table Note 75 Notes Dispensed. Consists of a five‐digit decimal count of the
and Table Note 78 number of dispensed notes.
If a transaction is prematurely stopped by a power failure, these
counts are updated to reflect the number of notes dispensed up to
the time of power failure.
g12 5 See Table Note 75 Last Transaction Notes Dispensed. Consists of a five‐digit decimal
and Table Note 78 count of the number of notes dispensed during the last transaction.
g13 5 See Table Note 75, Notes Deposited. Consists of a five‐digit decimal count of the total
Table Note 78 and number of deposited notes.
Table Note 80
GS 1 See Table Note 75 Group Separator.
g14 1 See Table Note 75 Cash Handler 1 data group ID ‘D’
g15 3 See Table Note 75 Cassette Type. Consists of one three‐digit identifier of the cassette
and Table Note 78 type being reported on. The identifier can be between 000 and 007
depending on the cash handler configuration.
g16 5 See Table Note 75 Notes In Cassettes. Consists of one five‐digit decimal count of the
and Table Note 78 number of notes in the cassette.
g17 5 See Table Note 75 Notes Rejected. Consists of a five‐digit decimal count of the number
and Table Note 78 of reject notes.
Although fields ‘g16’ and ‘g17’ may not be totally accurate, the sum
of these counts accurately represents the difference between the
original number of notes added and the number of notes dispensed.
This is because notes presented but not taken and then retracted are
sent to the reject bin. In this scenario, the Notes Rejected count is not
increased, but the Notes In Cassettes count is decremented.
g18 5 See Table Note 75 Notes Dispensed. Consists of a five‐digit decimal count of the
and Table Note 78 number of dispensed notes.
If a transaction is prematurely stopped by a power failure, these
counts are updated to reflect the number of notes dispensed up to
the time of power failure.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-68 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
g19 5 See Table Note 75 Last Transaction Notes Dispensed. Consists of a five‐digit decimal
and Table Note 78 count of the number of notes dispensed during the last transaction.
g20 5 See Table Note 75, Notes Deposited. Consists of a five‐digit decimal count of the
Table Note 78 and number of deposited notes.
Table Note 80
GS 1 See Table Note 75 Group Separator.
g21 1 See Table Note 75 Coin dispenser data group ID ‘E’.
g22 2 See Table Note 75 Hopper Type Number. Consists of one two‐digit identifier of the
and Table Note 79 hopper type being reported on. The identifier can be between 01
and 08 depending on the coin hopper configuration.
g23 5 See Table Note 75 Coins Remaining. Consists of a five‐digit decimal count of the total
and Table Note 79 number of coins remaining in the hopper type identified in field
g22. The counts are set by supervisor functions and are
decremented on each dispense transaction. These counts are zero if
not set by an ‘Add Coins’ or ‘Std Coins’ supervisor function. The
count is set to 65535 (the decimal equivalent of 0FFFF hex) if more
coins have been dispensed from a hopper than it has been set to
contain, or if coins are dispensed from a hopper type that has not
been set.
g24 5 See Table Note 75 Coins Dispensed. Consists of a five‐digit decimal count of the total
and Table Note 79 number of coins dispensed from the hopper type identified in field
g22. This count is consistent with coin counts reported since the
counts were last cleared by a supervisor transaction.
g25 5 See Table Note 75 Last Transaction Coins Dispensed. Consists of a five‐digit decimal
and Table Note 79 count of the number of coins dispensed on the last transaction
processed by the SST. This field allows Central to recover coin
counts after power failure, even if the power failure occurred in the
middle of a dispense operation.
g26 5 See Table Note 75, Coins Deposited. Consists of a five‐digit decimal count of the total
Table Note 79, and number of coins deposited from the hopper type identified in field
Table Note 80 ‘g22’. This count is consistent with coin counts reported since the
counts were last cleared by a supervisor transaction.
GS 1 See Table Note 75 Group Separator.
g27 1 See Table Note 75 Envelope Depository data group ID ‘F’
g28 5 See Table Note 75 Envelopes Deposited. Consists of one five‐digit decimal count of the
number of envelopes deposited since the count was last cleared by a
Supervisor transaction. The count includes envelopes deposited up
to and including the transaction defined in field ‘g3’.
g29 5 See Table Note 75 Last Envelope Serial Number. The last envelope serial number is
always 00000.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-69
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
GS 1 See Table Note 75 Group Separator.
g30 1 See Table Note 75 Camera data group ID ‘G’.
g31 5 See Table Note 75 Camera Film Remaining. The camera film remaining is always
00000.
GS 1 See Table Note 75 Group Separator.
g32 1 See Table Note 75 DPM data group ID ‘H’. Not supported.
g33 2 See Table Note 75 Deposit Bin Identifier. Not supported.
g34 5 See Table Note 75 Documents Deposited in Bin. Not supported.
and Table Note 110
GS 1 See Table Note 75 Group Separator.
g35 1 See Table Note 81 BNA Cassette Counts data group ID ‘I’.
and Table Note 82
g36 3 See Table Note 81, NDC Cassette Type. Consists of one three‐digit identifier. The
Table Note 82 identifier can be between 001 and 999.
and Table Note 83
g37 5 See Table Note 81, Total Notes In Cassette. Consists of a five‐digit decimal count of the
Table Note 82 number of notes in the cassette.
and Table Note 83
g38 3 See Table Note 81, Number of Note Types Reported. This is a value in the range ‘000’
Table Note 82 to ‘999’
and Table Note 83
g39 4 See Table Note 81, Note Type Identifier. This is a value in the range’0001’ to ‘FFFF’
Table Note 82
and Table Note 84
g40 5 See Table Note 81, Number of notes of the type identified by the note type identifier in
Table Note 82, field ‘g39’. Consists of a five‐digit decimal count of the number of
Table Note 84 and notes of an identified type.
Table Note 85
GS 1 See Table Note 75 Group Separator.
g41 1 See Table Note 86 Cheque processor data group ID ‘J’
g42 1 See Table Note 86 Bin Number
and Table Note 87
g43 5 See Table Note 86 Cheques deposited in bin
and Table Note 87
GS 1 See Table Note 75 Group Separator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-70 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
g44 1 See Table Note 88 BNA Emulation (and Extended Emulation) deposit data group ID
‘K’
g45 5 See Table Note 88 Total Notes Refunded
and Table Note 89
g46 5 See Table Note 88, Total Notes Returned Rejected
Table Note 89 and
Table Note 92
g47 5 See Table Note 88 Total Notes Encashed
and Table Note 89
g48 5 See Table Note 88 Total Notes Escrowed
and Table Note 89
GS 1 See Table Note 75 Group Separator.
g49 1 See Table Note 75, Dual Dispenser combined data group ID ‘l’
Table Note 80 and
Table Note 90
g50 3 See Table Note 83 Cassette Type. Consists of one three‐digit identifier. The identifier
can be between 001 and 007 depending on the cash handler
configuration.
g51 5 See Table Note 83 Notes in Cassette. Consists of a five‐digit decimal count of the
number of notes in the cassette.
g52 5 See Table Note 83 Notes Rejected. Consists of a five‐digit decimal count of the number
of reject notes.
g53 5 See Table Note 83 Notes Dispensed. Consists of a five‐digit decimal count of the
number of dispensed notes.
g54 5 See Table Note 83 Last Transaction Notes Dispensed. Consists of a five‐digit decimal
count of the number of notes dispensed during the last transaction.
g55 5 See Table Note 83 Notes Deposited. Consists of a five‐digit decimal count of the
and Table Note 91 number of deposited notes.
GS 1 See Table Note 75 Group Separator.
g58 1 See Table Note 81 ECB 6 Category 2 Notes data group ID ‘N’
Not supported by Advance NDC.
g59 3 See Table Note 81 NDC Cassette Type. Consists of one three‐digit identifier of the
and Table Note 83 cassette type. The identifier can be between 001 and 999 depending
on the cash handler configuration.
g60 5 See Table Note 81 Total Number Category 2 Notes. Consists of a five‐digit decimal
and Table Note 83 count of the number of deposited notes identified as counterfeit
under ECB 6.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-71
Terminal to Central Messages
Solicited Status Messages
Number of
Field Mandatory/Optional Description
Characters
g61 3 See Table Note 81 Number of Reported Category 2 Note Types. Consists of a
and Table Note 83 three‐digit count of the number of deposited note types being
reported as counterfeit under ECB 6. The count can be between 000
and 999.
g62 4 See Table Note 81 Category 2 Note Type Identifier. Consists of one four‐digit identifier
and Table Note 84 of the note type reported as counterfeit under ECB 6. The identifier
can be between 0001 and FFFF.
g63 5 See Table Note 81 Category 2 Notes. Consists of a five‐digit decimal count of the total
and Table Note 84 number of notes of the note type in field g62 identified as
counterfeit under ECB 6.
GS 1 See Table Note 75 Group Separator.
g64 1 See Table Note 81 ECB 6 category 3 notes group data id ‘O’
Not supported by Advance NDC.
g65 3 See Table Note 81 NDC Cassette Type. Consists of one three‐digit identifier of the
and Table Note 83 cassette type being reported on. The identifier can be between 001
and 999 depending on the cash handler configuration.
g66 5 See Table Note 81 Total Number Category 3 Notes. Consists of a five‐digit decimal
and Table Note 83 count of the number of deposited notes identified as category 3
under ECB 6.
g67 3 See Table Note 81 Number of Reported Category 3 Note Types. Consists of a
and Table Note 83 three‐digit count of the number of deposited note types being
reported as category 3 under ECB 6. The count can be between 000
and 999.
g68 4 See Table Note 81 Category 3 Note Type Identifier. Consists of one four‐digit identifier
and Table Note 84 of the note type reported as category 3 under ECB 6. The identifier
can be between 0001 and FFFF.
g69 5 See Table Note 81 Category 3 Notes. Consists of a five‐digit decimal count of the total
and Table Note 84 number of notes of the note type identified in field g62 identified as
category 3 under ECB 6.
GS 1 See Table Note 75 Group Separator.
g78 1 Second Card Reader data group id ‘T’
g79 5 See Table Note 77 Cards Captured
Table Note 75: Fields are arranged in groups. The groups included
in the message depend on the presence of devices in the SST. When
a group is present, all counts of that group are included and the
group is terminated by a group separator. In future releases, new
groups may be added and new counts added to the end of existing
groups.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-72 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Table Note 76: Cards Captured is reported as zero when the
contactless card reader is the primary card reader.
Table Note 77: Cards Captured is always reported as zero when
there is a contactless card reader. From Advance NDC 4.04, a
contactless card reader is always the secondary card reader.
Table Note 78: Fields g8 to g13 and g15 to g20 are repeated for each
cassette type present in the dispenser. They will be repeated either
four or seven times depending on the setting of Enhanced
Configuration option 76.
Table Note 79: Fields g22 to g26 are repeated for each configured
hopper type in the coin dispenser.
Table Note 80: These fields used only on devices that can recycle
deposited items.
Table Note 81: These fields are included in Enhanced Cash Deposit
mode.
Table Note 82: These fields are included when bit 3 of Enhanced
Configuration option 45 is set and Enhanced Cash Deposit is not
enabled. For details of option 45, see “Option 45 – BNA Settings” on
page 7‐15.
Table Note 83: Fields g36 to g38, g49 to g55 and g58 to g69 are
repeated for each NDC cassette type.
Table Note 84: Fields g39 and g40 and g58 to g69 are repeated for
each Note Type Identifier within each cassette. These fields are not
present if there are no notes in the cassette.
Table Note 85: Field g40 includes all notes identified as category 2,
category 3, or category 4 under ECB 6.
Table Note 86: Fields g41 to g43 are only included when a cheque
processor is present.
Table Note 87: Fields g42 and g43 report the number of cheques
stored in each bin.
Table Note 88: Fields g44 to g48 are only included in BNA
Emulation modes.
Table Note 89: Fields g45 to g48 contain the counts for all note types.
Table Note 90: Fields g49 to g55 are included only when dual cash
handlers are emulating a single cash handler as defined by
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-73
Terminal to Central Messages
Solicited Status Messages
enhanced configuration option 76. For details, see “Option 76 –
Cash Handlers” on page 7‐19.
Table Note 91: Field g55 is used only if recycling is enabled. If
recycling is not enabled, this field contains ‘00000’.
Table Note 92: Notes returned to the cardholder without being
processed are unknown under CEN XFS.
Send Tally Information 9
Tally reporting is not supported. A default message is sent to the
host in response to a Send Tally Group Terminal Command message
(a command code of ‘5’).
The data is always as shown in the following table:
Table 9-31
Send Tally Information Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘3’.
g2 1 M Group Number. Contains the group number of the requested tallies
(‘A’ to ‘N’ or ‘V’).
g3 12 M Date And Time Last Cleared.
This field always contains the following default date and time:
YY = Year (‘00’)
MM = Month (‘01’)
DD = Day (‘01’)
HH = Hour (‘00’)
MM = Minute (‘00’)
SS = Second (‘00’)
g4 6 M Tally Data.
This field is always = 000000
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-74 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Send Error Log Information 9
Note: Error log reporting is not supported. A default message is
sent to the host in response to a Send Error Log Group message (a
command code of ‘6’)
The data is always as shown in the following table:
Table 9-32
Send Error Log Information Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘4’.
g2 1 M Group Number. The group number of the requested log group
(‘A’, ‘B’ or ‘C’).
g3 2 M New Entries.
This field is always 00.
g4 12 M Date Last Cleared.
This field always contains the following default date and time:
YY = Year (‘00’)
MM = Month (‘01’)
DD = Day (‘01’)
HH = Hour (‘00’)
MM = Minute (‘00’)
SS = Second (‘00’)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-75
Terminal to Central Messages
Solicited Status Messages
Send Date/Time Information 9
This solicited status message is sent to the host in response to a Send
Date And Time message (a command code of ‘8’). For details, see
“Terminal Commands” on page 10‐3.
Table 9-33
Send Date/Time Information Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘5’.
g2 1 M ToD Clock Status. This field has the following values:
‘0’ ‐ Time is actual.
‘1’ ‐ Time is default (clock not loaded with actual time).
‘2’ ‐ ToD malfunction.
g3 12 M Terminal Date/Time. The actual date and time returned by the
terminal clock in the following format:
YY = Year (‘00’ ‐ ‘99’)
MM = Month (‘01’ ‐ ‘12’)
DD = Day (‘01’ ‐ ‘31’)
HH = Hour (‘00’ ‐ ‘23’)
MM = Minute (‘00’ ‐ ‘59’)
SS = Second (‘00’ ‐ ‘59’)
If 00<=YY<=89, the year is taken to be in the range 2000<=YY<=2089. If
90<=YY<=99, the year is taken to be in the range 1990<=YY<=1999.
In the case of a ToD malfunction, these are zero. In the case of Default
time, the value is initialised to the lowest value, and counting starts
from this.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-76 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Send Configuration ID 9
This solicited status message is sent to the host in response to a Send
Configuration ID terminal command message (a command code of
‘3’). For details, see “Terminal Commands” on page 10‐3.
Table 9-34
Send Configuration ID Response
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Message Identifier. This message has identifier ‘6’.
g2 4 M Configuration ID. Contains the last four‐digit configuration ID
number (0000‐9999) sent to the SST from the host.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-77
Terminal to Central Messages
Solicited Device Fault Status
Solicited Device Fault Status 9
This section describes the information contained in the Status
Information field when the Status Descriptor is ‘8’ ‐ Device Fault,
For details, see “Device Fault Status Information Field” on
page 9‐79.
All solicited status device fault messages require the host to reply
with a Transaction Reply command. The cash handler and
depository devices are used only in response to a Transaction Reply
(TR) command, and only give unsolicited statuses during
Transaction Reply processing.
The first character in the Status Information field identifies the
device by means of a DIG. Devices are identified by the same code
in Solicited and Unsolicited messages. For details, see Appendix E,
“Device Identifiers”.
The following table shows the solicited device fault status messages
Device Fault Status which may be returned for each Transaction Reply command.
Responses 9
Table 9-35 Transaction Reply Command Device Faults
Device Fault Status in Response to
Transaction Reply Commands Deposit and Print Depository
Dispense and Print Cash Handler, Coin
Dispenser
Print Immediate None
Set Next State and Print None
Night Safe Deposit and Print Night Safe
Card Before Cash Card Reader/Writer, Cash
Handler, Coin Dispenser
Fast Cash Cash Handler, Coin
Dispenser
Card Before Parallel Dispense and Card Reader/Writer, Cash
Print Handler, Coin Dispenser
Print Statement and Wait Statement Printer and
Receipt in sideways mode
Print Statement and Set Next State Statement Printer and
Receipt in sideways mode
Refund Bunch Note Acceptor
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-78 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Device Fault Status
Transaction Reply Command Device Faults
Encash Bunch Note Acceptor
Process Cheque Cheque Processing Module
Process Multiple Cheques Cheque Processing Module
When the Status Descriptor is ‘8’ ‐ Device Fault, the information
Device Fault Status given in Table 9‐36 is present in the Status Information field. In the
Information Field 9
“Number of Characters” column, a number in brackets indicates the
maximum field length.
The data returned in the fields is variable in length as it is different
for each device, but each device will always send the same number
of characters. For details, see “Fitness Data” on page E‐20.
Table 9-36
Device Fault Status Information Field
Number of
Field Mandatory/Optional Description
Characters
g1 1 M Device Identifier Graphic (DIG). The device identifier.
g2 Var (17) O Transaction Status. Contains information required to make a
transaction completion decision.
FS 1 See Table Note 93 Field Separator
g3 Var (14) O Error Severity. Contains information required to decide whether to
shut down or continue to use the SST. Each character is always coded
in the same way:
Code Description
‘0’ No Error. Continue to use ‐ no error has occurred. Diagnostic
information follows.
‘1’ Routine. Continue to use ‐ a routine error has occurred and
diagnostic information follows.
‘2’ Warning. Continue to use, but it is recommended that the
network operator be informed of the error or exception
condition. Diagnostic information follows.
‘3’ Suspend. This code indicates that the terminal will suspend
transaction processing on completion of the current
transaction (state 000 entered). This is sent if cardholder
tampering is suspected. If no action is taken by the host, the
terminal will attempt to go back in service in five minutes.
Diagnostic information follows.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-79
Terminal to Central Messages
Solicited Device Fault Status
Number of
Field Mandatory/Optional Description
Characters
‘4’ Fatal. This code indicates that the device is out‐of‐service and
will continue to report fatal error until operator intervention
at the terminal. It is recommended that the terminal is put
out‐of‐service or that transactions involving the faulty device
are not allowed.
FS 1 See Table Note 93 Field Separator
g4 Var O Diagnostic Status. Used for logging errors. The field length may be
omitted if there is no error condition to be reported. The field will
always be present if preceded by an Error Severity field with a value
of 1 or greater. The following vendor‐specific rules are applied for all
devices:
Characters 1 and 2 contain a main error status value (M‐Status) in the
range 0‐99, transmitted as two characters which give the decimal
representation of the M‐Status value.
M‐Status is used mainly as an error log to assist machine servicing. It
may also be used in a transaction log to supplement Transaction
status or Device status information.
Note: For a GBRU with Enhanced Configuration option 78 set to
000, see “GBRU to CDM M‐Status Mapping” on page 9‐81 for the
M‐Status reporting.
Characters 3 to n (M‐Data) contain detailed diagnostic information
related to the device. Each byte is transmitted as two characters.
These give the hexadecimal representation of the value of the byte.
Note: The data returned for devices is hardware‐dependent, except
for the EJ printer, where the data is application‐driven.
Note: Where an EPP is present, the data returned in this field is of
the format 00mm. 00 is always returned in characters 1 and 2, and mm,
in characters 3 to n, contains the value from byte 0 of the T‐data.
FS 1 See Table Note 93 Field Separator.
g5 Var (8) O Supplies Status. Contains information about the state of supplies
(paper, currency, magnetic cards, envelopes, inkwells, documents) in
the terminal. This field contains 1 character for each supplies
container managed by the device. Each character is always coded in
the same way:
‘0’ No New State. The state of the container can be assumed to
be unchanged.
‘1’ Good State. The state of the container is known to be good,
for example, not low, empty or overfilled.
‘2’ Media Low.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-80 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Device Fault Status
Number of
Field Mandatory/Optional Description
Characters
‘3’ Media Out.
‘4’ Overfill. The container has sensed a full condition and
should be emptied.
If this field is omitted, it can be assumed that there is ‘no new state’
on any container.
Table Note 93: Included if any of the subsequent fields are present.
As the field lengths may change with the hardware being used, the
host should not attempt to analyse these fields by allocating a fixed
length to each device. Instead field lengths should be determined by
searching for the FS (field separator) characters.
GBRU to CDM M‐Status Mapping 9
For a GBRU device used as a cash dispenser, you can choose to
report the M‐Status (field ‘g4’) as a CDM or as a GBRU. This is set
using Enhanced Configuration option 78. For details, see “Option 78
– GBRU M‐Status Reporting” on page 7‐20.
To report the status using the CDM M‐Status, the GBRU M‐Status is
mapped to an equivalent CDM M‐Status.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-81
Terminal to Central Messages
Other Solicited Messages
Other Solicited Messages 9
Other solicited messages that can be sent from the terminal to the
host are as follows:
Encryptor Initialisation Data
Upload EJ Data Message
This message class/sub‐class is used when initialising the encryptor
Encryptor Initialisation module, and is used in a similar way to the terminal state message.
Data 9
However, it does not contain any of the fields associated with
message authentication, and is therefore suitable for the initial
exchange of data required to initialise the encryptor.
This solicited message is returned in response to an Extended
Encryption Key Change message, described in “Extended
Encryption Key Change” on page 10‐37.
Table 9-37
Encryptor Initialisation Data Response
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘2’ ‐ Solicited message.
c 1 M Message Sub‐Class. The message sub‐class is:
‘3’ ‐ Encryptor Initialisation Data.
FS 1 M Field Separator
d 3 or 9 M Logical Unit Number (LUNO). This number is defined in a field
transmitted to the terminal in a Configuration Parameters Load
message. The default is 000. If the data security feature is configured,
an additional six characters are present. These contain the security
terminal number.
FS 1 M Field Separator
FS 1 M Field Separator
e 1 M Information Identifier. Identifies the type of information sent, as
follows:
‘1’ EPP serial number and signature
‘2’ EPP public key and signature
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-82 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Other Solicited Messages
Number of
Field Mandatory/Optional Description
Characters
‘3’ New Key Verification Value (KVV)
‘4’ Keys status
‘5’ Public Key loaded
‘6’ Key entry mode
‘7’ Certificate RSA encryption KVV
‘8’ SST certificate
‘9’ SST random number
‘A’ PKCS7 key loaded
‘B’ Encryptor capabilities and state
‘C’ Key deleted
‘D’ EPP attributes
‘E’ Variable‐length EPP serial number and signature
‘F’ Reserved
‘G’ Reserved
‘H’ Host Certificate
‘I’ EPP Unbound
‘J’ Extended Capabilities
‘K’ Extended Key Status
‘L’ Authentication Token
FS 1 M Field Separator
f Var O Encryptor Information, dependent on the Information Identifier in
field ‘e’, as follows:
When Information Identifier = ‘1’:
8 EPP Serial Number (SN‐EPP)
320 EPP Serial Number Signature, created using the RSA NCR key,
(SN‐EPP) * NCR‐SK, and base 94 encoded. For further details of EPP
authentication and base 94 encoding, see “EPP Authentication
Process” on page 11‐21 and “Base 94 Encoding and Decoding” on
page 11‐30.
When Information Identifier = ‘2’:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-83
Terminal to Central Messages
Other Solicited Messages
Number of
Field Mandatory/Optional Description
Characters
320 EPP Public Key (PK‐EPP), base 94 encoded.
The exponent of the EPP Public Key is always 65537, and is
therefore not sent to the host.
320 EPP Public Key Signature, created using the RSA NCR key, (PK‐EPP) *
NCR‐SK, and base 94 encoded. For further details of EPP
authentication and base 94 encoding, see “EPP Authentication
Process” on page 11‐21 and “Base 94 Encoding and Decoding” on
page 11‐30.
When Information Identifier = ‘3’:
6 or 72 New KVV for key just loaded or reactivated
When Information Identifier = ‘4’:
Keys Status, containing KVVs as follows:
6 Master Key KVV
6 Communications Key KVV
6 MAC Key KVV
6 B Key KVV
If a key has not been loaded, its KVV will be six zeroes.
If the hardware does not allow a KVV to be generated, 6 spaces (0x20)
will be reported
Note: The host should accept a variable length Key Status field, in case
new keys need to be added in the future.
For details of the calculation of KVVs, see “Key Verification Values”
on page 11‐17.
When Information Identifier = ‘5’:
For Key Loaded, this field is absent.
When Information Identifier = ‘6’:
Key Entry Mode, a single character in the range ‘1’ to ‘4’ describing the
key entry mode, as follows:
‘1’ Single length without XOR
‘2’ Single length with XOR
‘3’ Double length with XOR
‘4’ Double length, restricted.
When Information Identifier = ‘7’
3 Binary data length
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-84 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Other Solicited Messages
Number of
Field Mandatory/Optional Description
Characters
Var RSA KVV base 94 encoded
When Information Identifier = ‘8’
3 Binary data length
Var SST certificate base 94 encoded
The certificate can either be in the CEN 3.03 or TR34 format
When Information Identifier = ‘9’
Var SST random number, ASCII hexadecimal encoded.
This message is not required in the Basic Signature Remote Key
Loading Scheme and if received, will be rejected with a specific reject
code of E02.
When Information Identifier = ‘A’
6 KVV of new DES key
3 Binary data length
Var Key Load Acknowledgement Packet, base 94 encoded
See Table Note 94
When Information Identifier = ‘B’
2 Remote Key Protocol. The remote key scheme capabilities reported as
a bitmap. This is a two‐digit decimal value defined as follows:
Bit 0 If set, the EPP supports the Signature Scheme
Bit 1 If set, the EPP supports the Certificate Scheme
Bit 2 If set, the EPP supports the Enhanced Signature Scheme
Bits Reserved and must be 0
3‐7
Examples are as follows:
‘00’ None
‘01’ Signature
‘02’ Certificate
‘03’ Signature and certificate
‘04’ Enhanced signature
‘06’ Enhanced signature and certificate
As the Remote Key Protocol is reported as a bitmap, a number of
different protocols can be supported simultaneously as shown above
The significant bits are 0, 1, 2 and 4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-85
Terminal to Central Messages
Other Solicited Messages
Number of
Field Mandatory/Optional Description
Characters
2 Certificate state
‘00’ Not ready or not supported
‘01’ Certificate primary
‘02’ Certificate secondary
1 EPP Variable Length Serial Number Capability
See Table Note 95
‘0’ Variable length EPP serial numbers not supported
See Table Note 96
‘1’ Variable length EPP serial numbers supported
See Table Note 97
When Information Identifier = ‘C’
For Key Deleted, this field is absent
When Information Identifier = ‘D’
EPP attributes are defined as follows:
1 ‘0’ EPP Vendor Company Name Identifier
Var Alphanumeric characters that define the EPP vendor company
name as registered with PCI
1 Group Separator
1 ‘1’ EPP Model Identifier Data Identifier
Var Alphanumeric characters that define the EPP model identifier
as registered with PCI
1 Group Separator
1 ‘2’ EPP Hardware Identifier Data Identifier
Var Alphanumeric characters that define the EPP hardware
identifier as registered with PCI
1 Group Separator
1 ‘3’ EPP Firmware Identifier(s) Data Identifier
Var Alphanumeric characters that define the EPP firmware
module identifiers as registered with PCI.
1 Group Separator
1 ‘4’ EPP Application Identifier(s) Data identifier
Var Alphanumeric characters that define the application module
identifiers as registered with PCI
When Information Identifier = ‘E’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-86 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Other Solicited Messages
Number of
Field Mandatory/Optional Description
Characters
The variable‐length EPP serial number and signature are returned as
follows:
Var EPP serial number (SN‐EPP)
1 Group Separator
Var SN‐EPP signature signed using SK‐Vendor (SN‐EPP * SK‐Vendor base
94 encoded)
When Information Identifier = ‘H’
1 Certificate loaded flag
0 Certificate is not loaded and certificate data will not follow
1 Certificate is loaded and certificate data will follow
Var Contains the host certificate, base 94 encoded
See Table Note 98
When Information Identifier = ‘I’
For EPP Unbound, this field is absent
When Information Identifier = ‘J’
The Extended Capabilities are returned as follows
1 Supports variable length serial numbers
1 Supports Standard Signature RKL
1 Supports Enhanced Signature RKL
1 Supports CEN 3.03 format (Diebold) certificate
1 Supports TR34 certificate
1 Supports TR31 symmetric key exchange (Key block A)
1 Supports TR31 symmetric key exchange (Key block B)
1 Supports TR31 symmetric key exchange (Key block C)
Var New features will be added and must be ignored if the Terminal
handler does not support or understand them
0 Not supported
1 Supported
When Information Identifier = ‘K’
Extended key status
Sub‐
Field
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-87
Terminal to Central Messages
Other Solicited Messages
Number of
Field Mandatory/Optional Description
Characters
3 M f1 Key ID
1 M f2 Key loaded and active
0 ‐ Key not loaded
1 ‐ Key loaded and active
Var O f3 Status data
1 O f4 Group separator
Fields f1 to f4 are repeated for every key. There is no group separator
after the last key is reported.
See Table Note 99
When Information Identifier = ‘L’
Var Contains the Authentication Token, ASCII hexadecimal encoded.
See Table Note 100
Table Note 94 The key load acknowledgement packet is
summarised as follows:
(Sign(SKSST)[RHost||RSST||IHost])
This is interpreted as follows:
SKSST = SSTʹs verification secret key
RHost = Host’s random number
RSST = SST’s random number
IHost = Host identifier
Table Note 95 A number of messages were originally defined with
an 8‐byte fixed‐length field for the EPP serial number. However, 8
bytes are not sufficient for EPPs from some vendors. This field
reports whether variable‐length serial numbers are supported.
When variable‐length EPP serial numbers are supported, NCR
recommends that the host uses variable‐length variants of
messages.
Table Note 96: If variable length EPP serial numbers are not
supported, the following conditions apply:
Only EPPs with 8‐byte serial numbers can be supported
The EPP serial number can only be requested through the
Extended Encryption Key Change (EEKC) command with a
modifier of ‘F’ (the response is Data Identifier ‘1’).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-88 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Other Solicited Messages
Table Note 97 If variable length EPP serial numbers are supported
the following apply:
EPPs with any length of serial number can be supported
The EPP serial number can be requested through the EEKC
command with a modifier of ‘F’ (the response is Data Identifier
‘1’). This works only on EPPs with 8‐byte serial numbers.
The EPP serial number can be requested through the EEKC
command with a modifier of ’V’ (the response is Data Identifier
‘E’). This works on EPPs with serial numbers of any length.
Table Note 98 The data consists of the host certificate encoded using
base 94. The certificate can either be in the CEN 3.03 or TR34 format.
Table Note 99 The encryption keys managed by NDC have the
following identifiers:
Table 9-38 ID Encryption Key
Encryption Keys
001 A Key/ Master Key/TR31 Key Block Protection Key
002 B Key
003 Communication Key
004 MAC Key
005 Host Public Key
006 Host Root Public Key
007 Host Public Key Certificate Loaded (TR34 or CEN 3.03
compatible certificate)
008 Certificate Module State
The above list of keys will be extended and reported in the
Extended Encryption Key Status.
The format of the Key Status Data field depends on the type of key.
The data can report multiple types of key status data for each key
and each block of data associated with a single key is separated
using a Record Separator character. In future releases, more data
may be added to any key type. New data will be added by
preceeding the data with a Record Separator. Host should be
written to ignore data it does not expect.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-89
Terminal to Central Messages
Other Solicited Messages
For Key IDs 001–004 (symmetric keys), the Key Status Data is
formatted as follows:
Table 9-39 Number of Mandatory/
Symmetric Key Data
Key Status Data (Key IDs 001 - 004) Bytes Optional
6 O KVV ‐ Present only if Key is loaded
1 O Record Separator ‐ Present only if any data
follows
Var O Key Block Header ‐ Present only if key is
loaded through TR31
For Key IDs 005–007, no additional Key Status Data is returned. If
the TR34 Host Certificate is loaded, it can be retrieved using the
EEKC command with modifier ‘g’.
For the Key ID 008 (Certificate Module State), the Key Status Data is
formatted as follows:
Table 9-40 Number of Mandatory/
Symmetric Key Data
Key Status Data for the Key ID 008 Bytes Optional
2 M Certificate Module Status
‘00’ ‐ Not ready/Not supported
‘01’ ‐ Primary Certificates will be accepted
‘02’ ‐ Secondary Certificates will be accepted
Table Note 100 The data consists of the authentication token that is
used by the host when generating the authentication data. In some
cases, TR34 Forced Unbind, this token needs to be generated by the
EPP but is not used to generate the Authentication Block. In these
cases the token will still be generated and sent to the host but should
not be included when generating the authentication data. The TR34
standard specifies what must be used to generate the authentication
data. The content of the data returned to the host is controlled by the
TR34 standard, the data transmitted will be in ASCII hexadecimal
format.
The SST sends this solicited message to the host in response to an EJ
Upload EJ Data Message 9
Command, taking the data from the file ejdata.log in the c:\program
files\ncr aptra\advance ndc\data directory on the SST. A pointer is
maintained in persistent memory to indicate the location of the next
block of data to be uploaded. Any binary zeros in the electronic
journal data are replaced with an ASCII question mark (?) character
before the upload data is sent.
The size of the electronic journal data blocks that are sent in each
upload message can be set in the EJ Options and Timers command.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-90 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Other Solicited Messages
For details of EJ Options and Timers and acknowledgement
messages, see “EJ Commands” on page 10‐96.
The SST will continue to upload EJ data blocks as long as an
acknowledgement message is received from the host for each
message sent. If an acknowledgement is not received within the
time specified by timer 60, the SST will re‐send the current block up
to the maximum number of retries set in the EJ Options and Timers
message. When all EJ data is uploaded, the data is deleted from the
ejdata.log file.
The SST will only send an Upload EJ Data message, or process an EJ
command, when in Out‐of‐Service mode or In‐Service mode when
there is no transaction in progress. Upload EJ Data messages will
not be sent when the SST is in Supervisor mode. Any EJ data
accumulated in the EJ file ejdata.log while the SST is in Supervisor
mode will be sent at the next opportunity.
Note: The Supervisor function INIT EJRNL should not be
performed during EJ upload. For more information, refer to Chapter
3, “Replenish Menu” of the APTRA Advance NDC, Supervisor’s
Guide, .
Table 9-41
Format of the Upload EJ Data Message
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘6’ ‐ Electronic Journal.
c 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Upload Data.
FS 1 M Field Separator
FS 1 M Field Separator
FS 1 M Field Separator
FS 1 M Field Separator
d 6 M Machine Number. Range 000000 to 999999.
e 6 M Date. Range 000000 to 999999 in the format YYMMDD.
Date the block was sent, determined by the SST’s internal clock.
f 6 M Time. Range 000000 to 999999 in the format HHMMSS.
Time the block was sent, determined by the SST’s internal clock.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-91
Terminal to Central Messages
Other Solicited Messages
Number of
Field Mandatory/Optional Description
Characters
g 6 M Last Char Previous Block.
Range 000000 to 999999. See Table Note 101.
h 6 M Last Char This Block.
Range 000000 to 999999. See Table Note 101.
The SST compares the Last Character Received field in the
acknowledgement message sent from the host with the Last Char This
Block field of the last Upload EJ Data message it sent to the Host. If
these two values are not the same, the acknowledgement message is
ignored. For more details, see the “EJ Commands” section in
Chapter 10, “Central to Terminal Messages”.
The Last Character Previous Block field can be used by the host to
check on the received message.
i 3 M Block Length.
Range 001‐350. Default is 200.
Set using the EJ Options and Timers command message; only the last
data block sent to the host should be less than this block length.
j Var M Response Data. Range as specified by Field ‘i’
Range 001‐350.
Upload data consists of ASCII text with a carriage return (CR) at the
end of each line. Lines are a maximum of 40 characters. See Table Note
102.
Table Note 101: The Last Char Previous Block and Last Char This
Block values are based on a modulus 1,000,000 character count
which starts at zero following a cold start of the SST. The count is
incremented for each character written to the electronic journal. The
count is not reset for a warm start, that is, a power fail or reset
during which the persistent memory is preserved.
Table Note 102: If the last block length at the end of file is less than
specified in Field ‘i’, that length will be returned.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-92 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Unsolicited Status Messages
Unsolicited Status Messages 9
Unsolicited status messages are used to report any change of
condition at the SST, such as the following:
Recognition of an external event
Device errors
Supplies problems.
Unsolicited status messages do not require a reply from the host.
Conditions for Sending They are sent under the following conditions:
Unsolicited Messages 9
Power failure: a message is sent on power‐up
An external event is detected. This includes bin inserted/
removed, alarm activated, Supervisor keys and switches. The
reporting of supervisor switch changes is delayed if the SST is in
use
A device fault is detected as a result of processing a Transaction
Reply command, but the fault condition does not require host
recovery action. This means that Transaction Reply processing
can continue as if no fault had occurred
A device fault is detected that is not the result of processing a
Transaction Reply command. For example, printer/MCRW
errors
If an alarm is activated during a power failure or
communications loss, a message is sent when power or
communications are restored
If Supervisor/supply switch values are changed while off‐line,
the last change of both switches is reported when
communications are restored
If the message mode option is set to enable the Cancel key while a
Statement and Wait function is being carried out and the
consumer presses the Cancel key. For details, refer to the APTRA
Advance NDC, Supervisor’s Guide.
Errors in the Close state.
Note: Exits can also send unsolicited status messages. These are of
the same format as standard unsolicited status messages, but the
content of the Status Information field depends on the Exit. For
more information, refer to APTRA Advance NDC, Extending the
Product.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-93
Terminal to Central Messages
Unsolicited Status Messages
Table 9-42
Unsolicited Status: Message Format
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘1’ ‐ Unsolicited message.
c 1 M Message Sub‐Class. The message sub‐class is:
‘2’ ‐ Status message.
FS 1 M Field Separator
d 3 or 9 See Table Note 103 Logical Unit Number (LUNO). This number is defined in a field
transmitted to the SST in a Configuration Parameters Load message.
The default is 000. If the data security feature is configured, an
additional six characters are present. These contain the security
terminal number.
FS 1 M Field Separator
FS 1 M Field Separator
e Var M Status Information. The content of this field varies according to the
message mode selected at installation time. See Table 9‐43.
f Var M Trailer. Protocol‐dependent.
Table Note 103: In power‐up status messages, this field contains
either the LUNO that has been previously downloaded, or ‘000’.
One of the following conditions must be satisfied before an
Unsolicited Status unsolicited message is sent:
Information Field 9
Device status is non‐zero
Error severity is 2 (warning) or greater
Supplies status is 2, 3, or 4.
A routine error does not generate an unsolicited status message.
The following table shows the structure of the Status Information
field in unsolicited status messages.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-94 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Unsolicited Status Messages
Table 9-43
Unsolicited Status: Status Information Field
Number of
Field Mandatory/Optional Description
Characters
e1 1 M Device Identifier Graphic (DIG). The device identifier
e2 Var O Device Status. Used for recording any transaction exception of
(154 max) change of state of the device. For devices which report both
Solicited and Unsolicited Status messages, a common set of
Transaction/ Device Status codes are defined for use in either type
of message. When processing a Transaction Reply command, any
unsolicited Transaction exceptions are reported prior to the
solicited ‘device fault’ or ‘ready’ status.
FS 1 See Table Note 104 Field Separator
e3 Var (14) O Error Severity. As ‘g3’ in Solicited messages.
FS 1 See Table Note 104 Field Separator
e4 Var O Diagnostic Status. As ‘g4’ in Solicited messages.
FS 1 See Table Note 104 Field Separator
e5 Var (8) O Supplies Status. As ‘g5’ in Solicited messages.
e6 Var O Additional data specific to device message. Can be used to report
the card number of a captured card.
Table Note 104: This field separator is included if any of the
optional fields that follow it are included.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-95
Terminal to Central Messages
Device Status Information
Device Status Information 9
Solicited or unsolicited status information can be reported for
devices as described in the following sections.
For information on the journaling that occurs, refer to the APTRA
Advance NDC, Supervisor’s Guide.
This message indicates that the Time‐of‐Day Clock is not available.
Time‐Of‐Day Clock The host can either keep the SST out‐of‐service or return it to
(Unsolicited) 9
service.
Table 9-44
Time-Of-Day Clock Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘A’.
e2 1 Device Status.
‘1’ ‐ Clock reset but running.
‘2’ ‐ Clock has stopped.
e3 1 Error Severity.
‘2’ ‐ Warning ‐ clock reset.
‘4’ ‐ Fatal ‐ clock malfunction.
e4 Not present.
e5 Not present.
This message is sent during power‐up to tell the host that a power
Power Failure interruption has occurred. If the SST is configured to send a
(Unsolicited) 9
message whenever communications is restored, this message is sent
when the connection is re‐established.
The host can use the configuration ID contained in this message to
check whether a download is needed before sending a Start Up
Terminal Command message to put the SST into service.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-96 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Table 9-45
Power Failure Status
Field No. of Characters Content
e1 1 Device Identifier Graphic ‘B’.
e2 4 Device Status. This contains the configuration identification number (0000‐9999) of
the customisation data stored on disk. The host can use this information to check if a
download is needed before putting the SST in‐service. A value of ‘0000’ indicates that
a download must be performed.
e3 Not present.
e4 Not present.
e5 Not present.
This message gives details of any exception condition that is
Card Reader/Writer detected during card processing.
(Solicited/Unsolicited) 9
A card reader can be either a contact or contactless card reader.
When both the card readers are available on an SST, the contact card
reader is always the primary card reader. When a contactless card
reader alone is present on an SST, it is the primary card reader.
If the primary card reader is a contactless card reader, the following
information is reported to the host:
‘1’ for Supplies status
‘0’ for Transaction/Device status
Solicited device faults are reported only on Card Before Cash
transactions.
If failure occurs in the physical connection, an unsolicited status
message is reported indicating that the card reader has a fatal
severity and that the device is inoperative. Advance NDC does not
put the SST into Out of Service mode when the card reader enters a
fatal state. It is the responsibility of the host and the host must be
configured to do this if required.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-97
Terminal to Central Messages
Device Status Information
Table 9-46
Card Reader/Writer Status
Number of
Field Content
Characters
g1/ 1 Device Identifier Graphic ʹDʹ.
e1 The primary card reader.
g2/ 1 Transaction/Device Status. Gives details of any transaction‐related exception condition
e2 detected while processing a card at the SST. Possible values are:
Sol/
Code Description
Unsol
U ‘0’ No transaction exception condition occurred but consult other fields for
error severity, diagnostic status or supplies status changes.
S/U ‘1’ The cardholder did not take his card within the allowed time and it was
captured or jammed.
See Table Note 105 and Table Note 106
S/U ‘2’ The mechanism failed to eject the card, which was either captured or
jammed.
See Table Note 105 and Table Note 106
S/U ‘3’ The mechanism failed to update the requested tracks on the card.
S/U ‘4’ Invalid track data received from the host.
U ‘7’ Error in track data.
If using EMV/CAM2, use the EMV/CAM2‐generated hardware error to identify the
device status.
EMV/CAM2 can also generate messages to identify whether the error is due to hardware
or data problems using a DIG of ‘c’.
For more information about EMV/CAM2 messages, refer to the EMV Integrated Circuit
Card (icc) Reference Manual.
g3/ Var Error Severity. This is a one or two character field coded in the standard way to be used to
e3 (1 or 2) make a shut‐down decision.
g4/ Var Diagnostic Status (M‐status plus M‐data). This contains information to be used for
e4 logging device errors. The M‐status describes the main error found.
See Table Note 143
g5/ 1 Supplies Status. This is a single character field indicating the state of the Card Capture
e5 bin.
Code Description
‘0’ No new state, No cassette accessed
‘1’ No overfill condition (capture bin)
‘4’ Overfill condition (capture bin)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-98 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Table Note 105: If a card jams during a capture operation, multiple
unsolicited messages are sent. The final message will have a device
status of ‘1’ although the preceding messages may have a device
status of ‘0’.
Table Note 106: If Enhanced Configuration option 41 is set to
include data read from a card when retracted, all the magnetic track
details are included in the status message. If this data is to be
included, the fields described in Table 9‐47, “Additional Track Data
on Card Retract” are added to the message.
Table 9-47 Field Number of Characters Content
Additional Track Data on Card Retract
FS 1 Field separator
e600 Var (78) Track 1 data
GS 1 Group separator
e601 Var (39) Track 2 data
GS 1 Group separator
e602 Var (106) Track 3 data
This message gives details of a dispense operation in response to a
Cash Handler Transaction Reply command message.
(Solicited/Unsolicited) 9
The format depends on the setting of Enhanced Configuration
option 76, as described in Table 9‐48 below. When Enhanced
Configuration option 76 is set to 001, the counts and status fields
report cassette types in numerical order.
For details of the status and supplies reported when cassettes are
replenished during deposits, see “Cassette Re‐enabled During
Deposit Transactions” on page 9‐103. If Option Digit 4A is set, a
solicited status message is returned when notes are successfully
retracted. For details of option digits, refer to the APTRA Advance
NDC, Supervisor’s Guide.
Table 9-48
Cash Handler Status
Number of
Field Content
Characters
g1/e1 1 Device Identifier Graphic ‘E’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-99
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
g2/e2 Var (23) Transaction/Device Status (T‐code plus T‐data). Gives details of a dispense operation in
response to a Transaction Reply Command message. Character 1 (T‐code) can be:
Sol/Unsol Code Description
U ‘0’ Successful operation and no cassette accessed, but an exception has
occurred as detailed in subsequent fields.
S ‘1’ Short dispense.
For a spray dispenser, this can also indicate that an extra note has
been dispensed.
S ‘2’ No notes dispensed.
S ‘3’ Notes dispensed unknown. The cardholder may have had access to
any presented notes, so it should be assumed some may have been
dispensed. Intervention may be required to reconcile the cash
amount totals. The following counts contain requested dispense
values.
S ‘4’ No notes dispensed or card not ejected. This status is returned on a
card before cash transaction if the stack operation fails and the notes
are purged prior to card eject.
S/U ‘5’ Some notes have been retracted when the notes were not taken
following a Present time‐out. The number of notes retracted is
unknown.
See Table Note 113
When Enhanced configuration option 76 is set to 000, the counts are reported as follows:
Characters 2‐9 (T‐data) contain notes dispensed counts. Each pair of characters
represents a two‐digit decimal value in the range 00‐99 for a particular cassette type.
Characters Cassette Types
2‐3 1
4‐5 2
6‐7 3
8‐9 4
The following optional characters 10‐17 are only valid for a spray cash dispenser, and
contain a count of notes dispensed to the cardholder plus notes in an unknown location.
Each pair of characters represents a two‐digit decimal value in the range 00‐99 for a
particular cassette type.
The default message format does not include these characters. The extra fields are
enabled in Option Digit 4C. For details of option digits, refer to the APTRA Advance
NDC, Supervisor’s Guide.
Characters Cassette Types
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-100 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
10‐11 1
12‐13 2
14‐15 3
16‐17 4
When Enhanced configuration option 76 is set to 001, the counts are reported as follows:
Characters 2‐15 (T‐data) contain notes dispensed counts. Each pair of characters
represents a two‐digit decimal value in the range 00‐99 for a particular cassette type.
Characters Cassette Types
2‐3 1
4‐5 2
6‐7 3
8‐9 4
10‐11 5
12‐13 6
14‐15 7
The following optional characters 16‐31 are only valid for a spray cash dispenser, and
contain a count of notes dispensed to the cardholder plus notes in an unknown location.
Each pair of characters represents a two‐digit decimal value in the range 00‐99 for a
particular cassette type.
The default message format does not include these characters. The extra fields are
enabled in Option Digit 4C. For details of option digits, refer to the APTRA Advance
NDC, Supervisor’s Guide.
Characters Cassette Types
16‐17 1
18‐19 2
20‐23 3
24‐25 4
26‐27 5
28‐29 6
30‐31 7
g3/e3 5 or 8 Error Severity. Used to make a shut‐down decision.
Character ‘0’ Severity information related to complete device
Character ‘1’ Severity related to cassette type 1
Character ‘2’ Severity related to cassette type 2
Character ‘3’ Severity related to cassette type 3
Character ‘4’ Severity related to cassette type 4
If enhanced configuration option 76 is set to 001, the error severity is reported for the
further cassettes as follows:
Character ‘5’ Severity related to cassette type 5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-101
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
Character ‘6’ Severity related to cassette type 6
Character ‘7’ Severity related to cassette type 7
If all cassettes of one type are unusable for any reason, for example, empty, not present,
or faulty, then the severity code for that cassette type is marked as fatal.
If dual cash handlers are used, this severity code can be changed to suspend using a
registry key, as described in the APTRA Advance NDC, Developer’s Guide. The suspend
severity is reported when neither cash handler has the required note mix. Reporting a
fatal severity means that an available note type is never requested; the suspend severity
allows transactions to continue requesting both note types.
g4/e4 Var Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found
and occupies two characters.
g5/e5 5 Supplies Status. Indicates the state of the currency cassettes and reject bin.
See Table Note 108
Character ‘0’ state of reject bin
Character ‘1’ state of cassette type 1
Character ‘2’ state of cassette type 2
Character ‘3’ state of cassette type 3
Character ‘4’ state of cassette type 4
If Enhanced Configuration option 76 is set to 001, the supplies status is reported for the
further cassettes as follows:
Character ‘5’ state of cassette type 5
Character ‘6’ state of cassette type 6
Character ‘7’ state of cassette type 7
Codes for characters 1 to 7 are:
Code Description
‘0’ No new state (cassette not accessed or state unknown because of a fatal
hardware malfunction).
See Table Note 109
‘1’ Sufficient notes.
‘2’ Notes low.
‘3’ Out of notes.
Codes for character 0 are:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-102 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
Code Description
‘0’ No new state (cassette not accessed or state unknown because of fatal
hardware malfunction).
See Table Note 109
‘1’ No overfill condition.
‘4’ Overfill condition.
Note: If an attempt is made to dispense notes from a cassette type that is not installed, a
supplies status code of ‘3’ is returned.
Table Note 107: For a spray dispenser the notes dispensed counts
are significant. For example, the cardholder may have received
some, but not all, requested notes due to an error condition. In this
case, these are counts of the notes delivered to the cardholder.
However, if the notes stick in the transport, these counters display
the number of notes requested and not the number delivered.
Table Note 108: When notes are retracted, the supplies status of all
cassettes is included in the unsolicited message and journaled.
Table Note 109: By default, the supply status reported for repeated
transactions, is that of the cassette referenced by the transaction. If
the status remains the same as the previous transaction, it does not
change to 0 (“no new state”). The purge bin never reports 0.
Reporting of the actual status of all cassettes can be configured
through the registry. For details of the registry setting, refer to the
APTRA Advance NDC, Developer’s Guide.
Cassette Re‐enabled During Deposit Transactions 9
A recycling cassette previously reported as out of notes can be
replenished during a deposit transaction. When this occurs, the
cassette is re‐enabled for dispensing and the following information
is reported in an unsolicited status message:
The Transaction/Device Status (field ‘g2’) reports a successful
operation (‘0’) and both the dispensed and presented counts
report zero
The Error Severity (field ‘g3’) reports the current cash handler
severity values
The Diagnostic Status (field ‘g4’) reports no error (‘00’)
The Supplies Status (field ‘g5’) reports the following:
— Updated supply values for any supply status that has
changed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-103
Terminal to Central Messages
Device Status Information
— No change (‘0’) for any supply status that has not changed.
This message gives details of a deposit operation in response to a
Depository Transaction Reply Command message.
(Solicited/Unsolicited) 9
Table 9-49
Depository Status
Number of
Field Content
Characters
g1/e1 1 Device Identifier Graphic ‘F’.
g2/e2 1 Transaction/Device Status. Gives details of a deposit operation in response to a
Transaction Reply Command message. The values are:
Sol/
Code Description
Unsol
U ‘0’ Successful operation, but an exception has occurred as detailed in
subsequent fields.
S ‘1’ Time‐out on cardholder deposit.
S ‘2’ Failure to enable mechanism for a deposit.
S ‘3’ Envelope/document jam or envelope/document deposit failed. The
cardholder has access. This status is also returned if there is any doubt
about cardholder access.
S ‘4’ Envelope/document jam or envelope/document deposit failed. The
cardholder does not have access.
g3/e3 1 Error Severity. Standard code.
g4/e4 Var Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found.
g5/e5 Supplies Status. Indicates the state of the deposit bin. This field is not sent with the
message when a deposit time‐out occurs. States reported are:
Code Description
‘0’ No envelope deposited
‘1’ No overfill condition
‘4’ Overfill detected
This message indicates whether or not a print operation has been
Receipt Printer successfully completed. A solicited status message may be sent in
(Solicited/Unsolicited) 9
response to the following Transaction Reply commands if sideways
printing has been requested:
Print Statement and Wait
Print Statement and Set Next State.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-104 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Table 9-50
Receipt Printer Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘G’.
e2 1 Transaction/Device Status. Indicates whether or not the print was successfully completed.
Sol/
Code Description
Unsol
U ‘0’ Successful print
S/U ‘1’ Print operation not successfully completed
U ‘2’ Device not configured
U ‘4’ Cancel key pressed during sideways receipt print
U ‘5’ Receipt retracted
e3 Var (2) Error Severity. Standard code used to make a shut‐down decision.
Holds the severity information about the receipt printer and capture bin.
Byte/char 1 Receipt Printer
Byte/char 2 Capture Bin
By default, not reported; can be included through the registry
For details, refer to Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC Developer’s Guide
e4 Var Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found.
e5 5 Supplies Status. Indicates the status of the printer paper, ribbon, print‐head, knife and
capture bin. The capture bin severity and supplies will be reported as ‘0’, if the printer
does not have a capture bin.
Char Code Description
0 ‘1’ Sufficient paper
‘2’ Paper low
‘3’ Paper exhausted
1 ‘1’ Ribbon OK
‘2’ Ribbon replacement recommended
‘3’ Ribbon replacement mandatory
2 ‘1’ Print‐head OK
‘2’ Print‐head replacement recommended
‘3’ Print‐head replacement mandatory
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-105
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
3 ‘1’ Knife OK
‘2’ Knife replacement recommended
4 1 Capture bin OK
4 Capture bin overfill
When a ‘paper exhausted’ condition is detected and the capture bin status is reported, the
status message is:
Transaction Status = 0
Error Severity = 40
Supplies Status = 31111
(Ribbon, print‐head, knife and capture bin are OK).
This message indicates whether or not a print operation has been
Journal Printer completed successfully. Continuous messaging of fatal journal
(Unsolicited) 9
device status is set and cannot be changed.
Note: Although no knife is present on the 40‐column journal
printer, a status of ‘1’ (knife OK) is always returned in any
unsolicited status message, as a common format is used across all
the 40‐column printers.
Table 9-51
Journal Printer Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘H’.
e2 1 or 25 Transaction/Device Status. Indicates whether or not the print was successfully
completed.
See Table Note 110, Table Note 111, and Table Note 112.
Sol/
Code Description
Unsol
U ‘0’ Successful print
U ‘1’ Print operation not successfully completed
U ‘2’ Device not configured
U ‘6’ Journal printer backup activated
U ‘7’ Journal printer backup and reprint terminated
U ‘8’ Journal printer backup reprint started
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-106 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
U ‘9’ Journal printer backup halted
U ‘:’ Journal printer backup log security error
U ‘;’ Journal printer backup reprint halted
U ‘<’ Journal printer backup tamper state entered
e3 1 Error Severity. Standard code used to make a shut‐down decision.
e4 Var Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found.
e5 4 Supplies Status. Indicates the status of the printer paper, ribbon and print‐head.
Char Code Description
0 ‘1’ Sufficient paper
‘2’ Paper low
‘3’ Paper exhausted
1 ‘1’ Ribbon OK
‘2’ Ribbon replacement recommended
‘3’ Ribbon replacement mandatory
2 ‘1’ Print‐head OK
‘2’ Print‐head replacement recommended
‘3’ Print‐head replacement mandatory
3 ‘1’ Knife OK
When a ‘paper exhausted’ condition is detected, the status message is:
Transaction Status = 0
Error Severity = 4
Supplies Status = 3111
(Ribbon and print‐head are OK; knife is always OK).
Table Note 110: If the transaction code is ‘:’, Journal Printer backup
is operational, and the value of Enhanced Configuration Parameter
option 22 is ‘2’, the following extra data is sent:
An ASCII digit string with a format of
*XXX*dd/mm/yy*hh:mm*YYYY, as follows:
XXX the last printed Security Trace Number
dd/mm/yy hh:mm the record date and time
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-107
Terminal to Central Messages
Device Status Information
YYYY the record number relative to the last
printed Security Trace Number
Table Note 111: If required, supervisor message mode option 12 can
be used to report a journal out status as low. For more information,
refer to the APTRA Advance NDC, Supervisor’s Guide.
Table Note 112: When no journal printer is connected to the SST and
the EJ has not been activated, no unsolicited message is sent to the
host to indicate that the journal is not configured.
This message indicates whether or not a print operation has been
Electronic Journal Printer completed successfully.
(Unsolicited) 9
Note: If cutover automatic initialisation is in use, this message
should not be returned when the EJ file reaches 90% or 100% full. As
cutover performs an initialisation operation when the EJ file reaches
90% full, the 100% full message is returned only if the cutover
operation fails. For information on enabling cutover, refer to the
APTRA Advance NDC, Supervisor’s Guide.
Table 9-52
Electronic Journal Printer Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘H’.
e2 1 Transaction/Device Status. Indicates whether or not the print was completed successfully.
Sol/
Code Description
Unsol
U ‘0’ Successful print
U ‘1’ Print operation not completed successfully
U ‘2’ Device not configured. By default this code is suppressed. For more
information, refer to the APTRA Advance NDC, Developer’s Guide.
See Table U ‘=’ EJ in dual mode print operation successful
Note 113
U ‘>’ EJ in dual mode print operation not successful
e3 1 Error Severity. Standard code used to make a shut‐down decision.
e4 Var Diagnostic Status (M‐status plus M‐data). This data is generated by Advance NDC. The
M‐status describes the main error found, as follows:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-108 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
0 EJ status OK
1 EJ fatal
5 EJ log file full
6 EJ not configured
7 EJ log file not found
50 EJ log file open failure
51 EJ log file close failure
52 EJ flex disk not found
53 EJ flex disk drive head jam
54 EJ flex disk protected
55 EJ flex disk full.
e5 1 Supplies Status. Indicates the status of the electronic journal, as follows:
Char Code Description
0 ‘1’ EJ log space OK
‘2’ EJ log space low
‘3’ EJ log full
1 ‘1’ Value always ‘1’
2 ‘1’ Value always ‘1’
3 ‘1’ Value always ‘1’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-109
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
When an ‘electronic journal log space low’ condition is detected, the status message is:
Transaction Status = 0
Error Severity = 2
Supplies Status = 2111
Table Note 113: If option 35 in the Enhanced Configuration
Parameters load (see page 10‐17) is set to 001 (‘report EJ in dual
mode’ unsolicited errors) or 002 (‘report EJ and hard copy backup in
dual mode’ unsolicited errors) and both the journal printer and the
EJ are in error, two unsolicited errors will be reported: one for the
physical device and one for the EJ. If the option is set to the default
of 000, only the physical device will be reported. The following table
lists the message sequences returned for dual mode for each type.
Table 9-53
Unsolicited Message Sequences for
Option 35 (EJ Dual Mode)
Option 35
Type Message Sequence Comment
Value
000 Physical H0 Print operation succeeded Paper supplies are low or out
journal
H1 Print operation failed Sent when the print operation is
unsuccessful
Note: No messages are sent from the EJ or
hard copy backup
001 Physical H0 Print operation succeeded Paper supplies are low or out
journal
H1 Print operation failed Sent when the print operation is
unsuccessful
EJ only H= EJ print operation Sent in addition to messages for physical
succeeded journal. EJ is nearly full
H> EJ print operation failed EJ is full
Note: No messages are sent from hard
copy backup
002 EJ and H0 Print operation succeeded Paper supplies are low
hardcopy
backup
H6 Journal printer backup Sent when the physical journal printer
activated enters a fatal state
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-110 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Option 35
Type Message Sequence Comment
Value
H8 Journal printer backup Sent when the journal printer restarts
reprint started
H7 Journal printer backup Sent after H8 when the reprint is
and reprint terminated successfully completed
H; Journal printer backup Sent if the journal printer enters a fatal
reprint halted state during a reprint
EJ only H= Successful EJ print Sent in addition to messages for physical
operation journal. EJ is nearly full
H> EJ print operation failed EJ is full
A solicited status message is sent in response to a Transaction Reply
Night Safe Depository Command message if the deposit has not been detected. It indicates
(Solicited/Unsolicited) 9
that one of the following conditions has occurred:
Cardholder has not attempt a deposit
Deposit door is jammed closed
Bag detection mechanism is faulty.
The unsolicited status message is sent on the tenth consecutive
‘cardholder did not attempt deposit’ indication.
Table 9-54
Night Safe Depository Status
Number of
Field Content
Characters
g1 1 Device Identifier Graphic ‘K’.
g2 1 Transaction/Device Status.
Sol/
Code Description
Unsol
U ‘0’ Tenth consecutive ‘customer did not attempt a deposit’. Reported only
once.
S ‘1’ Undetected deposit, or bag detection switch blocked before enable.
See Table Note 114.
g3 1 Error Severity.
Code Description
‘0’ No error. Bag detection mechanism was clear when the deposit door was
unlocked.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-111
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
‘2’ Warning. Bag detection mechanism was blocked when the deposit door was
unlocked (solicited status). NCR recommends that you shut down the SST if you
require confirmation of all deposits.
Tenth consecutive ‘customer did not make deposit’ (unsolicited status).
g4 Var Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found.
g5 1 Supplies Status. Indicates the status of the night safe.
Code Description
‘0’ No new state (solicited only)
‘1’ No overfill condition
‘4’ Overfill condition
Table Note 114: If the bag detection mechanism is blocked when the
deposit door is unlocked, the cardholder is given time to make the
deposit (timer 08). When timer 08 expires, the error status is sent.
The ‘more time’ screen (screen ‘C00’) is not displayed unless the bag
detection mechanism is clear when the door is unlocked.
If message mode Option Digit 3A is set to check the bag detection
mechanism before unlocking the Night Deposit door, and the dour
is found to be blocked (overfill), the solicited status message is sent
immediately. For details, refer to the APTRA Advance NDC,
Supervisor’s Guide. In this case, no deposit is allowed. The current
transaction must be terminated by Central, and no further Night
Deposit transactions will be allowed by Central until the condition
is cleared.
This message indicates that an attempt to use the encryptor has
Encryptor (Unsolicited) 9
failed. If an error status is reported, NCR recommends that an
attempt be made to re‐enter the local encryption keys.
Table 9-55
Encryptor Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘L’.
e2 1 Device Status.
‘1’ Encryptor error.
‘2’ Encryptor not configured.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-112 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
e3 1 Error Severity. Standard code used to make a shutdown decision.
e4 Var Diagnostic Status.
Note: The encryptor status is reported in the M‐data field of the Diagnostic Status for
compatibility with NDC+.
e5 1 Not used.
This message indicates that a camera error has been detected. For
Camera (Unsolicited) 9
details of the Enhanced Configuration option to enable unsolicited
error reporting for the security camera, see “Option 32 – Unsolicited
Reporting Control” on page 7‐10.
Supervisor message mode Option Digit 3B can also be set to send
unsolicited messages. For details, refer to the APTRA Advance NDC,
Supervisor’s Guide.
Table 9‐56
Camera Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘M’.
e2 1 Device Status. Always ‘0’.
e3 1 Error Severity. This can be good, warning or fatal.
e4 Var Diagnostic Status.
Note: The M‐data information applies only to certain types of camera.
e5 1 Supplies Status. Indicates the status of the storage capacity for pictures.
Code Description
1 Capacity OK
2 Nearly Full
3 Capacity Exhausted
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-113
Terminal to Central Messages
Device Status Information
This message is sent on Supervisor mode entry and exit, tamper
Sensors (Unsolicited) 9
indicating bin in/out conditions and alarm conditions.
Table 9-57
Sensors Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘P’.
e2 19 Device Status. This field contains up to 19 bytes.
Byte 1 indicates the type of change being reported:
Char Code Description
1 ‘1’ ‘TI’ sensor change
‘2’ Mode change
‘3’ Alarm state change
See Table Note ‘5’ Full TI and full alarms change detected
117
See Table Note ‘6’ Flexible TI and alarms change detected
117
If byte 1 = ‘2’ (mode change) the next byte gives details of the current state:
2 ‘0’ Supervisor mode exit
‘1’ Supervisor mode entry
3 ‘1’ Simulated Supervisor mode entry/exit during AER (if configured through
the registry)
Bytes 3/4‐13 are omitted.
For example, ‘P21’ indicates Supervisor mode entry and ‘P20’ Supervisor mode exit.
If an extra field is included to distinguish between simulated Supervisor entry and exit
during AER, the codes are ‘P211’ and ‘P201’. Byte 3 is used if the extra field is added in the
message.
For information on configuring the extra field through the registry, refer to the
“Configuring Supervisor Functionality” section in chapter 5 “Configuring Advance NDC
and Associated Components” of the APTRA Advance NDC, Developer’s Guide.
If byte 1 = ‘1’(TI sensor change) or ‘3’ (Alarm state change) bytes 2‐13 give details of the
state of the following sensors:
2 ‘0’ Supervisor mode inactive
‘1’ Supervisor mode active
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-114 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
3 ‘0’ Vibration and/or heat sensor inactive.
See Table Note 115 and Table Note 116.
‘1’ Vibration and/or heat sensor active
4 ‘0’ Door contact sensor inactive. See Table Note 115 and Table Note 116.
‘1’ Door contact sensor active
5 ‘0’ Silent signal sensor inactive. See Table Note 115 and Table Note 116.
‘1’ Silent signal sensor active
6 ‘0’ Electronics enclosure sensor inactive. See Table Note 115 and Table Note
116.
‘1’ Electronics enclosure sensor active
7 ‘0’ Deposit bin out
‘1’ Deposit bin in
8 ‘0’ Zero is always returned
9 ‘0’ Currency reject bin out
‘1’ Currency reject bin in
10 ‘0’ Currency cassette in position 1 (top) out
‘1’ Currency cassette in position 1 (top) in
11 ‘0’ Currency cassette in position 2 (second) out
‘1’ Currency cassette in position 2 (second) in
12 ‘0’ Currency cassette in position 3 (third) out
‘1’ Currency cassette in position 3 (third) in
13 ‘0’ Currency cassette in position 4 (bottom) out
‘1’ Currency cassette in position 4 (bottom) in
If byte 1 = ‘5’ (full TI and full alarms change detected) bytes 2‐13 are as above. Bytes 14‐19
give details of the state of the following sensors.
Char Code Description
14 ‘0’ Coin dispenser out
‘1’ Coin dispenser in
15 ‘0’ Coin dispenser hopper 1 out
‘1’ Coin dispenser hopper 1 in
16 ‘0’ Coin dispenser hopper 2 out
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-115
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
‘1’ Coin dispenser hopper 2 in
17 ‘0’ Coin dispenser hopper 3 out
‘1’ Coin dispenser hopper 3 in
18 ‘0’ Coin dispenser hopper 4 out
‘1’ Coin dispenser hopper 4 in
19 ‘0’ CPM pockets open
‘1’ CPM pockets closed
If byte 1 = ‘6’ (flexible TI and alarms change detected), the data is the same as that for the
Extended Tamper Indicator Identifier ‘C’ of the Tamper and Sensors Data command. For
details, see Table 9‐24, “Tamper and Sensor Data Response” on page 9‐56.
e3 Not present
e4 Not present
e5 Not present
Table Note 115: If the SST is not configured with the Tamper
Indicating feature, a code of ‘1’ is never returned and bytes 7‐13 are
omitted from all messages.
Table Note 116: If a device is not configured, the associated tamper
byte will take the value zero.
Table Note 117: These types of change are reported only when
option 24 is set to send the Enhanced TI/Sensor status.
This message indicates that the keyboard has detected an error.
Touch Screen Keyboard
(Unsolicited) 9
Table 9-58
Touch Screen Keyboard Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘Q’.
e2 1 Device Status. Always ‘3’, indicating a hardware error.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-116 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
e3 1 Error Severity. Always ‘4’, indicating fatal.
e4 Var Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found.
e5 ‐ Not present.
This message is sent to inform the host of the functions selected by
Supervisor Keys the operator after entry to Supervisor mode.
(Unsolicited) 9
Note: When Diagnostics is selected from the Select menu in
Supervisor, an R07 message is sent to the host. This indicates that
the Diagnostics option has been selected, but not whether entry to
Diagnostics has been successful.
Table 9‐59
Supervisor Keys Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘R’.
e2 Var Device Status.
Char Code Description
If Option Digit 0 = ‘0’, the device status field will contain two characters:
1‐2 ‘00’ ‐ ‘98’ Key selection from Select menu.
or
If Option Digit 0 = ‘1’, the device status field will contain three characters:
1 ‘0’ Select menu
‘1’ Replenishment menu
‘2’ Configure menu
‘3’ Access menu
‘4’ Reserved.
‘7’ Exit menu. See Table Note 118.
‘8’ Exit menu. See Table Note 118.
2‐3 ‘00’ ‐ ‘98’ Menu item selected. For the permitted values for each menu, refer to
the APTRA Advance NDC, Supervisor’s Guide.
or
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-117
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
If Option Digit 0 = ‘2’, the device status field will contain five characters:
1‐3 as for Option Digit 0 = ‘1’
4‐5 ‘00’ ‐ ‘98’ Item selected from a sub‐menu, such as the Key Entry menu. For the
permitted values for each menu, refer to the APTRA Advance NDC,
Supervisor’s Guide.
or
If Option Digit 0 = ‘3’, the device status field will contain three to seven characters:
1‐5 as for Option Digit 0 = ‘2’
6‐7 ‘00’ ‐ ‘98’ Item selected from the options, such as component selection on the
Key Entry menu. For the permitted values for each menu, refer to the
APTRA Advance NDC, Supervisor’s Guide.
or
If Option Digit 0 is set to any value greater than ‘3’, the selections are reported as if Option Digit 0 had been set
to ‘2’; that is, the component selections are not reported.
Table Note 118: Menu numbers 7 and 8 are reserved for Exits
designers. You may also redefine these messages using the SUPCTR
file. For more information, refer to the APTRA Advance NDC,
Extending the Product publication.
Table Note 119: When a menu is longer than one screen, function
‘99’ is used to switch between the screens. No message is
transmitted for this selection.
The menu item is normally as defined in the APTRA Advance NDC,
Supervisor’s Guide, but with the following exception:
For compatibility with previous releases, function ʹ25ʹ Key Entry on
the Access menu is not reported when Option Digit 0 = ‘1’. Actions
in the Key Entry sub‐menu are reported using the Access menu
functions ‘6’ to ‘11’. The components of each key are entered and
written to the encryptor as follows:
Key Enter Component Write to Encryptor
V 06 07
A 08 09
B 10 11
All other fields are omitted.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-118 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
An unsolicited message is sent to indicate a state change in the
Cardholder Display Alarm cardholder display sensor. The reporting of unsolicited message is
(Unsolicited) 9
controlled through Enhanced Configuration Parameter option 32.
For details, see “Option 32 – Unsolicited Reporting Control” on
page 7‐10.
Table 9-60
Cardholder Display Alarm Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘S’.
e2 1 Device Status
Always ‘0’
e3 1 Error Severity. This is a single character field coded in the standard way to be used to
make a shutdown decision. The value can either be 0 or 4.
‘0’ ‐ No error/not supported.
‘4’ ‐ Fatal.
e4 Field not present.
e5 Field not present.
A solicited status message is sent to the host if a fault requiring
Statement Printer attention occurs during transaction processing. An unsolicited
(Solicited/Unsolicited) 9
status message is sent when a statement is detected in the transport,
the statement printer supplies (paper, ribbon, print‐head, knife,
capture bin) require attention, or an error occurs on a
cut‐and‐deliver function during a Close state.
Table 9-61
Statement Printer Status
Number of
Field Content
Characters
g1/ 1 Device Identifier Graphic ‘V’.
e1
g2/ 1 Transaction/Device Status.
e2
Sol/
Code Description
Unsol
U ‘0’ No transaction error condition, but check other fields for error severity,
diagnostic status or supplies status change.
S/U ‘1’ Print/cut not successful
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-119
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
S ‘2’ Device not configured
U ‘3’ Statement present in transport
U ‘4’ Cardholder pressed Cancel during a ‘print statement and wait’ function.
N/A ‘5’ Reserved
N/A ‘6’ Reserved
g3/ 1 Error Severity. Standard code used to make a shut‐down decision.
e3
g4/ Var Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found.
e4
g5/ 5 This five‐character field indicates the status of the printer paper, paper ribbon, print‐head,
e5 knife and capture bin.
Char Code Description
0 ‘1’ Sufficient paper
‘2’ Paper low
‘3’ Paper exhausted
1 ‘1’ Ribbon OK
‘2’ Ribbon replacement recommended
‘3’ Ribbon replacement mandatory
2 ‘1’ Print‐head OK
‘2’ Print‐head replacement recommended
‘3’ Print‐head replacement mandatory
3 ‘1’ Knife OK
‘2’ Knife replacement recommended
‘3’ Knife replacement mandatory
4 ‘1’ Capture bin OK
‘4’ Capture bin overfill. See Table Note 121.
Table Note 120: If message mode Option Digit 3C is set, the Cancel
key on the consumer keyboard is enabled during Print Statement
And Wait functions. For details, refer to the APTRA Advance NDC,
Supervisor’s Guide. If the cardholder presses the Cancel key, a new
unsolicited status message is sent to the host. If this option is used,
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-120 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
the host application must be changed so that it recognises the new
status message.
The print statement function being performed when the consumer
presses Cancel is unaffected and is completed as normal.
Table Note 121: If the statement capture bin returns a status of
‘overfill’, the statement printer must be initialised using the
Supervisor option ‘INIT STMNT’ from the Replenish Menu, once
the capture bin has been emptied. For details, refer to the APTRA
Advance NDC, Supervisor’s Guide.
If there is a problem with the voice guidance system and Enhanced
Voice Guidance Configuration option 32 is set, this unsolicited message gives the
(Unsolicited) 9
status of the following features of voice guidance:
The audio card
The enhanced audio control
The audio jack
The voice guidance XML configuration file.
For details of option 32, see “Option 32 – Unsolicited Reporting
Control” on page 7‐10.
Table 9-62
Voice Guidance Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘a’.
e2 1 Device Status. Indicates there is a problem with the voice guidance system. The value is:
Sol/
Code Description
Unsol
U ‘1’ An error has occurred
e3 1 Error Severity.
Code Description
0 No errors
2 Warning
4 Fatal
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-121
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
e4 Var Diagnostic Status. The diagnostic status is formatted as follows:
Byte Code Description
1 00 Audio card is inaccessible
01 Audio card is accessible
2 00 No audio jack available
01 The audio system is in manual mode and the public state. All audio
messages are played through the speakers.
02 The audio system is in automatic mode and the public state. When a
headset is inserted, the audio messages are played through the audio
jack; otherwise audio messages are played through the speakers.
04 The audio system is in semi‐automatic mode and the public state. When a
headset is inserted, the audio messages are played through the audio
jack; otherwise audio messages are played through the speakers.
08 The audio system is in manual mode and the private state. All audio
messages are played through the audio jack only, whether or not a
headset is inserted.
16 The audio system is in automatic mode and the private state. When a
headset is inserted, audio messages are played through the audio jack;
when the headset is removed, the device enters the public state.
32 The audio system is in semi‐automatic mode and the private state. All
audio messages are played through the audio jack; when the headset is
removed, the audio system remains in the private state.
3 00 No audio jack is present
01 A headset is connected
02 No headset is connected
4 00 The XML definition file is inaccessible
01 The XML definition file is accessible
e5 Not used.
This message gives the status of the cash acceptor or recycling unit
Note Acceptor in the following situations:
(Solicited/Unsolicited) 9
Solicited device status messages sent in response to the
following Transaction Reply command messages:
— Refund Cash Deposit
— Deposit Cash
— Deposit Cash and Wait
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-122 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
— Dispense notes first during valuable media exchange
— Deposit notes first during valuable media exchange
As a result of a cash acceptor or recycling unit error
Whenever the device completes an operation, for example, after
processing inserted notes. This is always reported, whether the
operation is successful or produces an error.
In the event of an error, for example when a refund operation
jams, the number of notes at each location in the BNA will
become indeterminable. In this case, the best known
representation of the counts will be shown. A counter of 0,
represented by a space in the message, may be reported for
active note types whose counts are unknown.
Counts are returned as follows:
— All count fields (for notes in the escrow, vaulted notes and
returned notes) in status messages include category 3
(suspect) and category 4 (authenticated) notes combined.
— Counts for category 2 (counterfeit) notes are never included
except in ECB 6 messages for category 2 notes, indicated by
the message designator ‘?’.
— ECB 6 messages for category 3 notes have a message
designator of ‘@’ and include the counts for category 3 notes.
During a dispense operation where recycling is enabled and the
supplies status changes from Media Full to Media High or from
Media High to Good for a cassette, an unsolicited status
message is sent. No transaction note counts are reported.
If error recovery is enabled and a power failure occurs with
notes in the escrow, then on power‐up an unsolicited status
message is sent reporting the vaulted counts returned by XFS. If
the platform has limitations in reporting updated counts, the
message COUNTS MAY BE INACCURATE is journaled.
Reporting of CIM NDC Cassette Types 9
The number of CIM NDC cassette types and the order in which they
are reported to the host depends on the reporting of the XFS logical
cash units by the platform.
On a GBXX system, CIM NDC cassette type reporting depends on
the initial position of the cassettes following installation. If new XFS
logical cash units are inserted, these are appended to the existing
reporting order.
Counts in ECB 6 Unsolicited Messages 9
When category 2 (counterfeit) notes are sent in a w? unsolicited
message or category 3 (suspect) notes in a w@ unsolicited message,
counts are reported as follows:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-123
Terminal to Central Messages
Device Status Information
Direct deposits
Counts are reported in the Vaulted Counts field, which is used
to report note counts after notes are inserted
Escrow deposits
Counts are reported in the Escrow Counts field
Table 9-63
Bunch Note Acceptor Status
Field Number of
Content
(Subfield) Characters
g1/e1 1 Device Identifier Graphic ‘w’.
g2/e2 1 Transaction/Device Status; gives details of a cash acceptor or recycle unit operation in
response to a Transaction Reply command message, or as a result of a cash acceptor or
recycling unit error
Values are:
(g200/ 1 Error Code
e200) See Table Note 122
Sol/
Code Description
Unsol
U ‘0’ Successful operation, but an exception has occurred or notes have been
moved in the device outside a Transaction Reply function. Up to date
counts are included, which will be in the escrow notes field (refundable
deposits) or the vaulted notes field (direct deposits). In this case, both
counts are cumulative within the transaction. See Table Note 123
It is also possible for a w0 code to be returned when notes are refunded
for example, in the Close state. In this case, counts are reported in the
Refunded counts fields
U ‘1’ Cancel selected, Refund selected or a time‐out occurs during the Cash
Accept state. Note counts will be in the escrow notes field (refundable
deposit) or the vaulted notes field (direct deposit). See Table Note 123
N/A ‘2’ Reserved for legacy implementations
S/U ‘3’ Error ‐ if counts are included, they are as accurate as the available
information allows, except for notes left in the escrow in the Close state
when the note counts are accurate.
See Table Note 123 and Table Note 124
S/U ‘4’ Device inoperative ‐ notes are left at the exit slot; counts are included.
Usually this is returned counts in the w4 message as notes are at the exit
slot. See Table Note 123
S ‘5’ No notes in the escrow when the Transaction Reply function attempts to
vault escrowed notes or return cash, indicating an error at the host
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-124 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Field Number of
Content
(Subfield) Characters
U ‘6’ Notes detected at power‐up; if automatic error recovery is disabled
counts are included in the escrow counts field; if automatic error
recovery is enabled and the notes are successfully moved, the counts
will be in the vaulted counts field.
U ‘7’ Notes not taken, but retracted; counts are included in the Vaulted
Counts field. (not reported on cash acceptors that do not support retract
operations or with retract disabled)
See Table Note 125 and Table Note 126
N/A ‘8’ Unable to be vaulted. Not supported
N/A ‘9’ Reserved for legacy implementations
U ‘?’ Counterfeit notes have been detected.
See Table Note 127, Table Note 128 and Table Note 129
U ‘@’ Suspect notes have been detected.
See Table Note 127, Table Note 128 and Table Note 129
N/A A Reserved for legacy implementations
N/A B Reserved for legacy implementations
N/A C Reserved for legacy implementations
N/A D Reserved for legacy implementations
U F In the Close state, the notes are captured to casettes and/or bins as part
of the Auto Error Recovery. The captured notes are reported in the
vaulted counts, which includes the counts of all the notes that are moved
to the cassettes and/or bins from all parts of the device during the auto
error recovery. The counts may not be accurate if the device has not
detected all the notes that are captured during error recovery.
See Table Note 133
(g201/ 50 Escrow counts up to 90 for each of the 50 NDC note types (1 byte each)
e201) See Table Note 130
(g202/ 50 Vaulted counts up to 90 for each of the 50 NDC note types (1 byte each)
e202) See Table Note 130
(g203/ 50 Returned counts up to 90 for each of the 50 NDC note types (1 byte each)
e203) See Table Note 130
(g204/ 1 Total number of notes, up to 90, returned to the exit slot
e204) See Table Note 131
g205/ 1 Total number of notes, up to 90, in the escrow
e205) See Table Note 131
(g206/ 1 Total number of notes, up to 90, just vaulted
e206) See Table Note 131
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-125
Terminal to Central Messages
Device Status Information
Field Number of
Content
(Subfield) Characters
When bit 1 of option 45 is set, the following fields are also present for note types with more than 90 notes. Each
pair consists of a Note Type, and a Note Count the value of which is added to the previous note count to report
the total number of notes entered.
Note: These fields are repeated for each note type where the number of notes entered is more than 90. If any of
these fields is present, all the group separators must be present even if there is no data for the data groups. If all
the total values are not more than 90 notes, no fields after g206/e206 will be present.
(g207/ Escrow counts for each NDC note type with more than 90 notes
e207) See Table Note 132
2 Note type as a hexadecimal value
3 Note count as a decimal value, added to the previous note count for that type, to report
the total number of notes entered
(g208/ Vaulted counts for each NDC note type with more than 90 notes
e208) See Table Note 132
2 Note type as a hexadecimal value
3 Note count as a decimal value, added to the previous note count for that type, to report
the total number of notes entered
(g209/ Returned counts for each NDC note type with more than 90 notes
e209) See Table Note 132
2 Note type as a hexadecimal value
3 Note count as a decimal value, added to the previous note count for that NDC note type,
to report the total number of notes entered
(g210/ 3 Total number (decimal value) of notes returned (moved to the exit slot) in excess of 90
e210) See Table Note 134
(g211/ 3 Total number (decimal value) of notes in the escrow or in the top transport in excess of 90
e211) See Table Note 134
(g212/ 3 Total number (decimal value) of notes just vaulted in excess of 90
e212) See Table Note 134
g3/e3 Var Error severity, as described in “Cash Acceptor Fitness (DIG ‘w’)” on page E‐25
g4/e4 Var Diagnostic status (M‐status plus M‐data); the M‐status describes the main error found
See Table Note 135 and Table Note 136
g5/e5 Var Supplies status of all cassettes in the device, as described in “Cash Acceptor Supplies
(DIG ‘w’)” on page E‐17
The status is reported as follows:
Code Description
‘0’ No change
‘1’ Good state
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-126 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Field Number of
Content
(Subfield) Characters
‘2’ Bin out (missing or removed)
‘3’ Media high (nearly full)
‘4’ Media full (overfill)
Table Note 122: For field ‘g2’, the error code information is obtained
by mapping from XFS to the corresponding error code.
Table Note 123 Counts are cumulative up to the point that notes are
refunded. Then a retract operation will restart the count.
Table Note 124: If a deposit transaction is initiated on an SST
without a BNA, no status message is sent to the host.
Table Note 125: If notes not taken by the consumer are retracted to
the escrow, the cash acceptor is reported as in a fatal condition. The
notes must be removed from the SST and either the Initialise BNA
or Clear BNA Supervisor options must be performed to resolve this
condition.
Table Note 126: If notes are taken late, that is, just as the retract
operation starts, no w7 message is sent and Advance NDC remains
in the Cash Accept state.
Table Note 127: The reporting of counterfeit and suspect notes can
be configured. For details of this configuration, refer to Chapter 5,
“Configuring Advance NDC and Associated Components” in the
APTRA Advance NDC, Developer’s Guide. If both counterfeit and
suspect notes are detected, separate unsolicited messages are sent
for each type. Suspect note counts are included in the note counts
for all status messages other than ‘w?’ status messages. Counterfeit
notes are included only in ‘w?’ status messages.
Table Note 128: The counterfeit and suspect note counts in both the
escrow counts field (refundable deposit) and the vaulted counts
field (direct deposit) are cumulative. That is, each message reports
the total counts in the Escrow counts field for all bunches of notes
inserted until either a Transaction Request message is sent or notes
are refunded. In multiple bunch deposits, a message is sent for each
bunch deposited even if no more suspect or counterfeit notes have
been added. For refundable deposit in ECB 6 mode, the inserted
suspect notes (category 3) will be reported together with the
authenticated notes (category 4) in the Escrow counts fields
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-127
Terminal to Central Messages
Device Status Information
independently of the actual possible physical location of the suspect
notes.
The ‘w?’ and ‘w@’ messages are not sent if no notes of the category
have been inserted during the transaction.
Table Note 129: If counterfeit and suspect notes are configured, this
message can also be configured to include cardholder data after the
supplies data. If this data is to be included, the fields described in
Table 9‐64 are added to the message. For details of configuring this
extension to the message, refer to Chapter 5 “Configuring Advance
NDC and Associated Components” of the APTRA Advance NDC,
Developer’s Guide.
Table 9-64 Field Number of Characters Content
Additional Cardholder Data
FS 1 Field separator
e600 Var (78) Track 1 data
GS 1 Group separator
e601 Var (39) Track 2 data
GS 1 Group separator
e602 Var (106) Track 3 data
Table Note 130: Each byte contain an ASCII value between 20H and
7AH, representing the number of notes of that denomination; for
example, ASCII char !(21H) in position 2 means one note of NDC
note type 2.
Table Note 131: A single ASCII value between 20H and 7AH,
representing a total for the number of notes within a processing
category; for example, ASCII char !(21H) means one note.
Table Note 132: A group of zero or more data pairs providing
information for denominations with more than 90 notes. Only
denominations that have more than 90 notes are included;
denominations with exactly 90 notes are not. Each data pair consists
of a Denomination Type field and a Note Count field. The
Denomination Type field has a hexadecimal value in the range 01 to
32. The Note Count field has a decimal value in the range 001 to 999.
The Note Count value is added to the equivalent previous
single‐byte ASCII note count. The sum of the previous field and the
current field provides the total number of notes.
Table Note 133 The status message “wF” does not journal the
counts as these counts are journaled as part of the recovery.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-128 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Table Note 134: The decimal value (001 to 999) to be added to the
equivalent previous single byte ASCII note count. The sum of the
previous field and this value provides the total number of notes. If
any of fields ‘e210’/’g210’ to’ e212’/’g212’ are present, all must be
present.
Table Note 135: When a ‘w6’ message (notes detected at start of day)
or a ‘w3’ message (device error) is sent, and the platform has not
provided an M‐Status value, an appropriate fixed non‐zero
M‐Status value will be included in the message.
Table Note 136 Native diagnostics data is reported if available
(always available on NCR SSTs) otherwise XFS values are mapped
to GBRU M‐Status values.
The envelope dispenser reports unsolicited status messages
Envelope Dispenser depending on the value of Enhanced Configuration Parameter
(Unsolicited) 9
option 23 (see page 10‐17). Status messages are sent when the
envelope dispenser is detected as being low/out or an envelope
failed to be presented or retracted.
Remote status indicators and the remote relay are optionally set and
enabled depending on the value of option 23. Solicited status
messages are never sent for the envelope dispenser, regardless of
the value of option 23.
Messages detailing fitness, configuration and supplies information
are sent to the host in response to the ‘send configuration data’
terminal command.
Table 9-65
Envelope Dispenser Status
Number of
Field Content
Characters
e1 1 Device Identifier Graphic ‘\’.
e2 1 Device Status. Indicates whether the last operation was successful.
Sol/
Code Description
Unsol
U ‘0’ Envelope presented satisfactorily.
U ‘1’ Failure ‐ envelope not presented or retracted.
e3 1 Error Severity. Standard code.
e4 Var Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found.
e5 1 Supplies Status. Indicates the replenishment status of the bin containing envelopes to be
dispensed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-129
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
Code Description
‘1’ Sufficient envelopes.
‘2’ Envelopes low.
‘3’ Envelopes exhausted.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-130 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
This message gives details of possible cheque processor responses to
Cheque Processor a Transaction Reply command, some of which can be controlled by
(Solicited/Unsolicited) 9
Enhanced Configuration option 83 in Close State. For details, see
“Option 83 – Cheque Processor” on page 7‐21.
If a Transaction Reply command contains one of the cheque
processor function values and the SST does not have a cheque
processor configured, a solicited error message is returned.
Table 9-66
Cheque Processor Status
Number of
Field Content
Characters
g1 1 Device Identifier Graphic ‘q’.
g2 Var(2) Transaction/Device Status. Gives details of a cheque processor operation in response to a
Transaction Reply Command message. The values are:
Error Code (e200/g200).
Sol/
Code Description
Unsol
U ‘0’ Successful operation, but an exception has occurred.
S/U ‘1’ Cancel selected/Time‐out occurs during processing (entry/retrieval) of
cheque, due to one of the following:
‐ Cardholder did not insert a cheque
‐ Cardholder inserted cheque which was not successfully accepted, but
retrieved by cardholder
‐ Cardholder selected Cancel key instead of inserting cheque.
When option 83 bit 0 and bit 1 are set to zero, this code also reports
retracts.
S/U ‘2’ Cheque processor failure.
U ‘3’ Cheque detected at power‐up.
S/U ‘4’ Error, no access (error on bin).
S/U ‘5’ Cheque jam.
S ‘6’ Cheque jam, no access.
When option 83 bit 0 or bit 1 is set to one, the following code may also be returned:
S/U ‘7’ Cheque retracted and captured.
Error Position (e201/g201)
Code Description
(space) ‘ ’ Non‐hardware status reported, or error position not known (severity is Good,
Suspend or Fatal).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-131
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
‘E’ Cheque entry/re‐entry error (Suspend or Fatal).
On a bunch cheque acceptor, this is reported after an error has occurred while
inserting cheques or when an error occurs while retracting cheques
‘F’ Image lifting error (Suspend or Fatal).
On a bunch cheque acceptor, this is not reported
‘J’ Eject error (Suspend or Fatal).
On a bunch cheque acceptor, this is reported after an error when all cheques are
returned to the cardholder
‘C’ Capture error (Suspend or Fatal).
On a bunch cheque acceptor, this is reported after an error when all cheques are
captured
‘W’ Endorse error (Suspend or Fatal).
On a bunch cheque acceptor, this is reported when an error is detected with the
endorser before cheques are moved from the stacker or any items have been
endorsed. All cheques are waiting to be processed
‘P’ Power‐fail error, last cheque endorsed (Error code 3, Suspend only).
On a bunch cheque acceptor, this is not reported
‘N’ Power‐fail error, last cheque not endorsed (Error Code 3, Suspend only).
On a bunch cheque acceptor, if a power fail error occurs, some cheques may
have been endorsed, but some may not
When option 83 bit 1 is set to one, the following additional data is returned to indicate the
location of the media
See Table Note 137
1 GS Group Separator
See Table Note 138 and Table Note 139
3 Cheque ID. The three‐digit decimal number assigned to each cheque in the range 000‐999
2 Cheque Location
Value Description
01 The cheque is inside the device, but not in a bin
02 The cheque is in a bin. The bin is identified in the Bin Number field
03 The cheque has been returned to the cardholder
04 The location of the cheque is unknown
2 Bin Number. A two‐digit decimal value containing the number of the bin in which the
cheque has been deposited
If the cheque is not in a bin, this is ‘00’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-132 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
g3/ Var Error Severity.
e3
When option 83 bit 0 and bit 1 are set to zero, a single character is returned, which
represents the overall error severity of the device.
Char Description
1 Overall cheque processor
When option 83 bit 0 or bit 1 is set to one, the following is returned:
Char Description
1 Overall cheque processor
2 Endorse printer
3 Stamper
4 Reserved
5 Reserved
6 Bin 1
7 Bin 2
8 Bin 3
: :
n Bin n
The number of bins reported depends on hardware configuration
Each character can take one of the following values:
Value Description
‘0’ No error / Not configured
‘1’ Routine
‘2’ Warning
‘3’ Suspend
‘4’ Fatal
g4/ Var Diagnostic Status.
e4
When option 83 bit 0 and bit 1 are set to zero, this field contains zeroes and is 14 bytes
long.
When option 83 bit 0 or bit 1 is set to one, this field is variable length and contains the
cheque processor diagnostic information.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-133
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
g5/ Var Supplies Status.
e5
When option 83 bit 0 and bit 1 are set to zero, this field contains zeroes and is 4 bytes long.
When option 83 bit 0 or bit 1 is set to one, the following is returned:
1 Endorse printer
1 Stamper
1 Reserved
1 Reserved
1 Bin 1
1 Bin 2
1 Bin n
Supplies Status Values
Value Description
‘0’ Not configured / Reserved
‘1’ Good state
‘2’ Media low
‘3’ Media out
‘4’ Overfill
‘5’ Media high (almost full)
Table Note 137: If an error occurs, it is not always possible to
accurately report the location of a cheque.
Table Note 138: When information on cheque location is reported,
each cheque is reported within a group separated by a group
separator. All fields must be present for each cheque that has a
cheque ID, including any cheques that the cardholder requested for
return. Each cheque data group is preceded by a group separator.
No group separator follows the final cheque to be reported, and if
no cheques are reported, no group separator is present.
Table Note 139: When the unsolicited message is generated before a
transaction request has been sent to the host, no information on the
cardholder or the cheques is available to the host. However, all local
data is journaled.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-134 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
This message gives details of a Coin Dispenser response to a
Coin Dispenser Transaction Reply Command message. Unsolicited messages
(Solicited/Unsolicited) 9
always have a device status of 0.
When option 79 is set to ‘000’, this message reports the status of four
hopper types. When option 79 is set to ‘001’, this message reports
the status of the number of hopper types reported in the Hardware
Configuration message. The status is always reported for a
minimum of four hopper types. For details of option 79, see “Option
79 – Coin Dispenser” on page 7‐21.
Table 9-67
Coin Dispenser Status
Number of
Field Content
Characters
g1/ 1 Device Identifier Graphic ‘Y’.
e1
g2/ 1 Transaction/Device Status. Gives details of a coin dispense operation in response to a
e2 See Table Transaction Reply Command message. The values are:
Note 140
See Table Sol/
Code Description
Note 141 Unsol
S/U ‘0’ Successful operation, but an exception has occurred, described in the
Diagnostic Status field.
S ‘1’ The coin dispenser low thresholds for each coin hopper were not set
during the configuration of the SST. No coins have been dispensed.
S ‘3’ The coin dispense has not started as the requested hopper is:
in a fatal state
out of coins
not in the correct position to allow a dispense
in a low condition without enough coins to perform the dispense.
No coins have been dispensed.
S ‘4’ The coin dispense has failed for a reason other than a jam. Some coins
may have been dispensed.
S ‘9’ The coin dispense has failed due to a jam in the hopper. Some coins
may have been dispensed.
S ‘:’ The coin dispense has failed due to a jam in the transport chute. Some
coins may have been dispensed.
S ‘;’ The transport chute exit sensor was blocked at the start of the coin
dispense. No coins have been dispensed.
S ‘<’ A coin dispense has been attempted while the coin dispenser is in a
fatal state. No coins have been dispensed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-135
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
S ‘=’ Tampering detected during dispense. The coin dispense has failed
due to the module being accessed during the dispense. Some coins
may have been dispensed.
Var Coins Dispensed
See Table
Char Description
Note 142
2‐3 Decimal representation of the number of coins dispensed from hopper type 1
4‐5 Decimal representation of the number of coins dispensed from hopper type 2
6‐7 Decimal representation of the number of coins dispensed from hopper type 3
8‐9 Decimal representation of the number of coins dispensed from hopper type 4
10‐11 Decimal representation of the number of coins dispensed from hopper type 5
<n>‐(<n Decimal representation of the number of coins dispensed from hopper type
>+1) <n>
g3/ Var Error Severity. Used to make a shut‐down decision. Holds the severity information for the
e3 coin dispenser and the sub‐device elements (coin hoppers 1 to <n>).
Char Description
1 Coin dispenser core components
2 Coin hopper type 1
3 Coin hopper type 2
4 Coin hopper type 3
5 Coin hopper type 4
6 Coin hopper type 5
<n> Coin hopper type<n>
Each character can take one of the following values:
Value Description
‘0’ No error
‘1’ Routine
‘2’ Warning
‘3’ Suspend. This is only used for the coin dispenser core components character
‘4’ Fatal
g4/ Var(14) Diagnostic Status. Maintenance data reported by the coin dispenser.
e4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-136 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
g5/ Var(4) Supplies Status. Holds the replenishable condition for the coin dispenser and the
e5 sub‐device elements. See field g3/e3 (Error Severity) for the order of reporting on the coin
dispenser and the sub‐device elements.
Value Description
‘0’ State not determined during this operation
‘1’ Good
‘2’ Hopper Low. The sensor associated with this hopper has indicated a low
condition.
‘3’ Hopper Empty. The sensor associated with this hopper has indicated low and
the coin low threshold limit has been reached.
Table Note 140: For field g2, the error code information is obtained
by mapping the received ActiveXFS event to its corresponding error
code.
Table Note 141: Unsolicited messages always have a device status of
‘0’.
Table Note 142: This information can be used to facilitate a
transaction reversal or correction if required. The information refers
to coins that have left the hopper, but not necessarily reached the
cardholder.
This message gives details of the barcode reader response to a
Barcode Reader Transaction Reply command message. Unsolicited device status
(Unsolicited) 9
messages are sent only if option 48 is set to 1. For more information,
see “Option 48 – Barcode Reader” on page 7‐18.
Table 9-68
Barcode Reader Status
Number of
Field Content
Characters
e1/ 1 Device Identifier Graphic ‘f’
g1
e2/ 1 Device Transaction Status
g2 Error Code (e200/g200)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-137
Terminal to Central Messages
Device Status Information
Number of
Field Content
Characters
Sol/
Code Description
Unsol
U ‘0’ Good operation but some exception has occurred as detailed in the
accompanying data.
U ‘1’ Barcode reader is inoperative.
1 Field Separator
e3/ 1 Overall Barcode Reader Error Severity
g3
Code Description
‘0’ No error / Not configured
‘1’ Routine
‘2’ Warning
‘3’ Suspend
‘4’ Fatal
1 Field Separator
e4/ Var Diagnostic status
g4 Barcode reader diagnostic information
1 Field Separator
e5/ 0 Supplies Status
g5
Secondary Card Reader This message gives details of any exception condition that is
detected during card processing by the secondary card reader.
(Unsolicited) 9
Advance NDC supports only a contactless card reader as the
secondary card reader and does not report solicited device faults for
a secondary card reader. If a contact and a contactless card reader
are available on an SST, the contactless card reader is always the
secondary card reader.
Note: If failure occurs in the physical connection or in the
configuration of the reader, an unsolicited status message is
reported indicating that the secondary card reader has a fatal
severity and that the device is inoperative. Advance NDC does not
put the SST into Out of Service mode even when either or both the
card readers enter a fatal state. It is the responsibility of the host and
the host must be configured to do this if required.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-138 APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Table 9-69
Secondary Card Reader Status
Number of
Field Content
Characters
g1/ 1 Device Identifier Graphic ‘y’
e1
g2/ 1 Transaction/Device Status. Gives details of any transaction‐related exception condition
e2 detected while processing a card at the SST. Only one value is returned as follows:
Sol/
Code Description
Unsol
U ‘0’ No transaction exception condition occurred but consult other fields
for error severity, diagnostic status or supplies status changes.
g3/ Var Error Severity. This is a one or two character field coded in the standard way to be used to
e3 (1 or 2) make a shut‐down decision. For details, see “Device Fault Status Information Field” on
page 9‐79 “
g4/ Var Diagnostic Status (M‐status plus M‐data). This contains information to be used for
e4 logging device errors. The M‐status describes the main error found.
See Table Note 143
g5/ 1 Supplies Status. This is a single character field indicating the state of the card capture bin.
e5
Code Description
‘1’ No overfill condition (capture bin)
Table Note 143 When the contactless card reader fails as a result of
any error, one of the following m‐status is reported:
Table 9-70
M-Status for Card Reader Failure
M-Status (Dec) Severity Literal Description
53 ROUTINE MS_XML_CONFIG_ERROR There has been an error when configuring
the device using the contactlessenabler
.xml file.
54 ROUTINE MS_TRANSIDNOTFOUND_ER Transaction Identifier not found in the
ROR contactlessenabler.xml file.
55 FATAL MS_READER_DATA_ERROR The data returned by the reader is invalid
and this could be as a result of the reader
firmware getting corrupted, or the
installed reader firmware does not
support the contactless card reader.
See Table Note 144
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 9-139
Terminal to Central Messages
Device Status Information
M-Status (Dec) Severity Literal Description
96 FATAL MS_USB_COMMS_FAILURE There has been an error due to
transmission of data with a contactless
card reader.
97 FATAL MS_DEVICE_TIMEOUT There has been an error due to no
response received from the contactless
card reader.
98 FATAL MS_DEVICE_COMMS_ There has been an error when USB
FAILURE communications cable is disconnected
from the contactless card reader.
Table Note 144 When m‐Status 55 is sent to the host, FIRMWARE
MISMATCH is displayed on the fault display, indicating that the USB
contactless card reader (USBCCR) component of 93.01.00.03 version
or above must be installed.
For more information on the ContactlessEnabler.xml file, refer to
section “Configuring Contactless Card Reader” in Chapter 5,
“Configuring Advance NDC and Associated Components” of the
APTRA Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-140 APTRA™ Advance NDC, Reference Manual
Table of Contents
Central to Terminal Messages
Chapter 10
Central to Terminal Messages
Overview 10‐1
Command Limitations 10‐2
Terminal Command Limitations 10‐2
Customisation Data Command Limitations 10‐2
EMV Message Class Support 10‐2
Terminal Commands 10‐3
Customisation Data Commands 10‐7
State Tables Load 10‐9
Screen/Keyboard Data Load 10‐11
Managing Keyboards and Associations 10‐13
Configuration Parameters Load 10‐15
Enhanced Configuration Parameters Load 10‐17
FIT Data Load 10‐22
Configuration ID Number Load 10‐24
Message Authentication Field Selection Load 10‐26
Date and Time Load 10‐33
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Central to Terminal Messages
Encryption Key Change 10‐34
Extended Encryption Key Change 10‐37
Dispenser Currency Cassette Mapping Table 10‐46
XML Configuration Download 10‐49
Transaction Reply Command 10‐52
Specific Command Reject Messages for
Buffer ‘d’ 10‐68
Terminal Functions for Transaction Completion 10‐69
Interactive Transaction Response 10‐91
Support for Touch‐Screen Emulation 10‐91
Support for Voice‐Guided Sessions 10‐91
Message Coordination Number (MCN) 10‐92
EJ Commands 10‐96
EJ Options and Timers 10‐96
Acknowledge EJ Upload Block 10‐97
Acknowledge and Stop EJ 10‐98
Continuous Upload 10‐99
Batch Upload 10‐100
Batch Upload Failure 10‐100
Message Validation 10‐102
Valid Message Classes 10‐102
SST to Central 10‐102
Central to SST 10‐102
Command Reject Causes 10‐102
Other Invalid Parameters 10‐109
Exits 10‐109
Messages Received in Wrong Operational Mode 10‐110
Customisation Data Commands 10‐110
Transaction Reply Command Actions 10‐111
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Central to Terminal Messages
Actions for Terminal Commands 10‐112
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Central to Terminal Messages
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Central to Terminal MessagesJ
Overview
Overview 10
This chapter describes host to terminal messages, under the
following topics:
Terminal Commands
Customisation Data Commands
Transaction Reply Command
Interactive Transaction Response
Electronic Journal Commands
Message Exception Handling
Messages Received in Wrong Operational Mode.
For any differences on other vendors’ SSTs, refer to the APTRA
Advance NDC, Multi‐Vendor Support Reference Manual.
For information on clearing persistent storage, refer to section
“Clearing Persistent Memory (NVRAM)” in Chapter 11, “Interactive
Installation of Advance NDC” of the APTRA Advance NDC,
Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-1
Central to Terminal Messages
Command Limitations
Command Limitations 10
Commands that are not supported in APTRA Advance NDC are
marked as not supported or reserved in the message formats, except
for send tallies and send error logs, as default messages are returned
if these commands are sent.
All terminal commands are processed and acknowledged, with the
Terminal Command exception of the following:
Limitations 10
Send tally information (command code 5).
This always reports a last cleared date of midnight 1st January
2000 (000101000000) and no tally data (000000)
Send error log information (command code 6).
This always reports no new entries (00) and a last cleared date of
midnight 1st January 2000 (000101000000)
Retrieve and send hallmark key from EKC, command code =
This command is rejected with the reason
Function not supported by software
Enable FREE JDATA, command code >
This command is rejected with the reason
Function not supported by software
Enable image dumping, command code ?
This command is rejected with the reason
Function not supported by software.
All data commands are processed and acknowledged, except the
Customisation Data following:
Command Limitations 10
Initialise EKC (identifier F)
Override reserved screens (identifier G)
Screen/Keyboard Data: Nested Keyboard Data (field ‘j3’)
Message class 8 is supported by EMV/CAM2 Exits for APTRA
EMV Message Class Advance NDC. For details, refer to the EMV Integrated Circuit Card
Support 10
(ICC) Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-2 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Terminal Commands
Terminal Commands 10
These commands are sent by the host to start up or shut down the
SST, or to request configuration details, counter values or date and
time information.
Table 10-1
Terminal Commands
Number of Mandatory/
Field Description
Characters Optional
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘1’ ‐ Terminal Command.
c 1 O Response Flag. Included for future use and ignored by the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). Included for future use and ignored by the
terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. Included for future use and ignored by the
terminal.
FS 1 M Field Separator.
f 1 M Command Code. One‐character field used to identify the type of Terminal
Command. The codes that can be used in this field are:
Code Description
1 Go in‐service (start‐up).
The Start‐Up command is used to put the terminal into service
after a power‐up and Customisation Data load. The terminal
sends a Ready status in response to a start‐up command when
the terminal enters the In‐Service mode. If a start‐up
command is received while the terminal is In‐Service, but not
in State 000, the terminal sends a Ready status when it enters
State 000. The start‐up command can also put the terminal into
service after a shut‐down, exit from Supervisor mode or
Suspend.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-3
Central to Terminal Messages
Terminal Commands
Number of Mandatory/
Field Description
Characters Optional
2 Go out‐of‐service (shut‐down).
The Shut‐Down command places the terminal temporarily
Out‐of‐Service. All pending messages are sent and current
transactions completed before the terminal executes the
shut‐down. The terminal then indicates that it has successfully
completed the shut‐down procedure by sending a Ready
status in a Solicited Status message.
3 Send configuration ID.
The Send Configuration ID command asks the terminal to
send the Config ID number to Central.
4 Send supply counters.
The Send Supply Counters command asks the terminal to
send the state of the supply counters to Central in the format
identified by the Command Modifier field ‘g’, as follows:
‐ Send basic supply counters message
‐ Send extended supply counters message
5 Send tally information. Not supported; default message
returned.
6 Send error log information. Not supported; default message
returned.
7 Send configuration information.
The Send Configuration Information command asks the
terminal to send the following configuration information data,
identified by the Command Modifier field ‘g’, to Central:
‐ Hardware Configuration *
‐ Supplies Status *
‐ Hardware Fitness *
‐ Sensor Status
‐ Software ID and release number
‐ Local Configuration Option Digits
‐ Report cash deposit definition
* These categories return information for a subset of possible
devices.
8 Send date and time information.
The Send Date and Time Information command asks the
terminal to send the locally held date and time to Central.
9 Reserved.
: Reserved.
; Reserved.
= Reserved.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-4 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Terminal Commands
Number of Mandatory/
Field Description
Characters Optional
< Reserved.
> Reserved.
? Reserved.
F Disconnect.
For details, see Chapter 13, “CCM VISA2 Dialup System”.
G Maintain connection to complete transaction (No‐Op).
For details, see Chapter 13, “CCM VISA2 Dialup System”.
g 1 0 Command Modifier. This field can optionally be used when the Command
Code is 2 or 4 and must be present when the Command Code is 5, 6 or 7.
Code Go out of service (Command Code = 2).
‘0’ Standard Out‐of‐Service screen displayed
‘1’ Temporary Out‐of‐Service screen displayed
Defaults to zero if:
‐ Any value other than zero or one is sent
‐ The field is empty
Code Send Supply Counters message (Command Code = 4)
none Send basic supply counters message
‘1’ Send basic supply counters message
‘2’ Send extended supply counters message
Code Tally (Command Code = 5)
Not supported
Code Error Log (Command Code = 6)
Not supported
Code Configuration Information (Command Code = 7)
none Send configuration information (included for compatibility
with earlier releases)
‘1’ Send hardware configuration data only
‘2’ Send supplies data only
‘3’ Send fitness data only
‘4’ Send tamper and sensor status data only
‘5’ Send software ID and release number data only
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-5
Central to Terminal Messages
Terminal Commands
Number of Mandatory/
Field Description
Characters Optional
‘6’ Send enhanced configuration data
‘7’ Send local configuration option digits
‘8’ Report cash deposit definition
If the command modifier is not within the range ‘1’ ‐ ‘8’, the message will
be rejected. If the specific command reject option is set, a Specific
Command Reject will be returned.
h Var M Trailer. Protocol‐dependent.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-6 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Customisation Data Commands
Customisation Data Commands 10
Central can use various Customisation Data commands to
download different types of data to the terminal. The commands are
as follows:
State Tables Load
Screen/Keyboard Data Load
Configuration Parameters Load
Enhanced Configuration Parameters Load
FIT Data Load
Configuration ID Number Load
MAC Field Selection Load
Date and Time Load
Encryption Key Change
Extended Encryption Key Change
Dispenser Currency Cassette Mapping Table
XML Configuration Download
The following table shows the message class, sub‐class and
identifier for each command.
Table 10-2 Message Message
Identifier Command
Customisation Data Commands Class Sub-Class
3 1 1 Screen/Keyboard Data Load
3 1 2 State Tables Load
3 1 3 Configuration Parameters Load
3 1 4 Reserved
3 1 5 FIT Data Load
3 1 6 Configuration ID Number Load
3 1 A Enhanced Configuration Parameters
Load
3 1 B MAC Field Selection Load
3 1 C Date and Time Load
3 1 D Reserved
3 1 E Dispenser Currency Cassette
Mapping Table
3 1 F Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-7
Central to Terminal Messages
Customisation Data Commands
Message Message
Identifier Command
Class Sub-Class
3 1 G Reserved
3 1 I XML Configuration Download
3 2 0‐2 Interactive Transaction Reply
3 3 1‐9 Encryption Key Change
3 4 1‐9, Extended Encryption Key Change
A‐K
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-8 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
State Tables Load
State Tables Load 10
Use this message to download state tables to the terminal. It may
take more than one message to transmit the state tables, in which
case each message will contain a portion of the state tables.
For details of the state tables, see Chapter 2, “State Tables”.
Table 10‐3
State Tables Load
Number of
Field Mandatory/ Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. Included for future use and ignored by the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Customisation Data
g 1 M Message Identifier. The message identifier is:
‘2’ ‐ State Table
FS 1 M Field Separator.
h 3 M State Number. Contains a base 10 (decimal) number in the range 000
‐254 or 256‐999, or a base 36 (alphanumeric) number in the range
000‐254 or 256‐ZZZ. This identifies the state number for the state data
which follows it.
See Table Note 2
i Var (25) M State Table Data. The first character identifies the state type. Valid
values are: A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, R, S, T, V, W, X,
Y, Z, b, d, e, f, g, k, m, w, z,_,&, >.
Characters 2 to 25 give associated state data.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-9
Central to Terminal Messages
State Tables Load
Number of
Field Mandatory/ Optional Description
Characters
FS 1 O Field Separator.
3 O State Number.
Var (25) O State Table Data.
The field separator, state number and state data fields may be repeated if necessary to the maximum
length per message permitted by the protocol.
FS 1 See Table Note 1 Field Separator.
j 8 See Table Note 1 Message Authentication Code (MAC) Data. Contains the value
transmitted for authentication of this message.
k Var M Trailer. Protocol‐dependent.
Table Note 1: The field separator and field ‘j’ are only used when
the Data Security feature is selected and the flags are correct. For
details, refer to the APTRA Advance NDC, Supervisor’s Guide.
Table Note 2: Enhanced Configuration Parameters Load option 80
with the required setting for the Alphanumeric State Entry state
must be sent before the State Tables Load message. If it is not sent,
the default value of base 10 is assumed. For more information, see
“Enhanced Configuration Parameters Load” on page 10‐17.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-10 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Screen/Keyboard Data Load
Screen/Keyboard Data Load 10
This message is used to download screen and/or keyboard data into
the terminal. The maximum length of a single Screen/Keyboard
Data Load message is 2000 bytes.
Table 10-4
Screen/keyboard Data Load
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol Dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. Included for future use and ignored by the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Customisation Data
g 1 M Message Identifier. The message identifier is:
‘1’ ‐ Screen and/or Keyboard Data
FS 1 M Field Separator.
h 3, 5 or 6 See Table Note 3 Screen Number. Identifies the screen data being transmitted. For
Table Note 4 details, see Chapter 3, “Screen Data”.
Screen numbers can be specified as three decimal digits (123), four
decimal digits in double quotes (“0123“), a group letter and two digits
or a group letter and four digits. The groups with four digit numbers
are ‘E’, ‘X’, ‘Y’, ‘Z’ and ‘u’. A screen defined in group ‘l’ is also
accepted, mapping directly onto group ‘u’ (l0123 is equivalent to
u0123).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-11
Central to Terminal Messages
Screen/Keyboard Data Load
Number of
Field Mandatory/Optional Description
Characters
Note: The numbering for error message reserved screens consists of
an alpha character followed by four numeric digits. The numbering for
all other reserved screens consists of an alpha character followed by
two numeric digits.
i Var See Table Note 3 Screen Data Field. Represents the data to be displayed on the
cardholder screen or printer. This field always follows a screen
number field and is always followed by a field separator or
protocol‐dependent trailer. For details, see Chapter 3, “Screen Data”.
GS 1 See Table Note 3 Group Separator.
j1 Var See Table Note 5 Keyboard Number and Keyboard Data. Identifies the physical
keyboard data being transmitted. It must have a minimum of three
characters in the range 000‐999 that are used to specify the keyboard
number to be processed. The remaining characters make up a variable
length data field that defines the keyboard layout.
This data is made up of sets of four characters, two for the position
code and two for the return code. For details, see “The Keyboard
Interface” on page 4‐2.
GS 1 See Table Note 5 Group Separator.
j2 Var See Table Note 5 Touch Screen Data. Identifies the touch screen keyboard data being
transmitted. The characters make up a variable length data field that
defines the keyboard layout. This data is made up of sets of 34
characters, 32 for defining the touch area plus two for the return code.
For details, see “Rear Interface: Operator Keyboard Layout” on
page 4‐14.
If you create new definitions, you can calculate the co‐ordinates of the
touch area manually. For details, see “Calculating Full Touch‐Screen
Positions” on page 4‐17.
GS 1 See Table Note 5 Group Separator.
j3 3 See Table Note 5 Nested Keyboard Data. (Not supported)
GS 1 See Table Note 5 Group Separator.
j4 Var See Table Note 5 Miscellaneous Keyboard Data.
This field is reserved for future expansion.
k Var M Trailer. Protocol‐dependent.
Table Note 3: Screen data and/or keyboard data may be
downloaded in a message. If any part of field ‘j1’ ‐ ‘j4’ is present, the
screen data field must be terminated by a group separator to
indicate the start of keyboard data.
Table Note 4: Fields ‘h’ ‐ ‘j4’ may be repeated any number of times,
as defined by the communications protocol limit but not exceeding
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-12 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Screen/Keyboard Data Load
the maximum message length of 2000 bytes for Screen/Keyboard
data. The field separator preceding field ‘h’ must be repeated for
each additional screen and/or keyboard definition.
Table Note 5: If keyboard data is to be downloaded, it must be
separated from the screen data field by a group separator even
when no screen data is present in the message.
Each field of keyboard data must be terminated by the associated
group separator, even when that field is empty. The only exception
to this is that trailing group separators may be omitted after the last
keyboard field that contains actual data. This rule means that the
keyboard data type can be identified by the number of group
separators preceding it.
It is possible to add, delete and change keyboard layouts and
Managing Keyboards and associations between screens and layouts. The following list gives
Associations 10
examples of how this is done.
a To add or update a keyboard definition alone:
<gs>
<keyboard no.> <keyboard data>
<gs>
<touch data>
b To delete a keyboard and any associations to it:
<gs>
<keyboard no.>
c To replace existing screens without changing any associations:
<screen no.> <screen data>
<fs>
<screen no.> <screen data>
d To delete screens and any associations with them:
<screen no.>
<fs>
<screen no.>
e To delete a screen and delete a keyboard layout, destroying any
other associations to that layout:
<screen no.>
<fs>
<keyboard no.>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-13
Central to Terminal Messages
Screen/Keyboard Data Load
f To send a new screen and its associated keyboard details in one
message:
<screen no> <screen data>
<gs>
<keyboard no.> <keyboard data>
<gs>
<touch data>
g To send a new screen and specify an associated keyboard that
will be provided elsewhere:
<screen no.> <screen data>
<gs>
<keyboard no.>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-14 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Configuration Parameters Load
Configuration Parameters Load 10
This message downloads the Logical Unit Number (LUNO),
parameters and timers into the terminal. For details of the
parameters, see “Configuration Parameters Load Message” on
page 7‐2. For descriptions of the timers, see “Timers” on page 7‐24.
This message does not enable the configuration of additional
options available with Advance NDC, for which you use the
“Enhanced Configuration Parameters Load” message described on
page 10‐17.
Table 10-5
Configuration Parameters Load
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. Included for future use and ignored by the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. Included for future use and ignored by the
terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Customisation Data
g 1 M Message Identifier. The message identifier is:
‘3’ ‐ Configuration Data
FS 1 M Field Separator.
h 1 See Table Note 6 Camera Control
i 3 See Table Note 6 Reserved
j 3 See Table Note 6 Reserved
k 3 See Table Note 6 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-15
Central to Terminal Messages
Configuration Parameters Load
Number of
Field Mandatory/Optional Description
Characters
l 3 See Table Note 6 Reserved
m 3 O Supply Mode, Ready Status and Amount Buffer Length Options.
See Table Note 6 (For details, see page 7‐2)
n 9 O Reserved. Must be 000 000 000.
See Table Note 6
FS 1 See Table Note 7 Field Separator.
o 3 O LUNO. Logical Unit Number to return in transaction requests, and
solicited status and unsolicited status messages sent by the terminal.
(For details, see page 7‐3)
FS 1 See Table Note 7 Field Separator. Must be present if the following fields are present.
p 2 O Timer Number.
See Table Note 8 (For a list of timers, see Table 7‐3 on page 7‐4; for detailed descriptions,
see page 7‐24)
q 3 O Number of 800 Millisecond Ticks per Timer Field.
(For details, see page 7‐4)
The timer number and ticks are repeated. The data for each timer is downloaded in this sequence: timer
number (2 bytes), number of 800‐millisecond ticks (3 bytes) unless stated otherwise in the table above. If
a particular timer is not included, a default value is assumed.
r Var M Trailer. Protocol‐dependent.
Table Note 6: Fields ‘h’ to ‘n’ may be omitted unless field ‘m’ is
populated when all the earlier fields must be populated. The
omitted fields assume a value of zero.
Table Note 7: This field separator must be present if any of the later
fields in the message are present.
Table Note 8: Unless otherwise stated in the timer descriptions a
time‐out interval of 000 is taken as infinity, and an unconfigured
timer takes a time‐out interval of 30 ticks (see “Time Units for
Timers” on page 7‐24).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-16 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Enhanced Configuration Parameters Load
Enhanced Configuration Parameters
Load 10
This message supports configuration of options and timers,
including additional options that are not supported in the
Configuration Parameters Load message. For more details of the
format, see“Enhanced Configuration Parameters Load Message” on
page 7‐6
This message does not include options and timers for the Electronic
Journal (EJ) Upload feature; these are set in the EJ Options and
Timers command. For details, see “EJ Commands” on page 10‐96.
Table 10-6
Enhanced Configuration Parameters Load
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. Included for future use and ignored by the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. Included for future use and ignored by the
terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Customisation Data
g 1 M Message Identifier. The message identifier is:
‘A’ ‐ Enhanced Configuration Data
FS 1 M Field Separator.
h 3 O Logical Unit Number. As field ‘o’ of Configuration Parameters Load;
(for details see page 7‐3)
FS 1 See Table Note 9 Field Separator. Must be present if any of the following fields are
present.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-17
Central to Terminal Messages
Enhanced Configuration Parameters Load
Number of
Field Mandatory/Optional Description
Characters
i 2 O Option Number. Contains a configuration option number, for which
See Table Note 11 the values are held in field ‘j’.
j 3 O Option Code. Specifies the configuration for the function (option
See Table Note 11 number) in field ‘i’. Option numbers are as follows. For details of the
option codes for each option, see “Enhanced Configuration Parameters
Load Message” on page 7‐6.
Option
Description of Option
Number
00 Camera control option: as field ‘h’ in
Configuration Parameters Load; (for details, see page 7‐2)
01 Ready/Supply/Amount buffer options: as field ‘m’ in
Configuration Parameters Load; (for details, see page 7‐2)
02 Auto voice
03 Date format for Supervisor journal messages
04 Roll width
05 Left print column
06 Reserved
07 Track 1 format
08–11 Reserved
12 Specific command reject option
13–14 Reserved
15 Transaction status information option
16 Journal printer backup time option
17 Journal printer backup print operations option
18 ‐ 22 Reserved
23 Envelope dispenser status option
24 Enhanced TI/Sensor status option
25 Media entry/exit indicators flash rate option
26 Reserved
27 Remote relay
28 ‐ 31 Reserved
32 Unsolicited Reporting Control for camera and voice guidance
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-18 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Enhanced Configuration Parameters Load
Number of
Field Mandatory/Optional Description
Characters
33 Simulate Supervisor Mode entry/exit
34 MCN range
35 Report Dual Mode EJ and Hardcopy Backup Unsolicited
Messages
See Table Note 10 36 Enhanced EJ backup
37 Print Track 2 to Journal
38 ‐ 43 Reserved
44 Bunch Note Acceptor (BNA) Journal Vaulted Notes Count
45 Bunch Note Acceptor (BNA) Message Settings
46 MCRW Enhanced Card Device (ECD) Security Jitter
47 Reserved
48 Barcode reader
49‐68 Reserved
69 EMV Smart Card Extended Status: reserved for use with
EMV/CAM2 Exits
70 EMV Smart Card: reserved
71 Time‐Out State entry
74 Cash Deposit Retract Destination
76 Cash Handlers
77 Next state number
78 GBRU variant reporting
79 Coin Dispenser
See Table Note 12 80 Alphanumeric State Entry
82 Unsolicited application status
83 Cheque Processing Module
FS 1 See Table Note 9 Field Separator.
k 2 O Timer Number. Contains the timer number. The use of the timers is as
See Table Note 11 follows. Timers with an asterisk (*) can be adjusted for a voice‐guided
session. For more information, see “Timers” on page 7‐24.
‘00’ * Keyboard entry time‐out
‘01’ * Cardholder response to time‐out screen time‐out
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-19
Central to Terminal Messages
Enhanced Configuration Parameters Load
Number of
Field Mandatory/Optional Description
Characters
‘02’ Close state screen time‐out
‘03’ Communications response time‐out
‘04’ * Envelope/cheque/card insertion time‐out
‘05’ * Cash retract time‐out
‘06’ Poll/select time‐out
‘07’ * Present time‐out
‘08’ * Night safe deposit time‐out
‘09’ * Card removal time‐out
‘10’ Additional present time‐out
‘11 ‐ Reserved
59’
‘60’ EJ acknowledgement timer
‘61’ * Barcode reader scan time‐out
‘62’ Reserved
‘63’ Hardware failure screen time‐out
‘64 ‐ Reserved
67’
‘68’ Statement MEI duration time‐out
‘69’ Receipt MEI duration time‐out
‘70’ Reserved
71’
‘72’ DASH card removal time‐out
‘73 Reserved
‐76’
‘77’ * BNA cash acceptance time‐out
‘78’ * GBXX cash retract time‐out
‘79 ‐ Reserved
86’
‘87’ * Cheque capture screen time‐out
‘88 ‐ Reserved
91’
‘92’ Fault display time‐out
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-20 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Enhanced Configuration Parameters Load
Number of
Field Mandatory/Optional Description
Characters
‘93’ Reserved
‘94’ * Cheque removal time‐out
‘95’ * Statement retract time‐out
‘96’ * Statement present time‐out
‘97 ‐ Reserved.
99’
l 3 O Customisation Data Commands Number of Seconds per Timer Field.
See Table Note 11 Specifies the time‐out interval for the preceding timer in seconds. The
number of seconds can be 001‐255. If the time‐out interval is not
specified, the timer default value of 30 seconds is applied
m Var M Trailer. Protocol‐dependent.
Table Note 9: This field separator must be present if any of the
subsequent fields in the message are present.
Table Note 10: A Supervisor option allows option 36 to be ignored
if sent from the host. For further information, refer to the APTRA
Advance NDC, Supervisor’s Guide.
Table Note 11: Fields ‘i’, ‘j’, ‘k’ and ‘l’ may be repeated to define
multiple options and/or timers.
Table Note 12: Enhanced Configuration Parameters Load option 80
(Alphanumeric State Entry) affects following State Tables Load
messages. For more information, see “State Tables Load” on
page 10‐9.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-21
Central to Terminal Messages
FIT Data Load
FIT Data Load 10
This message downloads Financial Institution Tables (FIT) to the
terminal. Each command can include as many tables as the protocol
permits. Up to 1000 FITs can be stored on the SST. One FIT is
required for each member Financial Institution in the network. For
details, see Chapter 8, “Financial Institution Tables”.
Table 10-7
FIT Data Load
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. Included for future use and ignored by the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Customisation Data
g 1 M Message Identifier. The message identifier is:
‘5’ ‐ FIT Data
FS 1 M Field Separator.
h 3 M FIT Number. Designates the number assigned to the FIT in the
following field. Values in the range 000 to 999 are valid. The FIT
number defines the search order. For example, FIT 000 is the first entry
checked during a FIT search. If there is a gap in the numbering range,
all omitted entries in the FIT data default to 000. If linked FITs are
used, they must have consecutive FIT numbers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-22 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
FIT Data Load
Number of
Field Mandatory/Optional Description
Characters
i Var M FIT Data. Specifies control words for the following:
Remote PIN encryption
Local PIN verification
Indirect next state processing.
FIT data consists of a number of three‐character decimal entries in the
range 000‐255. The terminal stores 41 entries. Those in excess of this
are ignored. If fewer than 41 entries are received, no values are stored.
For details of the data, see “Linked FITs” on page 8‐12.
FS 1 M Field Separator.
j 3 M FIT Number. As field ‘h’.
See Table Note 13
k Var M FIT Data. As field ‘i’.
See Table Note 13
FS 1 See Table Note 14 Field Separator.
l 8 See Table Note 14 Message Authentication Code (MAC) Data. Contains the value
transmitted for authentication of this message.
The characters are 0‐9, A‐F.
m Var M Trailer. Protocol‐dependent.
Table Note 13: A field separator and fields ‘j’ and ‘k’ can be
repeated until the maximum length permitted by the protocol is
reached.
Table Note 14: The field separator and MAC Data field ‘l’ are only
present if the flag settings are correct. 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, Reference Manual 10-23
Central to Terminal Messages
Configuration ID Number Load
Configuration ID Number Load 10
This message contains an identifier for the customisation data in the
terminal. At terminal installation time, or any time customisation
data is sent to the terminal, the configuration ID is set to 0000. The
configuration ID number load message must be included as the last
of the downloaded customisation data messages to set the
configuration ID to the desired number. The configuration ID
number can be any number from 0001 to 9999.
The terminal holds customisation data and the configuration ID on
the system disk. On receipt of a power‐up status message from the
terminal, Central can verify that the customisation data has been
correctly loaded. Only if a configuration ID of 0000 is received does
Central need to reload the customisation data.
Note: Config ID is stored in memory, but not saved until a
go‐in‐service is issued. If power fail occurs before the command is
issued, the Config ID will need to be reloaded.
Table 10-8
Configuration ID Number Load
Number of
Field Mandatory/ Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. Included for future use and ignored by the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. Included for future use and ignored by
the terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Customisation Data
g 1 M Message Identifier. The message identifier is:
‘6’ ‐ Configuration ID number
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-24 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Configuration ID Number Load
Number of
Field Mandatory/ Optional Description
Characters
FS 1 M Field Separator.
h 4 M Configuration ID Number. The valid range is 0001‐9999.
i Var M Trailer. Protocol‐dependent.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-25
Central to Terminal Messages
Message Authentication Field Selection Load
Message Authentication Field
Selection Load 10
This message is used to set the messages and fields specified for full
or selective MAC verification, if a change to the default values is
necessary. Fields are selected for inclusion in the MAC if the
relevant offset byte is set to 1.
Table 10-9
Message Authentication Field Selection
Load
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. This field is included for future use and is ignored by
the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). This field is included for future use and
is ignored by the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. This field is included for future use and is
ignored by the terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Customisation Data
g 1 M Message Identifier. The message identifier is:
‘B’ ‐ Message Authentication Field selection
FS 1 M Field Separator.
h Var (47) See Table Note 15 Transaction Request Field. This field contains the field selection data
for the transaction request message.
The fields of the Transaction Request message are selected for inclusion
in the MAC if the relevant offset byte is set to 1. The offsets for the
Transaction Request message fields are shown:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-26 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Message Authentication Field Selection Load
Number of
Field Mandatory/Optional Description
Characters
Offset Description
0 0 ‐ MAC the complete message. Ignore the following digits in
the field
1 ‐ Selectively MAC the fields below if the relevant byte is set to
1
1 Fields ‘b’ and ‘c’
2 Field ‘d’
3 Reserved
4 Field ‘e’
5 Field ‘f’
6 Field ‘g’
7 Field ‘h’
8 Field ‘i’
9 Field ‘j’
10 Field ‘k’
11 Field ‘l’
12 Field ‘m’
13 Field ‘n’
14 Field ‘o’
15 Field ‘p’
See Table Note 15 16 Fields ‘q’ and ‘r’, optionally buffer ‘f’
17 Field ‘aa’ * ‐ Identified by Data ID ‘A’ ‐ Reserved
18 Field ‘ab’ * ‐ Identified by Data ID ‘B’ ‐ Reserved
19 Field ‘ac’ * ‐ Identified by Data ID ‘6’ ‐ Reserved
20 Field ‘ad’ * ‐ Identified by Data ID ‘C’ ‐ Reserved
21 Field ‘ae’ * ‐ Identified by Data ID ‘D’ ‐ Reserved
22 Field ‘af’ * ‐ Identified by Data ID ‘E’ ‐ Reserved
23 Field ‘ag’ * ‐ Identified by Data ID ‘F’ ‐ Reserved
24 Field ‘ah’ * ‐ Identified by Data ID ‘G’ ‐ Reserved
25 Field ‘ai’ * ‐ Identified by Data ID ‘H’ ‐ Reserved
26 Field ‘aj’ * ‐ Identified by Data ID ‘I’ ‐ Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-27
Central to Terminal Messages
Message Authentication Field Selection Load
Number of
Field Mandatory/Optional Description
Characters
27 Field ‘ak’ * ‐ Identified by Data ID ‘J’ ‐ Reserved
28 Field ‘al’ * ‐ Identified by Data ID ‘K’ ‐ Reserved
29 Field ‘am’ * ‐ Identified by Data ID ‘L’ ‐ Reserved
30 Field ‘an’ * ‐ Identified by Data ID ‘M’ ‐ Reserved
31 Field ‘ao’ * ‐ Identified by Data ID ‘N’ ‐ Reserved
32 Field ‘ap’ * ‐ Identified by Data ID ‘O’ ‐ Reserved
33 Field ‘aq’ * ‐ Identified by Data ID ‘P’ ‐ Reserved
34 Field ‘ar’ * ‐ Identified by Data ID ‘Q’ ‐Reserved
35 Field ‘as’ * ‐ Identified by Data ID ‘R’ ‐ Reserved
36 Field ‘at’ * ‐ Identified by Data ID ‘S’ ‐ Reserved
37 Field ‘au’ * ‐ Identified by Data ID ‘T’ ‐ Reserved
38 Field ‘av’ * ‐ Identified by Data ID ‘U’ ‐ CSP Data
39 Field ‘aw’ * ‐ Identified by Data ID ‘V’ ‐ Confirmation CSP Data
40 Field ‘ax’ * ‐ Identified by Data ID ‘W’ ‐ Available for use by
Exits
41 Field ‘ay’ * ‐ Identified by Data ID ‘X’ ‐ Available for use by
Exits
42 Field ‘az’ * ‐ Identified by Data ID ‘Y’ ‐ Available for use by
Exits
43 Field ‘ba’ * ‐ Identified by Data ID ‘Z’ ‐ Available for use by
Exits
44 Field ‘bb’ * ‐ Identified by Data ID ‘[’ ‐ Available for use by
Exits
45 Field ‘bc’ * ‐ Identified by Data ID ‘\’ ‐ Available for use by
Exits
46 Field ‘bd’ * ‐ Identified by Data ID ‘5’ ‐ Available for use by
EMV/CAM2 Exits
51 Field ‘ce’ identified by Data ID ‘e’ ‐ Barcode reader data
* Indicates that all the elements present for that field will be MACed
(group separators excluded).
FS 1 O Field Separator.
i Var (36) See Table Note 16 Transaction Reply Field. This field contains the selection data for the
and Table Note 19 Transaction Reply message.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-28 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Message Authentication Field Selection Load
Number of
Field Mandatory/Optional Description
Characters
The fields of the Transaction Reply message are selected for inclusion in
the MAC if the relevant offset byte is set to 1. The offsets for the
Transaction Reply message fields are shown below:
Offset Description
0 0 ‐ MAC the complete message. Ignore the following digits in
the field
1 ‐ Selectively MAC the fields below if the relevant byte is set to
1
1 Fields ‘b’ and ‘c’
2 Field ‘d’
3 Field ‘e’
4 Field ‘f’
5 Fields ‘g’, ‘h’, ‘i’, ‘j’ and ‘j1’ ‐ ‘jn’
6 Field ‘k’
7 Field ‘l’
8 Field ‘m’
9 Field ‘n’
10 Field ‘o’
11 Field ‘p’
See Table Note 15 12 Fields ‘q’ and ‘r’
13 Fields ‘s’ and ‘t’
14 Fields ‘u’, ‘v’ and subsequent print fields.
See Table Note 18.
15 Field ‘w’
16 Field ‘x’
17 Field ‘aa’ * ‐ Identified by Data ID ‘A’ ‐ Reserved
18 Field ‘ab’ * ‐ Identified by Data ID ‘B’ ‐ Reserved
19 Field ‘ac’ * ‐ Identified by Data ID ‘C’ ‐ Reserved
20 Field ‘ad’ * ‐ Identified by Data ID ‘D’ ‐ Reserved
21 Field ‘ae’ * ‐ Identified by Data ID ‘E’ ‐ Reserved
22 Field ‘af’ * ‐ Identified by Data ID ‘F’ ‐ Reserved
23 Field ‘ag’ * ‐ Identified by Data ID ‘G’ ‐ Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-29
Central to Terminal Messages
Message Authentication Field Selection Load
Number of
Field Mandatory/Optional Description
Characters
24 Field ‘ah’ * ‐ Identified by Data ID ‘H’ ‐ Reserved
25 Field ‘ai’ * ‐ Identified by Data ID ‘I’ ‐ Reserved
26 Field ‘aj’ * ‐ Identified by Data ID ‘J’ ‐ Reserved
27 Field ‘ak’ * ‐ Identified by Data ID ‘K’ ‐ Track 1 Data
28 Field ‘al’ * ‐ Identified by Data ID ‘L’ ‐ Track 2 Data
29 Field ‘am’ * ‐ Identified by Data ID ‘M’ ‐ Virtual Controller data
30 Field ‘an’ * ‐ Identified by Data ID ‘N’ ‐ Virtual Controller data
31 Field ‘ao’ * ‐ Identified by Data ID ‘O’ ‐ Virtual Controller data
32 Field ‘ap’ * ‐ Identified by Data ID ‘P’ ‐ Virtual Controller data
33 Field ‘aq’ * ‐ Identified by Data ID ‘Q’ ‐ Virtual Controller data
34 Field ‘ar’ * ‐ Identified by Data ID ‘R’ ‐ Virtual Controller data
35 Field ‘as’ * ‐ Identified by Data ID ‘a’ ‐ single cheque deposit
data.
See Table Note 20.
36 Field ‘at’ * ‐ Identified by Data ID ‘5’ ‐ Available for use by
EMV/CAM2 Exits. See Table Note 20.
* Indicates that all the elements present for that field will be MACed
(group separators excluded).
FS 1 O Field Separator.
j 11 See Table Note 16 Solicited Status Field. This field contains the MAC selection data for the
solicited status message.
FS 1 O Field Separator.
k 4 See Table Note 16 Other Messages Field.
This field contains the MAC selection data for FIT load, state tables
load, and terminal state status and Dispenser Currency Cassette
Mapping Table messages.
FS 1 O Field Separator.
l 6 See Table Note 16 Track 1 Field. This field contains the MAC selection data for magnetic
card track 1.
FS 1 O Field Separator.
m 6 See Table Note 16 Track 2 Field. This field contains the MAC selection data for magnetic
card track 2.
FS 1 O Field Separator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-30 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Message Authentication Field Selection Load
Number of
Field Mandatory/Optional Description
Characters
n 11 See Table Note 16 Track 3 Field. This field contains the MAC selection data for magnetic
card track 3.
FS 1 O Field Separator.
o 5 See Table Note 16 EMV Smart Card Configuration. This field contains the MAC selection
data for the EMV Configuration message.
FS 1 See Table Note 17 Field Separator.
p 8 See Table Note 17 Message Authentication Code (MAC) Data. This field contains the
eight‐character value transmitted for authentication of this message.
The characters are 0‐9 and A‐F.
q Var M Trailer. Protocol‐dependent.
Table Note 15: Offset 16 not only controls whether fields ‘q’ and ‘r’
are included in the MAC generation, but also whether buffer ‘f’ is
included when more than four hopper types are supported by the
coin dispenser.
Table Note 16: Variable length fields may be truncated, that is,
trailing characters may be omitted. The omitted characters will take
a value of zero. If Message Authentication is turned on, any fixed
(not variable) length fields must be either empty or fully populated,
or the message will be rejected with a MAC failure.
Table Note 17: The field separator and MAC are only present when
the Data Security feature is selected and the flags are set correctly.
For details, refer to the APTRA Advance NDC, Supervisor’s Guide.
When the Data Security feature is set, all the messages sent from
Central to the terminal that contain a MAC field must have this
optional field present.
Table Note 18: The printer fields, following fields ‘u’ and ‘v’, will
be MACed if fields ‘u’ and ‘v’ are to be MACed. The group
separators between the additional printer fields will not be included
in the MACing activity.
Table Note 19: The MACing of other messages, including the
Dispenser Currency Cassette Mapping Table message and the EMV
Configuration messages, are specified in “Selective Message
Authentication” on page 11‐13”.
Table Note 20: If you wish to use selective MACing on EMV ICC
data with Advance NDC and NDC+ based terminals, you cannot
use the same Message Authentication Field Selection Load message.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-31
Central to Terminal Messages
Message Authentication Field Selection Load
This is because of the different EMV field offsets (35 for NDC+ and
36 for Advance NDC). For more information about EMV Integrated
Circuit Card (ICC or ‘Smart Card’) configuration using APTRA
Advance NDC, See “Other NCR Documentation” on page G‐6.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-32 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Date and Time Load
Date and Time Load 10
This message is used to set the local date and time in the terminal.
Table 10-10
Data and Time Load
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. This field is included for future use and is ignored by
the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). This field is included for future use and
is ignored by the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. This field is included for future use and is
ignored by the terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Customisation Data
g 1 M Message Identifier. The message identifier is:
‘C’ ‐ Date and Time
FS 1 M Field Separator.
h 10 M Date/Time Data.
This field contains the date and time in the following format:
YY = Year (‘00’ ‐ ‘99’)
MM = Month (‘01’ ‐ ‘12’)
DD = Day (‘01’ ‐ ‘31’)
HH = Hour (‘00’ ‐ ‘23’)
MM = Minute (‘00’ ‐ ‘59’)
If 00<=YY<=89, the year is taken to be in the range 2000<=YY<=2089. If
90<=YY<=99, the year is taken to be in the range 1990<=YY<=1999.
Note: Seconds are set to zero when the date and time are set.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-33
Central to Terminal Messages
Encryption Key Change
Encryption Key Change 10
For security, the Central programmer can use this message to
change the Master Key (‘A’ key), Communication Key (‘B’ key) and
VISA Master Key (‘V’ key) initially entered by a local operator
through Supervisor mode. From Advance NDC 2.02, it is possible to
change the Communication key while the terminal is in‐service, but
not currently handling a transaction. This is not possible when the
terminal is in suspend mode, or the operator is initiating the
execution of settlement transactions.
In addition to the Encryption Keys, the operator may change the
Message Authentication Key and VISA Key Table. For details, refer
to the APTRA Advance NDC, Supervisor’s Guide.
Note: If an Encryption Key Change message is sent in Supervisor
mode, the message is not processed until the front keyboard is
disabled, following a menu selection or Supervisor mode exit.
The Encryption Key Change message may:
Include an encrypted encryption key.
Specify the current encryption key that the terminal must use to
decrypt this encrypted encryption key.
Specify which of the current encryption keys to replace.
The above specifications are contained in the modifier field of the
message.
A solicited status message will be returned to Central after an
attempt to modify an encryption key, to indicate its success or
failure.
Central must encrypt the new encryption key with the same key
designated to decrypt it at the terminal.
PIN verification may require the use of a separate PIN key. The key
used in this case is the PEKEY, contained in the FIT, which can be
different for each financial institution in the system.
On power failure, the host sends the Key Exchange messages.
This message is not considered part of the customisation data and
does not reset the configuration ID to zero.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-34 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Encryption Key Change
Table 10-11
Encryption Key Change
Number of
Field Mandatory/ Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. This field is included for future use and is ignored by
the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). This field is included for future use and
is ignored by the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. This field is included for future use and is
ignored by the terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘3’ ‐ Encryption Key Information
g 1 M Modifier. This one‐character field specifies the encryption key change
to take place:
‘1’ ‐ Decipher new master key with current master key *
‘2’ ‐ Decipher new communications key with current master key *
‘3’ ‐ Decipher new communications key with current communications
key *
‘4’ ‐ Use locally‐entered communications key (‘B’ key) as current
communications key
‘5’ ‐ Decipher new MAC key with current master key *
‘6’ ‐ Decipher new MAC key with current communications key *
‘7’ ‐ Use locally‐entered communications key (‘B’ key) as current MAC
key
‘8’ ‐ Decipher new VISA master key with current VISA master key
‘9’ ‐ Key data is new VISA key table; the equivalent old key is
overwritten. See Table Note 21.
* The equivalent old key is overwritten.
FS 1 O Field Separator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-35
Central to Terminal Messages
Encryption Key Change
Number of
Field Mandatory/ Optional Description
Characters
h 24 or 288 O New Key Data. Key data consists of entries of three characters. The
valid range of each entry is 000‐255.
Each entry defines the value of two hexadecimal encryption key digits.
A key consists of eight entries. The first entry contains digits 1 and 2.
The last entry contains digits 15 and 16 (95 and 96).
For example, 255, 254, 253, 252, 251, 250, 249, 248 is equivalent to FF,
FE, FD, FC, FB, FA, F9, F8 entered locally at the terminal.
See Table Note 22.
i Var M Trailer. Protocol‐dependent
Table Note 21: When VISA PIN verification is used, any change to
the keys should be done with a message modifier ‘8’ to change the
master key, followed by a message modifier ‘9’ to load the new key
table.
Table Note 22: In all messages where key data is present, except for
modifier ‘9’, only one key is present. For modifier ‘9’, twelve keys
comprising the six VISA key table pairs are present.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-36 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Extended Encryption Key Change
Extended Encryption Key Change 10
With an Encrypting PIN Pad (EPP), this message can be used to
change the Master Key (A key), Communication Key (B key) and
VISA Master Key (V key) initially entered by a local operator
through Supervisor mode. If an EPP is not present, this message is
rejected.
It is possible to change the Communication key while the terminal is
in‐service, but not currently handling a transaction. This is not
possible when the terminal is in Suspend mode, or the operator is
initiating the execution of supervisory or settlement transactions.
This message supports the terminal key modes of single and
double‐length keys. For further details, see Chapter 11, “Security
Features”.
Note: If an Extended Encryption Key Change message is sent in
Supervisor mode, the message is not processed until the front
keyboard is disabled, following a menu selection or Supervisor
mode exit.
The Extended Encryption Key Change message may:
Include an encrypted encryption key
Specify the current encryption key that the terminal must use to
decrypt this encrypted encryption key
Specify which of the current encryption keys to replace.
The above specifications are contained in the modifier field of the
message.
The Extended Encryption Key Change message enables single‐
length keys to be downloaded (as the previous Encryption Key
Change message), but also double‐length keys.
If this message is sent for a single‐length key when the terminal is in
double‐length key mode, or vice versa, a command reject is issued
indicating an Encryption Key Change message of the wrong length
has been issued.
The Extended Encryption Key Change message can be sent to
change the Communication Key (‘B’ key) at any point after it is
initially entered, except when a transaction is in process, or the
terminal is in Suspend mode, or when the operator is executing a
supervisor/settlement transaction.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-37
Central to Terminal Messages
Extended Encryption Key Change
If the key load is successful, an “Encryptor Initialisation Data”
message is returned to Central to report the Key Verification Value
(KVV) for the new key. If the key load fails, a reject message is sent.
When a DES key is used to encrypt the new encryption key, Central
must encrypt the new encryption key with the same key designated
to decrypt it at the SST.
PIN verification may require the use of a separate PIN key. The key
used in this case is the PEKEY, contained in the FIT, which can be
different for each financial institution in the system.
On power failure the Master key is unchanged, but the
Communications key and MAC key are changed to the locally
entered B key if the Restart Mode option specifies this, or if
configuration data reload from disk fails.
The host must ensure that any required Extended Encryption Key
Change messages are sent.
The Extended Encryption Key Change message can be sent to
change the MAC key to the current Master key (modifier 5) or the
current Communications key (modifier 6) at any point after it is
initially entered, except for the following:
When a cardholder transaction is in progress
When the SST is in Suspend mode
When a Supervisor settlement transaction is in progress.
This message is not considered part of the customisation data and
does not reset the configuration ID to zero.
Table 10-12
Extended Encryption Key Change
Number of
Field Mandatory/ Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. This field is included for future use and is ignored by
the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). This field is included for future use and
is ignored by the terminal.
FS 1 M Field Separator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-38 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Extended Encryption Key Change
Number of
Field Mandatory/ Optional Description
Characters
e 3 O Message Sequence Number. This field is included for future use and is
ignored by the terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘4’ ‐ Extended Encryption Key Information
g 1 M Modifier. This one‐character field specifies the encryption key change
to take place:
‘1’ ‐ Decipher new master key with current master key.
See Table Note 23.
‘2’ ‐ Decipher new communications key with current master key.
See Table Note 23.
‘3’ ‐ Decipher new communications key with current communications
key. See Table Note 23 and Table Note 24.
‘4’ ‐ Use locally entered communications key (‘B’ key) as current
communications key.
See Table Note 24 and Table Note 26.
‘5’ ‐ Decipher new MAC key with current master key.
See Table Note 23.
‘6’ ‐ Decipher new MAC key with current communications key.
See Table Note 23 and Table Note 24.
‘7’ ‐ Use locally entered communications key (‘B’ key) as current MAC
key.
See Table Note 24 and Table Note 26.
‘8’ ‐ Decipher new VISA master key with current VISA master key.
See Table Note 26.
‘9’ ‐ Key data is new VISA key table.
See Table Note 23 and Table Note 25.
‘A’ ‐ Decipher new VISA master key with current master key.
See Table Note 23 and Table Note 25.
‘B’ ‐ Load Host Security Module (HSM) public key and signature.
See Table Note 27.
The key data field contains the HSM public key (PK‐HSM) and
signature block (PK‐HSM) created using SK‐NCR, each base 94
encoded giving a total length of 640 bytes.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-39
Central to Terminal Messages
Extended Encryption Key Change
Number of
Field Mandatory/ Optional Description
Characters
‘C’ ‐ Load initial master key (A‐key) with RSA key.
See Table Note 27.
The key data field contains the initial A‐key encrypted with the EPP
public key [A‐KEY], PK‐EPP and signature block ([A‐KEY], PK‐EPP)
created using SK‐HSM, each base 94 encoded giving a total length of
640 bytes.
See Table Note 35.
‘D’ ‐ Load new initial communications key (B‐key) with RSA key.
See Table Note 27.
The key data field contains the initial B‐key encrypted with the EPP
public key [B‐KEY], PK‐EPP and signature block ([B‐KEY], PK‐EPP)
created using SK‐HSM, each base 94 encoded giving a total length of
640 bytes.
See Table Note 24 and Table Note 35.
‘E’ ‐ Load new initial VISA master key (V‐key) with RSA key.
See Table Note 27.
The key data field contains the initial V‐key encrypted with the EPP
public key [V‐KEY], PK‐EPP and signature block ([V‐KEY], PK‐EPP)
created using SK‐HSM, each base 94 encoded giving a total length of
640 bytes.
See Table Note 35.
‘F’ ‐ Send EPP serial number.
See Table Note 27.
The terminal will respond with an Encryptor Initialisation Data
message containing the signed serial number.
If the EPP serial number returned by the EPP is not 8 bytes in length. it
will be rejected with a Specific Command Reject code of E06.
If the encryptor has previously been used in BAPE mode, this
command option will fail unless the key entry mode is changed
through either the modifier ‘J’ or the Supervisor Access menu.
See Table Note 33.
‘G’ ‐ Send EPP public key.
See Table Note 27.
The terminal will respond with an Encryptor Initialisation Data
message containing the signed EPP public key
‘H’ ‐ Send all KVVs. See Table Note 26
‘I’ ‐ Reserved.
‘J’ ‐ Set key entry mode. See Table Note 27 and Table Note 33
‘K’ ‐ Send current key entry mode
‘L’ ‐ Load host certificate (primary or secondary)
‘M’ ‐ Send SST certificate
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-40 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Extended Encryption Key Change
Number of
Field Mandatory/ Optional Description
Characters
‘N’ ‐ Send SST random number
This is supported only if the SST is using certificates or the Enhanced
Signature scheme for remote key loading. If ʹNʹ is not supported, the
message will be rejected with reason E02:
‘O’ ‐ Load A‐key PKCS7 encoded.
‘P’ ‐ Replace certification authority certificate
If the command fails or is not supported, the message will be rejected
with reason C02.
If the EPP is not present, the message will be rejected with reason E02.
‘Q’ ‐ Send encryptor capabilities and state.
‘R’ ‐ Load NCR Sub public key and signature. See Table Note 36
‘S’ ‐ Delete HSM public key. See Table Note 37
‘T’ ‐ Delete NCR Sub public key. See Table Note 36 and Table Note 37
‘U’ ‐ Send EPP attributes
See Table Note 38
‘V’ ‐ Send variable length EPP serial number. See Table Note 39
‘W’ ‐ Reserved
‘X’ ‐ Load HSM public key (Bind EPP) with TR34 certificate. See Table
Note 40
‘Y’ ‐ Load TR31 Key Block protection key with TR34 certificate. See
Table Note 40
‘Z’ ‐ Reload HSM public key (Rebind EPP) with TR34 certificate. See
Table Note 40
‘a’ ‐ Reload HSM public key (Force Rebind EPP) with TR34 certificate.
See Table Note 40
‘b’ ‐ Delete HSM public key (Unbind EPP) with TR34 certificate. See
Table Note 40
‘c’ ‐ Delete HSM public key (Force Unbind EPP) with TR34 certificate.
See Table Note 40
‘d’ ‐ Reserved.
‘e’ ‐ Load New Communications key with current TR31 Key Block
Protection Key. See Table Note 41
‘f’ ‐ Load new MAC key with current TR31 Key Block protection key.
See Table Note 41
‘g’ ‐ Send host certificate
‘h’ ‐ Send extended capabilities
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-41
Central to Terminal Messages
Extended Encryption Key Change
Number of
Field Mandatory/ Optional Description
Characters
‘i’ ‐ Send extended key Status
‘j’ ‐ Diebold unbind EPP
This identifier is not supported
‘k’ ‐ Start Authenticated command
See Table Note 42
FS 1 O Field Separator.
h 3 O Key Data Size. Specifies the size of the following key data field in
hexadecimal (hex).
For a single‐length DES key, the size is 018 hex (24 decimal) characters.
For a double‐length DES key, the size is 030 hex (48 decimal)
characters.
For the six VISA table keys, the size is 120 hex (288 decimal) characters.
i 0 ‐ 640 O New Key Data. Maximum length is 640 bytes.
See Table Note 27, Table Note 32 and Table Note 33
For DES keys, the key data consists of entries of three characters. The
valid range of each entry is 000‐255.
Each entry defines the value of two hexadecimal encryption key digits.
A key consists of eight entries for a single‐length key, or sixteen entries
for a double‐length key. The first entry contains digits 1 and 2. The last
entry contains digits 15 and 16 (95 and 96).
For example, 255, 254, 253, 252, 251, 250, 249, 248 is equivalent to FF,
FE, FD, FC, FB, FA, F9, F8 entered locally at the terminal.
In all messages where DES key data is present, except for modifier ‘9’,
only one key is present. For modifier ‘9’, twelve keys comprising the
six VISA key table pairs are present.
The key is interpreted as single or double‐length depending on the
Key Entry mode option selected from the Supervisor Access menu. For
more information, see Chapter 11, “Security Features”.
Table Note 23: For modifiers ‘1’, ‘2’, ‘3’, ‘5’, ‘6’, ‘8’, ‘9’ and ‘A’ the
equivalent old key is overwritten.
Table Note 24: Modifiers ‘3’, ‘4’, ‘6’, ‘7’ and ‘D’ cannot be used if the
Key Entry mode is set to Double Length Restricted, when they will
be rejected with reason C17. See Chapter 11, “Security Features”.
Table Note 25: When VISA PIN verification is used, any change to
the keys should be performed with message modifier ‘8’or ‘A’ to
change the master key, followed by message modifier ‘9’ to load the
new key table.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-42 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Extended Encryption Key Change
Table Note 26: For modifiers ‘4’, ‘7’ and ‘H’, field ‘i’ is not present.
Table Note 27: Modifiers ‘B’, ‘C’, ‘D’, ‘E’, ‘F’, ‘G’ ‘J’, ‘U’ and ‘V’ are
supported only by the EPP. If the terminal does not have an EPP, the
message will be rejected with Specific Command Reject E02
‘Function not supported in hardware’.
Table Note 28: Only the A key has to be downloaded using RSA.
The communications key, MAC key and VISA key, encrypted by the
A key, can be loaded.
Table Note 29: Modifiers 2 and 3 can be used while the terminal is
in service, but not performing a transaction, to change the
communications key. All other modifiers can only be used while the
terminal is out of service. If the terminal is not in the correct mode,
the message is rejected with reason C15.
Table Note 30: Depending on the single/double encryption mode
of the terminal, the initial keys (A, B and V) may be single or double
length. As the length of an encrypted RSA block is always 256 bytes,
the message length remains unchanged.
Table Note 31: The exponent of the HSM‐PK is always 65537, and
is therefore not transmitted to the terminal.
Table Note 32 The format of field ‘i’ for modifiers ‘L’, ‘M’, ‘N’, ‘O’,
‘P’ and ‘Q’ is as follows:
Modifier Key Data Format Number of characters
‘L’ or ‘P’ Binary data length 3 bytes
Certificate, base 94 encoded VAR
M Certificate type 1
‘0’ = encryption certificate
‘1’ = verification certificate
‘N’ & ‘Q’ No key data
‘O’ Binary data length 3 bytes
Key Load Packet VAR
Table Note 33: Modifier ʹJʹ is supported only on the EPP encryptor,
and has the additional restriction that it will be accepted only after
the host has demonstrated that it has the ability to download
encryption keys using RSA key download. This is achieved by the
exchange of public keys and reading the EPP serial number. If this
exchange of messages has not been performed since the last power
up the command will be rejected (Reason C18 ‐ not authorised). To
permit migration from previous NDC+ releases, if the EPP is
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-43
Central to Terminal Messages
Extended Encryption Key Change
operating in BAPE emulation mode this modifier will be accepted
once without the need for the authorisation sequence. Changing the
key entry mode will switch the encryptor into EPP mode.
For modifier ʹJʹ the key data consists of a single character in the
range ʹ1ʹ to ʹ4ʹ which selects the new mode, as follows:
ʹ1ʹ = Set mode to single length without XOR
ʹ2ʹ = Set mode to single length with XOR
ʹ3ʹ = Set mode to double length with XOR
ʹ4ʹ = Set mode to double length restricted.
The mode controls the manual encryption key entry mode, the
encryption key size and the restrictions placed on key usage. When
using a remote key protocol, the mode must be set based on the DES
key size to be used and the level of restriction to be placed on the
usage of encryption keys.
All four key modes are supported for a non‐secure EPP on NCR and
other vendors’ machines. With a secure EPP and firmware such as
DAPI‐7, only key mode ʹ4ʹ is supported. If the mode cannot be
supported by the EPP, a Specific Command Reject is returned.
Table Note 34: Security messages from Central will not be
processed if the application is in Supervisor mode.
Table Note 35: For modifiers ‘C’, ‘D’ and ‘E’, the key data consists
of either a single‐ or double‐length DES key, which is padded and
encrypted with PK‐EPP using the RSAES‐PKCS1‐v1_5 encryption
scheme. The 256‐byte result is then signed with SK‐HSM using the
RSASSA‐PKCS1‐v1_5 signature algorithm to give a 256‐byte
signature. Each block is Base 94 encoded giving 320 bytes.
The same process is followed when the Enhanced Signature scheme
is used but the signature is generated from the random number
returned in response to an EEKC request with modifier ‘N’ and
concatenated with the encrypted single‐ or double‐length DES key.
The random number is not included in the message from the host to
the EPP. All of the data returned in the random number from the
SST must be used in the cryptogram.
Table Note 36: Modifiers ‘R’, ‘S’ and ‘T’ are supported only under
the enhanced signature remote key protocol. If the enhanced
signature is not supported, Specific Command Reject E02 is
returned.
Table Note 37: Modifiers ‘S’ and ‘T’ are used to delete the HSM
public key and HSM Root public key.
Table Note 38: Modifier ‘U’ is used to return the EPP attributes for
the host to determine whether the EPP is PCI compliant.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-44 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Extended Encryption Key Change
Table Note 39: Where variable length EPP serial numbers are
supported use modifier ʹVʹ to report EPP serial numbers for all
hardware variants to avoid different host processing requirements
on different hardware.
Note: The application adds the SN‐EPP to the message data for
verification.
Table Note 40: For modifiers ‘X’, ‘Y’, ‘Z’, ‘a’, ‘b’ and ‘c’ the key data
consist of the TR34 certificate encoded using base 94. The key data
size is ignored and should be set to 000. The length of the certificate
is determined by inspecting the length attribute in the first tag after
base 94 decoding.
Table Note 41: For modifiers ‘e’ and ‘f’ the key data consists of the
TR31 key block. This data is not base 94 encoded as the TR31 format
defines that the key block consists of printable characters and ASCII
encoded hex. The key data size is ignored and should be set to 000.
Table Note 42: Modifier ‘k’ is used to request EPP data that needs
to be included when generating an authentication data block for a
command, which needs to be authenticated before it can be
completed by the EPP. The data included with modifier ‘k’
identifies the command that is about to be executed that requires
authentication. The Key Data Size is ignored and should be set to
000. The data included with modifier ‘k’ is a one byte field
containing the modifier for the command that is about to be
executed. The modifiers ‘b’ and ‘c’ require authentication data to be
requested.
Request for Authentication data for other modifiers will be rejected
with a specific reject of B38. Existing authentication mechanisms are
not affected by this new protocol.
The Enhanced Signature RKL mechanism for public key deletion
does not use this command.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-45
Central to Terminal Messages
Dispenser Currency Cassette Mapping Table
Dispenser Currency Cassette
Mapping Table 10
The table contained in this message is used to define currency types,
which map to the configuration settings in table entry 7 of the
Amount Check State defined in the Amount Check State Table.
When the Data Security feature is set, all the messages sent from the
host to the terminal that contain a MAC field must have this
optional field present.
Table 10‐13
Dispenser Currency Cassette Mapping
Number of
Field Mandatory/ Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. This field is included for future use and is ignored by
the terminal.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). This field is included for future use
and is ignored by the terminal.
FS 1 M Field Separator.
e 3 O Message Sequence Number. This field is included for future use and
is ignored by the terminal.
FS 1 M Field Separator.
f 1 M Message Sub‐Class. The message sub‐class is:
‘1’ ‐ Customisation Data
g 1 M Message Identifier. The message identifier is:
‘E’ ‐ Dispenser Currency Cassette Mapping Table
FS 1 M Field Separator.
h 2 M Number of Mapping Entries. Two‐digit ASCII hex value (range 01 to
FF). See Table Note 43.
i1 2 See Table Note 43 Currency Type. Single‐digit ASCII hex value (range 01 to FF). Used
for mapping to state type ‘G’ table entry 7.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-46 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Dispenser Currency Cassette Mapping Table
Number of
Field Mandatory/ Optional Description
Characters
i2 1 See Table Note 43 Cassette Type. Single‐digit ASCII hex value (range 0 to F, types 1 to 4
supported).
i3 5 See Table Note 43 Denomination for Cassette. Five‐digit ASCII numeric value (for
example, 00005 for $5).
FS 1 See Table Note 44 Field Separator.
j 8 See Table Note 44 Message Authentication Code (MAC) Data. Contains the value
transmitted for authentication of this message. The characters are 0‐9,
A‐F.
k Var M Trailer. Protocol‐dependent.
Table Note 43: If field h is greater than 01, the fields i1 to i3
inclusive are repeated for the number of times indicated by field h.
The Data Command message is expected at the SST only when the
SST is in out‐of‐service mode or supply/Supervisor mode.
If the host transmits a Data Command message that does not
conform to the format above, or is sent unexpectedly, a solicited
error message is generated, identifying a Specific Command Reject
value for the failure reason (or simply ʹAʹ if Specific Command
Reject processing is not activated).
If a Specific Command Reject value is generated then the message
content will be ignored.
The following example shows the contents for fields h and i using
two currencies and four cassette types:
Cassette type 1 = 10 dollars
Cassette type 2 = 20 dollars
Cassette type 3 = 100 euros
Cassette type 4 = 200 euros
.... 04 01 1 00010 01 2 00020 02 3 00100 02 4 00200
....
The spaces are included for clarity but do not appear in the actual
message to the SST.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-47
Central to Terminal Messages
Dispenser Currency Cassette Mapping Table
Table Note 44: The field separator and MAC are present only when
the Data Security feature is selected and the flags are set correctly.
For details, refer to the APTRA Advance NDC, Supervisor’s Guide.
When the Data Security feature is set, all the messages sent from the
host to the terminal that contain a MAC field must have this
optional field present.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-48 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
XML Configuration Download
XML Configuration Download 10
This message is a generic command that downloads configuration
data to the terminal. The configuration data content is defined in
XML files and is contained within a number of XML schema files.
These schema files are defined when new configuration
requirements are identified.
Advance NDC responds to the XML configuration download in the
same way as all other data commands, for example, it sends a
‘Ready 9’ or a Reject solicited message. An XML schema file
containing configuration data can be downloaded in parts (up to a
maximum of 9999), or as a single file. The ‘Ready 9’ acknowledges
receipt of each XML schema file part; but this does not imply the
content is valid. Validation occurs only when the final part of the
file is downloaded.
The host must download the parts of the file in sequence. When the
last part of the file is downloaded, Advance NDC constructs the
whole file, validates the file, completes the configuration process
and stores the file. The name of the file is read from the XML
configuration data and is stored in the C:\Program Files\NCR
APTRA\config directory. If part of a file is downloaded out of
sequence, a Specific Command Reject is returned. If the host does
not receive the ‘Ready 9’ acknowledgement, it can re‐send the last
part without getting an error. This allows the host to recover from a
communications failure or continue with the download after a
power failure at the SST.
The host can cancel a download (and potentially re‐start the whole
process) by setting either field ‘h’ (Total Message Parts), or field ‘i’
(Message Part) to ‘0000’. The cancel download request is required if
the host receives a Specific Command Reject. Advance NDC replies
with a ‘Ready 9’ when it has processed the cancel download
request.
All parts of the download are discarded when the final part has
been downloaded and processed, or when the host cancels the
download.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-49
Central to Terminal Messages
XML Configuration Download
Table 10-14
XML Configuration Download Message
Format
Number of Mandatory/ /
Field Description
Characters Optional
b 1 M Message Class.
The message class is: ‘3’ ‐ Data Command.
c 1 O Response Flag.
This field is included for future use and is ignored by the terminal.
1 M Field Separator.
d 3 O Logical Unit Number.
Included for future use and is ignored by the terminal.
1 M Field Separator.
e 3 O Message Sequence Number.
Included for future use and is ignored by the terminal.
1 M Field Separator.
f 1 M Message Subclass.
The message subclass is: ‘1’ ‐ Customisation Data.
g 1 M Message Identifier.
The message identifier is: ‘I’ ‐ XML Configuration Download.
1 M Field Separator.
h 4 M Total Message Parts.
Total number of parts that the configuration data is split into. It contains a
four digit decimal number, in the range ‘0000’ to ‘9999’. If this value is
‘0000’, all previous parts of a partial configuration data download are
discarded (see Table Note 45).
1 M Field Separator.
i 4 M Message part.
Part number for the configuration data contained within this message. It
contains a four‐digit decimal number, in the range ‘0000’ to ‘9999’. If this
value is ‘0000’, all previous parts of a partial configuration data download
are discarded (see Table Note 45). If this value equals the value in Total
Message Parts (field h), the downloaded parts are combined and validated
against the specific schema. If the data is valid the configuration data is
stored in an XML file at a specific location.
1 M Field Separator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-50 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
XML Configuration Download
Number of Mandatory/ /
Field Description
Characters Optional
j Var M NDC Configuration Data.
For details of the configuration data format, refer to the APTRA Advance
NDC Developer’s Guide
1 See Table Field Separator.
Note 46.
k 8 See Table Message Authentication Code Data (MAC) Data.
Note 46. Value transmitted for authentication of this message. The characters are in
the range ‘0‐9’ and ‘A‐F’.
Table Note 45: If either field h or i contain the value ‘0000’, all
previous parts of a partial configuration download are discarded.
Table Note 46: The field separator and MAC Data field k are only
present if the flag settings are correct. For details, 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, Reference Manual 10-51
Central to Terminal Messages
Transaction Reply Command
Transaction Reply Command 10
A Transaction Reply command is sent to the SST once the
cardholder has entered all the data necessary for a specific
Transaction Request, and a request has been sent to Central.
The SST regards the Transaction Reply command as an
authorisation to complete the transaction. If the transaction cannot
be completed successfully, the SST sends a solicited device fault
status message to Central. The SST then waits for another
Transaction Reply command, authorising it to complete the
transaction in another way.
The maximum length of a Transaction Reply command depends on
the communications protocol in use.
Table 10-15
Transaction Reply Command: Message
Format
Number of
Field Mandatory/ Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘4’ ‐ Transaction Reply Command
c 1 O Response Flag. Included for future use and ignored by the terminal.
FS 1 M Field Separator.
d 3 or 9 O Logical Unit Number (LUNO). The contents of this field are only used
when Central asks for the security terminal number to be checked. In
this case the field will contain nine characters, the last six of which are
checked.
FS 1 M Field Separator.
e 3 or 8 See Table Note 57 Message Sequence/Time Variant Number. The Message Sequence
number field is ignored by the terminal and is included for future use.
The Time Variant field contains an eight‐character time variant
number which should be the same as the last time variant number
transmitted to Central.
FS 1 M Field Separator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-52 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
f 3 O Next State ID Data. Contains a base 10 (decimal) number in the range
000‐254 or 256‐999, or a base 36 (alphanumeric) number in the range
000‐254 or 256‐ZZZ. This identifies the state number which the SST
should execute after it has completed the specified Transaction Reply
command.
This field must be included in all Transaction Reply messages except
a Print Immediate.
FS 1 M Field Separator.
g1 2 See Table Note 53, Number of type 1 notes to dispense. Contains the number of type 1
Table Note 54, Table notes to be dispensed. Valid range is defined by hardware
Note 55, and Table capabilities.
Note 56
g2 2 See Table Note 53, Number of type 2 notes to dispense. Contains the number of type 2
Table Note 54, Table notes to be dispensed. Valid range is defined by hardware
Note 55, and Table capabilities.
Note 56
g3 2 See Table Note 53, Number of type 3 notes to dispense. Contains the number of type 3
Table Note 54, Table notes to be dispensed. Valid range is defined by hardware
Note 55, and Table capabilities.
Note 56
g4 2 See Table Note 53, Number of type 4 notes to dispense. Contains the number of type 4
Table Note 54, Table notes to be dispensed. Valid range is defined by hardware
Note 55, and Table capabilities.
Note 56
g5 2 See Table Note 53, Number of type 5 notes to dispense. Contains the number of type 5
Table Note 54, Table notes to be dispensed. Valid range is defined by hardware
Note 55, and Table capabilities.
Note 56
g6 2 See Table Note 53, Number of type 6 notes to dispense. Contains the number of type 6
Table Note 54, Table notes to be dispensed. Valid range is defined by hardware
Note 55, and Table capabilities.
Note 56
g7 2 See Table Note 53, Number of type 7 notes to dispense. Contains the number of type 7
Table Note 54, Table notes to be dispensed. Valid range is defined by hardware
Note 55, and Table capabilities.
Note 56
GS 1 See Table Note 60 Group Separator
j1 2 See Table Note 61 and Number of hopper type 1 Coins to Dispense.
Table Note 60 Contains the number of coins to be dispensed from hopper type 1.
Valid range is defined by hardware capabilities. See Table Note 62.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-53
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
j2 2 See Table Note 61 Number of hopper type 2 Coins to Dispense.
and Table Note 60 Contains the number of coins to be dispensed from hopper type 2.
Valid range is defined by hardware capabilities. See Table Note 62.
j3 2 See Table Note 61 Number of hopper type 3 Coins to Dispense.
and Table Note 60 Contains the number of coins to be dispensed from hopper type 3.
Valid range is defined by hardware capabilities. See Table Note 62.
j4 2 See Table Note 61 Number of hopper type 4 Coins to Dispense.
and Table Note 60 Contains the number of coins to be dispensed from hopper type 4.
Valid range is defined by hardware capabilities. See Table Note 62.
j5 2 See Table Note 61 Number of hopper type 5 Coins to Dispense.
and Table Note 60 Contains the number of coins to be dispensed from hopper type 5.
Valid range is defined by hardware capabilities. See Table Note 62.
... Repeated for the number of hopper types present.
jn 2 See Table Note 61 and Number of hopper type n Coins to Dispense.
Table Note 60 Contains the number of coins to be dispensed from hopper type n.
Valid range is defined by hardware capabilities. See Table Note 62.
FS 1 M Field Separator.
k 4 M Transaction Serial Number. Number that Central uses to identify the
transaction. It is used by the SST for the following functions:
‐ Default PPD printing
‐ Transaction number of the last transaction processed by the SST.
(This can be requested by Central by transmitting a Send Supply
Counters Terminal Command to the SST.)
‐ Part of the information printed on the journal when an exception
status is sent to Central.
Valid range is 0000‐9999
l 1 M Function Identifier. Instructs the terminal on what functions are to be
performed:
Function ID Functions Performed
‘1’ or ‘7’ Deposit and print. See Table Note 49.
‘2’ or ‘8’ Dispense and print. See Table Note 47.
‘3’ or ‘9’ Display and print
‘4’ Print immediate
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-54 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
‘5’ Set next state and print
‘6’ Night safe deposit and print
‘A’ Eject card and dispense and print (card before cash)
‘B’ or ‘C’ Parallel dispense and print and card eject
‘E’ Reserved. A specific command reject will be sent if this is
received.
‘F’ Card before parallel dispense/print
‘O’ Reserved
‘P’ Print statement and wait. See Table Note 48.
‘Q’ Print statement and set next state. See Table Note 48.
‘R’ Reserved. A Specific Command Reject will be sent if this
is received.
‘S’ Reserved. A Specific Command Reject will be sent if this
is received.
‘T’ Reserved. A Specific Command Reject will be sent if this
is received.
‘#’ Print passbook and set next state (Not supported)
‘%’ Print passbook and wait (Not supported)
‘*’ Refund notes and print
‘‐’ Deposit notes and print
‘’’ Deposit notes and wait
‘:’ Process cheque
‘b’ Dispense notes first during valuable media exchange
‘c’ Process multiple cheques
‘e’ Print valuable media and set next state (not supported)
‘f’ Deposit media first during valuable media exchange
Table Note 47: If the Dispense and Print function is used with a
spray cash dispenser and a motorised card reader, the full timeout on
cash taken before returning card and then printing will be used.
Table Note 48: Function IDs ‘P’ and ‘Q’ are used to print
statements on the statement printer when the printer flag in the
Transaction Reply is ‘8’ or sideways on the receipt printer when the
printer flag is ‘=’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-55
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
The action taken on a Print Immediate command depends on when it
is received and the contents of the next state ID field.
Table Note 49: Diebold mode is not supported, therefore Advance
NDC operation is different from NDC+. In Advance NDC, an
envelope is always dispensed on execution of the transaction reply if
an envelope has not previously been dispensed through the execution
of the Envelope Dispenser State.
State Next State Field Action
Trans. Included As next state and print.
Request
Trans. Omitted Print and wait for new Transaction Reply
Request command.
Other ‐ See “Message Validation” on page 10‐102.
m 3 or 5 Screen Number. Contains either a three‐digit decimal value from 010
to 999, or a five‐character value containing a four‐digit screen number
prefixed with the letter ‘u’ or ‘l’. The screen number defines the screen
to be displayed on the terminal during execution of the specified
function.
To select a screen from the current language group, use either group
ʹlʹ or a three‐digit screen number. To select a screen independently of
language group, use group ‘u’.
On a Card Before Cash or Card Before Parallel Dispense and Print
transaction, this screen should contain two nested screen numbers for
displaying at different times during the transaction; S0 (screen 1) S0
(screen 2). Do not include a clear screen control, as this prevents the
nested screens being displayed.
This field must be present if field ‘n’ is present. Otherwise, it is
optional. If the screen number is not present or not defined, no voice
data will be played.
n Var O Screen Display Update. Contains screen numbers and new screen
data which can replace existing screen data. The new screen data is
displayed when its screen number is referenced during transaction
processing.
To immediately update a displayed screen, the displayed screen must
be the first screen in the screen update data. In a voice‐guided session,
this can be used to insert dynamic audio data in a message; for
details, See “Digital Audio Control for Voice Guidance” on page 3‐23.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-56 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
Screen numbers in the screen update can be specified as four digit
numbers in group ʹuʹ (u1234) to load a screen independent of
language group. A screen number from group ʹlʹ (l1234) can be
specified to load a screen in the current language group. A screen
number specified with three decimal digits (123) will be language
independent, unless a language has been selected with a group size of
1000 or greater, in which case the screen number will be adjusted for
language.
The screen update data is in the following format:
No. Of Bytes Content
3, 5 or 6 Screen number
Var Screen data
1 * Group separator
4 * Reserved
3 * Screen number
Var * Screen data
* These fields are only included when multiple screens are to be
updated within one message. They are repeated for each additional
screen.
FS 1 M Field Separator.
o 1 M Message Co‐ordination Number.
For details, see field “g” on page 9‐3
p 1 M Card Return/Retain Flag. Tells the terminal to either return or retain
the card during the Close state
‘0’ ‐ return card during the Close state
‘1’ ‐ retain card during the Close state
‘4’ ‐ return card while processing the transaction reply. This value can
only be used when the function id is ‘b’ or ‘f’. If this value is used with
any other function id the transaction reply will be rejected (Specific
Command Reject E01)
This flag is ignored and the card is always returned if the Function ID
is ‘A’, ‘B’ or ‘C’ and the card is not in the card reader at the close state.
q 1 M Printer Flag. Tells the terminal which printer or printers to use.
See Table Note 50
‘0’ ‐ Do not print
‘1’ ‐ Print on journal printer only
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-57
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
‘2’ ‐ Print on receipt printer only
‘3’ ‐ Print on receipt and journal printer
‘4’ ‐ Print on PPD if the Function ID is ‘1’ or ‘7’ (Deposit and print).
‘5’ ‐ Print on PPD and journal if the Function ID is ‘1’ or ‘7’ (Deposit
and print).
‘8’ ‐ Print on statement printer only
‘9’ ‐ Reserved
‘:’ ‐ Print on passbook (not supported)
‘=’ ‐ Print sideways on the receipt printer if the Function ID is ‘P’
(Print Statement and Wait) or ‘Q’ (Print Statement and Set Next
State).
‘>’ or ‘w’ ‐ Identifies audio data for a voice‐guided session.
See Table Note 66
‘a’ ‐ Stamp cheque if the Function ID is ‘:’ (Process cheque). This flag
indicates that a cheque is to be stamped. The data field is ignored as
the stamp content is fixed. This flag is not actioned if the cheque is
ejected.
‘b’ ‐ Endorse cheque if the Function ID is ‘:’ (Process cheque) or ‘c’
(Process Multiple Cheques). This flag indicates that printing takes
place on the reverse of a cheque and relates to cheque endorsement.
This flag is not actioned if the cheque is ejected.
If the Function ID is ‘B’ or ‘C’ (Parallel dispense, eject and print), NCR
recommends that you use only one journal print data field and one
receipt print data field.
If multiple printer flags ‘4’ and/or ‘5’ are used in the same transaction
message, only the first printer data field will be printed on the
depository.
If printer flag ‘8’ is used in any functions other than ‘P’ and ‘Q’, the
following printer data field will be ignored. Only the first printer data
field with flag value ‘8’ will be accepted in a message.
For sideways printing on the receipt, only one printer flag of ‘=’ will
be accepted in the message for functions ‘P’ and ‘Q’. If printer flag ‘=’
is used in any other function, the following printer data field will be
ignored.
If printer flags ‘=’ and ‘8’ are both present in a transaction reply along
with Function ID ‘P’ or ‘Q’, the first of these flags encountered in the
message will be accepted and processed. It is therefore recommended
that only one of these printer flags is present in a Print Statement and
Wait or Print Statement and Set Next State function.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-58 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
Printer flags ‘9’ and ‘:’ are ignored.
r Var (500) O Printer Data Field. The maximum length of this field depends on the
amount of data compression used in the transmitted data, but it is at
least 500 bytes of uncompressed print data. Data sent to each separate
printer data field is printed on a new line. Inserted data is printed by
the printer indicated in the Printer Flag field.
Each printer device has its own restrictions:
Text sent to print on the depository must be 80 characters or less.
Text sent to print on the receipt printer must be:
‐ 24 lines or less if printing in normal mode
‐ 49 lines or less if local configuration option digit 6B is set
‐ 20 lines or less for sideways printing on the receipt.
Sideways printing i s not supported for the journal printer.
Text sent to be printed sideways on the receipt printer can be up to a
maximum width of 80 characters.
The statement printer is constrained either to the compressed data
length and the overall message length, or to the length of paper.
When used with printer flag ‘b’ for Function ID ‘:’ (Process cheque) or
Function ID ‘c’ (Process Multiple Cheques), this field contains the
endorsement print data (ASCII text) for the cheque.
When used with printer flag ‘w’ or ‘>’ (Identify audio data for voice
guidance), this field contains the audioID sub‐element reference to
the Text element in the voice guidance XML configuration file, and
any dynamic audio data to be included in the message. See Table Note
66.
If the first character is ‘?’, the text is printed in the alternative format.
The alternative format could be normal, bold, or compressed text
depending on the cheque processor variant.
The ‘?’ character can be used to select the XFS PTR form to use. These
forms can be used to modify the text format. For details, refer to the
APTRA documentation under APTRA XFS | Programmer’s
Reference | XFS Service Providers | XFS PTR Service Provider.
No escape sequences or control codes are supported with printer flag
‘b’. If no endorsement data is suppled with this flag, a Specific
Command Reject is returned.
GS 1 See Table Note 50 Group Separator.
s 1 O Printer Flag. See field ‘q’.
t Var (500) O Printer Data. See field ‘r’.
GS 1 See Table Note 50 Group Separator.
u 1 O Printer Flag. See field ‘q’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-59
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
v Var (500) O Printer Data. See field ‘r’.
GS 1 See Table Note 50 Group Separator
v1 1 O Printer Flag. See field ‘q’.
v2 Var (500) O Printer Data. See Field ‘r’.
GS, ‘v1’ and ‘v2’ may be repeated up to nine further times. See Table Note 50.
FS 1 See Table Note 52 Field Separator.
w 1 O Buffer Identifier. A ‘4’ in this field identifies the following data as
See Table Note 52 Track 3 data.
x Var (106) O Track 3 Data. Contains the data to be written on to Track 3 during the
See Table Note 52 Card Write state or Card Before Cash function command. This data
replaces any existing data in the terminal’s Track 3 buffer. The Track 3
data consists of up to 106 characters including the start and end
sentinels.
FS 1 See Table Note 52 Field Separator.
ak1 1 O Buffer Identifier ‘K’. A value of ‘K’ for the Buffer Identifier indicates
that the following fields define the new Track 1 data that is to be
written to the card.
ak2 Var (78) O Track 1 Data. This field contains the data to be written to Track 1
during the Card Write state or Card Before Cash function command.
This data replaces any data already in the terminal’s Track 1 buffer.
The Track 1 data consists of up to 78 characters.
FS 1 See Table Note 52 Field Separator.
al1 1 O Buffer Identifier ‘L’. A value of ‘L’ for the Buffer Identifier indicates
that the following fields define the new track data that is to be written
to the card.
al2 Var(39) O Track 2 Data. This field contains the data to be written to Track 2
during the Card Write state or Card Before Cash function command.
This data replaces any data already in the terminal’s Track 2 buffer.
The Track 2 data consists of up to 39 characters.
FS 1 See Table Note 52 Field Separator.
am1 1 O VC data ID ‘M’.
Fields am1/am2 to ar1/ar2 are reserved for Exits use. The first field in
the pair is a data identifier, the second is a variable length buffer. The
data identifier should be in the range ‘M’ (4DH) to ‘R’ (52H). The
fields can be selectively MACed. For details, See “Message
Authentication” on page 11‐10.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-60 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
am2 Var O VC data
The Exit data. The data field should not contain the Group Separator
character (1DH).
FS 1 See Table Note 52 Field Separator
an1 1 O VC data ID ‘N’
an2 Var O VC data
FS 1 See Table Note 52 Field Separator
ao1 1 O VC data ID ‘O’
ao2 Var O VC data
FS 1 See Table Note 52 Field Separator
ap1 1 O VC data ID ‘P’
ap2 Var O VC data
FS 1 See Table Note 52 Field Separator
aq1 1 O VC data ID ‘Q’
aq2 Var O VC data
FS 1 See Table Note 52 Field Separator
ar1 1 O VC data ID ‘R’
ar2 Var O VC data
FS 1 See Table Note 52 Field Separator
as1 1 See Table Note 52 Buffer Identifier ‘S’ (Reserved for internal use)
as2 1 See Table Note 52 Cash handler number (0 or 1)
as3 3 See Table Note 52 1st cassette type in specified cash handler
as4 3 See Table Note 52 Number of bills to dispense from 1st type
as5 3 See Table Note 52 2nd cassette type in specified cash handler
as6 3 See Table Note 52 Number of bills to dispense from 2nd type
as7 3 See Table Note 52 3rd cassette type in specified cash handler
as8 3 See Table Note 52 Number of bills to dispense from 3rd type
as9 3 See Table Note 52 4th cassette type in specified cash handler
as10 3 See Table Note 52 Number of bills to dispense from 4th type
...
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-61
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
asn 3 See Table Note 52 Last cassette type in specified cash handler
asn+1 3 See Table Note 52 Number of bills to dispense from last type
FS 1 O See Table Note 59
at1 1 See Table Note 52 Smart card data ID ‘5’
at2 Var See Table Note 52 Smart card data. For data that is specific to EMV/CAM2, the data will
begin with ‘CAM’. For more information, refer to the EMV Integrated
Circuit Card (ICC) Reference Manual. Other smart card customisations
may begin with a different value.
FS 1 O See Table Note 59
ba1 1 See Table Note 52 Buffer Identifier ‘a’ (Cheque(s) Destination Data)
ba2 1 See Table Note 52 and Cheque(s) destination data
Table Note 63 ‘1’ ‐ Deposit cheque into pocket 1
‘2’ ‐ Deposit cheque into pocket 2
‘3’ ‐ Deposit cheque into pocket 3
‘E’ ‐ Eject the cheque
The host can determine the number of pockets present by retrieving
the Hardware Configuration Data only message. If the Transaction
Reply specifies a pocket which does not exist, the cheque will be
captured to the reject pocket and the count for the reject pocket will
be updated. If a Transaction Reply is sent that does not contain one of
the above destination values (an invalid cheque destination field), a
Specific Command Reject with error code B13 ‐ Unrecognised
Document Destination will be returned.
If the Transaction Reply does not include endorsement print data (see
page 10‐59), no endorsement data is printed and cheques are sent to
pocket 2 (pocket 1 if only one pocket is available).
FS 1 O See
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-62 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
bb1 1 O Buffer Identifier ‘b’ (Process Multiple Cheques)
bb2 3 See Table Note 64 Cheque Identifier.
Range ‘000’‐’999’
Refers to specific cheques reported in the Transaction Request
message. If this refers to a cheque that was not reported in the
Transaction Request message, specific command reject B34 is
returned
If this is ‘000’, the following fields apply to all cheques that do not
have a specific action defined
If this buffer does not include actions for all cheques included in the
Transaction Request message, either explicitly or with a setting of
‘000’, specific command reject B34 is returned and none of the
cheques are processed
For details of the specific command reject B34, see Table 10‐41
“Specific Command Reject Value/Qualifier Combinations” on
page 10‐103
bb3 2 See Table Note 64 Cheque Destination
Specifies the destination for the cheque identified by the Cheque
Identifier field
‘00’ ‐ Return cheque to cardholder
‘01’ ‐ Deposit cheque into pocket 1
...
‘15’ ‐ Deposit cheque into pocket 15
bb4 1 See Table Note 64 Cheque Stamp
Specifies whether the cheque is to be stamped if supported by the
hardware
‘0’ ‐ Do not stamp the cheque
‘1’ ‐ Stamp the cheque
bb5 4 See Table Note 64 Reserved
Must be filled with zeros
bb6 Var See Table Note 64 Cheque Endorse Text
Contains the text to use when endorsing the cheque. Any print data
provided for Printer flag ‘b’ is ignored
Multiple lines of text can be provided with each line separated by a
carriage return (0x0D) and line feed (0x0A) sequence
If the bunch cheque acceptor does not support multi‐line
endorsement, the carriage return and line feed characters are
removed and replaced with a space (0x20) character
GS 1 See Table Note 64 Group separator
FS 1 See Field separator
bc 1 O Used for EMV dynamic currency conversion transactions. For details,
refer to the EMV Integrated Circuit Card (ICC) Reference Manual.
FS See Table Note 52 Field separator
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-63
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
bd1 1 O Buffer Identifier ‘d’
See Table Note 52 This and its associated fields can be included in any Transaction
Reply with any function identifier, but is typically used in the reply to
a pre‐authorisation request for a subsequent cash deposit within the
same consumer transaction.
It indicates that the following data fields define the limits for the
following consumer deposit: the limit for the amount of the deposit,
the limit for the number of notes or both limits.
The data received is valid until the next Transaction Reply is received.
If the consumer/transaction data is required across a number of
Transaction Replies, it must be sent in each Transaction Reply. The
data is cleared by the Close state.
bd2 10 See Table Note 52 Reserved
bd3 3 See Table Note 52 and Customer/Transaction Data Element Identifier
Table Note 58 Valid values are:
001 = Deposit amount limit (applies to the specified currency)
002 = Deposit note number limit (applies to all currencies that can be
deposited during the transaction)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-64 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Number of
Field Mandatory/ Optional Description
Characters
bd4 Var See Table Note 52 and Customer/Transaction Data Element Buffer
Table Note 58 Format and content depend on the value of field bd3:
If bd3 = 001
A three‐character ISO currency code followed by the maximum value
in decimal of the primary currency unit. For example,
001GBP100.00 indicates that the maximum value in pounds sterling
that can be deposited during the transaction is £100.00.
Multiple deposit limit parameters can be provided in a single
transaction reply. For example, if the Customer/Transaction Data
Element buffer contains
‘d0000000000001GBP200.00<GS>001EUR250.00<GS>002050’,
a maximum of 200 pounds sterling and 250 euros with a limit of 50
notes can be deposited.
Note: The decimal point must be used regardless of the currency.
If bd3 = 002
A three‐digit decimal number specifying the maximum number of
notes that can be deposited in the transaction.
For example, 002050 indicates that a maximum number of 50 notes
can be deposited.
If the Customer/Transaction Data Element Identifier 002 occurs more
than once in the field, the number of notes specified in the last
element is used. For example, if the buffer contains
‘d0000000000002030<GS>002050’, a maximum of 50 notes for all
available currencies can be deposited during the transaction.
Note: The Customer/Transaction Data Elements in a Transaction
Reply can be in any order, for example,
‘d0000000000001GBP200.00<GS>002050’ or
‘d0000000000002050<GS>001EUR250.00’
See Table Note 67 and Table Note 68
bd5 1 See Table Note 58 Group separator (GS)
FS 1 See Table Note 59 Field separator
y 8 O Message Authentication Code (MAC) data
Contains the transmitted value for authentication of this message.
The characters can be 0‐9, A‐F.
z Var M Trailer. Protocol‐dependent.
Table Note 50: A group separator and optional fields ‘s/t’, ‘u/v’,
‘v1/v2’ and so on, comprise a group. When included in the message,
all fields of the group must be present. There may be up to thirteen
print field groups within a message.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-65
Central to Terminal Messages
Transaction Reply Command
Table Note 51: When defining the Transaction Reply message for a
cheque processor, the message must contain one or both of printer
flags ‘a’ or ‘b’. If neither flag is present all cheques are deposited in
the reject bin.
Table Note 52: The field separator followed by optional fields ‘w’
and ‘x’ or ‘ae*’, ‘af*’, ‘ak*, ‘ar*’, ‘as’, ‘at*’ or ‘bd*’ comprise a group.
When included in a message, all fields of the group must be present.
If the group is not included, the field separator must be omitted.
Table Note 53: A higher‐numbered type can be omitted if no
dispense of that type is requested.
Table Note 54: It is possible to dispense from as many cassette
types as are present in the cash handler.
Table Note 55: The length of this field is dependent on the setting
of Enhanced Configuration option 76. For details, See “Option 76 –
Cash Handlers” on page 7‐19.. A Specific Command Reject is sent if
the field is too long.
Table Note 56: The maximum number of notes that can be
dispensed is reported in the Hardware Configuration message. The
maximum number of notes is taken from the service provider
capability information. Any request for more than 999 notes is
rejected as this is above the message reporting capacity
Table Note 57: The Time Variant Number, length eight bytes, is
present if the MAC flag settings are correct. Otherwise, the Message
Sequence Number, length three bytes, is optionally present. For
details, refer to the APTRA Advance NDC, Supervisor’s Guide.
Table Note 58 Fields bd3 and bd4 are repeated for each element of
the customer/transaction data, separated by a group separator. The
last element of the customer/transaction data is not followed by a
group separator.
Table Note 59: The field separator and MAC data field ‘y’ are
present if the Data Security feature is selected, and the MAC flag
settings are correct. For details, refer to the APTRA Advance NDC,
Supervisor’s Guide.
Table Note 60: This group separator should only be included if a
coin dispense is required.
Table Note 61: Field ‘j1’ must be present if the preceding group
separator is included. However, higher numbered hoppers may be
omitted if no dispense from these hoppers is required. The total
number of coins dispensed must not exceed 25.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-66 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table Note 62: The maximum number of coins that can be
dispensed is reported in the Hardware Configuration message. The
maximum number of coins is taken from the service provider
capability information. Any request for more than 999 coins is
rejected as this exceeds the message reporting capacity.
Table Note 63: The message format can also support destinations
‘4’ through ‘9’ to deposit the cheque into cheque processor bins 4
through 9; and ‘a’ through ‘f’ to deposit the cheque into cheque
processor bins 10 through 15. Advance NDC does not support these
destinations.
Table Note 64: Fields bb2 to bb6 are repeated for each cheque, and
the details for each cheque are separated by a Group Separator.
Details for the cheques within a single currency can be provided in
any order, that is, the cheque details are provided as an unordered
list. The last cheque does not have a group separator following the
data. Field bb2 corresponds to the Cheque Identifier used in the
Transaction Request message.
Table Note 65: The field separator is required only if the following
field is present.
Table Note 66: The voice guidance data is played after successful
processing of the transaction reply function and before moving to
the next state specified in the transaction reply message. If the
transaction reply processing fails, for example, because of a
dispenser fault, resulting in a solicited status sent to the host, voice
data from the original transaction reply message is discarded. If
alternative voice data is required, the host must send it in the
subsequent transaction reply message.
Table Note 67: The host specifies the deposit limit for specific
customers using transaction reply. If both the direct deposit limit
and the transaction reply limits are defined, then the limit specified
by the transaction reply takes precedence.
Table Note 68 : If a direct deposit limit and state based limit
(amount or number of items) are set in a deposit transaction, the
limit that is exceeded first is considered.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-67
Central to Terminal Messages
Transaction Reply Command
For cash deposit transactions, the following table describes the
Specific Command Reject circumstances in which Transaction Replies containing Buffer
Messages for Identifier ‘d’ are rejected:
Buffer ‘d’ 10
Table 10-16
Invalid Customer/Transaction Data
Element Details
Specific Command Reject Code Examples
A01 — Message length error
Buffer Identifier ʹdʹ (field bd1) is present but the subsequent fields are
missing
Reserved field bd2 of length 10 is missing after Buffer Identifier ʹdʹ
Buffer Identifier ‘d’ (field bd1) and a value of 0000000000 in field bd2 are
present but the subsequent fields are missing
Buffer Identifier ʹdʹ is present, there is a value of 0000000000 (ten zeros) in
field bd2 and the Customer/Transaction Data Element Identifier (field bd3)
is present, but the subsequent field (bd4) is missing, for example,
‘d0000000000001’
The length of the Customer/Transaction Data Element Identifier is not three
digits, for example, ‘d000000000001’
A limit on the number of notes that can be deposited is specified but the
length of the Customer/Transaction Data Element Buffer (field bd4) is not
three digits, for example, ‘d000000000000205’ or
‘d00000000000020500’
All the fields are the correct length but a group separator is missing between
the Customer/Transaction Data Elements, for example,
‘d0000000000002050001EUR500’
A04 — Group separator missing
or found unexpectedly
The last Customer/Transaction Data Element Buffer has a group separator
following the data, for example,
‘d0000000000001EUR100<GS>002050<GS>’
B08 — Data field value out of
range
The Customer/Transaction Data Element Identifier (bd3) is not numeric, for
example, ‘d0000000000XXX050’
The Customer/Transaction Data Element Buffer (bd4) defines a deposit
amount limit but the value is not numeric, for example,
‘d0000000000001EUR200b’ or ‘d0000000000001EUR100.5b’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-68 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Specific Command Reject Code Examples
There are two Customer/Transaction Data Element Buffers but the first one
is not numeric while the second one is valid (or the other way around), for
example, ‘d0000000000001EURXXX<GS>002030’
The limit for the number of notes specified in the Customer/Transaction
Data Element Buffer has the correct length but is not numeric, for example,
‘d000000000000205d’
Reserved field bd2 is present but it is not set to ʹ0000000000ʹ.
The Customer/Transaction Data Element Identifier in field bd3 is not
supported, for example ‘d0000000000003050’ or ‘d0000000000006050’
The currency specified in the Customer/Transaction Data Element Buffer
(field bd4) is not a valid three‐character ISO code, for example,
‘d0000000000001$100’
The limit on the deposit amount or/and the limit on the number of notes is
set to 000, for example, ‘d0000000000002000<GS>001EUR000’
The limit specified for the number of notes that can be deposited is of the
correct length and is numeric but it is invalid because it contains a decimal
point, for example, ‘d00000000000023.5’
Field ‘l’ of the Transaction Reply contains a Function Identifier. This
Terminal Functions for tells the SST what functions are to be performed to complete the
Transaction Completion 10
transaction. The functions are as follows:
Deposit and Print (Table 10‐17 on page 10‐70)
Dispense and Print (Table 10‐18 on page 10‐71)
Display and Print (Table 10‐19 on page 10‐72)
Print Immediate (Table 10‐20 on page 10‐72)
Set Next State and Print (Table 10‐21 on page 10‐73)
Night Safe Deposit and Print (Table 10‐22 on page 10‐73)
Eject Card, Dispense and Print (Card Before Cash) (Table 10‐23
on page 10‐74)
Parallel Eject/Dispense and Print (Table 10‐24 on page 10‐75)
Card Before Parallel Dispense and Print (Table 10‐25 on page
10‐76)
Print Statement and Wait (Table 10‐26 on page 10‐77)
Print Statement and Set Next State (Table 10‐27 on page 10‐78)
Refund Notes and Print (Table 10‐28 on page 10‐79)
Deposit Notes and Print (Table 10‐29 on page 10‐80)
Deposit Notes and Wait (Table 10‐30 on page 10‐81)
Process Cheque (Table 10‐31 on page 10‐81)
Dispense Cash First during Valuable Media Exchange
(Table 10‐32 on page 10‐82)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-69
Central to Terminal Messages
Transaction Reply Command
Process Multiple Cheques (Table 10‐34 on page 10‐86).
Deposit Media First during Valuable Media Exchange
(Table 10‐35 on page 10‐87)
Dispense functions may have slightly different behaviour if a spray
dispenser is present. This is because the spray dispenser sends each
note straight into a receiving pocket instead of stacking and
presenting them as a standard dispenser does. Also, there is no
possibility of retracting notes dispensed by a spray dispenser.
The following tables illustrate the sequence of events, and related
screen displays, for each of these functions.
Table 10-17
Deposit and Print (Function ID ‘1’ or ‘7’)
State Screen Operation
Transaction Request Transaction Request Screen
(PLEASE WAIT)
Transaction Reply Command Present envelope. See Table Note 69
Screen Enable depository.
(INSERT ENVELOPE) Start slow beep. See Table Note 70.
Switch on media entry indicator.
Wait for cardholder to insert envelope.
Stop beeping.
(Enter Time‐Out state if timer 04 expires.
See Table Note 71 and Table Note 72).
Print on envelope.
Print on receipt and journal to defined level.
Send status.
Next State in Next State Screen Switch off media entry indicator.
Transaction Reply (for example, SELECT
Command TRANSACTION) Cut and deliver receipt if necessary and eject card.
Eventual Close state Close Screen Wait for card to be taken or captured. Timer 02
(for example, TAKE CARD) Capture card if timer 09 expires. See Table
See Table Note 72. Note 73.
Table Note 69: An envelope is presented only if an envelope has
not previously been dispensed during the Envelope Dispenser State.
For details, see “C ‐ Envelope Dispenser State” on page 2‐19.
Table Note 70: If the beeper is not required, local configuration
option digit 2C can be set to stop its operation. For details, refer to
the APTRA Advance NDC, Supervisor’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-70 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table Note 71: The Cancel key is active when the ‘Insert Envelope’
screen is displayed. Pressing the Cancel key causes a time‐out status
to be sent to Central.
Table Note 72: For details of timers, see “Configuration Parameters
Load” on page 10‐15.
Table Note 73: Timer 02 (page 7‐7) is used to determine the length
of time that the Close screen is displayed.
Table 10-18
Dispense and Print (Function ID ‘2’ or ‘8’)
State Screen Operation
Transaction Request Transaction Request Screen Dispense the requested cash and
(PLEASE WAIT) coins.
See Table Note 74
Transaction Reply Screen Print on receipt and journal to Timers
(TAKE CASH) defined level. (07 + 10)
or
Send status. (05 + 07)
See Table
Note 75
Next State in Next State Screen
Transaction Reply (for example, SELECT
Command TRANSACTION)
Table Note 74: A dispense can consist of notes only, coins only, or a
combination of notes and coins. If the dispense includes a
combination of notes and coins, the notes must be successfully
dispensed before the coins are dispensed.
Table Note 75: If the SST is configured not to retract notes, timers
07 (page 7‐26) and 10 (page 7‐27) are used to control the minimum
length of time for the transaction, with timer 05 (page 7‐25) if
beeping is active.
If the SST is configured to retract notes, timer 05 is used if beeping is
active, and then timer 07. Timer 05 is started when notes are
presented. If the local configuration option is selected, the beeper is
sounded during the time that timer 05 is in use. For details of
configuration options, refer to the APTRA Advance NDC,
Supervisor’s Guide.
If the notes are taken before the expiry of timer 05, the timer is
cancelled. If the timer expires before the notes are taken, a retract is
attempted. If some notes are retracted, the ‘Presenter Error’ message
is logged to the journal, and an unsolicited error is reported to
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-71
Central to Terminal Messages
Transaction Reply Command
Central. For details, see “Cash Handler (Solicited/Unsolicited)” on
page 9‐96.
Timer 07 is started after notes have been taken, and the next state is
entered on expiry.
For timer format in a message, see “Configuration Parameters
Load” on page 10‐15.
Table 10-19
Display and Print (Function ID ‘3’ or ‘9’)
State Screen Operation
Transaction Request Transaction Reply Screen Print on receipt and journal to Timer
(for example, DISPENSE defined level.
ERROR) Send status. (10 + 07)
or
(07)
See Table
Note 76.
Next State in Next State Screen
Transaction Reply (for example, SELECT
Command TRANSACTION)
Table Note 76: On an SST configured not to retract notes, timers 10
(page 7‐27) and 07 (page 7‐26) are used. On an SST configured to
retract notes, timer 07 is used.
For details of the timer format in a message, see “Configuration
Parameters Load” on page 10‐15. For details of configuration
options, refer to the APTRA Advance NDC, Supervisor’s Guide.
Table 10-20
Print Immediate (Function ID ‘4’)
State Screen Operation
Transaction Request Transaction Request Screen Print on receipt and journal to defined level.
(PLEASE WAIT) Wait for another Transaction Reply command.
Print Immediate may also be received at other times. For details, see
“Messages Received in Wrong Operational Mode” on page 10‐110.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-72 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table 10-21
Set Next State and Print (Function ID ‘5’)
State Screen Operation
Transaction Request Transaction Request Screen Print on receipt and journal to
(PLEASE WAIT) defined level.
Send status.
Next State in Next State Screen
Transaction Reply
Command
Table 10-22
Night Safe Deposit and Print
(Function ID ‘6’)
State Screen Operation
Transaction Request Transaction Request Screen Unlock night safe.
(PLEASE WAIT) Start slow beep.
Transaction Reply Command Wait for cardholder to insert bag.
Screen Stop beeping.
(INSERT BAG) (Enter Time‐Out state if timer 08 expires
See Table Note 77 See Table Note 78).
Print on receipt and journal to defined level.
Send status.
Next state in Next State Screen
Transaction Reply (for example, Transaction
Command State)
Table Note 77: The Cancel key is active when the ‘Insert Bag’
screen is being displayed. Pressing the Cancel key causes an
‘undetected deposit’ status to be sent to Central.
Table Note 78: Timer 08 (page 7‐26) is started when the night safe
door is unlocked to accept a night safe deposit.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-73
Central to Terminal Messages
Transaction Reply Command
Table 10-23
Card Before Cash (Function ID ‘A’)
State Screen Operation
Transaction Request Transaction Request Screen Eject card. Count and
See Table Note 79. (PLEASE WAIT) See Table Note 80. stack cash
Transaction Reply Screen 1 Wait for card to be taken.
(TAKE CARD) (Capture card if timer 09 expires)
Transaction Reply Screen 2 Dispense the requested cash and coins.
(PLEASE WAIT FOR CASH See Table Note 80 and Table Note 82.
AND RECEIPT) Print on receipt and journal to defined level.
Send status.
Cut and deliver receipt if necessary.
Close Close screen Table Entry 2 TTimer 02
(TAKE RECEIPT AND (Determines the length of time that
CASH) the Close screen is displayed).
or
Table Entry 4
(TAKE CASH)
Table Note 79: In normal usage the next state is always Close.
Table Note 80: Track 3 update can take place before card eject if
new Track 3 data is contained in the transaction reply message.
Table Note 81: A dispense can consist of notes only, coins only, or a
combination of notes and coins. If the dispense includes a
combination of notes and coins, the notes must be successfully
dispensed before the coins are dispensed.
Table Note 82: For a terminal configured for note retraction, timer
05 (page 7‐25) is started after the cash has been dispensed. Timer 05
is also used for beeping in Card Before Cash transactions where the
SST is configured not to retract notes. For details of configuration
options, see the APTRA Advance NDC, Supervisor’s Guide.
On SSTs with cash retract enabled, if the notes have not been taken
when this timer expires, retraction is attempted. If some notes are
retracted, the ‘Presenter Error’ message is logged to the journal and
an unsolicited error is reported to Central. For details, see “Cash
Handler (Solicited/Unsolicited)” on page 9‐99. If the notes are taken
before the timer expires, the timer is cancelled. In both cases, timer
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-74 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
07 is started, and the next state is entered on expiry. For details of
timers, See “Timers” on page 7‐24..
If local configuration option digit 2B is set at the SST, the beeper is
sounded during the time that timer 05 is operative. For details, see
the APTRA Advance NDC, Supervisor’s Guide.
Table Note 83: When the no retract option is set in a Card Before
Cash transaction, the recommended minimum value of timer 07 is 5
seconds.
Table 10-24
Parallel Eject/Dispense and Print -
Fast Cash (Function ID ‘B’ or ‘C’)
State Screen Operation
Transaction Request Transaction Request Screen Parallel Eject/Dispense and Print.
See Table Note 84 (PLEASE WAIT) See Table Note 86, Table Note 87 and Table Note 89
Transaction Screen Print receipt and journal to defined level.
(TAKE CARD AND CASH) Send status.
See Table Note 88.
Cut and deliver receipt if necessary.
Close Close Screen Table Entry 2 Wait for card to be taken or captured, Timer 02
(AND RECEIPT) if not already taken. See Table
or Note 90.
Table Entry 4
(NULL)
See Table Note 85
Table Note 84: In normal usage the next state is Close.
Table Note 85: NCR recommends that the Close screens add text to
the Transaction Reply screen rather than clear the screen.
Table Note 86: Following the parallel eject/dispense and print,
timers 05 and 07 are started. For details of timers, see
“Configuration Parameters Load” on page 10‐15. If the total timeout
period expires before the cash is taken a retract is attempted. If some
notes are retracted the ‘Presenter Error’ message is logged to the
journal, and an unsolicited error is reported to Central. For details,
See “Cash Handler (Solicited/Unsolicited)” on page 9‐99.. If the
notes are taken before the timer expires, it is cancelled and the next
state is entered. If the local configuration option is selected, the
beeper is sounded whilst timer 07 is in use. For details of
configuration option, 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, Reference Manual 10-75
Central to Terminal Messages
Transaction Reply Command
Table Note 87: A transaction that uses the Parallel Eject/Dispense
and Print reply is commonly referred to as a Fast Cash transaction.
To achieve optimum performance with a Fast Cash transaction, this
reply should be used together with the “T ‐ Card Read ‐ PIN Entry
Initiation State” described in Chapter 2.
Table Note 88: Printer and card reader errors are reported as
unsolicited status messages. A dispense error is reported by a
solicited status message to give the host the option of printing an
error report or displaying an error screen.
Table Note 89: A dispense can consist of notes only, coins only, or a
combination of notes and coins. If the dispense includes a
combination of notes and coins, the notes must be successfully
dispensed before the coins are dispensed.
Table Note 90: Timer 02 is used to determine the length of time that
the Close screen is displayed.
Table 10-25
Card Before Parallel Dispense and Print
(Function ID ‘F’)
State Screen Operation
Transaction Request Transaction Request Screen Wait for transaction reply
See Table Note 91 (PLEASE WAIT)
Transaction Reply Screen 1 Eject card.
(TAKE CARD) Wait for card to be taken.
(Capture card if timer 09 expires)
Send status if failure and abort (see Table Note 94).
Otherwise continue.
See Table Note 92 Transaction Reply Screen 2 Stack and dispense cash, and print full receipt data,
(PLEASE WAIT FOR CASH but only cut the receipt if a form feed is sent or a
AND RECEIPT) complete page (24 or 49 lines) has been printed.
Send status if failure and abort.
Send status.
See Table Note 95.
Close Close Screen Cut and deliver receipt if necessary.
See Table Note 93
Table Note 91: In normal usage, the next state is a Close state.
Table Note 92: A dispense can consist of notes only, coins only, or a
combination of notes and coins. If the dispense includes a
combination of notes and coins, the notes must be successfully
dispensed before the coins are dispensed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-76 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table Note 93: NCR recommends that the Close screens do not
clear the screen but simply add text to the Transaction Reply screen.
Table Note 94: Printer and card reader errors are reported as
solicited status messages. A dispense error is reported by a solicited
status message to give Central the option of printing an error report
or displaying an error screen.
Table Note 95: Following the card eject, dispense and print, timers
05 and 07 are started. If the total timeout period expires before the
cash is taken, a retract is attempted, the ‘Presenter Error’ message is
logged to the journal and an unsolicited error will be reported to
Central if the local configuration option to delay status reporting is
not set.
If the notes are taken before the timers expire, they are cancelled
and the next state entered. For details, See “Timers” on page 7‐24..
If the local configuration option to sound the beeper is set and the
no‐retract option is not set, the beeper will be sounded during the
time that timers 05 plus 07 are operative.
For details of local configuration options, refer to the APTRA
Advance NDC, Supervisor’s Guide.
Table 10-26
Print Statement and Wait
(Function ID ‘P’)
State Screen Operation
Transaction Request Transaction Request Screen
(PLEASE WAIT)
Transaction Reply Screen Print on statement or print sideways on receipt
(STATEMENT BEING printer and journal to defined level.
PRINTED) Send status (statement printer or receipt printer if
printing sideways on the receipt).
Wait for another Transaction Reply command.
Note: A local configuration option (Option Digit 3C) can be set to
enable the Cancel key on the cardholder keyboard. For details, 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, Reference Manual 10-77
Central to Terminal Messages
Transaction Reply Command
Table 10-27
Print Statement and Set Next State
(Function ID ‘Q’)
State Screen Operation
Transaction Request Transaction Request Screen Print on Statement or print sideways on receipt
(PLEASE WAIT) printer.
Transaction Reply Screen Print on receipt and journal to Timer 96
(TAKE STATEMENT) defined level.
Send status (statement printer or
receipt printer if printing sideways on
the receipt)
Next State in Next State Screen
Transaction Reply
Command
Table Note 96: Timer 96 is used only in the print statement and
continue function and is started whether or not a statement is being
delivered. When the timer expires, the next state specified by the
Transaction Reply command is entered.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-78 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table 10-28
Refund Notes and Set Next State
(Function ID ‘*’)
State Screen Operation
Transaction Request Transaction Request Screen Attempt to move notes from the
(PLEASE WAIT) escrow to the refund slot.
See Table Note 97
Transaction Reply Screen Wait for notes to be removed from Timer 78
(PLEASE REMOVE NOTES the refund slot.
FROM REFUND SLOT) If specified, print on receipt and
See Table Note 98 and Table journal to defined level.
Note 99 Send status as follows:
If an error occurs before the notes are
presented, send a solicited message.
If an error occurs or Timer 78 expires
after the notes are presented and
before the notes are removed, either
retract the notes if the retract option is
set and send an unsolicited message,
or just send an unsolicited error
message to Central.
Send a Ready message when the
notes are successfully presented.
Next State in Next State Screen
Transaction Reply
Command
Table Note 97: If inserted cash is deposited directly to the cassettes,
the notes cannot be refunded. In this situation, a solicited status
message (‘w5’) reports that the escrow is empty.
Table Note 98: If the screen referenced in the Transaction Reply
only contains nested screens, the first nested screen is displayed
when the notes are presented; and the second nested screen is
displayed when the notes are being retracted (if the customer has
not taken the notes and Advance NDC has been configured to
retract the notes). If the screen referenced in the Transaction Reply
contains more than nested screens, it is fully displayed when the
notes are presented.
Table Note 99: If the consumer takes the refunded notes late as the
retract operation starts, no unsolicited message (‘w7’) is sent but if a
‘retract notes’ screen is configured, it is displayed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-79
Central to Terminal Messages
Transaction Reply Command
Table 10-29
Deposit Notes and Print
(Function ID ‘-’)
State Screen Operation
Transaction Transaction Request Screen
Request (PLEASE WAIT)
Transaction Reply Screen Attempt to encash the notes. If cash has been deposited
(YOUR CASH IS BEING directly to the cassettes, this is a logical operation only: no
DEPOSITED) See Table physical movement of notes takes place as the operation
Note 100 and Table Note is already complete.
111 If specified, print on receipt and journal to defined level.
This is normally done after the encash operation.
Print on statement or print sideways on receipt printer.
Send status as follows:
If an error occurs, send a solicited error message.
If notes are successfully deposited, set the next state and
send a Ready message to Central.
Unsolicited messages can accompany the Ready message
when a threshold or cassette error occurs during the
successful encash
Next State in Next State Screen
Transaction Reply
Command
Table Note 100 Enhanced Configuration Parameter option 44 can
be used to journal the encash counts in the usual status message
format whenever the Ready message is sent.
Table Note 101 If configured in the registry, the transaction reply
print data will be printed while notes are being moved to the
cassettes, otherwise it will be printed after the Deposit operation is
completed. For details of the registry setting,
DoParallelEncashPrint, refer to the APTRA Advance NDC
Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-80 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table 10-30
Deposit Notes and Wait
(Function ID ‘’’)
State Screen Operation
Transaction Transaction Request Screen
Request (PLEASE WAIT)
Transaction Reply Screen Attempt to move the notes from the escrow to the cash
(YOUR CASH IS BEING deposit bin (encash). If cash has been deposited directly
DEPOSITED) See Table to the cassettes, this is a logical operation only: no
Note 100 and Table Note physical movement of notes takes place as the operation
111 is already complete.
If specified, print on receipt and journal to defined level.
This is normally done after the encash operation.
Send status as follows:
If an error occurs send a solicited message.
If the notes are successfully deposited Send a Ready
message. Unsolicited messages can accompany the Ready
message when a threshold or cassette error occurs during
the successful encash
Wait for another Transaction Reply command.
Table 10-31
Process Cheque (Function ID ‘:’)
State Screen Operation
Transaction Request Transaction Request Screen
(PLEASE WAIT)
Transaction Reply Screen Endorse cheque, and attempt to move
(YOUR CHEQUE IS BEING cheque to bin 1, 2 or 3.
PROCESSED) See Table Note 102
Cheque stamping is not supported by
Advance NDC.
Send status:
‐ If the cheque is successfully Timer 94
processed, send a Ready 9 message to
Central.
‐ If cheque is ejected, but not taken,
retain in bin 2 and send an unsolicited
error message to Central.
Next State in Next State Screen
Transaction Reply
Command
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-81
Central to Terminal Messages
Transaction Reply Command
Table Note 102: On a single cheque processor, cheques are
endorsed when pocketed, retracted or returned by the host. If the
single cheque processor fails to endorse a returned cheque, this is
reported in an unsolicited status message for the cheque processor.
Table 10-32
Dispense Cash First During Valuable
Media Exchange (Function ID ‘b’)
State Screen Operation
Transaction Request Transaction Request Screen Wait for transaction reply See Table
(PLEASE WAIT) Note 103
and Table
Note 104
Transaction Reply Screen Return card (if specified) See Table
(TAKE CARD) If card return during transaction Note 105
processing is specified then the card
is returned and must be taken.
(TAKE CASH) Dispense notes See Table
Wait for the consumer to take the Note 106
notes (when retract is enabled and and Table
option 4a set to 1) Note 107
Dispense the coins See Table
Note 108
Deposit the notes, print the receipt See Table
and journal data in parallel. Note 109
and Table
Note 110
Send status
Next State in Next State Screen
Transaction Reply (for example SELECT
Command TRANSACTION)
Table Note 103 This function must only be used when notes are to
be deposited and cash is to be dispensed in a single transaction
reply If only a note deposit is to be processed, the Deposit Notes and
Print (function ID ʹ_ʹ) must be used. If this function is used and no
notes or coins are specified, the request will be rejected with a
Specific Command Reject of B11).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-82 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table Note 104 This function can also be used for the following:
When the extended cash dispenser interface is used (Enhanced
Configuration option 76 is set to 001) to support more than 4
cassette types
When a dual dispenser is present.
Table Note 105 If card return during transaction processing is
specified, the card is returned to the consumer and must be taken
before any notes are dispensed. If there is an error while processing
the card or the consumer does not take the card and it is captured, a
solicited card reader device status message is sent. No notes and
coins are dispensed and media will not be deposited. If the card is
not to be returned during the transaction processing, notes are
dispensed as the first step in the process.
Table Note 106 The notes specified in the Transaction Reply are
dispensed to the cardholder. If the notes are successfully dispensed,
any coins specified are dispensed at the point where a Ready 9 or
Ready B status message would normally be generated for the cash
dispense operation; then the notes are deposited.
In a cash dispense operation, Supervisor Message Mode options 2
and 4 control when solicited messages for the cash dispenser are
sent (error messages and Ready 9). Advance NDC can be configured
(Message Mode option 4a is set to 0) to send a solicited message
after notes have been successfully presented, or an error has
occurred, up to and including the present operation, (without
waiting for a cash retract operation or an auto‐purge cycle).
Alternatively, Advance NDC can also be configured (Message
Mode option 4a is set to 1) to send a solicited message after an error
occurs up to and including the present operation or after the notes
have been retracted/taken.
For details of how the flow of operations is affected by the settings
for Message Mode options 2 and 4, see Table 10‐33, “Dispense Cash
First During Valuable Media Exchange: Operational Flow” on
page 10‐85.
Table Note 107 If the note dispense fails, a cash dispenser solicited
status message is sent to the host, no coins are dispensed and the
inserted notes are not deposited. Advance NDC waits for further
instruction from the host, for example, the host uses the Refund
Notes and Print function (Function ID ʹ*ʹ) to return the notes to the
cardholder, or Deposit Notes and Print (function ID ʹ‐ʹ) to deposit
the notes.
Table Note 108 If there is a failure during the coin dispense, a
solicited status message for the coin dispenser is sent; the inserted
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-83
Central to Terminal Messages
Transaction Reply Command
notes are not deposited and Advance NDC waits for further
instruction from the host.
Table Note 109 During deposit, notes are moved to the cash
deposit bins defined by the device configuration.
Table Note 110 If the note deposit operation fails, a solicited
message for the cash acceptor is sent to the host and Advance NDC
waits for further instructions from the host.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-84 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table 10-33
Dispense Cash First During Valuable
Media Exchange: Operational Flow
Notes Notes Notes Cash Print
Option 2A Option 4A Coins Dispensed Message Sent
Presented Taken Retracted Deposited Operations
0 0 Ready 9
(retract (coin
enabled) dispense
starts after
notes
presented)
0 0 Unsolicited
(coin Notes Retract;
dispense Ready 9
starts after
notes
presented)
0 1 Ready 9
(coin
dispense
starts after
notes taken)
0 1 Solicited
(no coins Notes Retract
dispensed as
notes not
taken)
1 — Ready 9
(Ignored) (coin
dispense
starts after
notes
presented)
1 — Ready 9
(Ignored) (coin
dispense
starts after
notes
presented)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-85
Central to Terminal Messages
Transaction Reply Command
Table 10-34
Process Multiple Cheques (Function ID ‘c’)
State Screen Operation
Transaction Request Transaction Request Screen
(PLEASE WAIT)
Transaction Reply Screen Cheque handling is specified by the Timer 94
See Table Note 111 content of buffer ‘b’ in the
Transaction Reply message, as
follows:
Return all cheques to the
cardholder without endorsing or
stamping any cheque
Deposit all cheques, stamped and
endorsed
Return all cheques to the
cardholder, stamped and
endorsed
Selectively return or deposit
cheques, control stamping and
endorsement individually for
each cheque. A default action can
be defined for all cheques where
a specific action is not defined.
If cheques are ejected, but not taken,
retract and retain them and send
message to Central as follows:
If multiple bunches must be used
to return all cheques and cheques
are retracted before all have been
presented, send a solicited error
message
If cheques are retracted after all
cheques have been presented and
the status message has already
been sent, send an unsolicited
message to indicate that the
cheques have been retracted
If the retracted cheques jam
before reaching the reject bin,
send an unsolicited error
message to report a jam
Next State in Next State Screen
Transaction Reply
Command
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-86 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table Note 111: Screens referenced by the Transaction Reply must
contain only nested screens. The screens are displayed as follows:
Nested screen 1 (TRANSACTION RESULT and PLEASE WAIT)
Nested screen 2 (PLEASE REMOVE CHEQUES)
Nested screen 3 (PLEASE WAIT FOR MORE CHEQUES)
Nested screen 4 (CHEQUES BEING RETRACTED).
Table 10-35
Deposit Media First During Valuable Media
Exchange (Function ID ‘f’)
State Screen Operation
Transaction Request Transaction Request Screen Wait for transaction reply See Table Note 112
(PLEASE WAIT) and Table Note
113
Transaction Reply Screen Deposit notes See Table Note 114
(PLEASE WAIT) and Table Note
115
Return card (if specified) See Table Note 116
(TAKE CASH) Dispense notes See Table Note 117
Wait for the consumer to take the and Table Note
notes (when retract is enabled and 118
option 4a set to 1)
Dispense the coins, print the See Table Note
receipt and journal data in parallel 118, Table Note
119, and Table
Note 120
Send status
Next State in Next State Screen
Transaction Reply (for example SELECT
Command TRANSACTION)
Table Note 112 This function must only be used when notes are
deposited and cash is to be dispensed within a single transaction
reply. If only a note deposit is to be processed, the Deposit Notes
and Print (function ID ʹ_ʹ) must be used. If this function is used and
no notes or coins are specified, the request will be rejected with a
Specific Command Reject of B11).
Table Note 113 This function can also be used for the following:
When the extended cash dispenser interface (option 76 set to
001) is used to support more than 4 cassette types.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-87
Central to Terminal Messages
Transaction Reply Command
When a dual dispenser is present.
Table Note 114 The inserted notes are deposited as the first step in
the process and moved to the cash deposit bins as defined by the
device configuration.
Table Note 115 If a solicited note deposit message is sent to the
host, no cash (notes and/or coins) has been dispensed. Advance
NDC waits for further instruction from the host, for example, to
display an error message and print a receipt indicating that all the
consumer’s inserted notes have been captured by the SST and no
cash has been dispensed.
Table Note 116 If card return during transaction processing is
specified, the card is returned to the consumer and must be taken. If
there is an error while processing the card, or the consumer does not
take the card and it is captured, a solicited device status message for
the card reader is sent and cash will not be dispensed. If the card is
not to be returned during the transaction processing, cash will be
dispensed after the inserted notes are deposited.
If the dispense fails then a solicited status message for the cash
handler is sent. If the device is a combined cash handler and note
deposit device, an unsolicited status message for the note acceptor
will also be sent if its status is affected by the failure.
Table Note 117 When the notes specified in the Transaction Reply
have been dispensed, any coins specified are dispensed at the point
where a Ready 9 or Ready B status message would normally be sent
for the cash dispense operation. Advance NDC Message Mode
options 2 and 4 control when cash dispenser solicited messages are
sent (both Ready 9 and error messages).
Advance NDC can be configured (Message Mode option 4a is set to
0) to send a solicited message, after the notes have been successfully
presented or an error has occurred, up to and including the current
operation, that is, without waiting for a cash retract operation or an
auto‐purge cycle.
Alternatively, Advance NDC can be configured (Message Mode
option 4a is set to 1) to send a solicited message after an error occurs
up to and including the current operation or after the notes have
been retracted or taken. Within this function, any coins specified are
dispensed at the point where a Ready 9 or Ready B status message
would normally be sent for the cash dispense operation.
For details of how the flow of operations is affected by the settings
for Message Mode options 2 and 4, see Table 10‐36, “Deposit Media
First During Valuable Media Exchange: Operational Flow” on
page 10‐89.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-88 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Transaction Reply Command
Table Note 118 If a cash dispenser solicited status message is sent
to the host, no coins have been dispensed.
Table Note 119 If there is a failure during the coin dispense, a
solicited status message for the coin dispenser is sent. Printing will
continue as the print and coin dispense operations are performed in
parallel.
Table Note 120 The receipt data specified by the host will be
printed even if there is a problem dispensing coins. The host can
send additional receipt data in the Transaction Reply sent in
response to a solicited coin dispenser message.
Table 10-36
Deposit Media First During Valuable Media
Exchange: Operational Flow
Cash Notes Notes Notes Print
Option 2A Option 4A Coins Dispensed Message Sent
Deposited Presented Taken Retracted Operations
0 0 Ready 9
(retract (coin
enabled) dispense
starts after
notes
presented)
0 0 Unsolicited
(coin Notes Retract;
dispense Ready 9
starts after
notes
presented)
0 1 Ready 9
(coin
dispense
starts after
notes taken)
0 1 Solicited
(no coins Notes Retract
dispensed as
notes not
taken)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-89
Central to Terminal Messages
Transaction Reply Command
Cash Notes Notes Notes Print
Option 2A Option 4A Coins Dispensed Message Sent
Deposited Presented Taken Retracted Operations
1 — Ready 9
(Ignore (coin
d) dispense
starts after
notes
presented)
1 — Ready 9
(Ignore (coin
d) dispense
starts after
notes
presented)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-90 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Interactive Transaction Response
Interactive Transaction Response 10
The Interactive Transaction Response (ITR) message may be sent in
response to a Transaction Request in order to obtain more
information from the cardholder. This facility allows Central to
communicate directly with the keyboard and display in those
situations where state table sequencing is inappropriate. For
example, a cardholder account selection can be handled in this way.
Central can establish which accounts are available to the cardholder
and build the screen accordingly. The message defines screen data
and active keys.
Keyboard data is returned in a Transaction Request message. For
details, see “Transaction Request Messages” on page 9‐2.
The SST may support touch‐screen FDK emulation instead of
Support for Touch‐Screen physical FDKs. In this case, eight, fixed, touch areas are defined on
Emulation 10
screen, which the consumer touches instead of pressing the
corresponding FDK. The touch areas are enabled and disabled in
exactly the same way as the FDKs. For details, see “FDK Emulation”
on page 4‐2.
Alternatively, the terminal may support full touch‐screen
keyboards. In this case, touch areas are defined on the screen for all
the required keys. The cardholder touches these instead of pressing
a key on the keypad or an FDK. For details, see Chapter 4,
“Keyboard Data and Layouts”.
In a voice‐guided session, the host can send a message with one of
Support for Voice‐Guided two formats used in field ‘j’, as follows:
Sessions 10
Direct Audio Text format.
The text to be spoken is included in the field. The text must not
contain special characters, such as screen control characters. The
specified text is not repeated. To repeat the text, it must be
repeated in this field. Field ‘i’ is not adjusted for a voice‐guided
session.
Indirect Audio Text format.
The text to be spoken is contained in the voice guidance XML
configuration file and referenced from this field. The text
specified in the XML file is not repeated. To repeat the text,
multiple Text elements must be used or the recorded voice file
must contain repeated audio messages. Field ‘i’ is adjusted as
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-91
Central to Terminal Messages
Interactive Transaction Response
specified in the XML configuration file. For details of the XML
configuration file, refer to the APTRA Advance NDC, Developer’s
Guide.
If the MCN (field ‘e2’ in Table 10‐37, “Interactive Transaction
Message Coordination Response” below) is present, the Message Sequence Number (field
Number (MCN) 10
‘e1’) must also be present. If Message Sequence Numbers are not
normally populated, field ‘e1’ must be set to 000.
If field ‘e2’ is present, its content will be compared with the MCN in
the current Transaction Request. If the MCNs do not match, the
Interactive Transaction Response will be rejected by default. This
can be changed through Enhanced Configuration Parameter option
34.
The host can override validation of the MCN by either omitting field
‘e2’ or setting it to 0.
For details of the MCN in Transaction Requests and host responses,
see field ‘g’ of the Transaction Request message on page 9‐3.
For details of Enhanced Configuration Parameter option 34, see
“Option 34 – MCN Range” on page 7‐11.
Table 10-37
Interactive Transaction Response
Number of
Field Mandatory/Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘3’ ‐ Data Command
c 1 O Response Flag. This field is included for future use and is ignored by
the SST.
FS 1 M Field Separator.
d 3 O Logical Unit Number (LUNO). This field is included for future use and
is ignored by the SST.
FS 1 M Field Separator.
e1 3 O Message Sequence Number. This field is included for future use and is
ignored by the SST
e2 1 O Message Coordination Number. See “Message Coordination Number
(MCN)” above.
FS 1 M Field Separator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-92 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Interactive Transaction Response
Number of
Field Mandatory/Optional Description
Characters
f 1 M Message Sub‐Class. The message sub‐class is:
‘2’ ‐ Interactive Transaction Response
g 1 M Display Flag. This one character field instructs the terminal display as
follows:
‘0’ ‐ do not display cardholder keyboard entry
‘1’ ‐ display cardholder keyboard entry
‘2’ ‐ display ‘*’ for cardholder keyboard entry
The keyed response is stored in General Purpose Buffer ‘B’ (minimum
data length 1 character), which is the only buffer included in a
Transaction Request message following the Interactive Transaction
Response.
For more information on general purpose buffers refer to the APTRA
Advance NDC, Developer’s Guide.
h Var (10) M Active Keys/Touch Areas. This is a variable length field which
activates the required keys or touch areas for cardholder responses as
follows:
‘0’ ‐ de‐activate keys/touch areas
‘1’ ‐ activate keys/touch areas
The first character of this field either activates or de‐activates all
numeric keys.
Char All Numeric Keys
1 Numeric keys activator (0‐9)
The next nine characters either activate or de‐activate the function
keys or touch areas as follows:
Char Function Keys or Touch Areas
2 FDK A/FDK A touch area and Enter Key
3 FDK B/FDK B touch area
4 FDK C/FDK C touch area
5 FDK D/FDK D touch area
6 Cancel Key E
7 FDK F/FDK F touch area
8 FDK G/FDK G touch area
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-93
Central to Terminal Messages
Interactive Transaction Response
Number of
Field Mandatory/Optional Description
Characters
9 FDK H/FDK H touch area
10 FDK I/FDK I touch area
Trailing ‘0’ characters may be omitted from this field.
Note: If numeric keys are active and FDK A is also active (or FDK I if
the option enabling the keys to the left of the cardholder screen is set),
the Enter key will be active and equivalent to FDK A or FDK I.
During a voice‐guided session, the FDK, numeric, Clear, Cancel and
Enter keys can be used. If this message indicates that one or more
FDKs are active, the active FDKs are mapped to the numeric keyboard
as follows:
FDK Numeric Key
A 1
B 2
C 3
D 4
F 8
G 7
H 6
I 5
If this message defines both FDKs and numeric keys as active, this
mapping is not done and the FDKs must be used during the
voice‐guided session.
FS 1 M Field Separator.
i 3 M Screen Timer Field. This three character field contains the time‐out
intervals from the cardholder screen display. The valid range is
001‐255 ticks, to give a time‐out from 0.8 to 204 seconds. Entering 000
gives indefinite display. If the timer expires, a code of ‘T’ is stored in
the buffer and a Transaction Request message is sent.
FS 1 M Field Separator.
j1 Var M Screen Data Field. This is a variable‐length field that represents data to
be displayed on the screen.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-94 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Interactive Transaction Response
Number of
Field Mandatory/Optional Description
Characters
During a voice‐guided session, the content of this field depends on the
format used, as follows:
Direct Audio Text format ‐ this field contains audio data to use in
place of the screen display data. The data is treated as a string to
be spoken, nothing is displayed on the SST screen. This field must
contain the text to be spoken, and not reference any audioID
sub‐elements in the voice guidance XML configuration file. No
special characters can be used in the text.
Indirect Audio Text format ‐ this field contains dynamic audio
data with screen number and any other optional screen data. The
Screen Data Field must contain a reference to a base screen with
any other optional screen data and dynamic voice data. The base
screen being updated must include placeholder tags to
accommodate the dynamic audio placeholder data. There must be
a corresponding audioID sub‐element defined in the voice
guidance XML configuration file.
For details of the XML configuration file for voice guidance, refer to
the APTRA Advance NDC, Developer’s Guide.
GS 1 O Group Separator.
j2 Var O Screen Update Data Field. This must be present if the preceding group
separator is present. This field represents data which is displayed on
the SST screen when the Direct Audio Text format is used.
k Var M Trailer. Protocol‐dependent.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-95
Central to Terminal Messages
EJ Commands
EJ Commands 10
This section contains details of the following EJ commands:
EJ Options and Timers
Acknowledge EJ Upload Block
Acknowledge and Stop EJ
The format and content of each command is described in the
following sections, along with an explanation of continuous and
batch upload methods.
Note: If the EJ is not configured, any EJ commands sent will be
rejected with a command reject.
For details of the SST to host upload message, see “Upload EJ Data
Message” on page 9‐90.
This command may be sent by Central at any time to enable
EJ Options and Timers 10
electronic journal upload, and to specify the options and timer
values to be used. It may also be sent after receiving a power fail
message from the SST to re‐instate the EJ upload feature.
Table 10-38
EJ Options and Timers
Number of
Field Mandatory/ Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘6’ ‐ Electronic Journal
FS 1 M Field Separator
FS 1 M Field Separator
FS 1 M Field Separator
c 1 M Command Type. The command type is:
‘3’ ‐ Options and Timers
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-96 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
EJ Commands
Number of
Field Mandatory/ Optional Description
Characters
d 2 O Option Number. Possible values are:
Option 60 ‐ EJ Upload Block Size. Maximum size of the data portion of
the EJ Upload block. For details, see “Upload EJ Data Message” on
page 9‐90.
Option 61 ‐ Retry Threshold. The number of attempts to successfully
send an EJ Upload block before the EJ is automatically disabled.
See Table Note 121.
e 3 O Option Value.
For Option 60, the value range is 001‐350. Default is 200.
For Option 61, the value range is 000‐999. Default is 000 (infinite
retries).
Fields ‘d’ and ‘e’ are repeated if both options are being sent in the same message. No field separator is required
between options, but a field separator is mandatory before field ‘f’, Timer Number.
FS 1 M Field Separator.
f 2 O Timer Number. Possible value is:
Timer 60 ‐ EJ Acknowledgement Timer. Maximum time in seconds to
wait for an acknowledgement message from Central before resending
the block.
g 3 O Timer Value.
Range 000‐255. Default is 255, 000 is infinite.
Table Note 121: If the value sent for Option 60 is out of the possible
range, the safety value of 350 is substituted. The safety values for
Option 61 and Timer 60 are the same as the default values.
This command should be sent by Central each time a block of
Acknowledge EJ Upload electronic journal data is received from the SST. It can also be sent
Block 10
unsolicited at any time to enable the EJ upload function. If this
command is used to enable EJ upload instead of the EJ Options and
Timers command, then the default option and timer values will be
used.
If after sending an EJ block to Central, the SST does not receive an
acknowledgement within the specified time, the SST will send the
block again. On receipt of the acknowledgement message for the
final EJ data block to be sent, the SST will erase the acknowledged
data from its ejdata.log file.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-97
Central to Terminal Messages
EJ Commands
Table 10-39
Acknowledge EJ Upload Block
Number of
Field Mandatory/ Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘6’ ‐ Electronic Journal
FS 1 M Field Separator
FS 1 M Field Separator
FS 1 M Field Separator
c 1 M Command Type. The command type is:
‘1’ ‐ Acknowledge Upload Block
See Table Note 123
d 6 M Last Character Received. Range 000000‐999999.
See Table Note 122.
The value in this field should be the same as the value in the Last
Character This Block field in the last Upload EJ Data message sent by
the SST (see page 9‐90).
If the Last Character Received is not equal to the value of the Last
Character This Block in the last upload block sent by the SST, and if EJ
upload is in progress, the SST will not count this as an
acknowledgment, and will continue to wait for an acknowledgment
without resetting its timer. If the Last Character Received field
contains ‘000000’ then Advance NDC will resend the last block again.
Table Note 122: The Last Char Previous Block and Last Char This
Block values are based on a modulus 1,000,000 character count
which starts at zero following a cold start of the SST. The count is
incremented for each character written to the electronic journal. The
count is not re‐set for a warm start, that is, a power fail or reset
during which the persistent memory is preserved.
Table Note 123: If the Acknowledge EJ Block command is being
sent to enable the EJ upload function after a power fail or a
communications loss then the Last Character Received field can be
any value, but the recommended value is ‘000000’. This will cause
the SST to enable the EJ upload function, then transmit its current EJ
data, starting from the last unacknowledged block.
This command acknowledges the last EJ upload block received by
Acknowledge and Stop EJ 10
Central, and in addition indicates that EJ upload is to cease. This
will disable the EJ upload function until Central sends a new
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-98 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
EJ Commands
Acknowledge EJ Upload Block command or EJ Options and Timers
command.
The Acknowledge and Stop EJ command may also be sent to disable
EJ upload at any time (that is, not in response to an upload
message).
If Central disables EJ upload, EJ data will accumulate at the SST
until Central re‐enables the upload function. This procedure can be
used to control the upload of EJ data at peak line load times, as can
lengthening the time period before sending an acknowledgement
message. This time delay is configured in the EJ Options and Timers
command.
Table 10-40
Acknowledge and Stop EJ
Number of
Field Mandatory/ Optional Description
Characters
a Var M Header. Protocol‐dependent.
b 1 M Message Class. The message class is:
‘6’ ‐ Electronic Journal
FS 1 M Field Separator.
FS 1 M Field Separator.
FS 1 M Field Separator.
c 1 M Command Type. The command type is:
‘2’ ‐ Acknowledge and Stop EJ
d 1 M Last Character Received. Range 000000‐999999. See Table Note 124.
The value in this field should be the same as the value in the Last
Character This Block field in the last Upload EJ Data message sent by
the SST. If it is not, EJ upload will be disabled and when it is
re‐enabled the SST will send the last upload block again.
Table Note 124: The Last Char Previous Block and Last Char This
Block values are based on a modulus 1,000,000 character count
which starts at zero following a cold start of the SST. The count is
incremented for each character written to the electronic journal. The
count is not re‐set for a warm start, that is, a power fail or reset
during which the persistent memory is preserved.
Continuous upload is the normal method of operation when the EJ
Continuous Upload 10
upload function has been enabled. Central should acknowledge
each uploaded block as soon as it is known to be properly stored,
and the SST should mark EJ data in the ejdata.log file as being sent as
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-99
Central to Terminal Messages
EJ Commands
soon as it has been properly acknowledged. Then the next block of
EJ data will be sent as soon as the SST is able to send it.
In normal circumstances, the only occasion for Central to be
involved in a recovery situation is if the SST Retry Count (option 61
in the EJ Options and Timers command) is other than ‘000’ ‐ infinite.
In this situation, the SST may automatically disable the EJ upload
after the specified number of failed attempts to transmit a data
block. Central must be able to recognise this event and re‐enable the
EJ upload. An automatic disablement may be identified by the fact
that transactions are received but no accompanying upload data is
seen.
Batch upload can be used to restrict EJ uploads to certain times of
Batch Upload 10
the day, outside of which the EJ upload is disabled. The
recommended approach to using batch upload is as follows:
1 Central puts the SST out of service, to ensure that no more
transaction data can be added to the electronic journal log file
while the upload is in progress.
2 Central then enables the EJ upload.
3 The EJ upload proceeds, controlled by acknowledgement
messages from Central, until all the EJ data has been sent to
Central.
4 When the last message has been received, Central acknowledges
the message and then disables EJ upload.
The last message can usually be recognised by the fact that it is
the only message with a block length less than the maximum
block length set in the EJ Options and Timers message. It is
possible for the last message to be exactly the same length as the
maximum block length set; in this case the EJ upload will be
terminated due to a time‐out, as described in the next section.
5 Once the EJ upload is disabled, Central returns the SST to
In‐service mode.
Batch Upload Failure 10
If during the batch upload, the SST fails to send a new upload block
within a reasonable time, this may be evidence of either of the
following:
A communications failure
The final data block being exactly equal to the maximum block
length, and therefore not recognised as being the final block.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-100 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
EJ Commands
In either case, Central should send a Print Immediate command to
the SST with a short message, such as ‘END OF DAY’, to be printed on
the journal.
Central should then wait for this data to be sent back in an Upload
EJ Data message with a short block size. If the message is received,
EJ upload can terminate normally as described above. If nothing is
received, it is evidence of a communications problem. In this case
either the upload can be terminated or another Print Immediate
attempted.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-101
Central to Terminal Messages
Message Validation
Message Validation 10
Validation checks are performed on all messages received from
Central.
The following are the valid message classes that come from the SST
Valid Message Classes 10
to Central and from Central to the SST.
SST to Central 10
The valid message classes that are sent from the SST to Central are 1,
2, 5 and 8.
Central to SST 10
The valid message classes that are sent from Central to the SST are 1.
3, 4, 6, 7 and 8.
Note: Message class 8 enables EMV smart card configuration. For
details, refer to the EMV Integrated Circuit Card (ICC) Reference
Manual.
The situations which cause a command reject are as follows:
Command Reject Causes 10
Illegal message sub‐class
Illegal message identifier
Illegal terminal command code
Illegal terminal command modifier
Field separator in the wrong position
Insufficient fields in the message, for example, an incomplete
Interactive Transaction Reply message
Insufficient memory to hold the FIT entry (FIT number too
large)
The dispense amount requested is larger than the number of
notes and/or coins reported in the Hardware Configuration
message
The Message Coordination Number in a Transaction Reply or an
Interactive Transaction Response (ITR) does not match the
number in the Transaction Request and is not ‘0’
Invalid function ID in Transaction Reply command. An invalid
function ID is one not supported by the APTRA Advance NDC
software or one requiring the use of a device that is not part of
the hardware configuration.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-102 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Message Validation
Note: Commands requesting a receipt or journal print will not
be rejected because of an unconfigured printer.
An encryption key change message is received before the
original key has been entered at the terminal
More than 13 print fields in a Transaction Reply command
Date/Time data invalid in date and time load command.
When the specific command reject option is set, these errors will
generate an equivalent specific command reject.
Default operations include the following:
Entry to the default Close state. For example, non‐existent state
number
Conversion of illegal parameters to default legal values. For
example, non‐numeric ASCII characters changed to numeric
values by converting the top four bits to 3 hex. ‘A’ (41 hex)
becomes ‘1’ (31 hex)
Redundant information is ignored. For example, non‐existent
timer
Default display. For example, if the screen does not exist the
screen number is displayed on the cardholder screen.
The following are the conditions under which the specific command
reject value/qualifier combinations are produced.
Table 10-41 Value Qualifier Description
Specific Command Reject Value/Qualifier
Combinations A Message format errors.
01 Message length error. An incomplete message is
found under the following conditions:
Report Logs/Tallies missing the group number.
Load configuration ID incomplete or missing ID
field.
Option/Timer ‐ incomplete number/value field in
configuration message.
Customer/Transaction Data Elements are
incomplete, have the wrong length or are missing an
intervening group separator
Truncated MAC Field Selection Load, with expected
MAC data missing.
The Dispenser Currency Cassette Mapping Table is
incomplete.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-103
Central to Terminal Messages
Message Validation
Value Qualifier Description
02 Field Separator not found or found unexpectedly in
the following circumstances:
Found in the middle of an option/timer number and
value field in configuration message.
Not found when skipping the first three field
separators in a Transaction Reply message.
Not found at the end of the coinage field.
Not found in MAC Field Selection Load Data.
Mandatory last field separator not found or found
unexpectedly in a Transaction Reply message.
03 Too many print groups in the Transaction Reply
message. More than 13 print groups are present in a
Transaction Reply message.
04 A group separator is missing or found unexpectedly.
A group separator is required between fields ‘j’ and
‘j1’ as well as between ‘af2’ and ‘af3’ of the
Transaction Reply message.
There is a trailing group separator after the last
Customer/Transaction Data Element buffer (field
bd4)
06 Invalid dispense message, wrong format for current
mode or a request has been made to dispense from
multiple dispensers.
07 Malformed XML
08 XML does not conform to XML schema
09 Inconsistent configuration download, for example a
message part received out of order.
The download must be restarted.
B Field Value Errors.
01 Illegal Message Class. Message class was not ‘1’, ‘2’,
‘3’, ‘4’, ‘6’ or ‘7’, or message class was ‘7’ and exit
support was not detected.
If an SST is not configured for EMV, message class
‘8’ is not supported.
02 Illegal Message Sub‐Class or Identifier on a
Configuration Load Message with class ‘3’. The
following will cause this report:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-104 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Message Validation
Value Qualifier Description
Message sub‐class outside the range ‘1’ ‐ ‘4’.
Message identifier outside the range ‘1’ ‐ ‘6’, ‘A’ ‐ ‘C’
or ‘E’.
03 Illegal Load Key Message Identifier. Within a load
encryption key data message:
The modifier field is outside the range ‘1’ ‐ ‘9’.
04 Illegal Terminal Command Code:
Returned if the command code is outside the range
‘1’ ‐ ‘?’.
05 Illegal Terminal Command Modifier. Within a legal
terminal command, if a modifier is required:
Report tallies modifier outside the range ‘A’ ‐ ‘N’ or
‘V’ or ‘Y’ or ‘\’ or ‘[’.
Report error log modifier outside the range ‘A’ ‐ ‘C’.
The terminal command code is 7 and the command
modifier is outside the range 0‐7.
06 Invalid Function ID in Transaction Reply command:
Function ID is outside the range ‘1’ ‐ ‘9’, ‘A’, ‘B’, ‘C’,
‘F’, ‘O’, ‘P’, ‘Q’, ‘S’, ‘T’, ‘b’, ‘c’, ‘e’, ‘f’, ‘*’, ‘‐’, ‘’’, ‘:’, ‘#’
or ‘%’.
07 Data Field contains non‐numeric data. This is found
in the following circumstances:
Encryption key change message key data.
Coinage field has at least one non‐numeric character
present.
Option/Timer number or value in configuration
message.
A field in the range ‘ae5’ to ‘ae10’, or ‘af2’, ‘as2’ or
‘bd3’ in the Transaction Reply message contains a
non‐numeric character.
08 Numeric value out of range:
In a FIT message, a FIT data value is greater than
255.
A field in the range ‘ae3’ to ‘ae10’ or ‘af2’ in the
Transaction Reply message contains a value
exceeding the maximum.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-105
Central to Terminal Messages
Message Validation
Value Qualifier Description
One or more of the Customer/Transaction Data
Elements (fields bd3 and bd4) contain invalid values.
09 Invalid Message Coordination Number (MCN). In a
Transaction Reply or an Interactive Transaction
Response, the MCN is not zero and does not match
the value in the Transaction Request.
10 Illegal FIT number. A FIT in a FIT load message is
not in the range of the reserved pool size. Legal
values are 000‐999.
11 Too many notes in Transaction Reply command. The
total number of notes requested exceeds the limit of
40.
12 Reserved
13 Unrecognised cheque destination. Returned if the
destination specified in field ‘as2’ of the Transaction
Reply is not one of the allowed values, or if the field
is null.
14 Reserved
15 Unrecognised buffer identifier. Returned if the
Transaction Reply contains a buffer identifier not
currently supported.
16‐19 Reserved
20 No data supplied to endorse cheque in cheque
processor.
21 Reserved
22 Invalid key size sent in an Encryption Key Change
message, or an Extended Encryption Key Change
message. The key size may be incorrect (not 018 hex,
030 hex or 120 hex), not matching the key data
length, or invalid for the current key entry mode.
23 RSA Signature Verification Failed.
24 Signature or Encryption Key PKCS#1 Packing Failed.
25 Signature or Encryption Key PKCS#1 Unpacking
Failed.
26 Invalid Signature or Encryption Key PKCS#1 Pad
Block Type.
27 Fixed Header Decryption Failed.
28 Null Byte After Padding Missing.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-106 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Message Validation
Value Qualifier Description
29 Invalid Pad Byte Count.
33 Invalid Cassette Type (range 1 to 255).
34 Invalid/Incomplete Cheque Identifiers
35 Passbook Update not Supported in Specified
Transaction Reply Function
C Illegal Message Type for Current Mode.
01 Message type only accepted while terminal is in
In‐Service mode and is expecting a Transaction
Reply. The reject is caused by receipt of a
Transaction Reply at other times while the terminal
is In‐Service.
02 Message cannot be accepted while diagnostics is in
progress. This reply is designed to draw attention to
the fact that these programs are being executed. It
applies to the following messages:
Download messages for customisation.
Transaction Replies (not Print Immediate).
03 Message cannot be accepted while in Out‐of‐Service
or Supply modes. The following messages cannot be
accepted in these modes:
Transaction Replies (not Print Immediate).
Interactive Transaction Response.
04 Message unacceptable in current mode.
The following messages cannot be accepted while in
In‐Service mode:
Terminal commands ‘4’, ‘5’, ‘6’, ‘8’, ‘9’, ‘:’.
Interactive Transaction Response when not in
Transaction Request State.
Also applies to terminal command ‘?’ when
attempting to enable Supervisor ‘Dump Images’ but
terminal is performing a transaction.
Dispenser Currency Cassette Mapping table.
05 ‐ 09 Reserved.
10 Message not accepted while processing a
Transaction Reply.
11 Reserved.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-107
Central to Terminal Messages
Message Validation
Value Qualifier Description
12 Cannot process a document while a statement print
function is being carried out. Reported on 5665 only.
13 Cannot perform a statement print function while
processing a document. Reported on 5665 only.
14 Reserved.
15 Cannot perform a communications encryption key
change during a cardholder transaction, or when the
terminal is in suspend mode, or when the operator is
initiating the execution of supervisory or settlement
transactions.
16 Reserved.
17 Key change operation cannot be accepted in
restricted mode.
18 Key entry mode not authorised
D Hardware Failure.
01 Encryption Failure during key change message.
02 Time‐of‐Day clock failure during data/time set
command or invalid data sent.
03‐05 Reserved.
06 Insufficient disk space.
07 File I/O Error
08 File Not Found
E Not Supported.
01 Not supported by software. The requested function
is not supported by the software version in use. An
example is a DLL required to complete the
transaction reply processing is missing
02 Not supported by hardware. The hardware is not
present or cannot support the request.
Examples are:
– The Bunch Note Acceptor (BNA) function has
been requested but there is no BNA present.
– Sideways printing on receipt has been requested
but the option is not available.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-108 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Message Validation
Value Qualifier Description
03 ‐ 04 Reserved.
05 Journal printer backup is inactive.
06 The response message format definition is not
compatible with the data format/length that has to
be returned in response to a command request.
Any other invalid parameter in a received message will be accepted
Other Invalid Parameters 10
and the appropriate default operation will occur, but system
integrity will not be lost. As the operation is largely unpredictable,
NCR recommends that you ensure that Central validation occurs
before a message is sent, or check the terminal operation before
going live.
Exits 10
If a rule file specifies a DLL that cannot be loaded, or a routine that
cannot be accessed, the following will occur:
The error is traced, using trace messages T93 or T94.
See Appendix A, “Reserved Screens”.
If the error occurs during the execution of a user defined Exit
State, Advance NDC will also put the terminal into a default
Close state.
This will affect the following:
Messages of class 7, subclass 1, from Central to an Exit, if the file
MISCONT specifies an inaccessible DLL name or routine name
with Point of Use 7
Messages of classes 1, 2, 3 or 4 if the file VCCONT specifies an
inaccessible DLL name or routine name as an intercept routine.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-109
Central to Terminal Messages
Messages Received in Wrong Operational Mode
Messages Received in Wrong
Operational Mode 10
The following tables describe what action is taken if a message is
received by the terminal when it is in one of the following modes:
Power‐Up
Out‐of‐Service
Supply
In‐Service
The action taken will depend on which mode the terminal is in at
the time of receiving the message. The messages include:
Customisation Data Commands
Transaction Reply Commands
Terminal Commands.
For more details of these commands, see “Customisation Data
Customisation Data Commands” on page 10‐7.
Commands 10
Table 10-42 Out-of-
Command Mode Power-Up Supply In-Service
Actions for Customisation Data Commands Service
State Table Load ‐ A A R
Screen/Keyboard Data ‐ A A R
Load
Configuration ‐ A A R
Parameters Load
Interactive ‐ R R A2
Transaction Response
FIT Data Load ‐ A A R
Encryption Key ‐ A A A3
Change
Extended Encryption ‐ A A A3
Key Change
Configuration ID ‐ A A R
Number Load
Enhanced ‐ A A R
Configuration
Parameters Load
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-110 APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Messages Received in Wrong Operational Mode
Out-of-
Command Mode Power-Up Supply In-Service
Service
PIN Data Load ‐ A A R
Date and Time Load ‐ A A R
MAC Field Selection ‐ A A R
Load
Dispenser Currency ‐ A A R
Cassette Mapping
Table Load
R ‐ Command Reject.
A ‐ Accept for processing. Response is Ready (‘9’) status.
A2 ‐ Accept for processing. Response is Transaction Request if in
Transaction Request state, else response is Command Reject.
A3 ‐ Accept in In‐Service mode only if a transaction is not taking
place.
For more details of the Transaction Reply command, see
Transaction Reply “Transaction Reply Command” on page 10‐52.
Command Actions 10
Table 10-43 In-Service
Command In-Service
Actions for Transaction Reply Commands Mode
Power-Up Out-of-Service Supply (Not TREQ
(TREQ State)
State)
Print ‐ A A1 R A
Immediate
Other ‐ R R R A
R ‐ Command Reject.
A ‐ Accept for processing. If completed successfully, the response is
a Ready ‘9’ or Ready ‘B’ status. If a device error, the response is a
device fault status message. If a format error, the response is a
Command Reject.
A1 ‐ If the mode was entered from Out‐of‐Service, hold until
Out‐of‐Service is re‐entered and then process as A. Otherwise, the
response is a Command Reject. If another Print Immediate is
received, the first one is overwritten. There is no additional
response.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 10-111
Central to Terminal Messages
Messages Received in Wrong Operational Mode
For details of the SST commands, see “Terminal Commands” on
Actions for Terminal page 10‐3.
Commands 10
Table 10-44 Out-Of-
Command Mode Power-Up Supply In-Service
Actions for Terminal Commands Service
Go In‐Service ‐ A1 A2 A
Go Out‐of‐Service ‐ A A2 A3
Configuration ID ‐ C C C
Request
Configuration ‐ D D D
Information Request
Counters Request ‐ D P R
Date/Time Request ‐ D P R
D ‐ Response is requested information.
P ‐ Hold until supply mode is exited and then process according to
the mode entered. Note that the messages are not stacked and a new
request overwrites the previous request to which no response is
sent.
R ‐ Response is 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 cardholder activity while the
messages are being created.
A ‐ Response is Ready (‘9’) status.
A1 ‐ Change mode to In‐Service. Response is Ready (‘9’) status.
A2 ‐ Hold until Supply mode is exited and then process. Response is
Ready (‘9’) status. Note that if more than one command is received
while in Supply 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’).
C ‐ Response is the terminal state message containing the
Configuration ID.
Note: While In‐Service, a received Config ID request will be
processed and responded to immediately, whether the SST is in idle
or a cardholder session. All other terminal commands are held until
the terminal is idle and then processed. Commands are not stacked
and a new request, other than a Config ID, overrides the previous
request to which no response is sent.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
10-112 APTRA™ Advance NDC, Reference Manual
Table of Contents
Security Features
Chapter 11
Security Features
Overview 11‐1
BAPE Security 11‐2
EPP Security 11‐3
Remote PIN Block 11‐4
FIT Fields 11‐4
PIN Block Formats 11‐4
Diebold PIN Block 11‐5
ISO PIN Block Format 0 (ANSI) 11‐5
ISO PIN Block Format 1 11‐6
ISO PIN Block Format 3 11‐6
BANKSYS PIN Block 11‐6
PAN Block 11‐7
PIN Block Encryption 11‐8
Message Authentication 11‐10
Message Authentication Code 11‐10
Double‐length Keys 11‐11
Sending the MAC Field from the Terminal to Central 11‐11
Sending the MAC Field from Central to the Terminal 11‐11
Time Variant Number 11‐11
Full Message Authentication 11‐12
Selective Message Authentication 11‐13
Using Selective Message Authentication 11‐16
Key Verification Values 11‐17
Determining Encryptor Key Status 11‐17
RSA Initial Key Loading 11‐18
Identify EPP and Determine EPP Capabilities 11‐18
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Security Features
RSA Initial Key Loading for Signatures 11‐21
EPP Authentication Process 11‐21
Standard Signature Remote Key Loading
Authentication 11‐22
EPP Authentication 11‐24
Enhanced Signature Remote Key Loading
Authentication 11‐25
Loading Initial DES Keys 11‐26
Standard Message Sequence for DES Key Load 11‐27
Enhanced Message Sequence for DES Key Load 11‐28
RSA Encrypted DES Key Format 11‐29
Signature Format 11‐30
Base 94 Encoding and Decoding 11‐30
Encoding 11‐31
Decoding 11‐32
Changing the Encryption Key Entry Mode 11‐32
RSA Initial Key Loading for Certificates 11‐33
Exchange Certificates 11‐33
Load a DES Key for Certificates 11‐35
Replace a Certificate 11‐35
Primary and Secondary Keys 11‐36
Double‐Length Keys 11‐37
General Guidelines 11‐37
Advance NDC Guidelines 11‐37
‘Double Length Restricted’ Key Entry Mode 11‐38
Journal Printer Backup 11‐39
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Security Features
K
Overview
Overview 11
This chapter describes the security features in Advance NDC and
provides guidelines under the following topics:
BAPE and EPP security
Remote PIN block
Message authentication
Key verification values (KVVs)
RSA initial key loading
Double‐length keys
Journal printer backup.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-1
Security Features
BAPE Security
BAPE Security 11
The Basic Alpha PINpad and Encryptor (BAPE) provides an
intermediate level of security for keys and PINs entered at the
keyboard, with the following features:
Supervisor entry of initial key values
Storing of downloaded Master Key, Communications Key, VISA
master key, VISA table keys and MAC key
MAC generation
Secure PIN entry and PIN block generation for remote schemes
with VISA and ANSI PIN blocks. Secure entry is not allowed for
touch screen data
Secure PIN entry for local VISA and DES schemes
Secure PIN entry for the local DES scheme is not supported if
the terminal is in double‐length key mode and the PANPD in
the FIT specifies using the Master key
ISO Format 0 remote verification schemes, and DES and VISA
local schemes, are emulated in software.
PIN blocks or key data are stored in the PC core protected by single
encryption, and never in clear text.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-2 APTRA™ Advance NDC, Reference Manual
Security Features
EPP Security
EPP Security 11
When present on an NCR terminal, the Encrypting PIN Pad (EPP)
provides a high level of security for keys and PINs entered at the
keyboard, with the following features:
Supervisor entry of initial key values
Storing of downloaded Master Key, Communications Key, VISA
master key, VISA table keys and MAC key
MAC generation
Secure PIN entry and PIN block generation for remote schemes
with VISA and ANSI PIN blocks. Secure entry is not allowed for
touch screen data.
Triple DES encryption
Secure PIN entry for local VISA and DES schemes.
Secure PIN entry for the local DES scheme is not supported if
the terminal is in double‐length key mode and the PANPD in
the FIT specifies using the Master key.
Secure double‐length key operations in hardware
ISO Format 0 and ISO Format 3 remote verification schemes,
and DES and VISA local schemes, are emulated in software
Secure key entry enabled through CEN‐XFS.
For guidelines on effective security with the EPP, see
“Double‐Length Keys” on page 11‐37.
For information on key mode support on other vendors’ EPPs, refer
to Chapter 2, “Support for Advance NDC Features” in the APTRA
Advance NDC, Multi‐Vendor Support Reference.
For information on any necessary configuration for other vendors’
EPPs, refer to Chapter 6, “Advance NDC on Specific Vendors’ SSTs”
in the APTRA Advance NDC, Multi‐Vendor Support Reference.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-3
Security Features
Remote PIN Block
Remote PIN Block 11
The remote PIN block is formatted and encrypted as described in
the following passages:
FIT Fields
PIN Block Formats
PIN Block Encryption.
The following FIT fields are used to define the PIN block format and
FIT Fields 11
PIN block encryption:
PBFMT (PIN Block Format)
PMXPN (Maximum PIN Digits Entered and PIN block format)
PINPD (PIN Pad)
For details of these FIT field definitions, see the following sections in
Chapter 8, “Financial Institution Tables”:
“PBFMT (PIN Block Format)” on page 8‐11
“PMXPN (Maximum PIN Digits Entered)” on page 8‐4
“PINPD (PIN Pad)” on page 8‐6.
These FIT fields enable selection of:
PIN block format, as defined by PBFMT or PMXPN
PAD digit, as defined by PINPD
PIN block encryption mode.
For details of the PIN block encryption, see “PIN Block Encryption”.
The Advance NDC software supports the following PIN Block
PIN Block Formats 11
formats:
ISO Format 0 (ANSI)
ISO Format 1
ISO Format 3
BANKSYS.
All PIN blocks consist of 16 digits, although the PIN length varies.
The PIN Block formats are shown in the following sections.
For more information about the ISO PIN block formats, refer to the
ISO publication Banking ‐ Personal Identification Number Management
and Security (Part 1: PIN Protection Principles and Techniques) ‐
ISO/CD 9564‐1.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-4 APTRA™ Advance NDC, Reference Manual
Security Features
Remote PIN Block
Diebold PIN Block 11
The Diebold PIN Block consists of 16 hexadecimal digits. As
Advance NDC does not support the message co‐ordination number,
it is not included.
Figure 11-1
Diebold PIN Block PIN field (16 digits)
PIN PIN digits or PAD digits,
depending on PIN length
Minimum PIN length = 4; maximum PIN length = 16.
ISO PIN Block Format 0 (ANSI) 11
ISO PIN Block Format 0 consists of 16 hexadecimal digits, and
conforms to ANSI standard X9.8.
ISO PIN Block Format 0 is created by XORing together the PIN
block and the PAN block. For details of the PAN block, see “PAN
Block” on page 11‐7.
ISO PIN Block Format 0 is as follows:
Figure 11-2
ISO PIN Block Format 0
PIN field (16 digits)
Control PIN digits PAD digits,
Field "0” always 15
PIN digits or
PAD digits,
PIN length, depending on
PIN length
4 to 12
Minimum PIN length = 4; maximum PIN length = 12.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-5
Security Features
Remote PIN Block
ISO PIN Block Format 1 11
ISO PIN Block Format 1 is as shown below:
Figure 11-3
ISO PIN Block Format 1 PIN field (16 digits)
Control PIN digits Transaction
Field "1” digits,
PIN digits or
transaction digits, random 0 to 15
PIN length, depending on
PIN length
4 to 12
Minimum PIN length = 4; maximum PIN length = 12.
ISO PIN Block Format 3 11
ISO PIN Block Format 3 is created by XORing together the PIN
block and the PAN block. For details of the PAN block, see “PAN
Block” on page 11‐7.
ISO PIN Block Format 3 is as shown below:
Figure 11-4
ISO PIN Block Format 3 PIN field (16 digits)
Control PIN digits PAD digits,
Field "3” randomly
PIN digits or
PAD digits, selected in
depending on range 10
PIN length, to 15
PIN length
4 to 12
Minimum PIN length = 4; maximum PIN length = 12.
BANKSYS PIN Block 11
The BANKSYS PIN block is created by XORing together the PIN
block and the PAN block. For details of the PAN block, see “PAN
Block” on page 11‐7.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-6 APTRA™ Advance NDC, Reference Manual
Security Features
Remote PIN Block
The BANKSYS PIN block is as follows:
Figure 11-5
BANKSYS PIN Block PIN field (16 digits)
Control PIN digits or PAD digit,
Field "1" pad with 0 up to randomly selected
maximum PIN in range 0 to 15
length defined PIN digits or
PIN length, by PMXPN
4 to 12 PAD digit,
field in FIT depending on
PIN length
Minimum PIN length = 4; maximum PIN length = 12.
When the cardholder enters the PIN, the digits are padded to the
right with 0 hexadecimal11 to the maximum defined by the five
least significant bits of the PMXPN field. The block is completed by
padding the rest of the block with a pseudo‐random digit based on
time.
PAN Block 11
A PAN block is built for ISO Format 0 (ANSI), ISO Format 3 and
BANKSYS PIN blocks.
The PAN block is made up of 16 hexadecimal digits, and contains
the PAN digits selected from the cardholder’s card using the FIT
parameters PANDX and PINDX.
The PAN is located in the card data by using the PANDX FIT entry,
which indicates the start of the PAN. The end of the PAN is found
by searching for the next field separator, or the end of the track data.
The check digit at the end of the PAN is discarded and then the least
significant 12 digits are extracted to form the PAN block. This block
is padded to the left with 0 hexadecimal in order to create the full 16
digits.
Figure 11-6
PAN Block
PAD digits PAN digits
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-7
Security Features
Remote PIN Block
As a maximum of 12 PAN digits are placed in the PAN block, the
first four digits are always 0 hexadecimal.
The PIN and PAN blocks are then XORed together, to create the
PIN/PAN block. This is encrypted as defined by the FIT field PINPD
and placed in the Transaction Request message.
For all PIN blocks, the first digit of the PINPD FIT field specifies the
PIN Block Encryption 11
method of encryption and the encryption key.
The second digit is the digit used to pad the PIN.
The first digit is binary encoded.
The significance of each bit in the first digit is as follows:
Table 11-1 Bit 0 Double encryption sequence:
PINPD First Digit Bit Significance (1 hex) 0 ‐ MAST‐COM
1 ‐ PEKEY‐COM
Bit 1 Double/single designator:
(2 hex) 0 ‐ single
1 ‐ double
Bit 2 Encryption/no‐encryption:
(4 hex) 0 ‐ encrypt
1 ‐ no encrypt
Bit 3 Co‐ordination number/no co‐ordination number:
(8 hex) 0 ‐ no co‐ordination number
1 ‐ co‐ordination number included
This bit has no effect if the PIN block format is specified
using the PBFMT field.
Table 11-2 Hexadecimal
Type Of Encryption Encryption Key and Sequence
PINPD FIT Field Value
First Second
0 Single COM ‐
2 Double MASTER COM
See Table Note 2.
3 Double PEKEY COM
4 (None) ‐ ‐
See Table Note 1.
8 Single COM ‐
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-8 APTRA™ Advance NDC, Reference Manual
Security Features
Remote PIN Block
Hexadecimal
Type Of Encryption Encryption Key and Sequence
Value
First Second
A Double MASTER COM
B Double PEKEY COM
C (None) ‐ ‐
See Table Note 1.
Table Note 1: The encryption commands 4 and C hexadecimal,
which call for transmitting an unencrypted PIN are not secure.
These are not supported by Advance NDC.
Table Note 2: Double encryption involves encrypting the PIN field
using the first encryption key, then encrypting the encrypted PIN
field using the second encryption key.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-9
Security Features
Message Authentication
Message Authentication 11
When Message Authentication is used, either the host or the
terminal sending the message appends a Message Authentication
Code (MAC) to the end of the message. The MAC is calculated from
the message content, and is therefore specific to the message that it
is created from.
For single DES MACing, the message authentication procedure
conforms to ANSI standard X9.9. Triple DES MACing conforms to
ANSI standard X9.19.
The Message Authentication Code field can be added to Transaction
Message Authentication Request, Solicited Status (both device fault and terminal state),
Code 11
Transaction Reply, State Table, FIT Load, MAC Field Selection
Load, Dispenser Currency Cassette Mapping Table and EMV
Configuration messages.
If the transmission code is a different format, the MAC calculations
are performed on the data as follows:
For received messages, after conversion to ASCII
For sent messages, before conversion to the different format
For example, if the transmission code of a received message is
EBCDIC, then the data is converted to ASCII before a MAC
calculation is performed.
The MAC calculation is performed over the whole message, starting
from the first field following the protocol‐dependent header, up to
the field separator preceding the MAC field, or on selected fields of
the message that are specified by the MAC field selection table.
When selected fields are used, they are taken in sequence from the
start of the message and added together to form the data string that
is used for Message Authentication. If this results in a null string,
the Message Authentication code is set to 00000000. For all other
cases, the Message Authentication code is generated in the
following way:
1 The first eight bytes of the data are extracted and encrypted
using the MAC key.
2 The encrypted eight bytes are XORed with the next eight bytes
extracted from the data. If fewer than eight bytes remain, they
are padded to the right with 0 hexadecimal.
3 This value is then encrypted using the MAC key.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-10 APTRA™ Advance NDC, Reference Manual
Security Features
Message Authentication
4 Steps 2 and 3 are repeated until all the data has been dealt with.
5 The first four bytes of the final encryption form the MAC field. It
is regarded as eight hexadecimal digits, each of which is
converted to a character in the range ‘0’ ‐ ‘9’, ‘A’ ‐ ‘F’.
Double‐length Keys 11
If the MAC key is double length, steps 1 to 4 are performed using
the first half of the key. The final result is then decrypted using the
second half of the key, and encrypted again using the first half.
Step 5 is then performed to extract the MAC. This is also known as
Last Block Triple DES.
Note: Advance NDC only supports/uses the Last Block method to
calculate double‐length key MACs.
Sending the MAC Field from the Terminal to Central 11
The MAC field is calculated by the terminal and placed at the end of
the message. The message is sent to the host where the same
calculation is performed. The transmitted and calculated MAC
fields are compared. If they are equal, the host continues with the
processing. If they are unequal, the host treats this as an invalid
request and acts accordingly.
Sending the MAC Field from Central to the Terminal 11
The MAC field is calculated by the host and placed at the end of the
message. The message is sent to the terminal where the same
calculation is performed. The transmitted and calculated MAC
fields are compared. If they are equal, the terminal continues with
the processing. If they are unequal, the terminal sends a specific
command reject solicited status message to the host, and behaves as
though a normal command reject has been sent.
Time Variant Number 11
The time variant number, TVN, is an additional security feature that
is available when Message Authentication is used. It can be used in
Transaction Request and Solicited status messages.
When this feature is used, the terminal calculates the TVN from the
terminal time, and sends it in the message. The host should send the
same TVN back to the terminal. If the MAC in the message is
verified, the terminal compares the received TVN to the one it sent.
If the TVN is the same, the message is accepted and processed. If
not, a specific command reject (c‐2) solicited status message is sent
and a further reply awaited.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-11
Security Features
Message Authentication
Message Authentication is controlled by the entry of information at
Full Message the SST as part of the configuration process. For details, refer to the
Authentication 11
APTRA Advance NDC, Supervisor’s Guide. This information contains
flags that are described in the following tables.
Table 11-3 Flag 1
Message Authentication Configuration
Flag 1 0 Do not check the time variant number in Transaction Reply
messages, or the MAC in Transaction Reply, State Table, FIT
Load or Dispenser Currency Cassette Mapping Table
messages.
1 Check the time variant number in Transaction Reply
messages.
Check the MAC in Transaction Reply, State Table, FIT Load,
and Dispenser Currency Cassette Mapping Table messages.
Flag 2 must also be set for this flag to have any effect.
Table 11-4 Flag 2 See Table Note 3
Message Authentication Configuration
Flag 2 0 Do not send the time variant number and the MAC data in
Transaction Request messages.
1 Send the time variant number and the MAC data in
Transaction Request messages.
Table Note 3: Flag 2 must be set to ‘1’ to enable message
authentication. If this flag is set to ‘0’, no message authentication
occurs whatever the settings in flags 1, 8, 9 or 10.
Valid combinations of flags 1 and 2 are 00, 01 and 11. When flag
combination 01 is used, the following apply:
MAC and time variant fields are still expected in the Transaction
Reply and Interactive Transaction Reply from the host, but they
are not checked
MAC and time variant fields must not be included in the other
messages controlled by flag 1.
Table 11-5 Flag 8
Message Authentication Configuration
Flag 8 0 Do not check the Security Terminal Number in Transaction
Reply messages.
1 Check the Security Terminal Number in Transaction Reply
messages.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-12 APTRA™ Advance NDC, Reference Manual
Security Features
Message Authentication
Table 11-6 Flag 9
Message Authentication Configuration
Flag 9 0 The MAC calculation is performed on the whole message.
1 The MAC calculation is performed on the fields that are
specified in the MAC field selection table. Flag 2 must also be
set for this flag to have any effect.
Table 11-7 Flag 10
Message Authentication Configuration
Flag 10 0 Do not send the time variant number and the MAC on
Solicited status messages.
1 Send the time variant number and MAC on Solicited device
status messages (excluding RDY). Flag 2 must also be set for
this flag to have any effect.
Flags 3‐7 are not used, and must be zero when Flags 9 and 10 are
used.
Flags 1, 2 and 10 determine whether the MAC is to be
performed.Flag 2 must be set for the MAC to be performed.
Flag 9 determines the type of MAC to use.
Flag 8 is used to determine if the received message is for this
terminal.
In long messages, such as messages containing printer data,
Selective Message generating the MAC can add several seconds to the transaction
Authentication 11
time. Therefore, to derive the benefit of Message Authentication
without the time penalty, Message Authentication across selected
fields can be performed.
A field selection table is used to identify, for each message type, the
fields that are to be included in the MAC. Flag 9 in the MAC flags
indicates whether a full or selective MAC is to be used.
The field selection table consists of four fields, one each for
Transaction Request, Transaction Reply, and Solicited Status
messages, and one combined field for other types of message. These
are followed by three fields, one each for Track 1, Track 2 and
Track 3 data from the magnetic card stripe. A further field is present
for a Smart Card. For details of Transaction Request and
Transaction Reply offsets, see “Message Authentication Field
Selection Load” on page 10‐26.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-13
Security Features
Message Authentication
Table 11-8 Solicited Status Message
MAC Field Selection: Solicited Status
Message Offset Meaning
0 0 ‐ MAC complete message. Ignore the remaining digits.
1 ‐ Selectively MAC the fields below. See Table Note 4.
1 Fields b and c
2 Field d
3 Reserved
4 Field e
5 Field f
6 Field g1
7 Field g2. See Table Note 5.
8 Field g3
9 Field g4
10 Field g5
Table Note 4: Fields are selected for inclusion in the MAC if the
relevant offset byte is set to 1.
Table Note 5: When field ‘g2’ is set to be MACed selectively, any
group separators within that field will not be MACed.
Table 11-9 Other Messages
MAC Field Selection - Other Messages
Offset Meaning
0 0 ‐ Do not MAC FIT Load messages.
1 ‐ MAC FIT Load messages.
1 0 ‐ Do not MAC State Table Load messages.
1 ‐ MAC State Table Load messages.
2 0 ‐ Do not MAC Terminal State messages.
1 ‐ MAC Terminal State messages.
3 0 ‐ Do not MAC Dispenser Currency Cassette Mapping Table
messages.
1 ‐ MAC Dispenser Currency Cassette Mapping Table
messages.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-14 APTRA™ Advance NDC, Reference Manual
Security Features
Message Authentication
Table 11-10 Track 1, Track 2, Track 3
MAC Field Selection - Track 1, Track 2,
Track 3 Offset Meaning
0 0 ‐ MAC full track. Ignore bytes 1‐n.
1 ‐ Selectively MAC the fields below. See Table Note 6.
1 Sub‐field 1 (including start sentinel)
2‐n Sub‐fields 2‐n
Table Note 6: Sub‐fields are selected for inclusion in the MAC if the
relevant offset byte is set to 1.
A maximum of five fields is possible on Tracks 1 and 2, and ten on
Track 3.
If there are fewer than the maximum number of sub‐fields present
on the card, the excess bytes are set to zero. The last sub‐field
contains the end sentinel. If the sub‐fields that contain the start and
end sentinels are specified for inclusion in the MAC, then the
sentinels are included.
The track fields are only examined if the relevant offset byte is set in
the Transaction Request/Reply field.
The following table is only relevant if you are using an EMV
Integrated Circuit Card (ICC or ‘Smart Card’):
Table 11-11 EMV ICC (Smart Card) Configuration Messages
MAC Field Selection For EMV ICC
Configuration Messages Offset Meaning
0 0 ‐ Do not MAC ICC Currency Data Objects Table messages.
1 ‐ MAC ICC Currency Data Objects Table messages.
1 0 ‐ Do not MAC ICC Transaction Data Objects Table messages.
1 ‐ MAC ICC Transaction Data Objects Table messages.
2 0 ‐ Do not MAC ICC Language Support Table messages.
1 ‐ MAC ICC Language Support Table messages.
3 0 ‐ Do not MAC ICC Terminal Data Objects Table messages.
1 ‐ MAC ICC Terminal Data Objects Table messages.
4 0 ‐ Do not MAC ICC Terminal Acceptable AIDs Table
messages.
1 ‐ MAC ICC Terminal Acceptable AIDs Table messages.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-15
Security Features
Message Authentication
A set of default field values are provided. These are as follows:
Using Selective Message
Authentication 11
Table 11-12 Transaction Request Selective MAC on fields e, h (sub‐field l), j, k, l,
Selective MAC Default Field Values bd.
Transaction Reply Selective MAC on fields e, g, h, i, j, j1‐j4, k, l, at.
Solicited Status Full MAC.
FIT/State tables Full MAC.
Terminal State No MAC.
Track 1 Full MAC.
Track 2 Selective MAC on first sub‐field.
Track 3 Full MAC.
Dispenser Currency Full MAC.
Cassette Mapping
EMV ICC Full MAC.
Configuration
Table Note 7: These defaults can be changed by a download
configuration message.
Table Note 8: When selective fields are used, they are taken in
sequence from the message to build a single data string. Field and
group separators are not included. Empty fields are omitted. If the
complete data string is empty, no authentication is attempted and
the MAC is set to zero.
Table Note 9: The selective MAC is calculated in the same way as
for full Message Authentication.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-16 APTRA™ Advance NDC, Reference Manual
Security Features
Key Verification Values
Key Verification Values 11
Key Verification Values (KVVs) give positive confirmation of the
correct loading of an encryption key.
The KVV is created by encrypting eight zero bytes, taking the first
(leftmost) three bytes of the result and converting this to six
hexadecimal digits.
For double‐length keys, a triple DES encryption is performed.
The VISA key table is treated as 12 single length keys giving 12
separate KVVs.
The host (Central) can determine the status of keys in the encryptor
Determining Encryptor with the following message exchange:
Key Status 11
Figure 11-7
Obtain Key Status Message Exchange
Host SST
EEKC, 'H' - Send all KVVs
EID, '4' - KVV table
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-17
Security Features
RSA Initial Key Loading
RSA Initial Key Loading 11
Where an SST is fitted with an Encrypting PIN Pad (EPP), the
Advance NDC application supports the loading of the initial
encryption keys (A key, and B key and V key) using RSA
encryption, instead of local entry in Supervisor mode.
Initial key loading using RSA is supported on NCR SSTs using a
signature‐based scheme. For hardware from other vendors that use
a certificate‐based scheme, Advance NDC supports certificates.
In the following sections and diagrams, for both signatures and
certificates, the following abbreviations are used:
EEKC Extended Encryption Key Change
See “Extended Encryption Key Change” on page 10‐37
EID Encryptor Initialisation Data
See “Encryptor Initialisation Data” on page 9‐82
KVV Key Verification Value
See “Key Verification Values” on page 11‐17
As the host may have to handle a mixed network of SSTs, a system
Identify EPP and of reporting the capabilities of the PIN device is required to support
Determine EPP the following schemes:
Capabilities 11
Standard signature scheme
Enhanced signature scheme
Certificate scheme
The diagram on the next page shows the message sequence used to
determine the EPP capabilities.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-18 APTRA™ Advance NDC, Reference Manual
Security Features
RSA Initial Key Loading
Figure 11-8 Host NDC XFS PIN
Identify EPP and Determine EPP
Capabilities EEKC, ‘Q’
Send encryptor
capabilities and state
WFS_INF_PIN_CAPABILITIES
WFS_INF_PIN_STATUS
EID, ‘B’
Encryptor capabilities and state
(Remote key scheme Certificate state)
EEKC, ‘F’ or ‘V’
Send EPP serial number
EID, ‘5’
EPP serial number or Reject
Support for certificates depends on the CEN‐XFS interface and not
on NCR hardware. The Advance NDC message interface is not
tightly defined or optimised for NCR hardware, but reflects the
generalised definitions of the CEN interface. It is not possible from
the Advance NDC interface specification alone to determine exactly
how to implement remote key loading using certificates from the
host. Reference to the CEN, ANSI and RSA standards is required to
determine message formats.
The ANSI standard defines the overall operation of the key loading
schemes. The CEN‐XFS standard defines the interface to the PIN
device in the SST.
Support for the features defined in CEN XFS may vary from vendor
to vendor. Support for certificates and signatures on other vendors
hardware is designed to cover the features defined by the CEN‐XFS
specification but it does not imply that all features described are
supported by all vendors.
For further information about the RSA encryption and signature
schemes, refer to the RSA Laboratories Cryptographic Token Interface
Standard ‐ PKCS # 1 v 2.0.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-19
Security Features
RSA Initial Key Loading
For further information about the CEN‐XFS interface specification,
refer to
http://www.cen.eu/CEN/sectors/sectors/isss/activity/Pages/wsxfs.aspx
For further information about the ANSI standard, refer to
http://ansi.org/
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-20 APTRA™ Advance NDC, Reference Manual
Security Features
RSA Initial Key Loading for Signatures
RSA Initial Key Loading for
Signatures 11
Two versions of the signature‐based key exchange protocol are
supported for the initial key loading using RSA, as follows:
Standard Signature Remote Key Loading
Enhanced Signature Remote Key Loading.
Before using RSA encryption, the Host Security Module (HSM) at
EPP Authentication the host and the EPP in the terminal must perform an authentication
Process 11
process which satisfies the conditions described in this section.
The objective of the initial key download is to transfer a DES
encryption key from the HSM at the host to the EPP in the terminal.
There are three important conditions to this transfer:
The DES key must remain secret. Only the source HSM and
destination EPP can know the key.
The EPP must only accept a key from an HSM identified as
authentic.
The HSM must only send the key to an EPP identified as
authentic.
RSA encryption is used to meet these conditions. RSA encryption
uses asymmetric cryptography algorithms (also known as an
asymmetric encryption scheme) which use a pair of keys: one key is
used for encryption; the other key is used for decryption.
One of the keys is kept secret and the other key is made public.
During the authentication process, RSA encryption is used for
encrypting secret data and for signing data. With RSA encryption,
anybody can encrypt data using the public key, but only the holder
of the secret key can decrypt the data.
Signatures are used to prevent messages from being changed
during transmission and the sender from being impersonated. A
Secure Hashing Algorithm (SHA) is applied to the message and
then the result is encrypted. With RSA encryption, the secret key is
used for generating the signature. Only the holder of the secret key
can generate the signature, but anybody can verify the signature
using the public key.
In these sections and the diagrams, [message]PK is used to
represent a message encrypted with a public key (PK), and
(message) * SK represents a message signature using a secret key
(SK).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-21
Security Features
RSA Initial Key Loading for Signatures
Standard Signature Remote Key Loading
Authentication 11
Two pairs of RSA keys are used to transfer an initial DES key
(the A‐key) from the HSM to an EPP. One pair of keys is associated
with the HSM (SK‐HSM and PK‐HSM); the HSM retains SK‐HSM
and sends PK‐HSM to the EPP. The other pair is associated with the
EPP (SK‐EPP and PK‐EPP); the EPP retains SK‐EPP and sends
PK‐EPP to the HSM.
The HSM uses PK‐EPP to encrypt the A‐key, represented by
[A‐key] PK‐EPP, so that only the EPP can decrypt it using SK‐EPP.
The HSM signs the message using SK‐HSM, represented by
([A‐key] PK‐EPP) * SK‐HSM, so that the EPP can verify that the
message came from the HSM and has not been altered. This is
summarised in the following diagram:
Figure 11-9
HSM - EPP A-key Message Exchange: HSM EPP
Standard Mode
PK-EPP
PK-HSM
Host encrypts A-key using PK-EPP
and signs using SK-HSM
[A-key] PK-EPP + ([A-key] PK-EPP) * SK-HSM
There are still a couple of issues to resolve:
How the HSM checks that the PK‐EPP came from an authentic
EPP, rather than an impostor trying to steal the A‐key
How the EPP checks that the PK‐HSM came from an authentic
HSM, rather than an impostor attempting to load their own
keys.
A further step is thus required to authenticate the EPP and HSM
public keys. This uses a third pair of RSA keys generated by the
vendor—NCR in these examples—(SK‐NCR and PK‐NCR).
SK‐NCR will be kept in a security module in a highly secure
location within NCR.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-22 APTRA™ Advance NDC, Reference Manual
Security Features
RSA Initial Key Loading for Signatures
When PK‐EPP and SK‐EPP are generated and written to the EPP
during the EPP manufacturing process, SK‐NCR is used to sign
PK‐EPP, that is, (PK‐EPP) * SK‐NCR. This signature and PK‐NCR is
also written to the EPP. Using some other secure channel PK‐HSM
is transferred to the vendorʹs secure location and signed using
SK‐NCR, that is, (PK‐HSM) * SK‐NCR. Using a secure channel, this
signature and PK‐NCR are written to the HSM.
This process is summarised in the following diagram:
Figure 11-10 NCR Security
Authentication of EPP/HSM Public Keys: Module
Standard Mode Secure channel During manufacture
SK-EPP, PK-EPP,
PK-HSM PK-NCR, (PK-EPP) * SK-NCR
(PK-HSM) * SK-NCR PK-NCR
HSM New EPP
When the HSM and EPP exchange public keys, the signatures
created using SK‐NCR are also exchanged. The HSM and EPP can
authenticate the other’s public key by verifying the signatures using
PK‐NCR, as summarised by the following:
Figure 11-11 HSM EPP
HSM/EPP Signature Verification:
Standard Mode
PK-EPP + (PK-EPP) * SK-NCR
HSM verifies (PK-EPP) * SK-NCR
using PK-NCR
PK-HSM + (PK-HSM) * SK-NCR
EPP verifies (PK-HSM) * SK-NCR
using PK-NCR
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-23
Security Features
RSA Initial Key Loading for Signatures
As an additional authentication measure, every EPP has a unique
serial number (SN‐EPP) that is written to the EPP during
manufacture. The serial number is also signed with SK‐NCR and
can be transmitted to the host and the HSM.
A newly installed EPP requires an exchange of the above messages
with the host, to authenticate the EPP to the HSM and the HSM to
the EPP. Once the authentication is complete, RSA encryption can
be used to load the initial keys (A, B and V) into the EPP.
Note: Until the initial keys have been loaded into the encryptor,
Advance NDC is restricted in the operations it can perform. In
particular, it cannot MAC any messages without a MAC key or a B
key; therefore the authentication process cannot use message
formats which normally have a MAC. The Extended Encryption
Key change message is used for sending information to the SST, and
a new message format (Encryptor Initialisation Data) is used for
sending information from the SST to the host.
EPP Authentication 11
The message sequence to authenticate an EPP in Advance NDC in
Standard Signature Remote Key Loading mode is shown in the
following diagram:
Figure 11-12 Host SST
EPP Authentication Message Sequence:
Standard Mode
EEKC, ‘Q’ - Send encryptor capabilities and state
EID, ‘B’ - Encryptor capabilities and state
EEKC, ‘F’ or ‘V’ - Send EPP serial number
EID, ‘1’ or ‘E’ - EPP serial number and signature or Reject
EEKC, ‘B’ - Load HSM public key and signature
EID, ‘5’ - Key loaded or Reject
EEKC, ‘G’ - Send EPP public key
EID, ‘2’ - EPP public key and signature or Reject
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-24 APTRA™ Advance NDC, Reference Manual
Security Features
RSA Initial Key Loading for Signatures
Note: If the SST does not contain an EPP, the messages are rejected
with E02 ‘Function not supported by hardware’.
Enhanced Signature Remote Key Loading
Authentication 11
The Enhanced Signature Remote Key Loading Authentication
scheme is similar to the Standard Signature Remote Key Loading
authentication scheme but has the following differences:
An additional pair of RSA keys is introduced into the host key
hierarchy. This additional key pair is used to ensure only public
keys belonging to the correct host can be loaded into the EPP.
This key pair is known as ( SK‐HOSTRoot and PK‐HOSTRoot ).
A self signature must be provided before either the
PK‐HOSTRoot or PK‐HOST can be deleted. A key must be
deleted before it can be replaced.
In this scheme, SK‐NCR is used to sign the host root key
PK‐HOSTRoot using a secure channel as in the standard
authentication mode, and PK‐HOSTRoot is used to sign PK‐HOST
as shown in the following diagram:
Figure 11-13 NCR Security
Authentication of EPP/HSM Public Keys: Module
Enhanced Mode Secure channel During manufacture
PK-HSMRoot PK-NCR, SK-EPP, PK-EPP,
(PK-HSMRoot) * SK-NCR (PK-EPP) * SK-NCR
HSM New EPP
SK-HSM, PK-HSM, (PK-HSM) * SK-HSMRoot
This authentication exchange results in the HSM containing the
following:
PK‐NCR
SK‐HSMRoot
PK‐HSMRoot
(PK‐HSMRoot)*SK‐NCR
SK‐HSM
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-25
Security Features
RSA Initial Key Loading for Signatures
PK‐HSM
(PK‐HSM)*SK‐HSMRoot
The message sequence to authenticate an EPP in NDC in the
Enhanced Signature Remote Key Loading mode is shown in the
following diagram.
Figure 11-14
EPP Authentication Message Sequence: Host SST
Enhanced Mode
EEKC, ‘F’ or ‘V’ — Send EPP serial number
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐>
EID, ‘1’ or ‘E’ — EPP serial number & signature or Reject
<‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
EEKC. ‘R’, Load HSMRoot public key & signature
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐>
EID. ‘5’ — Key loaded or Reject
<‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
EEKC, ‘B’ — Load HSM public key and signature
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐>
EID ‘5’ — Key loaded or Reject
<‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
EEKC, ‘G’ —Send EPP public key
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐>
EID, ‘2’ — EPP public key & signature or Reject
<‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
If the SST does not contain an EPP, the messages are rejected with a
reject reason of E02 ‘Function not supported by hardware’. If the
Enhanced Signature scheme is not supported, the EEKC ʹRʹ message
is rejected with reason E02 ‘Function not supported by hardware’.
After performing the EPP authentication process, the DES keys can
Loading Initial DES Keys 11
be loaded. The sections on the following pages define the sequence
of messages for each scheme.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-26 APTRA™ Advance NDC, Reference Manual
Security Features
RSA Initial Key Loading for Signatures
Standard Message Sequence for DES Key Load 11
The standard message sequence is shown in the following diagram:
Figure 11-15 Host SST
DES Key Load Standard Message EEKC, ‘C’ - Load initial master key (A key) with RSA key
Sequence
EEKC, ‘C’ - Load initial master key (A key) with RSA key
EID, ‘3’ - New master key’s KVV
EID, ‘3’ - New master key’s KVV
EEKC, ‘2’ - Load comms key with master key
EEKC, ‘2’ - Load comms key with master key
EID, ‘3’ - New comms key’s KVV
EID, ‘3’ - New comms key’s KVV
EEKC, ‘5’ - Load MAC key with master key
EEKC, ‘5’ - Load MAC key with master key
EID, ‘3’ - New MAC key’s KVV
EID, ‘3’ - New MAC key’s KVV
EEKC, ‘A’ - Load V key with master key
EEKC, ‘A’ - Load V key with master key
EID, ‘3’ - New V key’s KVV
EID, ‘3’ - New V key’s KVV
EEKC, ‘9’ - Load VISA key table with V key
EEKC, ‘9’ - Load VISA key table with V key
EID, ‘3’ - New VISA keys’ KVVs
EID, ‘3’ - New VISA keys’ KVVs
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-27
Security Features
RSA Initial Key Loading for Signatures
Enhanced Message Sequence for DES Key Load 11
The enhanced message sequence is as follows:
Figure 11-16 Host SST
DES Key Load Enhanced Message
Sequence
EEKC, ‘N’ - Send SST Random Number
EID, ‘9’ - SST Random Number
EEKC, ‘C’ - Load initial master key (A key) with RSA key
EID, ‘3’ - New master key’s KVV
EEKC, ‘2’ - Load comms key with master key
EID, ‘3’ - New comms key’s KVV
EEKC, ‘5’ - Load MAC key with master key
EID, ‘3’ - New MAC key’s KVV
EEKC, ‘A’ - Load V key with master key
EID, ‘3’ - New V key’s KVV
EEKC, ‘9’ - Load VISA key table with V key
EID, ‘3’ - New VISA keys’ KVVs
Note: All the data returned in the random number from the SST is
included in the cryptogram.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-28 APTRA™ Advance NDC, Reference Manual
Security Features
RSA Initial Key Loading for Signatures
Key Deletion In the Enhanced Remote Key Loading scheme, the 11
host keys that have been imported must be deleted before they can
be replaced. In addition, to prevent unauthorised deletion of these
keys, the public keys are deleted only if the request is accompanied
by a signature of the concatenation of the EPP serial number and the
public key to be deleted with the corresponding secret key.
If the PK‐HOST is deleted, then PK‐HOSTRoot remains within the
EPP and can be used to load another PK‐HOST. If PK‐HOSTRoot is
deleted, both PK‐HOSTRoot and PK‐HOST are deleted.
The message sequence to delete the PK‐HOST in the EPP is as
follows:
Host SST
Figure 11-17
Enhanced Signature Remote Key Load
Mode: Delete PK-HOST EEKC, ‘S’ — Delete PK‐HOST
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐>
EID ‘C’ — Key deleted or Reject
<‐‐‐‐‐‐‐ ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
The message sequence to delete PK‐HOSTRoot in the EPP is as
follows:
Host SST
Figure 11-18
Enhanced Signature Remote Key Load
Mode: Delete PK-HOSTRoot EEKC, ‘S’ — Delete PK‐HOSTRoot
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐>
EID ‘C’ — Key deleted or Reject
<‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
Note: Deleting PK‐HOST before deleting PK‐HOSTRoot is not
necessary as deleting PK‐HOSTRoot automatically results in
PK‐HOST being deleted.
When loading an initial DES key using RSA encryption, the 8 or 16
RSA Encrypted DES Key bytes of the key are encrypted using the RSAES‐PKCS1‐v1_5
Format 11
scheme described in the RSA Laboratories Cryptographic Token
Interface Standard (PKCS #1 v2.0).
The SST decodes the block as a single or double‐length key,
depending on the key entry mode selected in Supervisor mode.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-29
Security Features
RSA Initial Key Loading for Signatures
For transmission to the terminal, the data is encoded as described in
“Base 94 Encoding and Decoding” below.
Message signatures are generated using the RSASSA‐PKCS1‐v1_5
Signature Format 11
scheme described in the RSA Laboratories Cryptographic Token
Interface Standard (PKCS #1 v2.0). The Secure Hash Algorithm
(SHA‐1) is applied to the message, and the result is encrypted.
SHA‐1 is described in the Federal Information Processing Standard
(FIPS 180‐1) Secure Hash Standard.
For transmission between the host and the terminal, the signature is
encoded as described in “Base 94 Encoding and Decoding”.
Note: When a public key is transmitted from NDC to the host, only
256 bytes of the modulus are sent. The bytes describing the
containing structure and the exponent of the key never change, so
they are not transmitted. The complete key structure shown below
must be reconstituted before the signing process.
3082010A ‐ Tag: structure, length 266 bytes
02820101 ‐ Tag: integer, length 257 bytes
00 ‐ Leading 00 ensures modulus is positive
MM..MM ‐ 256 byte modulus
0203 ‐ Tag: integer, length 3 bytes
010001 ‐ Exponent (always 65537)
Therefore, to reconstitute the key, bracket the modulus (MM..MM)
with the following byte sequences:
3082010A0282010100MM..MM0203010001
Base 94 encoding and decoding has been introduced to satisfy the
Base 94 Encoding and following constraints:
Decoding 11
Public keys, RSA encrypted data and signatures consist of
blocks of 256 bytes.
During the initialisation of the EPP, both encrypted keys and
signatures must be exchanged with the HSM in the host.
Only graphic characters can be transmitted, as the control
characters are used for the communications protocol and
message formatting.
Currently, NDC uses hexadecimal or decimal encoding to transmit
binary data. However, hexadecimal encoding doubles the number
of bytes, and decimal encoding triples the number of bytes. Clearly,
given the block size and the message length constraints, neither
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-30 APTRA™ Advance NDC, Reference Manual
Security Features
RSA Initial Key Loading for Signatures
encoding method is suitable for RSA blocks; a new encoding
method is required.
There are 94 graphic characters which can be included in the fields
of an NDC message. These have ASCII codes in the range 20
hexadecimal (space) to 7E (tilde). Using these characters, it is
possible to perform a base 94 encoding, which is far more efficient
than a base 16 or base 10 encoding.
Unlike decimal or hexadecimal encoding, the result is unreadable.
However, the original encrypted block was already unreadable, so
this makes no difference.
The following base 94 encoding scheme gives a ratio for encoded
bytes to binary bytes of 5 to 4. Thus a 256 byte RSA block can be
transmitted in 320 bytes.
Encoding 11
In base 94 encoding, 256 bytes of source data are encoded into 320
bytes of encoded data. Every four bytes of binary data become five
characters of encoded data.
The base 94 encoding process is as follows:
1 Take each set of four bytes of source data (src_data) and form a
32‐bit word (acc), such that the first byte (src_data [0])
becomes the least significant byte of acc. See Note 1:
acc = 0
for i = 0 to 3
{
acc = acc * 256 + src_data [3 - i]
}
2 Convert acc into five base 94 digits, by dividing by 94 and
taking the modulus. To shift each digit into the usable character
range, add 32 (ASCII space). Save the digits in the encoded data.
The first digit is the least significant.
for i = 0 to 4
{
enc_data [i] = acc % 94 + 32
acc = acc / 94
}
Note 1: The ordering of bytes is selected so that the conversion
between a 32‐bit word and four bytes of data can be implemented
efficiently on an Intel processor, by forcing the data type rather than
using a loop.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-31
Security Features
RSA Initial Key Loading for Signatures
Note 2: When EBCDIC is used for transmission, the encoding is
still performed using the ASCII character set and then the result is
converted to EBCDIC.
Decoding 11
In base 94 decoding, 320 bytes of encoded data are decoded into 256
bytes of binary data. Every five digits of encoded data become four
bytes of binary data.
The base 94 decoding process is as follows:
1 Take each set of five digits of encoded data (enc_data) and
convert from base 94 to create a 32‐bit word (acc). Each digit is
shifted into the range 0 to 93, by subtracting 32. The first digit is
the least significant.
acc = 0
for i = 0 to 4
{
acc = acc * 94 + enc_data [4 - i] - 32
}
2 Split acc up into four bytes of destination data (dst_data). The
least significant bye of acc becomes dst_data [0].
for i = 0 to 3
{
dst_data [i] = acc % 256
acc = acc / 256
}
After the authentication sequence is performed, the encryption key
Changing the Encryption entry mode can be changed remotely using the following sequence:
Key Entry Mode 11
Figure 11-19
Key Entry Mode Remote Change Host SST
Sequence
EEKC, 'J' - Set Key Entry Mode
EID, '6' - Key Entry Mode
Warning: Changing the key entry mode deletes all the DES keys in the
encryptor.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-32 APTRA™ Advance NDC, Reference Manual
Security Features
RSA Initial Key Loading for Certificates
RSA Initial Key Loading for
Certificates 11
Once the capabilities of the EPP are determined, certificates are
processed as follows:
Exchange certificates
Load a DES Key
Replace a certificate
Primary and secondary keys.
This exchange is used to exchange the public keys of the hosts HSM
Exchange Certificates 11
and the PIN device in the SST. It is very similar to the exchanging of
public keys in the signature system. Where there is a possibility of
multiple certification authorities (CAs) being used, the host can
determine which CA the SST expects by reading the SST’s
certificates, which contain the identity of the CA, before sending its
own. The message sequence is shown on the next page.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-33
Security Features
RSA Initial Key Loading for Certificates
Figure 11-20 Host NDC XFS PIN
Exchange Certificates
EEKC ‘M0’
Send SST encryptor certificate
WFS_CMD_PIN_
GET_CERTIFICATE
EID ‘8’ SST certificate
(SST encryption certificate) SST encryption Certificate)
EEKC ‘M1’
Send SST verification certificate
WFS_CMD_PIN_
GET_CERTIFICATE
EID ‘8’ SST certificate
(SST encryption certificate) (SST encryption Certificate)
EEKC ‘L’ Load host certificate
(Host certificate) (Host certificate)
WFS_CMD_
LOAD_CERTIFICATE
EID ‘7’ RSA KVV
(RSA KVV) (RSA KVV)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-34 APTRA™ Advance NDC, Reference Manual
Security Features
RSA Initial Key Loading for Certificates
The exchange required for loading a symmetric key is more
Load a DES Key for complex than that used with signatures.
Certificates 11
Figure 11-21 Host NDC XFS PIN
Load a Certificate DES Key
EEKC ‘N’ Send SST random number
WFS_CMD_PIN_
START_KEY_EXCHANGE
EID ‘9’ SST Random number
(RSST) (RSST)
EEKC ‘O’ Load A‐key PKCS7 encoded
(Key Load Packet) Key Load Packet)
WFS_CMD_PIN_IMPORT_RSA_
ENCIPHERED_PCKS7_KEY
EID ‘A’ PKCS7 key loaded
(Key Load Acknowledgement Packet)
(Key Load Acknowledgement Packet)
This exchange is unique to the certificate system and is used to
Replace a Certificate 11
replace the certification authority (CA) certificates. There is no
equivalent to this in the signature system.
Figure 11-22 Host NDC XFS PIN
Replace a Certificate
EEKC ‘P’ Replace CA Certificate
(CA Certificate)
WFS_CMD_
PIN_REPLACE_CERTIFICATE
EID ‘7’ RSA KVV
(RSA KVV) (RSA KVV)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-35
Security Features
RSA Initial Key Loading for Certificates
The certificate scheme supports primary and secondary sets of keys.
Primary and Secondary If the primary keys are compromised, the EPP can be switched to
Keys 11
use the secondary keys. The switch‐over is accomplished through
the host sending the EPP an instruction to use the secondary keys.
Data embedded in the PKCS#7 packet from the host indicates when
the EPP is to switch to using its secondary keys.
Once the secondary keys have been activated, it is not possible to go
back to using the primary keys. If the secondary keys are
compromised, this has to be resolved according to the
recommendations of the EPP manufacturer.
The Encryptor Capabilities returned in EID ʹBʹ indicate whether the
primary of secondary keys are in use.
The certificates returned in response to the Send SST Certificates
EEKC ʹMʹ will be either primary or secondary depending on the
state of the EPP.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-36 APTRA™ Advance NDC, Reference Manual
Security Features
Double-Length Keys
Double‐Length Keys 11
For greater security, NCR recommends that double‐length keys are
used. For effective PIN and encryption key management, the
following general and Advance NDC specific guidelines should be
followed:
The following general security guidelines should be applied:
General Guidelines 11
To protect sensitive information, all DES keys should be double
length to support triple DES encryption. Keys used for PIN
block encryption can still be single length.
PINs and encryption keys should be triple DES encrypted when
outside the SST’s security module.
Keys should not have multiple uses. For example, the key used
to protect other keys during transfer should not be used for
transferring PIN blocks or for local PIN verification.
Initial keys should be loaded or entered directly into the
encryptor module in two or more full‐length blocks, and then
XORed together to create the key.
MACing should be used to prevent modification of sensitive
data during transmission.
Advance NDC supports the Encrypting PIN Pad (EPP) and
Advance NDC Guidelines 11
double‐length keys.
The above guidelines can be met by using the following modes of
operation with Advance NDC 2.04 or above with an EPP:
All keys used should be double length, including the master key
(A‐key), communications key (and B‐key), MAC key and VISA
master key.
Use only the master key for loading other encryption keys, and
do not use the master key for any other purpose.
Use the communications key for PIN block encryption and ISO
format 3 PIN block.
Perform MACing in triple DES mode.
Load the initial master key (A‐Key) into the encryptor, and then
use the master key to load all the other required keys. Do not use
the master key as part of the local PIN verification or for PIN
block encryption.
Although all keys used should be double length, it is possible to use
a single length Encrypted PIN Key (PEKEY) provided the PIN block
is also encrypted using the communications key.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-37
Security Features
Double-Length Keys
Single‐length keys can still be used for local PIN verification
schemes.
For strict adherence to the guidelines, no other mode of operation
should be possible. However, for backwards compatibility all
current operations are supported, with a locally configurable option
to restrict the functionality to the recommended modes.
These guidelines can only be fully followed if an EPP is present in
the terminal. The security features provided using a BAPE and an
EPP are listed in “BAPE Security” and “EPP Security” respectively,
earlier in this chapter.
The Key Entry menu, available from Access Menu option 25, can be
‘Double Length Restricted’ used to set the key entry mode to option 4 ‘Double length
Key Entry Mode 11
restricted’.
Note: Only Key A and Key V can be entered locally when using key
mode 4.
This restricted double‐length key entry mode prevents the
following security violations:
Restricted double‐length key entry mode prevents the following
security violations:
Deciphering a new Communications key with the current
Communications key
Deciphering a new Message Authentication Code (MAC) key
with the current Communications key
Using a Communications key as the current MAC key
Sending a PIN block unencrypted
Using single‐length keys, except for PEKEY if the PIN block is
also encrypted using the communications key.
In this key entry mode, any messages from the host which request
these operations are rejected as ‘Message illegal in restricted
encryption mode’.
If an attempt is made to import a key with the same value as the
currently loaded key, the import is rejected with an ‘Encryption key
change failed’ message.
For further details of the menu options, refer to the APTRA Advance
NDC, Supervisor’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-38 APTRA™ Advance NDC, Reference Manual
Security Features
Journal Printer Backup
Journal Printer Backup 11
Journal printer backup lets journalling continue even when the
journal printer is in a fatal state. To set the option, set one or both of
options 16 and 17 in the Enhanced Configuration Parameters Load
message.
Note: Options 16 and 17 are not supported when dual mode is
active on the SST. If the options are sent, they are ignored.
Option 16 specifies the maximum time in hours that journal printer
backup is allowed before all journalling is discontinued. Option 17
specifies the maximum number of print operations (in hundreds) to
be buffered while the journal printer is fatal. For details of how to
set these options, see the “Enhanced Configuration Parameters
Load” on page 10‐17.
If journal printer backup is set and the journal printer enters a fatal
state, journalling continues, using the journal backup mode and the
buffer file resident on the system disk. The journalling includes the
text of the last journal printer command sent to the journal printer
before it entered the fatal state.
For details of what happens to the data when the journal printer
becomes operational again, refer to the APTRA Advance NDC,
Supervisor’s Guide.
For security reasons, reprinting from the journal backup log to the
journal printer is suspended if the SST goes off‐line, but continues as
soon as communications have been re‐established.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 11-39
Security Features
Journal Printer Backup
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
11-40 APTRA™ Advance NDC, Reference Manual
Table of Contents
EMV Smart Card Handling
Chapter 12
EMV Smart Card Handling
Overview 12‐1
Accepting and Reading Cards 12‐2
Motorised Readers 12‐2
DIP Readers 12‐2
Read Conditions and FIT Match 12‐2
Motorised Readers 12‐2
DIP Readers 12‐3
Contactless Card Readers 12‐3
Using EMV/CAM2 Exits for Advance NDC 12‐4
Example Chip Data Read State 12‐6
Guidelines for Handling Smart Card Transactions 12‐6
Magnetic Smart Card, FIT Check on Magnetic Data 12‐7
Magnetic Smart Data, FIT Check on Smart Data 12‐7
Recommendations 12‐8
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
HAVAPTRA™ Advance NDC, Reference Manual
Table of Contents
EMV Smart Card Handling
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
HAVAPTRA™ Advance NDC, Reference Manual
EMV Smart Card HandlingL
Overview
Overview 12
The smart card handling described in this chapter illustrates how
EMV smart cards can be used with Advance NDC.
For further details of using EMV smart cards, refer to the EMV
Integrated Circuit Card (ICC) Reference Manual.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 12-1
EMV Smart Card Handling
Accepting and Reading Cards
Accepting and Reading Cards 12
The process for accepting cards into the reader varies depending the
type of reader, and whether smart cards are supported and required
by the read conditions.
For motorised readers (SDC MCRW, RS232 or USB IMCRW),
Motorised Readers 12
Advance NDC supports non‐magnetic accept, which permits a card
without a magnetic stripe (a smart card) to be inserted into the
reader.
With a DIP reader, there is no control over what type of card is
DIP Readers 12
inserted into the reader. Except for the DASH reader in certain
conditions, the cardholder is expected to dip the card, that is, insert
and remove the card. The card is read as it is removed.
For a DASH reader the card will be latched on entry if the following
conditions are met:
? The state type is ‘T’
? The chip connect bit is set to 1.
Note: If using a DASH reader and state type ‘T’, but no chip
connect bit is set, the DASH will behave as a standard DIP reader.
Once a smart read has been determined, no magnetic read is
performed.
For information on additional fatal/suspend handling available for
DASH readers, refer to the APTRA Advance NDC, Developer’s Guide.
The processing of the read conditions varies, depending on the use
Read Conditions and FIT of the chip connect bit in the read conditions, and on the type of
Match 12
card reader.
If none of the read conditions has the chip connect bit set (or the
reader does not support smart cards) then the processing is the
same for all types of reader. The card read state will process the read
conditions in order and read the required tracks to satisfy them.
If any read condition has the chip connect bit set (and the reader
supports smart cards) then the processing varies between motorised
readers (MCRW or IMCRW) and DIP readers (for example, DASH).
Motorised Readers 12
For motorised readers, the conditions are processed in order until
the first condition which has the chip connect bit set. At this point
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
12-2 APTRA™ Advance NDC, Reference Manual
EMV Smart Card Handling
Accepting and Reading Cards
all remaining tracks that may be required to satisfy the remaining
read conditions are read.
If a smart card is found, the next state will be the No FIT Match next
state. If no smart card is found but one of the read conditions has
been satisfied using magnetic tracks, a FIT search is performed.
Depending on the result of the search, either the FIT Match or No
FIT Match next state number will be used.
If the Smart Chip state is read first, the Magnetic Track Data is never
read and therefore the Smart Chip state (008) should always be the
last state to be defined in the Read Conditions.
DIP Readers 12
For a DIP reader, the magnetic tracks are read on card removal.
If the SST has a DASH card reader, and any of the Card Read
Conditions has the Chip Connect Bit set to 1, the card is latched on
entry to the DASH card reader. Latching the card on entry to the
reader allows EMV processing to begin.
If the Answer To Reset from the chip on the card is successful, the
No FIT Match next state is taken and no magnetic track data will be
available. It is, however, possible to revert to magnetic stripe
processing upon a chip error by using the EMV Smart DIP Take
Card State.
Note: If using a DASH reader and Card Read State A, or Card Read
State T with no chip connect bit set, the DASH will behave as a
standard DIP reader.
If the Answer to Reset from the chip on the card fails, the DASH
card reader will unlatch the card and the cardholder is asked to
remove the card. Once the card is removed, normal magnetic stripe
processing commences and the card read conditions are checked. If
one of the read conditions is satisfied using magnetic tracks, a FIT
search is performed. Depending on the result of the search, either
the FIT Match or No Fit Match next state number will be used.
Contactless Card Readers 12
For contactless smart card readers, if all the magnetic read
conditions fail and the chip connect bit is set, the state will attempt
to match the relevant card data to the FIT data. Depending on the
result of the search either the FIT Match or No FIT Match next state
number will be used. To use contactless smart card readers, the
‘EMV/CAM2 Exits for APTRA Advance NDC’ product must be
installed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 12-3
EMV Smart Card Handling
Using EMV/CAM2 Exits for Advance NDC
Using EMV/CAM2 Exits for Advance
NDC 12
If you are using your own Exits to process smart cards instead of
EMV/CAM2 Exits, the No FIT Match next state has to be a C‐Exit
state with two functions, as follows:
? If a chip has been detected, it reads any chip data and place the
data in the magnetic track buffers before switching to the Smart
FIT Check state.
? If no chip has been detected, or the card failed a magnetic FIT
check within state A, then the No FIT Match state exits, probably
to a Close state.
For details of creating C‐Exit states, refer to the publication APTRA
Advance NDC, Extending the Product.
For details of how a ‘No FIT Match’ next state might work, see
“Example Chip Data Read State” on page 12‐6.
If chip data has been successfully read from the card, and placed
into the magnetic track buffers by the C‐Exit state, the Smart FIT
Check state (‘k’) will perform a FIT check on that data. For details of
this state, see “k ‐ Smart FIT Check State” in Chapter 2, “State
Tables”.
The read state handling is shown in the following illustration.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
12-4 APTRA™ Advance NDC, Reference Manual
EMV Smart Card Handling
Using EMV/CAM2 Exits for Advance NDC
Figure 12-1 Smart Card Handling
Exits Card Read State
Magnetic FIT Chip No chip detected or
Check Passed detected Magnetic FIT check failed
Good Read Next State No FIT Match Next State (C-Exit)
Read smart data and
place in track buffers
Smart FIT Check State ('k') No FIT Match Next State
Smart FIT Smart FIT
Check Passed Perform Smart Check Failed
FIT check
Good Read Next State No FIT Match Next State
Rest of transaction
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 12-5
EMV Smart Card Handling
Using EMV/CAM2 Exits for Advance NDC
This state is an example of a C‐Exit created to allow FIT checks to be
Example Chip Data Read performed on smart data. It would be defined as the No FIT Match
State 12
next state entered from the Card Read state.
The Chip Data Read state has two distinct functions, as follows:
? To handle failed magnetic data FIT checks from within the Card
Read State.
? To read smart card data and place it in the three data buffers
ready for the Smart FIT Check state to perform a FIT check.
The position of the card on entry to the Chip Data Read state will
indicate which function is required.
The state table below shows the recommended parameters for a
Chip Data Read state, but the exact functionality will be determined
by individual customers, according to their needs. Four further
parameters are available if required.
Table 12-1
Chip Data Read State
Table Number of
Contents Description
Entry Characters
1 1 State Type This should be a letter chosen from those available
for C‐Exit States. For a list of state types, see
Chapter 2, “State Tables”.
2 3 Good Chip Read Next State State to which the terminal proceeds if chip data is
successfully read and the track buffers are set up.
This should normally be a Smart FIT Check State.
3 3 Card Reject Next State State to which the terminal proceeds if either a card
has failed a magnetic card FIT check carried out in
State A, or read conditions had the chip connect bit
set but no chip could be found.
4 3 No Card Data Next State State to which the terminal proceeds if the accept
command was for non‐magnetic cards, and no chip
data or magnetic data was found. This state could
indicate to the cardholder that the card has
probably been inserted with the wrong orientation.
5 3 Cancel Next State Number State to which the terminal proceeds if the
cardholder presses the Cancel key.
This section provides recommendations and guidelines on how to
Guidelines for Handling handle some of the possible transactions involving smart cards.
Smart Card Transactions 12
Note that the different scenarios will require different values to be
set in Enhanced Configuration Parameters Load option 39
(Non‐magnetic Card Accept). The setting chosen will be determined
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
12-6 APTRA™ Advance NDC, Reference Manual
EMV Smart Card Handling
Using EMV/CAM2 Exits for Advance NDC
by the type of cards to be accepted and whether or not you are
operating an SST network with a mixture of smart and non‐smart
card readers.
Magnetic Smart Card, FIT Check on Magnetic Data 12
This transaction involves a magnetic smart card only. A FIT check is
performed on the magnetic data.
? Card Read State (‘A’ or ‘T’) ‐ cardholder enters a magnetic smart
card, and a FIT check is performed successfully on magnetic
data tracks as defined by the read conditions.
? PIN Entry State (‘B’) ‐ cardholder enters PIN, which is verified.
? FDK Selection State (‘E’ or ‘Y’) ‐ cardholder selects to do a smart
card transaction.
? Smart Card Transaction State (a user‐defined C‐Exit state) ‐ the
smart card is staged and, if a chip is detected, a menu of smart
card transaction options is displayed. Further Advance NDC
and C‐Exit states may then be executed. See Note below.
? Close State (‘J’) ‐ card is returned to the cardholder and the
transaction ends.
Note: Where a smart card is moved to or from the staged position
within a C‐Exit state, it is important to update the shared data
values before returning control of the transaction to Advance NDC.
Magnetic Smart Data, FIT Check on Smart Data 12
This transaction involves a magnetic smart card only. A FIT check is
performed on the smart data.
? Card Read State (‘A’ or ‘T’) ‐ cardholder enters a magnetic smart
card. First read condition has chip connect bit set so magnetic
data is read and then the card is staged in the smart card
position. A chip is successfully detected, and so the next state is
set to a Chip Data Read state.
Note: If using a DASH reader and Card Read State A, or Card
Read State T with no chip connect bit set, the DASH will behave
as a standard DIP reader.
? Chip Data Read State (a user‐defined C‐Exit state) ‐ chip data is
read and placed in the magnetic card read buffers.
? Smart FIT Check State (‘k’) ‐ a FIT check is performed
successfully on the magnetic read buffers.
? PIN Entry State (‘B’) ‐ cardholder enters PIN, which is verified.
? Transaction State ‐ transaction is carried out. Further standard
Advance NDC and C‐Exit states may then be executed. See Note
above.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 12-7
EMV Smart Card Handling
Using EMV/CAM2 Exits for Advance NDC
? Close State (‘J’) ‐ card is returned to the cardholder and the
transaction ends.
Recommendations 12
Do not use non‐magnetic card accept commands unless you have to
handle non‐magnetic smart cards.
During non‐magnetic smart card accept, if no magnetic or chip data
is found, display a screen during the Close state indicating to the
cardholder the correct orientation for entering cards.
Where the same read conditions are to be used on SSTs with a
mixture of magnetic card readers and smart card readers, make sure
that there is at least one magnetic data only read condition in the
Card Read State.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
12-8 APTRA™ Advance NDC, Reference Manual
Table of Contents
CCM VISA2 Dialup System
Chapter 13
CCM VISA2 Dialup System
Overview 13‐1
Dialup System Setup 13‐2
Baud Rate 13‐2
Dialup Timers 13‐2
Modem Timers 13‐2
Application Timers 13‐3
Pre‐Dial and Normal 13‐3
EJ Upload 13‐3
Dialup Messages: SST to Central 13‐4
I’m Alive Message 13‐5
Activity Timer 13‐5
Error Redial Timer 13‐6
Transaction Completion 13‐6
Message on CP 13‐6
Message Suppression 13‐6
Dialup Messages: Central to SST 13‐7
Disconnect Message 13‐7
No‐Op Message 13‐8
Example Usage of the No‐Op Command 13‐9
Go Out of Service (Supervisor Mode) 13‐9
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
CCM VISA2 Dialup System
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
CCM VISA2 Dialup System
M
Overview
Overview 13
With a dialup system, the application behaviour is not always the
same as in other systems. This chapter discusses how messages are
handled on SSTs that use CCM VISA2 dialup communications with
Central.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 13-1
CCM VISA2 Dialup System
Dialup System Setup
Dialup System Setup 13
Dialup functionality is enabled through the registry and configured
through the Dialup Configuration menu in Supervisor.
As SST transaction messages for a transaction session are small in
Baud Rate 13
size and few in number, connecting quickly is more important than
high‐speed data transfer. Therefore, NCR recommends a fixed,
low‐speed baud rate to reduce dialling time and minimize
re‐transmission for error correction.
Timers determine the way that the Dialup component works and
Dialup Timers 13
they must be set to the correct values for it to function correctly.
Modem Timers 13
The lower‐level communications (modem) timers, such as the
Modem Connect timer, the Modem Command Response timer and
the Dial on Send timer, affect the values for the application‐level
timers such as Timer 3, and the Error Redial Timer.
Table 13-1
Modem Timers
Modem Timer Description
Modem Connect The amount of time CCM VISA2 will wait for a connection attempt to a host modem to be
successful before trying to connect again
Modem Command The amount of time CCM VISA2 will wait for a response acknowledgment from the host
Response before trying to send the command response again.
DialonSend When the SST sends a message such as an unsolicited message, an EJ upload, or a
response to terminal command, this is done according to the DialonSend timer.
The dialup connection is maintained until either the DialonSend timer expires or the host
terminates the connection. The duration of this timer should therefore be short, but long
enough to send the longest message and allow time for any host reply. This timer is
configurable through Supervisor. The default is 20 seconds but for systems with long
download messages, such as screen or state messages or EMV systems, this will probably
need to be increased to at least 30 seconds
The modem timers are also affected by the number of times CCM
VISA2 will retry failed connections or unacknowledged messages to
the host. This setting can be configured in Supervisor. The default
setting is 2.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
13-2 APTRA™ Advance NDC, Reference Manual
CCM VISA2 Dialup System
Dialup System Setup
Application Timers 13
The application‐level timers must be configured according to the
modem timers as described in the following table. These
calculations represent the minimum recommended value for these
timers, and they can be increased.
Table 13-2
Application Timer Settings for Dialup
Application
Setting Calculation Description
Timers
Timer 3 (Number of Retries + 1) x (Modem Connect Allows time for modem error processing to be
timer + Modem Command Response completed if a Transaction Request fails to be sent or
timer) a connection fails to be established. The usual value
for this on other systems (about 20‐25 seconds) will
probably not be long enough for a dialup system.
Error (Number of Retries + 1) x (Modem Connect Can be any length of time depending on how often
Redial timer + Modem Command Response retries are required when a line error occurs; but for
Timer timer) the modem link to perform error recovery, it must
never be less than this calculation
Two options are available in Supervisor to configure when the SST
Pre‐Dial and Normal 13
will dial Central, as follows:
? Normal
Dial only when the Transaction Request is ready to be sent. This
is the default.
? Pre‐dial
Dial on card entry.
Normally, EJ upload acknowledgements must be received within
EJ Upload 13
the EJ timer period. For a dialup system, the acknowledgement
must be received within the Dial on Send timer period. NCR advises
that the EJ timer is the same length of time as the Dial on Send timer.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 13-3
CCM VISA2 Dialup System
Dialup Messages: SST to Central
Dialup Messages: SST to Central 13
In a dialup system, messages from the SST to Central always have a
header, with the following format:
Table 13-3
SST Messages Header Format
Number of
Field Type Contents Description
Characters
Device 2 Alpha‐n 50 Modified VISA II protocol.
Type umeric
BIN 7 Alpha‐n xxxxxxx Routing information for communications access;
umeric configurable in Supervisor.
Terminal 12 Alpha‐n xxxxxxxxxxxx Terminal ID, 12‐character sequence comprised of the
ID umeric following:
? Positions 1 to 2: The first 2 characters of the
six‐digit Terminal ID as entered in Supervisor
(Dialup Config menu)
? Positions 3 to 8: six‐digit machine number as
entered in Supervisor (Configure menu)
? Positions 9 to 12: Characters 3 to 6 of the
six‐character Terminal ID as entered in Supervisor
(Dialup Config menu).
FS 1 Byte 1Ch Field separator.
Message RQ or EQ Transaction request message.
Type See Table Note 1
CP or EP Communication Complete. Used with a solicited
See Table Note 1 status Ready message to complete a normal
transaction (withdrawal, balance, transfer) and
disconnect. Also used in a status response to a new
operational command with a ʹdisconnectʹ command
code.
CC or EC Connect Continuation. Used to maintain a connection
See Table Note 1 with the host when the current sequence of messages
is not complete; for example, with unsolicited status
messages, or with a response to a Write Command
(OAR or down loading).
Message var. Alpha‐n SST text message. See Table Note 2.
Text umeric
Table Note 1: When the system is configured to send a transaction
completion message to Central, ‘RQ’, ‘CC’ and ‘CP’ are used; when
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
13-4 APTRA™ Advance NDC, Reference Manual
CCM VISA2 Dialup System
Dialup Messages: SST to Central
it is not configured to send a completion message to Central, ‘EQ’,
‘EC’ and ‘EP’ are used. This allows Central to identify which mode
the SST is operating in.
Table Note 2: Only numeric data can be entered through the
Supervisor menus. For ways of providing alphabetic data, refer to
the APTRA Advance NDC, Developer’s Guide.
The “Iʹm Alive” message is a solicited status message with a status
I’m Alive Message 13
descriptor of ʹFʹ and a message identifier of ʹ6ʹ. This message is sent
as if a network operational command message with a command
code of ʹ3ʹ requesting configuration ID has been received and is
controlled by two timers: the Activity timer and the Error Redial
timer.
Table 13-4
I’m Alive Message Format
Mandatory/
Field Number of Bytes Description
Optional
a Var M Header ‐ Protocol‐dependent.
b 1 M Message Class. The message class is:
‘2’ ‐ Solicited message.
c 1 M Message Sub‐Class. The message sub‐class is:
‘2’ ‐ Status message.
FS 1 M Field Separator.
d 3 or 9 O Logical Unit Number (LUNO). This Number is defined in a
field transmitted to the terminal in a Configuration Parameters
Load message. The default number is 000. If the data security
feature is configured, an additional six characters are present
that contain the machine number.
FS 1 M Field Separator.
FS 1 M Field Separator.
f 1 M Status Descriptor. Describes the status message as follows:
‘F’ Terminal State.
FS 1 M Field Separator.
g Var M Status information.
Activity Timer 13
The Activity timer determines the length of time to wait before
sending an Iʹm Alive message. The timer is started on disconnection
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 13-5
CCM VISA2 Dialup System
Dialup Messages: SST to Central
of the line to Central and stopped on connection. If the timer
expires, the SST attempts to establish a connection. If the attempt
succeeds, an “I’m Alive” message is sent. The timer is configurable
through the Dialup Config menu in Supervisor.
Error Redial Timer 13
When an error is encountered on the line, the SST goes off‐line for
the period of the Error Redial timer, after which it dials up and
attempts to send an Iʹm Alive message. If the attempt succeeds, the
SST will go in‐service. If the attempt fails, the SST remains off‐line
and restarts the timer. The timer is configurable through the Dialup
Config menu in Supervisor.
Normally, an SST responds to a transaction reply with a Ready
Transaction Completion 13
message. In a dialup system, the default behaviour is for a Ready
message to trigger a disconnection. However, Transaction
Completion can be disabled through Supervisor. In this case,
Central will be expected to disconnect as soon as the Transaction
Reply has been acknowledged by the SST and no Ready message
will be sent. A solicited error or reject message will cause the SST to
redial Central.
When a CP message is sent to Central, the connection is normally
Message on CP 13
terminated by Central. However, if Central does not terminate the
connection and Message on CP is enabled, the connection is
maintained after the CP message is sent, for the duration of the CP
Message timer. This allows Central to send any additional messages
such as the NOOP message, and allows the connection to be
maintained over chained transactions. The CP Message timer is
configurable through Supervisor.
Message suppression is disabled by default but can be enabled
Message Suppression 13
through Supervisor. It allows suppression of Alarms and
Supervisor Key Presses messages except for Supervisor Entry and
Exit messages, which are always sent. The suppressed messages
will still be journalled.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
13-6 APTRA™ Advance NDC, Reference Manual
CCM VISA2 Dialup System
Dialup Messages: Central to SST
Dialup Messages: Central to SST 13
Some Central applications send messages with a header in the
following format. The header allows Central to request the SST to
dial when it is idle.
If a header is present on messages from Central, the Host Message
Header option must be enabled through Supervisor (Dialup
configuration menu).
Table 13-5
Central Messages Header Format
Field Number of Characters Type Contents Description
Command 1 Alpha‐n Y A command is pending at Central
Pending umeric
Flag Space No command in pending at Central
Reserved 7 Alpha‐n Spaces Reserved for future use.
umeric
Central can send a terminal command with a command code of ‘F’
Disconnect Message 13
to disconnect the line. When the SST sends a message to Central and
Central does not have any messages to send to the SST, Central will
send the disconnect command to the SST. If the SST has another
message to send to the host, that message will be sent. If the SST
does not have any other messages to send when the disconnect
comment is received, the SST will send a Ready message to trigger
disconnection.
Table 13-6
Disconnect Message Format
Mandatory
Field Number of Bytes Description
/Optional
a Var M Header ‐ Protocol‐dependent.
b 1 M Message Class. The message class is:
‘1’ ‐ Terminal Command.
FS 1 M Field Separator.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 13-7
CCM VISA2 Dialup System
Dialup Messages: Central to SST
Mandatory
Field Number of Bytes Description
/Optional
d 3 or 9 O Logical Unit Number (LUNO). This Number is defined in a
field transmitted to the terminal in a Configuration Parameters
Load message. The default number is 000. If the data security
feature is configured, an additional six characters are present
that contain the machine number.
FS 1 M Field Separator.
FS 1 M Field Separator.
f 1 M Command code. One character field used to identify the type of
Terminal Command code. The code used in this field is:
‘F’ Disconnect.
The No‐Op terminal command, with a command code ʹGʹ, can
No‐Op Message 13
optionally be sent to the SST. This command can be used to transfer
control of the line back to the SST after a CP or EP/Ready message,
and retain the connection. No message is sent in response to this
command.
Table 13-7
No-Op Message Format
Mandatory/
Field Number of Bytes Description
Optional
a Var M Header ‐ Protocol‐dependent.
b 1 M Message Class. The message class is:
‘1’ Terminal Command.
FS 1 M Field Separator.
d 3 or 9 O Logical Unit Number (LUNO). This Number is defined in a
field transmitted to the terminal in a Configuration Parameters
Load Message. The default number is 000. If the data security
feature is configured, an additional six characters are present
containing the machine number.
FS 1 M Field Separator.
FS 1 M Field Separator.
f 1 M Command code. One character field used to identify the type of
Terminal Command code. The code used in this field is:
‘G’ Maintain connection to complete transaction (No‐Op).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
13-8 APTRA™ Advance NDC, Reference Manual
CCM VISA2 Dialup System
Dialup Messages: Central to SST
Example Usage of the No‐Op Command 13
One example of this use is where a customer transaction requires
two request/reply completion transmissions in order to complete
the transaction. The No‐Op command sent after the first completion
allows the second request to be sent without the SST hanging up
and redialling. Message on CP must be enabled through Supervisor
to allow a message to be sent after the CP message.
If the host sends a Go Out of Service command to the SST while the
Go Out of Service SST is in Supervisor mode, the SST will send a Ready message
(Supervisor Mode) 13
immediately. This is different from a leased‐line system, where the
command is queued at the SST and not processed until the SST exits
Supervisor mode.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual 13-9
CCM VISA2 Dialup System
Dialup Messages: Central to SST
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
13-10 APTRA™ Advance NDC, Reference Manual
Table of Contents
Reserved Screens
Appendix A
Reserved Screens
Overview A‐1
Screen Content A‐1
Dynamic Text A‐1
Variable Print Data A‐1
Understanding the Tables A‐1
Screens with an Asterisk A‐2
Screens with a Lower‐case Letter A‐2
‘A’ Supervisor Acknowledgements A‐3
‘E’ Error Screens A‐5
‘I’ Supervisor Information A‐18
‘M’ and ‘m’ Supervisor Menus A‐25
‘P’ Supervisor Prompts A‐43
‘S’ Supervisor Information Lines A‐49
‘T’ and ‘t’ Journal Trace Information A‐53
‘U’ Cheque, EMV Smart Card and BNA A‐63
‘d’ Supervisor Diagnostic Screens A‐70
‘i’ Supervisor TCP/IP A‐72
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Reserved Screens
‘i’ Supervisor Dialup A‐75
‘i’ Supervisor BNA A‐88
‘i’ Supervisor Settlement Screens A‐92
‘j’ Supervisor and Journal Miscellaneous Screens A‐95
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Reserved Screens
A
Overview
Overview A
The tables in this appendix illustrate the default text for the
Supervisor menu screens, and the other reserved screens not
covered in Chapter 3, “Screen Data”. For all the reserved screens,
refer to the resrvd.def file provided with Advance NDC.
Some screens contain long control sequences as well as screen text,
Screen Content A
for example, screen M06. The meaning of the control is explained in
the table, instead of the control itself, which you can see in resrvd.def.
Other screens have printer control sequences, for example, M15. For
these, the ASCII text equivalent is shown in the table, with an
explanation of what the control does.
Dynamic Text A
In resrvd.def, the percent sign (%) is often used to indicate the start of
text that is dynamically edited before the screen is displayed or
printed. For screens that have such data, the % character acts as a
placeholder and must be left in place if you edit or localise the text.
The data is displayed without padding. In this appendix, the
percent sign is used in the tables to show the start and extent of the
space used by the dynamically edited data.
Variable Print Data A
Some of the screens, for example U0168 (see page A‐68), display
data from .NET data records, which consist of field name/value
pairs and are mapped to screen numbers.
For each of these screens in resrvd.def, the field names are
represented as text with a trailing percent sign (%) inside angle
brackets. The text has no spaces and when the screen is displayed on
the SST, the text and percent sign are replaced by the variable data,
which is displayed without padding. The extent of the variable data
is not indicated in the tables as the data length is unknown.
For screens that use this convention, the field name and percent sign
act as a placeholder and must be left in place. If you edit or localise
the text, NCR recommends that you carry out usability acceptance
testing to check the data is correctly formatted.
For each reserved screen, the tables identify the screen number and
Understanding the Tables A
the position of the text within the screen data (this is not necessarily
the final position displayed on the cardholder screen/enhanced
operator interface). Text position is displayed by the row and
column positions for each screen, starting from row 1, column 1 in
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-1
Reserved Screens
Overview
the top left corner. Operator screens are 16 rows by 32 columns and
printer screens are 16 by 40.
Screens with an Asterisk A
Screens with an asterisk (*) after the screen number indicate the
screens are used only on other vendors’ SSTs. For more information,
refer to the APTRA Advance NDC, Multi‐Vendor Support Reference
Manual.
Screens with a Lower‐case Letter A
Screens starting with a lower‐case letter apply to functionality
developed for Advance NDC and are placed after screens starting
with an upper‐case letter.
Additional Supervisor menus and functions for TCP/IP and Dialup
communications, cash acceptors and Supervisor settlement
transactions start with a lower‐case ‘i’. Further screens used in
Supervisor and for journaling start with a lower case ‘j’, and are
grouped at the end of the appendix.
Note: Sideways printing on the receipt is not supported when
printing Supervisor reserved screens.
For information on the screens used in Supervisor mode and for
journaling, refer to the APTRA Advance NDC, Supervisor’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-2 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘A’ Supervisor Acknowledgements
‘A’ Supervisor Acknowledgements A
‘A’ screens include acknowledgement lines for the cardholder and
enhanced operator (EOP) interfaces.
For details, refer to the APTRA Advance NDC, Supervisor’s Guide.
Table A‐1 Column Position
Supervisor Acknowledgement Screens Screen Row
Number Position 1 2 3
12345678901234567890123456789012
Acknowledgement Lines
A00‐A0 Reserved
3
A04 1 SUPPLY STATE PRINTD
A05 1 ALL COUNTERS PRINTD
A06 1 PRINTER INITIALISED
A07 Reserved
A08 1 CONFIG PRINTED
A09 1 KEY A ENTERED
A10 1 KEY A STORED CHKSUM =
A11 1 KEY B ENTERED
A12 1 KEY B STORED CHKSUM =
A13 Reserved
A14 1 KEY V ENTERED
A15 1 KEY V STORED
A16 Reserved
A17 1 ACCESS DATA PRINTED
A18 1 ACCESS SET
A19 1 DEFAULT SET
A20 1 FUNCTION DONE
A21 1 FUNCTION CANCELLED
A22 1 E/JOURNAL ACTIVE
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-3
Reserved Screens
‘A’ Supervisor Acknowledgements
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
A23 1 EJ LOG COPIED OK
A24 ‐ Reserved
A40
A41 1 COIN COUNTS CLEARED
A42 Reserved
A43 1 ENVELOPE TAKEN
A44 1 CAMERA INITIALISED
A45 1 DEPOSIT INITIALISED
A46 1 FUNCTION EXITED
A47– Reserved
A51
A52 1 EJ LOG RECOPIED OK
A53– Reserved
A60
A61 1 EJ & JOURNAL ACTIVE
A62 – Reserved
A69
A70 1 KEY A STORED
A71 1 KEY B STORED
A72– Reserved
A88
A89 1 KEY LOADED
A90 1 SILENTDEBUG STARTED
A91 1 SILENTDEBUG STOPPED
A92 1 SILENTDEBUG LOGS DELETED
A93 1 SILENTDEBUG LOGS COPIED
A94 1 SILENTDEBUG CONFIGURED
A95 1 STARTED
A96 1 STOPPED
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-4 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘E’ Error Screens
‘E’ Error Screens A
‘E’ or ‘e’ screens are error messages that appear on the cardholder
screen or enhanced operator interface.
For details, see the APTRA Advance NDC, Supervisor’s Guide.
Note: The Exxxx screens for passbook printers are shown on the
fault display independently of the presence of passbook authored
flows. If a passbook printer is attached, the fault display shows any
passbook device errors.
Table A-2 Column Position
Error Screens Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E0000 1 EC00
E0001 1 EC01
E0002 1 EC02
E0003 1 EC03
E0004 1 ILLEGAL EKC KEYSPCE (not supported)
E0005 1 NO HALLMARK KEY (not supported)
E0006– Reserved
E0009
E0010 1 NO DISK IN DRIVE
E0011 1 FLOPPY PROTECTED
E0012‐ Reserved
E0015
E0016 1 EJ NOT PRESENT
E0017 Reserved
E0018 1 TOO MANY DIGITS
E0019 1 NOT ENOUGH DIGITS
E0020 1 INVALID VALUE
E0021 Reserved
E0022 1 DEVICE NOT PRESENT
E0023 1 DISK I/O ERROR
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-5
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E0024 Reserved
E0025 1 COMMAND NOT ALLOWED
E0026 1 COINS EXCEED LIMIT OF 65534
E0027‐ Reserved
E0031
E0032 1 CAMERA FAILURE (not supported)
E0033 1 INVALID MEI OPTION
E0034– Reserved
E0035
E0036 1 FILE ALREADY EXISTS
E0037 Reserved
E0038 1 EJ BACKUP INVALID
E0039 1 FRONT FEATURE ONLY
E0040 1 DCS FAILURE
E0041 Reserved
E0042 1 LOAD ERROR
E0043– Reserved
E0046
E0047 1 CALL ERROR
E0048 1 JRNL PRNTR PRESENT
E0049 Reserved
E0050 1 NO PART 1 SET
E0051– Reserved
E0052
E0053 1 PART 1 ALREADY SET
E0054 JRNL LEVEL MUST BE <= EJ LEVEL
E0055– Reserved
E0059
E0060 1 CASH IN ERROR
E0061 1 CASH OUT ERROR
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-6 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E0062‐ Reserved
E0069
E0070 1 DRIVE INVALID
E0071‐ Reserved
E0099
E0100 1 INVALID FUNCTION
E0101 1 INVALID SELECTION
E0102 1 INCOMPLETE DATA
E0103 1 INVALID COMBINATION
E0104 1 INITIALISATION FAILURE
E0105 1 NO JOURNAL DEVICE
E0106 1 EJ ALREADY ACTIVE
E0107 1 PAPER JOURNAL ACTIVE
E0108 1 ERROR DURING ACTIVATION
E0109 1 COPY TO DRIVE FAILED
E0110 1 KEY DATA NOT PRESENT
E0111 1 INVALID KEY DATA
E0112 1 FAILED TO STORE KEY V
E0113 1 FAILED TO STORE KEY A
E0114 1 FAILED TO STORE KEY B
E0115 1 NO VALID DATA PRESENT
E0116 1 PRINT FAILURE
E0117 1 EKC TIMEOUT (not supported)
E0118 Reserved
E0119 1 INVALID MODE
E0120– Reserved
E1099
E1100 1 CARD READER
E1101 1 CARD READER ERROR
E1102 1 CARD READER FATAL
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-7
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E1103 1 CARD JAM
E1104 1 CARD POS UNKNOWN
E1105 1 SEC MOD NOT READY
E1106 1 CAPTURE BIN FULL
E1107 1 CAPT BIN FULL SOON
E1108 1 SECONDARY CARD READER
E1109– Reserved
E1199
E1200 1 CASH HANDLER
E1201 1 CASH HANDLER ERROR
E1202 1 CASH HANDLER FATAL
E1203 1 SAFE DOOR OPEN
E1204 1 SAFE DOOR UNLOCKED
E1205 1 SAFE DOOR ERROR
E1206 1 CASH UNITS FATAL
E1207 1 CASH UNITS ERROR
E1208 1 STACKER ERROR
E1209 1 SHUTTER JAMMED
E1210 1 SHUTTER ERROR
E1211 1 PRESENTER ERROR
E1212 1 TRANSPORT FATAL
E1213 1 TRANSPORT ERROR
E1214 1 TOP
E1215 1 SECOND
E1216 1 THIRD
E1217 1 FOURTH
E1218 1 REJECT
E1219 1 ERROR
E1220 1 VALS ERR
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-8 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E1221 1 NOTE ERR
E1222 1 REMOVED
E1223 1 FULL
E1224 1 FULL SOON
E1225 1 LOW
E1226 1 EMPTY
E1227 1 INTERLOCK OPEN
E1228 1 MANIPULATED
E1229 1 FIFTH
E1230– Reserved
E1249
E1250 1 CDM 01
E1251 1 CDM 01 ERROR
E1252 1 CDM 01 FATAL
E1253– Reserved
E1263
E1264 1 C1
E1265 1 C2
E1266 1 CDM 02
E1267 1 CDM 02 ERROR
E1268 1 CDM 02 FATAL
E1269– Reserved
E1299
E1300 1 PINPAD
E1301 1 PINPAD ERROR
E1302 1 PINPAD FATAL
E1303 1 ENC NOT INITIALISED
E1304 1 ENC STATE UNKNOWN
E1305 1 ENC NOT READY
E1306 1 ENC BUSY
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-9
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E1307– Reserved
E1399
E1400 1 RECEIPT PRINTER
E1401 1 JOURNAL PRINTER
E1402 1 RECEIPT ERROR
E1403 1 JOURNAL ERROR
E1404 1 RECEIPT FATAL
E1405 1 JOURNAL FATAL
E1406 1 MEDIA JAMMED
E1407 1 MEDIA NOT PRESENT
E1408 1 PAPER LOW
E1409 1 PAPER OUT
E1410 1 TONER LOW
E1411 1 TONER OUT
E1412 1 INK LOW
E1413 1 INK OUT
E1414 1 LAMP ERROR
E1415 1 RETRACT BIN FULL
E1416 1 PRINTHEAD LOW
E1417 1 PRINTHEAD OUT
E1418 1 KNIFE LOW
E1419 1 KNIFE OUT
E1420 1 STATEMENT PRINTER
E1421 1 STATEMENT ERROR
E1422 1 STATEMENT FATAL
E1423– Reserved
E1429
E1430 1 PASSBOOK
E1431 1 PASSBOOK ERROR
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-10 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E1432 1 PASSBOOK FATAL
E1433– Reserved
E1499
E1500 1 ENV DISPENSER
E1501 1 ENV DEPOSITORY
E1502 1 ENV DISP/DEPOSITORY
E1503 1 ENV DISPENSER ERROR
E1504 1 ENV DEPOSIT ERROR
E1505 1 ENV DISPENSER FATAL
E1506 1 ENV DEPOSIT FATAL
E1507 1 CONTAINER ERROR
E1508 1 CONTAINER MISSING
E1509 1 CONTAINER FULL SOON
E1510 1 CONTAINER FULL
E1511 1 TRANSPORT ERROR
E1512 1 TRANSPORT UNKNOWN
E1513 1 DISPENSER EMPTY
E1514 1 DISPENSER LOW
E1515 1 DISPENSER FULL
E1516 1 DISPENSER ERROR
E1517 1 DISPENSER UNKNOWN
E1518 1 ENV UNIT MISSING
E1519 1 PRINTER ERROR
E1520 1 PRINTER UNKNOWN
E1521 1 SHUTTER OPEN
E1522 1 SHUTTER JAMMED
E1523 1 SHUTTER UNKNOWN
E1524 1 NO DISPENSER
E1525 1 TONER LOW
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-11
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E1526 1 TONER EMPTY
E1527– Reserved
E1599
E1600 1 NIGHT SAFE DEPOSITORY
E1601– Reserved
E1649
E1650 1 COIN DISPENSER
E1651 1 COIN DISPENSER ERROR
E1652 1 COIN DISPENSER FATAL
E1653 1 RACKING ERROR
E1654 1 RACKING OUT
E1655 1 HOPPERS FATAL
E1656 1 HOPPERS ERROR
E1657 1 COIN HOPPER 1
E1658 1 COIN HOPPER 2
E1659 1 COIN HOPPER 3
E1660 1 COIN HOPPER 4
E1661 1 COIN HOPPER 5
E1662 1 COIN HOPPER 6
E1663 1 COIN HOPPER 7
E1664 1 COIN HOPPER 8
E1665 1 GOOD
E1666– Reserved
E1699
E1700 1 BARCODE READER
E1701 1 BARCODE READER FATAL
E1702‐ Reserved
E1709
E1710 1 CHEQUE PROCESSOR
E1711 1 CHEQUE PROCESSOR FATAL
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-12 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E1712‐ Reserved
E1719
E1720 1 POSSIBLE TAMPERING
E1721 1 MEDIA JAMMED
E1722 1 TONER OUT
E1723 1 INK OUT
E1724 1 BIN 1 FULL
E1725 1 BIN 2 FULL
E1726 1 BIN 3 FULL
E1727 1 TONER LOW
E1728 1 INK LOW
E1729 Reserved
E1730 1 BIN 1 REMOVED
E1731 1 BIN 2 REMOVED
E1732 1 BIN 3 REMOVED
E1733 1 BIN 1 FULL SOON
E1734 1 BIN 2 FULL SOON
E1735 1 BIN 3 FULL SOON
E1736‐ Reserved
E1749
E1750 1 CAMERA
E1751 1 CAMERA ERROR
E1752 1 CAMERA FATAL
E1753 1 CAPACITY NEARLY EXHAUSTED
E1754 1 CAPACITY EXHAUSTED
E1755 1 ROOM CAMERA
E1756 1 PERSON CAMERA
E1757 1 EXITSLOT CAMERA
E1758‐ Reserved
E1800
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-13
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E1801 1 COMMUNICATIONS CLOSED
E1802 1 COMMUNICATIONS FATAL
E1803 1 COMMUNICATIONS DOWN
E1804‐ Reserved
E1809
E1810 1 STANDARD AUDIO FATAL
E1811 1 ENHANCED AUDIO FATAL
E1812‐ Reserved
E1900
E1901 1 POSSIBLE TAMPERING
E1902 1 POSSIBLE JAM
E1903 1 NUMBER OF FAULTS = %
E1904 1 <PRESS CANCEL TO EXIT>
E1905‐ Reserved
E1908
E1909 1 HARDWARE ERROR
E1910 1 CARDLESS ALREADY %%%%%%%%
E1911 1 SET NEXT STATE NUMBER FIRST
E1912‐ Reserved
E1999
E2000 1 BUNCH NOTE ACCEPTOR
E2001 1 CASSETTE 1
E2002 1 CASSETTE 2
E2003 1 CASSETTE 3
E2004 1 CASSETTE 4
E2005 1 REJECT BIN
E2006 1 REMOVED
E2007 1 FULL
E2008 1 FULL SOON
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-14 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E2009 1 ROUTINE
E2010 1 WARNING
E2011 1 SUSPEND
E2012 1 FATAL
E2013 1 RETRACT BIN
E2014 1 COUNTERFEIT BIN
E2015 1 INSERTED
E2016 1 RCNL LIST EMPTY - CNTRS CLEARED
E2017 1 CASSETTE 5
E2100 1 UNKNOWN ERROR
E2101 1 INVALID USERNAME / PASSWORD
E2102 1 ROLE INFORMATION UNAVAILABLE
E2103 1 INCORRECT USER ROLE
E2104 1 INVALID MACHINE ACCOUNT
E2105 1 ERROR PASSWORD EXPIRED
E2106 1 ERROR ACCOUNT DISABLED
E2107 1 INCORRECT LOGON TYPE
E2108 1 FIRST LOGON INVALID PASSWORD
E2109 1 ACCOUNT LOCKED OUT
E2110 1 NO USERNAME/PASSWORD SUPPLIED
E2111 1 PASSWORD CHANGE DENIED
E2112 1 INTERNAL ERROR
E2113 1 INVALID NEW PASSWORD
E2114 1 INVALID PASSWORD COMPLEXITY
E2115 1 INVALID SUPPLIED USERNAME
E2116 1 PASSWORD HISTORY TOO RECENT
E2117 1 DEVICE OFFLINE
E2130 1 REJECT BIN 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-15
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
E2131 1 REJECT BIN 2
E2132 1 MALFUNCTION
E2133 1 INTERNAL/PORT ERROR
E2134 1 UNRESPONSIVE
E2135 1 FIRMWARE MISMATCH
e00 1 NOT CONFIGURED
e01 1 BIN NOT PRESENT
e02 1 FAILED TO CREATE CHECKSUM
e03 1 FAILED TO UPDATE CURRENCY
e04 1 FAILED TO UPDATE THRESHOLD
e05 1 DUPLICATE ENTRY - CASS % & %
e06* 1 FAILED TO UPDATE CONFIGURATION
e07* 1 FAILED TO CALIBRATE CASSETTE
e08 1
2 UNKNOWN OR SAME ORIENTATION
3
4 PRESS ENTER TO INSERT NOTE
5 OR CANCEL TO EXIT FUNCTION
e09 1 EJ UPLOAD MAY BE IN PROGRESS
2 PRESS 1- CONTINUE 0-CANCEL
e10 1 INVALID, EJ MODE IS STANDARD
e11 1 INVALID;MAX POSSIBLE VALUE=%
e12 1 INSUFFICIENT HARD DISK SPACE
e13 1 FAILED TO OVERWRITE IN CDRW
e15 1 XML FILE ERROR
e16 1 FILE NOT FOUND
e17 1 SCHEDULED INIT NOT CONFIGURED
e18 1 INVALID PSWD (MIN 4,MAX 20 CHARS)
e19 1 AUTO INIT COPY DRIVE FAILED
e20 1 NO DRIVES AVAILABLE
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-16 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘E’ Error Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
e21 1 CHECKSUM FAILED
e22 1 COMPRESSION FAILED
e23 1 AUTO INIT COPY DRIVE NOT CONFIGURED
e24 1 SILENTDEBUG NOT STARTED
e25 1 SILENTDEBUG NOT STOPPED
e26 1 SILENTDEBUG LOGS NOT DELETED
e27 1 SILENTDEBUG LOGS NOT COPIED
e28 1 NO DRIVES SUITABLE FOR COPY
e29 1 SILENTDEBUG ALREADY STARTED
e30 1 SILENTDEBUG ALREADY STOPPED
e31 1 SILENTDEBUG CONFIG INVALID
e32 1 INVALID:MAX VALUE=%%%%%
e33 1 NO SILENTDEBUG LOGS TO COPY
e34 1 INVALID XML FILE
e35 1 FAILED TO EXECUTE TASK
e36 1 TASK TIMED OUT
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-17
Reserved Screens
‘I’ Supervisor Information
‘I’ Supervisor Information A
‘I’ screens contain the following information:
Encryption keys
Cash and counter displays
Configuration data
Multiple card image selection for rear settlement
EJ log file inspection.
For details, see the APTRA Advance NDC, Supervisor’s Guide.
Table A-3
Supervisor Information Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
I00 1
2
3
4
5
6 ENCRYPTION KEY A
I01 1
2
3
4
5
6 ENCRYPTION KEY B
I02 Reserved
I03 1 % TYPE % TYPE %
2 CASSETTE %%%%% %%%%%
3 +REJECTED %%%%% %%%%%
4 =REMAINING %%%%% %%%%%
5 +DISPENSED %%%%% %%%%%
6 =TOTAL %%%%% %%%%%
7
8 TYPE % TYPE %
9 CASSETTE %%%%% %%%%%
10 +REJECTED %%%%% %%%%%
11 =REMAINING %%%%% %%%%%
12 +DISPENSED %%%%% %%%%%
13 =TOTAL %%%%% %%%%%
14 LAST CLEARED %%/%%/%% %%:%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-18 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘I’ Supervisor Information
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
I04 1
2 CARDS CAPTURED %%%%%
3 LAST CLEARED %%/%%/%% %%:%%
4
5 DEPOSITS MADE %%%%%
6 LAST CLEARED %%/%%/%% %%:%%
7
8 ACTIVITY COUNT = %%%%%%%
I05 1 *SUPPLIES STATUS*
I06 1 *CONFIGURATION DATA*
See ‘M’ and 2 ROLL WIDTH = %% JRNL=%%%%%
‘m’ 3 LEFT COLUMN = %% JRNL LVL=%
Supervisor 4 TRACK 1 TYPE = %%%%%% EJ LVL=%
Menus 5 MESSAGE MODE = %%%%%%%%%%%%%%%%%
6 MACHINE NO = %%%%%%%%%%%%%%%%%
7 DATE = %%/%%/%% TIME = %%:%%:%%
8 COUNT PRNTR = %%%%%%%
9 RESTART MODE = %%%%%%%
10 EJ BKUP=% NO. BKUPS=%%%%
11 VOLUME SST=0 VOLUME JACK=0
12 POWERUP MSG = %%%%%%%%
13 MAX ST LEN = %% RCT TOP MGN = %%
I07 1 *CASH TEST*
I08 1 CURRENT SCREEN = %%%
I09 1
2
3
4
5
6 ENCRYPTION KEY V
I10 1 *ACCESS DATA*
2 INITIAL ENT = %%%%%%
3 INITIAL DISP = %%%%%
4 EXIT MODE = %%%%%%%%%%
5 MAC NUMBER = %%%%%%%%%%%%%%%%
6 A KEY KVV = %%%%%%
7 B KEY KVV = %%%%%%
8 V KEY KVV = %%%%%%
9 COMS KEY KVV = %%%%%%
10 MAC KEY KVV = %%%%%%
Note: Digits in positions 17‐32 of message mode are only displayed if the corresponding digits are entered.
Trailing digits with default ‘0’ values are omitted.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-19
Reserved Screens
‘I’ Supervisor Information
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
I11 1 *HALLMARK VERIFICATION*
2
3
4 HMQ = %%%%%%%%%%%%%%%%%%%%
5 HMA = %%%%%%%%
6 FAV = %%%%%%%%
7 PEC = %
8 IPE = %
9 ROM FIRMWARE = %%%%%%%
10 RAM FIRMWARE = %%%%%%%
11 SERIAL NUMBER = %%%%%%%%
12
13 PRESS <ENT> FOR MENU OR
Note: From Advance NDC 2.06, hallmark verification is not supported.
I12–I14 Reserved
I15 1 PAPER
I16 1 DISK
I17 1 NONE
I18 1
2
3
4
5
6
7 <<A B>>
8
9
10 <<C D>>
11
12
13 <<E F>>
I19 1
2
3
4 <<A B>>
5 CURRENT DIGIT = %
6
7 <<C D>>
8
9
10 <<E F>>
I20 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-20 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘I’ Supervisor Information
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
I21 1 * M/C %%/%%/%% %%:%%:%% *
I22‐I26 Reserved
I27 1 MODULE = 2
I28 Reserved
I29 1
2 1 = SINGLE LENGTH WITHOUT XOR
3 2 = SINGLE LENGTH WITH XOR
4 3 = DOUBLE LENGTH WITH XOR
5 4 = DOUBLE LENGTH WITHOUT XOR
6
7
8 CURRENT MODE = %
9 NEW MODE = %
10
11 CHANGING MODE WILL
12 DESTROY ALL KEYS
I30 1 ENTER SECURE KEY
2 NCR PHYSICAL KEYBOARD LAYOUT
3 +---------------+
4 | 1 | 2 | 3 | A |
5 |---+---+---+---|
6 | 4 | 5 | 6 | B |
7 |---+---+---+---|
8 | 7 | 8 | 9 | C |
9 |---+---+---+---|
10 | D | 0 | E | F |
11 +---------------+
12
13 CURRENT DIGIT =
I31 1 ENTER SECURE KEY
2 PHYSICAL KEYBOARD LAYOUT
3 +-----------------------------+
4 | 1(B) | 2(C) | 3(D) | CLEAR |
5 |-------+------+------+-------|
6 | 4(E) | 5(F) | 6 | CANCEL|
7 |-------+------+------+-------|
8 | 7 | 8 | 9 | ENTER |
9 |-------+------+------+-------|
10 | SHIFT | 0(A) | | |
11 +-----------------------------+
12
13 CURRENT DIGIT =
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-21
Reserved Screens
‘I’ Supervisor Information
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
I32 Reserved
I33 1 *EJ CONFIGURATION DATA*
2
3 JRNL MODE = %
4 EJ MODE = %
5 MAX EJ BACKUPS = %%%%%
6 MULTIPLE DESTINATIONS = %%%%%
7 CUTOVER= %%%%%
8 SCHEDINIT= %%%%% PATTERN=%%%%%%%
9 AGENT = %%%%% SETTLMNT INIT=%
10 AUTOMATIC INIT COPY DRIVE=%%%
11 COMPRESSION=%%%%%
12 PRIVACY PASSWORD=%%%%%%%%
13 EJ FILE SIZE(KB) = %%%%%
14 HOST CONTROL EJ MODE=%%%%%
I34–I35 Reserved
I36 1 *CASH TEST* MODULE = 2
I37 1 *CASH TEST* MODULE = 1
I38 1 SWITCHED ON
I39 1 SWITCHED OFF
I40 1 THE CARD IMAGES PRESENT ARE
2 MARKED WITH X:
3
4 0 1 2 3 4 5 6 7 8 9
5
6 %
7
8
9
10
11
12
13
14
15 SELECT FROM THE LIST ABOVE-
I41 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-22 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘I’ Supervisor Information
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
I42 1
2 COIN DISPENSER
3
4 HOPPER % HOPPER %
5 REMAINING %%%%% %%%%%
6 +DISPENSED %%%%% %%%%%
7 =TOTAL COINS %%%%% %%%%%
8
9 HOPPER % HOPPER %
10 REMAINING %%%%% %%%%%
11 +DISPENSED %%%%% %%%%%
12 =TOTAL COINS %%%%% %%%%%
13 LAST CLEARED %%/%%/%% %%:%%
I43 Reserved
I44 1 *CONFIGURATION DATA*
2 STANDARD COIN COUNTS
3 HOPPER 1= %%%%% HOPPER 2= %%%%%
4 HOPPER 3= %%%%% HOPPER 4= %%%%%
5
6 CARDLESS TRANSACTIONS = %%%%%%%%
7 CARDLESS NEXT STATE NUMBER = %%%
I45 1 *CHECK COIN*
I46–I65 Reserved
I63 1 DUAL
I64‐I65 Reserved
I66 1 *CONFIGURATION DATA*
2 STANDARD COIN COUNTS
3 HOPPER 1= %%%%% HOPPER 2= %%%%%
4 HOPPER 3= %%%%% HOPPER 4= %%%%%
5 HOPPER 5= %%%%% HOPPER 6= %%%%%
6 HOPPER 7= %%%%% HOPPER 8= %%%%%
7
8 CARDLESS TRANSACTIONS = %%%%%%%%
9 CARDLESS NEXT STATE NUMBER = %%%
I67–I69 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-23
Reserved Screens
‘I’ Supervisor Information
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
I70 1
2 CARDS CAPTURED %%%%%
3 LAST CLEARED %%/%%/%% %%:%%
4
5
6
7
8 ACTIVITY COUNT = %%%%%%%
9
I71–I95 Reserved
I96 1
2 KVV VALUE = %%%%
I97 1 SELECT TO ENTER KEY
2 OR CHANGE KEY MODE
3
4 0 ENTER KEY A
5 1 ENTER KEY B
6 2 ENTER KEY V
7
8 9 CHANGE KEY ENTRY MODE
I98 1
2 1 = SINGLE LENGTH WITHOUT XOR
3 2 = SINGLE LENGTH WITH XOR
4
5
6
7
8 CURRENT MODE = %
9 NEW MODE = %
10
11 CHANGING MODE WILL
12 DESTROY ALL KEYS
I99 1
2 3 = DOUBLE LENGTH WITH XOR
3 4 = DOUBLE LENGTH RESTRICTED
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-24 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
‘M’ and ‘m’ Supervisor Menus A
‘M’ and ‘m’ screens contain information on keyboards and the
following menus:
Select
Replenish
Configure
Access
For details of the Supervisor menus, refer to the APTRA Advance
NDC, Supervisor’s Guide.
Note: On the Access menu, option 14 HALLMARK is not
supported in Advance NDC.
.
Table A-4 Column Position
Supervisor Menu Screens
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
M01 1
2 REPLENISH
3
4 0 DISP SPPLY 1 PRNT SPPLY
5 2 DISP CASH 3 DISP CNTRS
6 4 PRNT CNTRS 5 CLR CASH
7 6 CLR CARDS 7 CLR DEPOS
8 8 ADD CASH 9 INIT RECPT
9 10 TEST CASH 12 STD CASH
10 13 INIT STMNT 15 SPVR TRANS
11 18 DISP COINS 19 CLR COINS
12 20 ADD COINS 21 STD COINS
13 99 MORE
M02 1
2 CONFIGURE
3
4 0 DISP CONFIG 1 PRNT CONFIG
5 2 TRACK 1 3 ROLL WIDTH
6 4 MACHINE NO 5 DATE/TIME
7 6 MSG MODE 7 DISP SCRN
8 8 SET PRINT 9 SET CASH
9 10 RST MODE 11 SET DEFAULT
10 12 TRACE ON 13 TRACE OFF
11 14 SET COINS 30 SET JRNL
12 31 VOLUME SST 32 VOLUME JACK
13 33 DISBL JRNL 99 MORE
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-25
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
M03– Reserved
M05
M06 1 STD NON-SUP KEYBOARD NO. 0
2 Sets the standard Transaction Processing
keyboard 0 layout. For details, see “Standard
Keyboard Layouts” in Chapter 4, “Keyboard Data
and Layouts”.
M07 1
2 REPLENISH
3
4 40 INIT EJRNL 41 FILL ENV
5 42 SECURITY CAM 43 INIT DEPOS
6 44 CLR BINS 45 CHECK COIN
7 47 DUMP IMAGES 48 DSP BNA RCNL
8 49 PRN BNA RCNL 50 RCOPY EJRNL
9 51 DIRCT EJ BKP 52 PRN BNA EXCP
10 53 CLR BNA 54 INIT BNA
11 55 CREATE SIGS 56 EXTRACT SIGS
12 58 DSP BNA CNTS 59 PRN BNA CNTS
13 60 PRN BNA TTLS 99 MORE
14
M08 1
2 REPLENISH
3
4 62 RESET CONTACTLESS READER
5 99 MORE
6
7
8
9
10
11
12
13
14
M09 1 ALT NON-SUP KEYBOARD NO. 1
2 Sets the alternative Transaction Processing
keyboard 1 layout. For details, see “Standard
Keyboard Layouts” in Chapter 4, “Keyboard Data
and Layouts”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-26 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
M12 1
2 SELECT
3
4 4 REPLENISH 5 CONFIGURE
5 6 ACCESS 7 DIAGNOSTIC
6 8 TRANSFER 9 EXIT
7 26 FAULT DISPLAY
8 90 MISC FUNCS
M15 ESC[00p ESC(1 ESC)6
Sets the left margin and the primary and
secondary character sets. For details, see “Control
Codes for Special Features” on page 3‐20.
M16 DC2 ESC[00m ESCPi0 ESC\ FF
Sets colours to default, screen blinking off, clears
the screen, sets the cursor to the top left‐hand
corner and resets the display mode to the NDC+
default. For details, see “Control Characters” on
page 3‐16 and “Control Codes for Special
Features” on page 3‐20.
M60 1 %
2 +-----------------------+
3 | 1 | 2 | 3 |
4 | _#() | abc | def |
5 |-------+-------+-------|
6 | 4 | 5 | 6 |
7 | ghi | jkl | mno |
8 |-------+-------+-------|
9 | 7 | 8 | 9 |
10 | pqrs | tuv | wxyz |
11 +-------+-------+-------+
12 | 0 |
13 | -?!@ | CAPS >>
14 +-------+
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-27
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
M61 1 %
2 +-----------------------+
3 | 1 | 2 | 3 |
4 | _#() | ABC | DEF |
5 |-------+-------+-------|
6 | 4 | 5 | 6 |
7 | GHI | JKL | MNO |
8 |-------+-------+-------|
9 | 7 | 8 | 9 |
10 | PQRS | TUV | WXYZ |
11 +-------+-------+-------+
12 | 0 |
13 | -?!@ | CAPS >>
14 +-------+
m00 1 TCP/IP CONFIG
2
3 0 RMT ADDRESS 1 RMT PORT NO
4 2 LCL ADDRESS 3 LCL PORT NO
5 4 CONFIG AS SRV 5 ADVANCED
6 6 DISP TCP/IP 7 PRINT TCP/IP
7 8 PING 9 GATEWAY
8 10 SUBNET MASK 11 DNS ADDRESS
9 12 WINS ADDRESS 13 COMP NAME
10 14 FIREWALL 15 MULTI HOST
11 16 NAMED RMT HOST
12 17 XP KEEP ALIV 18 SSL CONFIG
13 19 DHCP 20 IPV4/IPV6
m01 1
2 ADVANCED TCP/IP CONFIG
3
4 0 MSG FORMAT 1 LEN SIZE
5 2 LEN FORMAT 3 LEN ADJUST
6 4 LEN OFFSET 5 LEN EMBED
7 6 RCV TIMEOUT 7 RETRY TIMER
8 8 KEEP ALIVE 9 RECON CLOSE
9
10
11
12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-28 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m02 1
2 CONFIGURE
3
4 34 EJ OPTIONS 35 JOURNAL LVL
5 37 TCPIP CONFIG 38 DIALUP CONFG
6 39 GBXX CONFIG 44 TROUBLESHOOT
7 45 MAX STATEMENT LENGTH
8 46 SELECT COMMS TYPE
9 47 EXTENDED ADD CASH
10 80 DISP CSH/ACC CONFIG
11 81 PRNT CSH/ACC CONFIG
12 82 BNA CASS CFG
13 84 POWERUP MSG 99 MORE
m03 1
2 ACCESS
3 0 DISP ACCESS 1 PRNT ACCESS
4 2 SET PASSWRD 3 INIT ENTRY
5 4 INIT DISPLY 5 EXIT MODE
6 6 ENTER V 7 WRITE V
7 8 ENTER A 9 WRITE A
8 10 ENTER B 11 WRITE B
9 12 ENTER MAC 13 SET ACCESS
10 14 HALLMARK
11 15 PROMOTE/COPYFILE
12 21 RELATE MENU 25 KEY ENTRY
m04 Reserved
m05 1
2 MISC FUNCS
3
4 0 PRNT CMPNT VERS
5 1 PRNT SCRW VERS
6 2 SOFTWARE UPDATE
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-29
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m06 1
2 ADD CASH
3
4 0 EXCHANGE CASH UNITS
5 1 CONFIGURE CASH UNITS
6 2 CLEAR CASH
7 3 ADD CASH
8 4 CALIBRATE CASH UNITS
9 5 TEST CASH
10
11 6 UPDATE NOTE TYPES
12 7 SET REJECT THRESHOLD
m07 1
2 UPDATE CURRENCY ID
3
4 CURRENT SETTING
5 CASSETTE %
6 CURRENCY = %
7
8 1. %
9 2. %
10 3. %
11 4. %
m08 1
2 UPDATE MEDIA TYPE
3
4 CURRENT SETTING
5 CASSETTE %
6 MEDIA = %
7
8 1. CASH (3)
9 2. COUPON/VOUCHER (7)
10 3. DOCUMENT (8)
m09 1
2 UPDATE MEDIA VALUE
3
4 CURRENT SETTING
5 CASSETTE %
6 VALUE = %
m10 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-30 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m11 1
2 UPDATE REJECT BIN
3 THRESHOLD
4
5 CURRENT SETTING
6
7 THRESHOLD = %
m12 1
2 TROUBLESHOOTING
3
4 1 PD INVESTIGATION
5 2 SILENT DEBUG
6 3 RETRIEVE ARCHIVE
m13 1
2 SELECT DRIVE
3
4 %
5 %
6 %
7 %
8 %
9 %
10 %
11
12
m14 1
2 CALIBRATE CASH UNIT
3
4 %
5
6 TO BE CALIBRATED
7 WITH 8 - 12 NOTES
8
m15 1 CALIBRATE CASH UNIT
2
3 1. TOP
4 2. SECOND
5 3. THIRD
6 4. FOURTH
7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-31
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m16 1
2 UPDATE SP CURRENCY ID
3
4 CURRENT SETTING
5 %
6
7 CURRENCY = %
8
9 1. %
10 2. %
11 3. %
12 4. %
13
m17 1
2 UPDATE SP MEDIA VALUE
3
4 CURRENT SETTING
5 %
6
7 VALUE = %
m18 Reserved
m19 1 NOTE SIGNATURES
2
3 ENTER NOTE IN
4 FRONT AND TOP
5 ORIENTATION
m20 1 NOTE SIGNATURES
2
3 ENTER NOTE IN
4 FRONT AND BOTTOM
5 ORIENTATION
m21 1 NOTE SIGNATURES
2
3 ENTER NOTE IN
4 BACK AND TOP
5 ORIENTATION
m22 1 NOTE SIGNATURES
2
3 ENTER NOTE IN
4 BACK AND BOTTOM
5 ORIENTATION
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-32 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m23 1
2 RCOPY
3
4 1 EJ%%%%%%.%%% %%/%%/%%
5 2 EJ%%%%%%.%%% %%/%%/%%
6 3 EJ%%%%%%.%%% %%/%%/%%
7 4 EJ%%%%%%.%%% %%/%%/%%
8 5 EJ%%%%%%.%%% %%/%%/%%
9 6 EJ%%%%%%.%%% %%/%%/%%
10 7 EJ%%%%%%.%%% %%/%%/%%
11 8 EJ%%%%%%.%%% %%/%%/%%
12 9 EJ%%%%%%.%%% %%/%%/%%
13 10 EJ%%%%%%.%%% %%/%%/%%
14
15 SELECT FROM LIST TO COPY:
16 OR PRESS ENTER TO SEARCH:
m24 1 CONFIGURE EJ
2
3 0 DISP EJ CONFIG
4 1 EJ BACKUP MODE
5 2 MAX NO OF BACKUPS
6 3 ENABLE MULTIPLE DESTINATIONS
7 4 AUTO INIT EJ OPTIONS
8 5 COMPRESSION
9 6 MAX FILE SIZE
10 7 DSBL HOST CNTRL OF EJ MODE
11 8 PRIVACY OPTIONS
m25 1
2 CONFIGURE EJ MODE
3
4 0 STANDARD EJ
5 1 MULTIPLE EJ
6
7
8 CURRENT = %
m26 1
2 RCOPY
3
4 1 DISPLAY EJ FILES
5 2 SEARCH EJ BY DATE
6 3 SEARCH EJ BY EXTENSION
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-33
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m28 1
2 SCHEDULED INIT OPTIONS
3
4 1 ENABLE/DISABLE EJ SCHEDULED INIT
5 2 SCHEDULED INIT PATTERN
6
7
8
9
10
11
m29 1
2 SCHEDULED INIT PATTERN
3
4 1 DAILY
5 2 WEEKLY
6 3 MONTHLY
7
8
9
10
11
m30 1
2 PRIVACY OPTIONS
3
4 1 DISABLE EJ PRIVACY
5 2 SET EJ PASSWORD
6
7
8
9
10
11
m31 1 AUTHENTICATION-EJ PRIVACY
2 +--------------+
3 |1ABC|2DEF|3GHI|
4 |----|----|----|
5 |4JKL|5MNO|6PQR|
6 |----|----|----|
7 |7STU|8VWX|9YZ*|
8 +----|----|----+
9 |0(#)|
10 +----+
11
12 %%%%%%%%%%%%%%%%%%%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-34 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m32 1 SET EJ PASSWORD
2 +--------------+
3 |1ABC|2DEF|3GHI|
4 |----|----|----|
5 |4JKL|5MNO|6PQR|
6 |----|----|----|
7 |7STU|8VWX|9YZ*|
8 +----|----|----+
9 |0(#)|
10 +----+
11
12 %%%%%%%%%%%%%%%%%%%%
m33‐ Reserved
m35
m36 1
2 ENTER SEARCH OPTION
3
4 0 ALL ARCHIVES
5 1 LAST 7 DAYS ARCHIVES
6 2 LAST 24 HRS ARCHIVES
7 3 SPECIFY DATE
8
m37 1
2 RETRIEVE ARCHIVE
3
4 0 SEARCH BY FILE
5 1 SEARCH BY GROUP
6 2 ARCHIVE NOW AND EXPORT
7 3 EXPORT CONFIGURED ARCHIVES
8
m38 1
2 PD INVESTIGATION
3
4 1 START INVESTIGATION
5 2 STOP INVESTIGATION
6 3 EXPORT INVESTIGATION
7 4 PAUSE INVESTIGATION
8 5 RESUME INVESTIGATION
9 6 ABANDON INVESTIGATION
10 7 DELETE INVESTIGATION
11 8 IMPORT TEMPLATE
12 9 DELETE TEMPLATE
13 10 INVESTIGATION STATUS
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-35
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m39
2 SILENT DEBUG: %%%%%%%
3
4
1 START
5
2 STOP
6
7 2 RECONFIGURE
8 2 COPY LOGS
9 2 DELETE LOGS
10
11
12
13
14
m40 1
2 SELECT JOURNAL LEVEL
3
4
5 CURRENT JOURNAL LEVEL = %
6 CURRENT EJ LEVEL = %
7
8
9 1 SET JOURNAL AND EJ LEVEL
10 2 SET JOURNAL LEVEL ONLY
11 3 SET EJ LEVEL ONLY
12
13
m41 1
2 REMOTE HOST IP
3
4 1 ADD REMOTE HOST IP
5 2 REMOVE REMOTE HOST IP
6
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-36 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m42 1
2 SSL CONFIG MENU
3 1 KEY RENEGOTIATION INTRVL
4 2 CHECK CRL FOR RECEIVED CERT
5 3 CIPHER SUIT ALGORITHM
6 4 RECEIVED CERT ISSUER
7 5 RECEIVED CERT SUBJECT
8 6 SECURE HANDSHAKE TIMEOUT
9 7 SECURE PROTOCOL TYPE
10 8 SESSION RENEGOT. INTERVAL
11 9 SUPPLIED CERT ID
12 10 SUPPLIED CERT SUB
13 11 CLOSE NOTIFICATION TOKEN
14 12 VALIDATION ON CHAIN POLICY
15
m43 1
2 WINS CONFIG
3
4 1 ENTER PRIMARY WINS
5 2 ENTER SECONDARY WINS
6
m44 1
2 SSL MENU
3
4
5 1 ENBL/DSBL SSL
6 2 CONFIGURE SSL
7
m45 1
2 RETRIEVE CONFIGURED ARCHIVES
3
4 1 EXPORT ALL ARCHIVES
5 2 EXPORT LAST 7 DAYS ARCHIVES
7 3 EXPORT LAST 24 HRS ARCHIVES
7
m46 1
2 CONFIG AS SRV
3
4
5 0 CLIENT
6 1 SERVER
7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-37
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m47 1
2 RELATE MENU
3
4 1 ENABLE/DISABLE RELATE
5
m48 1
2 SOFTWARE UPDATE MENU
3
4 0 RUN EXECUTABLE FILE
5 1 COPY FILES AND RESTART
m49 1
2 MS FIREWALL CONFIG
3
4 1 ENABLE FIREWALL
5 2 DISABLE FIREWALL
6 3 ADD FIREWALL ADV. SETTINGS
7 4 DEL FIREWALL ADV. SETTINGS
8 5 ENABLE ICMP ECHO
9 6 DISABLE ICMP ECHO
10 7 ADD PROGRAM TO EXCEP. LIST
11 8 DELETE PROGRAM FROM EXCEP. LIST
12 9 DISPLAY FIREWALL CONFIG
13 10 PRINT FIREWALL CONFIG
14
m50 1 UPDATE SP CASH UNIT ID
2 CURRENT SETTING
3 %%%%%
4
5 CASH UNIT ID = %%%%%
6
7 1. %%%%%
8 2. %%%%%
9 3. %%%%%
10 4. %%%%%
11 5. %%%%%
12 6. %%%%%
13 7. %%%%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-38 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m51 1 UPDATE CASH UNIT ID VALUE
2 CURRENT SETTINGS
3 CASSETTE %
4 CASH UNIT ID = %%%%%
5
6 0. NOT REQUIRED
7 1. %%%%%
8 2. %%%%%
9 3. %%%%%
10 4. %%%%%
11 5. %%%%%
12 6. %%%%%
13 7. %%%%%
m52 ‐ Reserved
m54
m55 1 * TCP/IP CONFIGURATION DATA *
2 CONFIG SERVER = %
3 REMOTE ADDR = %
4 REMOTE PORT = %
5 LOCAL PORT = %
6 KEEP ALIVE = %
7 RETRY TIMER = %
8 RECON CLOSE = %
9 MSG FORMAT = %
10 LEN SIZE = %
11 LEN FORMAT = %
12 LEN ADJUST = %
13 LEN OFFSET = %
14 LEN EMBED = %
15 RCV TIMEOUT = %
m56 1
2 DNS CONFIG
3
4 1 ENTER PRIMARY DNS
5 2 ENTER SECONDARY DNS
6 3 COPY DNS SUFFIX FROM DISK
7 4 ENTER DNS SUFFIX
8
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-39
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m57 1
2 IPV4/IPV6 MENU
3
4 CURRENT MODE = %%%%
5
6 1 IPV4 ENTRY MODE
7 2 IPV6 ENTRY MODE
8
9
m58‐ Reserved
m59
m60 1
2 AUTO INIT EJ OPTIONS
3
4 1 CUTOVER
5 2 SCHEDULED INIT OPTIONS
6 3 AGENT
7 4 AUTOMATIC INIT COPY DRIVE
8 5 INIT AFTER SETTLEMENT
9
10
11
m61 1 SERVICE
2 ASSIST
m62 1
2 SECURITY CAMERA
3
4 1 TEST CAMERA
5 2 COPY SNAPSHOTS
6 3 DELETE SNAPSHOTS
7
8
9
10
11
12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-40 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m63 1
2 COPY SNAPSHOTS
3
4 SNAPSHOTS ARE AVAILABLE
5 FROM % TO %
6
7
8
9
10
11
12
m64 1 CLEAR CASH
2 SELECT CASH HANDLER TO CLEAR
3 0 CASH HANDLERS 1 AND 2
4 1 CASH HANDLER 1 ONLY
5 2 CASH HANDLER 2 ONLY
m65 1 STD CASH
2 SELECT CASH HANDLER
3 0 CASH HANDLER 1 AND 2
4 1 CASH HANDLER 1 ONLY
5 2 CASH HANDLER 2 ONLY
m66‐ Reserved
m66
m67 1 SELECT COMMS TYPE
2
3 CURRENT COMMS -
4 %
5
6 SELECT NEW COMMS TYPE
7 1 - TCPIP
8 2 - PCCM
9 3 - DIALUP VISA2
10
11 SELECT OPTION -
m68‐ Reserved
m89
m90 1 MV DIAGNOSTICS
m91 1 DEVICE FITNESS
m92 1 0 CLEAR ALL 8 BACK 9 NEXT
m93 1 0 CLEAR ALL
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-41
Reserved Screens
‘M’ and ‘m’ Supervisor Menus
Column Position
Screen Row
1 2 3
Number Position
12345678901234567890123456789012
m94 1 26 FAULT DISPLAY 91 SHUTDOWN
m95 1 THERE ARE NO DEVICES CONFIGURED
m96 1 DEVICE SELF TEST
2
3 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4
5
6 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-42 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘P’ Supervisor Prompts
‘P’ Supervisor Prompts A
‘P’ or ‘p’ screens are prompt lines that appear on the cardholder
screen and enhanced operator interface.
For details, see the APTRA Advance NDC, Supervisor’s Guide.
Table A-5 Column Position
Supervisor Prompts Screens Screen Row
Number Position 1 2 3
12345678901234567890123456789012
P00 1 SELECT FUNCTION-
P01 Reserved
P02 1 ENTER CASSETTE TYPE-
P03 1 ENTER NO. OF NOTES-
P04 1 ENTER TRACK1 FORMAT-
P05 1 ENTER MACHINE NO. -
P06 1 ENTER DATE (YYMMDD) -
P07 1 ENTER TIME (HHMM) -
P08 1 ENTER MSG MODE-
P09 1 ENTER LEFT COLUMN -
P10 1 ENTER NO. OF COLUMNS -
P11 1 ENTER KEY A -
P12 1 ENTER KEY B -
P13 1 ENTER SCREEN NO -
P14 1 ENTER PRINTER -
P15 1 ENTER INITIAL DISPLAY -
P16 1 ENTER INITIAL MENU -
P17 1 ENTER EXIT TYPE -
P18 1 ENTER MAC -
P19 1 ENTER PASSWORD -
P20 1 ENTER NEW PASSWORD -
P21 1 ENTER KEY V -
P22 1 ENTER RESTART MODE -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-43
Reserved Screens
‘P’ Supervisor Prompts
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
P23 1 ENTER HALLMARK QUESTION -
(not supported)
P24 1 PLEASE WAIT FOR HALLMARK
(not supported)
P25 Reserved
P26 1
2 PLEASE SELECT DRIVE
3
4 % %
5 % %
6 % %
7 % %
8 % %
9 % %
10 % %
11 % %
12 % %
13 % %
14
15 SELECT DRIVE
P27‐P33 Reserved
P34 1 PRESS <AUX> FOR HELP
P35 1 PRESS <ENT> FOR MORE
P36 1 ENTER COIN HOPPER
P37 1 ENTER NO. OF COINS
P38 1 PRESS <AUX> TO EXIT HELP MODE
P39‐P41 Reserved
P42 1 SET JOURNAL OPTION -
P43–P52 Reserved
P53 1 KEY -
P54 1 ENTER KEY PART 1 -
P55 1 ENTER KEY PART 2 -
P56 1 CONFIRM KEY PART 1 -
P57 1 6 = CONFIRM NEW MODE -
P58 1 NEW KEY MODE -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-44 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘P’ Supervisor Prompts
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
P59 1 COMPONENT (1,2,3)-
P60–P74 Reserved
P75 1
2
3 PRESS ENTER TO SHUTDOWN ATM
4
5 PRESS CANCEL TO RETURN TO MENU
P76 1 ATM IS SHUTTING DOWN...
P77 1 PLEASE WAIT...
P78 1 RESTART REQUIRED
2
PRESS ENTER TO RESTART ATM
4
5 PRESS CANCEL TO RESTART LATER
P79–P80 Reserved
P81 PLEASE WAIT...
Note: This screen contains control characters and other display data that
must not be edited.
P82 1 CONFIRM KEY PART 2
P83 1 CONFIRM KEY
P84 1 PRESS <ENTER> OR PRESS <CANCEL>
P85 Reserved
P88 1 PLEASE WAIT
2
3
4
5 THIS PROCEDURE MAY TAKE
6 UP TO 5 MINUTES
P89 1 REGISTRY UPDATED
2
3 SELECT GBRU/GBNA CONFIGURATION
4 AGAIN AFTER REBOOTING
5 PRESS ENTER TO CONTINUE
P93 1 CONFIRM PASSWORD -
P94 1 ENTER JOURNAL LEVEL -
P95 ‐P96 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-45
Reserved Screens
‘P’ Supervisor Prompts
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
P97 1
2 TO ENTER DIAGNOSTICS
3
4 SET THE MODE SWITCH TO SUPERVISOR
5
6
7 PRESS CANCEL FOR PREVIOUS MENU
8
9
P98 1 ENTER JOURNAL & EJ LEVEL -
P99 1 ENTER EJ LEVEL -
p00 1 PRESS ENTER EVERY 3 DIGITS -
p01 1 ENTER PORT NO -
p02 1 ENTER NEW CONFIG -
p03 1 ENTER MSG FORMAT -
p04 1 ENTER LEN SIZE -
p05 1 ENTER LEN FORMAT -
p06 1 ENTER LEN ADJUST -
p07 1 ENTER LEN OFFSET -
p08 1 ENTER LEN EMBED -
p09 1 ENTER RCVD TIMEOUT -
p10 1 ENTER RETRY TIMER -
p11 1 ENTER KEEP ALIVE -
p12 1 ENTER RECONN CLS -
p13 1 ENTER GROUP RETRY SZ -
p14 1 ENTER MAXIMUM RETRYS -
p15 1 ENTER GROUP INTERVAL -
p16 1 ENTER RETRY INTERVAL -
p17 1 SELECT BIN -
p18 1 ENTER OFFLINE TIMER -
p19 Reserved
p20* 1 ENTER CURRENCY ID -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-46 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘P’ Supervisor Prompts
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
p21* 1 ENTER MEDIA TYPE -
p22* 1 ENTER MEDIA VALUE -
p23* 1 ENTER NEW THRESHOLD -
p24* 1 PRESS ANY <KEY> TO LOAD
2
3 PRESS <CANCEL> FOR MAIN MENU
p25 1 SELECT CASSETTE POSITION -
p26‐p29 Reserved
p30 1 STANDARD MODE ALREADY ACTIVE
p31 1 ENTER MAX EJ BACKUPS-
p32 Reserved
p33 1 ENTER MAXIMUM STMNT LENGTH-
p34 1 PRESS 1 TO ENABLE/0 TO DISABLE
p35 1 MULTIPLE DESTINATIONS ENABLED
p36 1 MULTIPLE DESTINATIONS DISABLED
p37 1 BACKUP FILES WILL BE DELETED
2 PRESS 1 TO DELETE, 0 TO RETAIN
p38 1 SOME BACKUPS MAY BE DELETED
2 PRESS 1 TO CONTINUE, 0 TO CANCEL
p39 1 SELECT DATE (MMDDYY):
p40 1 SELECT EXTENSION NO:
p41 1 CDM% ENTER CASSETTE TYPE-
p42‐p50 Reserved
p51 1 SET DAY OF THE WEEK-
p52 1 SET DAY OF THE MONTH-
p53 1 ENTER EJ FILE SIZE(KB)-
p54‐p55 Reserved
p56 1 PRESS ENTER TO CONTINUE INIT
2 OR CANCEL TO STOP
p57 1 PRESS ENTER TO DELETE LOGS -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-47
Reserved Screens
‘P’ Supervisor Prompts
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
p58‐p63 Reserved
p64 1 TO EXIT SUPERVISOR
2
3 SET MODE SWITCH TO NORMAL
p65 1 ENTER UNIT ID -
p66 1 PRESS <ENT> TO CONTINUE
p67 1 RESET SUCCESSFUL, CONFIG APPLIED
2
3
4
5 ATM RESTART REQUIRED TO APPLY CHANGES
6
7
8
9
10 TO FINISH PRESS ENTER
p68 11 RESET SUCCESSFUL, CONFIG FAILED
2
3
4
5 ATM RESTART REQUIRED TO APPLY CHANGES
6
7
8
9
10 TO FINISH PRESS ENTER
p69‐p77 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-48 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘S’ Supervisor Information Lines
‘S’ Supervisor Information Lines A
‘S’ or ‘s’ screens contain the following messages:
Media status
Test cash.
For details, see the APTRA Advance NDC, Supervisor’s Guide.
Table A-6 Column Position
Supervisor Information Lines Screens Screen Row
Number Position 1 2 3
12345678901234567890123456789012
S00 1 ALL SUPPLIES GOOD
S01 1 TYPE 1 CASH LOW
S02 1 TYPE 2 CASH LOW
S03 1 TYPE 3 CASH LOW
S04 1 TYPE 4 CASH LOW
S05 1 TYPE 1 CASH EMPTY/MISSING
S06 1 TYPE 2 CASH EMPTY/MISSING
S07 1 TYPE 3 CASH EMPTY/MISSING
S08 1 TYPE 4 CASH EMPTY/MISSING
S09 1 JOURNAL PAPER EXHAUSTED
S10 1 RECEIPT PAPER EXHAUSTED
S11 1 CASH REJECT BIN OVERFILL
S12 1 CARD BIN OVERFILL
S13 1 DEPOSIT BIN OVERFILL
S14 1 NO GOOD CASSETTES
S15 1 TOP CASSETTE GOOD
S16 1 SECOND CASSETTE GOOD
S17 1 THIRD CASSETTE GOOD
S18 1 FOURTH CASSETTE GOOD
S19 1 JOURNAL PAPER LOW
S20 1 RECEIPT PAPER LOW
S21 1 STATEMENT PAPER EXHAUSTED
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-49
Reserved Screens
‘S’ Supervisor Information Lines
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
S22 1 STATEMENT PAPER LOW
S23 1 STATEMENT RIBBON EXHAUSTED
S24 1 STATEMENT RIBBON LOW
S25 1 DISPENSER FAULT
S26 1 NIGHT DEPOSIT OVERFILL
S27 ‐ Reserved
S28
S29 1 RECEIPT CAPTURE BIN OVERFILL
S30 Reserved
S31 1 RECEIPT RIBBON EXHAUSTED
S32 1 RECEIPT RIBBON LOW
S33 1 RECEIPT HEAD EXHAUSTED
S34 1 RECEIPT HEAD LOW
S35 1 RECEIPT KNIFE EXHAUSTED
S36 1 RECEIPT KNIFE LOW
S37 1 JOURNAL RIBBON EXHAUSTED
S38 1 JOURNAL RIBBON LOW
S39 1 JOURNAL HEAD EXHAUSTED
S40 1 JOURNAL HEAD LOW
S41 1 STATEMENT HEAD EXHAUSTED
S42 1 STATEMENT HEAD LOW
S43 1 STATEMENT KNIFE EXHAUSTED
S44 1 STATEMENT KNIFE LOW
S45 1 STATEMENT BIN OVERFILL
S46 1 COIN HOPPER % GOOD
S47 ‐ Reserved
S49
S50 1 COIN HOPPER % JAM
S51 Reserved
‐S53
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-50 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘S’ Supervisor Information Lines
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
S54 1 COIN HOPPER % MISSING
S55 Reserved
‐S57
S58 1 TRANSPORT CHUTE GOOD
S59 1 TRANSPORT CHUTE JAMMED
S60 1 E/JOURNAL LOG FULL
S61 1 E/JOURNAL LOG SPACE LOW
S62 1 CAN'T WRITE TO E/JOURNAL
S63 1 COIN HOPPER % LOW
S64 Reserved
‐S66
S67 1 COIN HOPPER % OUT
S68 ‐ Reserved
S78
S79 1 COIN LOWS NOT SET UP
S80 Reserved
‐S83
S84 1 ENVELOPE DISPENSER LOW
S85 1 ENVELOPE DISPENSER EXHAUSTED
S86 1 CAPACITY NEARLY EXHAUSTED
S87 1 CAPACITY EXHAUSTED
S88‐ Reserved
S96
S97 1 CASH REJECT BIN HIGH
S98 1 CARD CAPTURE BIN HIGH
s00 1 BNA COUNTERFEIT BIN OVERFILL
s01 1 BNA RETRACT BIN MISSING
s02 1 BNA COUNTERFEIT BIN NEARLY FULL
s03 ‐ Reserved
s05
s06 1 TYPE % CASH LOW
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-51
Reserved Screens
‘S’ Supervisor Information Lines
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
s07 1 TYPE % CASH EMPTY/MISSING
s08 ‐ Reserved
s20
s21 1 C1
s22 1 C2
s23 1 ENDORSER RIBBON NEARLY EXHAUSTED
s24 1 ENDORSER RIBBON EXHAUSTED
s25 1 CHEQUE PROCESSOR STAMP INK LOW
s26 1 CHEQUE PROCESSOR STAMP INK EMPTY
s27 1 CHEQUE PROCESSOR BIN % OVERFILL
s28 1 CHEQUE PROCESSOR BIN % NEARLY FULL
s29 1 RECEIPT CAPTURE BIN OVERFILL
s30 1 BNA CASSETTE % OVERFILL
s31 1 BNA CASSETTE % MISSING
s32 1 BNA CASSETTE % NEARLY FULL
s33 1 BNA REJECT BIN OVERFILL
s34 1 BN REJECT BIN MISSING
s35 1 BNA REJECT BIN NEARLY FULL
s36 1 BNA RETRACT BIN OVERFILL
s37 1 BNA RETRACT BIN MISSING
s38 1 BNA RETRACT BIN NEARLY FULL
s40 1 FIFTH CASSETTE GOOD
s41 1 BNA RETRACT BIN % OVERFILL
s42 1 BNA RETRACT BIN % MISSING
s43 1 BNA RETRACT BIN % NEARLY FULL
s44 1 REJECT BIN % OVERFILL
s45 1 REJECT BIN % HIGH
s46 1 RETRACT BIN OVERFILL
s47 1 RETRACT BIN HIGH
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-52 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
‘T’ and ‘t’ Journal Trace Information A
‘T’ and ‘t’ screens contain the following messages:
Envelope serial number
Security trace
Presenter error
Envelope length
Journal reprint.
For details, refer to the APTRA Advance NDC, Supervisor’s Guide.
Table A‐7
Journal Trace Screens
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
T00 1 *ENVELOPE NUMBER = %%%% *
T01 1 CARD BIN REMOVED
T02 1 CARD BIN INSERTED
T03 1 REJECT BIN REMOVED
T04 1 REJECT BIN INSERTED
T05 1 TOP CASSETTE REMOVED
T06 1 TOP CASSETTE INSERTED
T07 1 SECOND CASSETTE REMOVED
T08 1 SECOND CASSETTE INSERTED
T09 1 THIRD CASSETTE REMOVED
T10 1 THIRD CASSETTE INSERTED
T11 1 FOURTH CASSETTE REMOVED
T12 1 FOURTH CASSETTE INSERTED
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-53
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
T13 1 DIAGNOSTIC DISPENSE REPORT
2 CASH HANDLER %
3 NOTES DISPENSED (DELTA)
4 TYPE 1 = %% TYPE 2 = %%
5 TYPE 3 = %% TYPE 4 = %%
6 NOTES REJECTED (DELTA)
7 TYPE 1 = %% TYPE 2 = %%
8 TYPE 3 = %% TYPE 4 = %%
T14 1 POWER-UP/RESET
T15 1 SUPERVISOR MODE ENTRY
T16 1 SUPERVISOR MODE EXIT
T17 1 CASH COUNTS CLEARED
2 CASH DISPENSED
3 TYPE 1 = %%%%% TYPE 2 = %%%%%
4 TYPE 3 = %%%%% TYPE 4 = %%%%%
5
6 CASH REMAINING
7 TYPE 1 = %%%%% TYPE 2 = %%%%%
8 TYPE 3 = %%%%% TYPE 4 = %%%%%
T18 1 CARDS CLEARED = %%%%%
T19 1 DEPOSITS CLEARED = %%%%%
T20 1 CASH ADDED
2 TYPE 1 = %%%%% TYPE 2 = %%%%%
3 TYPE 3 = %%%%% TYPE 4 = %%%%%
T21 1 ENVELOPE NUMBER RESET
T22 1 KEY A STORED
T23 1 KEY B STORED
T24 1 TIME AND DATE SET
T25 1 DEPOSIT BIN REMOVED
T26 1 DEPOSIT BIN INSERTED
T27 1 CARD/DEPOSIT BIN REMOVED
T28 1 CARD/DEPOSIT BIN INSERTED
T29 1 KEY V STORED
T30 1 PRESENTER ERROR
T31 1 PASSWORD CHANGED
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-54 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
T32 1 PASSWORD ERROR
T33 1 ENVELOPE LENGTH ERROR
T34 1 DISK NOT AUTHORISED
T35 1 CARD CAPTURED A/C NO. UNKNOWN
T36 1 CARD CAPTURED A/C %%%%%%%%%%%%%%
T37 1 SST OFF-LINE
T38 1 SST ON-LINE
T39 CARD REMOVED MANUALLY
T40–T42 Reserved
T43 1 EJ STARTED BY OPERATOR
T44 1 EJ LOG INITIALISED OK
T45 1 EJ LOG COPIED OK
T46 1 DUAL STARTED BY OPERATOR
T47 1 **** COMMENCING REPRINT ****
T48 1 **** REPRINT COMPLETED OK ****
T49–T50 Reserved
T51 1 **** REPRINT HALTED ****
T52 1 >>
T53 1 <<
T54 1 **** JOURNAL BACKUP STARTED ****
T55 1 **** JOURNAL LIMIT EXCEEDED ****
T56‐T57 Reserved
T58 1 COIN COUNTS CLEARED
2 COINS DISPENSED
3 HOPPER 1 = %%%%% HOPPER 2 = %%%%%
4 HOPPER 3 = %%%%% HOPPER 4 = %%%%%
5
6 COINS REMAINING
7 HOPPER 1 = %%%%% HOPPER 2 = %%%%%
8 HOPPER 3 = %%%%% HOPPER 4 = %%%%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-55
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
T59 1 COINS ADDED
2 HOPPER 1 = %%%%% HOPPER 2 = %%%%%
3 HOPPER 3 = %%%%% HOPPER 4 = %%%%%
T60 Reserved
T61 1 COIN DISPENSER REMOVED
T62 1 COIN DISPENSER INSERTED
T63 1 COIN HOPPER % REMOVED
T64 1 COIN HOPPER % INSERTED
T65‐T75 Reserved
T76 1 POWER INTERRUPTION DURING
2 DISPENSE
3 NOTES DISPENSED
4 TYPE 1 = %%%%% TYPE 2 = %%%%%
5 TYPE 3 = %%%%% TYPE 4 = %%%%%
6 NOTES REMAINING
7 TYPE 1 = %%%%% TYPE 2 = %%%%%
8 TYPE 3 = %%%%% TYPE 4 = %%%%%
T77–T82 Reserved
T83 1 EJ LOG RECOPIED OK
T84 1 RCOPY LOG FAIL
T86 1 BAD TIMEOUT KBD
T87 1 BAD SUPVSR KBD
T88 1 BAD HEX KBD
T89–T91 Reserved
T92 1 ACCOUNT NOT KNOWN
T93 1 DLL LOAD ERROR
T94 1 DLL CALL ERROR
T95 1 VAULTED NOTES COUNT
t01 1 CHEQUE PROCESSOR CLEARED
t02 1 CPM PCKT 1 CLRD = %%
t03 1 CPM PCKT 2/REJ BIN CLRD = %%
t04 1 CPM PCKT 3 CLRD = %%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-56 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
t05 1 CHEQUE PROCESSOR INITIALISED
t06 1 CHEQUE TRANSPORT CLEARED
t07* 1 CASSETTE % UPDATED
2 CURRENCYID = %
3 MEDIA TYPE = %
4 VALUE = %
5 UNIT ID = %
t08 1 REJECT BIN THESHOLD
2 UPDATED = %
t09 1 FIFTH CASSETTE REMOVED
t10 1 CASH ADDED
2 TYPE 1 = %%%%% TYPE 2 = %%%%%
3 TYPE 3 = %%%%% TYPE 4 = %%%%%
4 TYPE 5 = %%%%% TYPE 6 = %%%%%
5 TYPE 7 = %%%%%
t11 1 CASH COUNTS CLEARED
2 CASH DISPENSED
3 TYPE 1 = %%%%% TYPE 2 = %%%%%
4 TYPE 3 = %%%%% TYPE 4 = %%%%%
5 TYPE 5 = %%%%% TYPE 6 = %%%%%
6 TYPE 7 = %%%%%
7
8 CASH REMAINING
9 TYPE 1 = %%%%% TYPE 2 = %%%%%
10 TYPE 3 = %%%%% TYPE 4 = %%%%%
11 TYPE 5 = %%%%% TYPE 6 = %%%%%
12 TYPE 7 = %%%%%
t12 Reserved
t13 1 DIAGNOSTIC DISPENSE REPORT
2 CASH HANDLER %
3 NOTES DISPENSED (DELTA)
4 TYPE 1 = %% TYPE 2 = %%
5 TYPE 3 = %% TYPE 4 = %%
6 TYPE 5 = %% TYPE 6 = %%
7 TYPE 7 = %%
8 NOTES REJECTED (DELTA)
9 TYPE 1 = %% TYPE 2 = %%
10 TYPE 3 = %% TYPE 4 = %%
11 TYPE 5 = %% TYPE 6 = %%
12 TYPE 7 = %%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-57
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
t14 1 SP UPDATE - NEW VALUE FOR
2 %%%%%%
3 CURRENCYID = %%%
4 VALUE = %%%%%
5 UNITID = %%%%%
t15 1 CARD: %%%%%%%%%%%%%%%%%%%%%
2 DATE %%/%%/%% TIME = %%:%%:%%
t16–t18 Reserved
t19 1 ESCROW FULL
t20 1 NOTE ERROR OCCURRED:REASON:<ErrorReason%>
--<ErrorDescription%>
t21 1 Reserved
t22 1 TRANSACTION START
t23 1 CARDLESS TRANSACTION START
t24 1 PIN ENTERED
t25 1 CARD INSERTED
t26 1 NOTES STACKED
t27 1 CARD TAKEN
t28 1 NOTES PRESENTED %
t29 1 NOTES TAKEN
t30 1 TRANSACTION END
t31 FGRPRINT X CAPTURED
t32 FGRPRINT NOT CAPTURED
t33 1 Reserved
t34 1 CONFIGURE NOTE TYPES FAILED :
2 REASON:%%%-%%%%%%%%%%%%%%%%%%
t35 1 CUTOVER IS %%%%%%%
t36 1 SCHEDULED INIT IS %%%%%%%
t37 1 AGENT IS %%%%%%%
t38 1 COMPRESSION IS %%%%%%%
t39 1 AUTO INIT COPY DRIVE SET TO %
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-58 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
t40 1 ENABLED
t41 1 DISABLED
t42 1 CURRENT EJFILE SIZE(KB)-%%%%%
t43 1 EJ BACKUP MODE %
t44 1 NO OF EJ BACKUPS %%%%%
t45 1 HOST CONTROL EJ MODE IS %%%%%%%%
t46 1 INVALID-AUTO EJ INIT IN PROGRESS
t47 1 DIRECT EJ INIT PERFORMED
t48 1 DAY OF THE MONTH CHANGED TO %%
t49 1 SCHEDULED INIT TIME CHANGED TO %%%%
t50 1 DAILY
t51 1 WEEKLY
t52 1 MONTHLY
t53 1 INIT BY SUPERVISOR
t54 1 DAY OF THE WEEK CHANGED TO %%%
t55–57 Reserved
t58 1 CPM BIN % INSERTED
t59 1 CPM BIN % REMOVED
t60 1 SST IN SERVICE
t61 1 SST OUT OF SERVICE
t62 1 SST IN SUSPEND MODE
t63 1 SST OUT OF SUSPEND MODE
t64 1 TEST PRINT
2 !"%$@#0123456789:;<=>?@ABCDEFGHIJKLMNOPQ
3 STUVWXYZ[\]^abcdefghijklmnopqrstuvwxyz
t65 1 ENV DEPOSITED IN DIAG = %
t66‐t67 Reserved
t68 1 HOST TX TIMEOUT
t69 INPUT:%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-59
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
t70 1 COINS COUNT CLEARED
2 COINS DISPENSED
3 HOPPER 1 = %%%%% HOPPER 2 = %%%%%
4 HOPPER 3 = %%%%% HOPPER 4 = %%%%%
5 HOPPER 5 = %%%%% HOPPER 6 = %%%%%
6 HOPPER 7 = %%%%% HOPPER 8 = %%%%%
7
8 COINS REMAINING
9 HOPPER 1 = %%%%% HOPPER 2 = %%%%%
10 HOPPER 3 = %%%%% HOPPER 4 = %%%%%
11 HOPPER 5 = %%%%% HOPPER 6 = %%%%%
12 HOPPER 7 = %%%%% HOPPER 8 = %%%%%
t71 1 COINS ADDED
2 HOPPER 1 = %%%%% HOPPER 2 = %%%%%
3 HOPPER 3 = %%%%% HOPPER 4 = %%%%%
4 HOPPER 5 = %%%%% HOPPER 6 = %%%%%
5 HOPPER 7 = %%%%% HOPPER 8 = %%%%%
t72 FGRPRINT DATA SENT
t73 1 CONSUMER RESOURCE RELINQUISHED
t74 INIT AFTER SETTLEMENT %
t75 1 POWER INTERRUPTION DURING
2 DISPENSE
3 COINS DISPENSED %%%%%
4 HOPPER 1 = %%%%% HOPPER 2 = %%%%%
5 HOPPER 3 = %%%%% HOPPER 4 = %%%%%
6 HOPPER 5 = %%%%% HOPPER 6 = %%%%%
7 HOPPER 7 = %%%%% HOPPER 8 = %%%%%
8 COINS REMAINING
9 HOPPER 1 = %%%%% HOPPER 2 = %%%%%
10 HOPPER 3 = %%%%% HOPPER 4 = %%%%%
11 HOPPER 5 = %%%%% HOPPER 6 = %%%%%
12 HOPPER 7 = %%%%% HOPPER 8 = %%%%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-60 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
t76 1 POWER INTERRUPTION DURING
2 DISPENSE
3 NOTES DISPENSED %%%%%
4 TYPE 1 = %%%%% TYPE 2 = %%%%%
5 TYPE 3 = %%%%% TYPE 4 = %%%%%
6 TYPE 5 = %%%%% TYPE 6 = %%%%%
7 TYPE 7 = %%%%%
8 NOTES REMAINING
9 TYPE 1 = %%%%% TYPE 2 = %%%%%
10 TYPE 3 = %%%%% TYPE 4 = %%%%%
11 TYPE 5 = %%%%% TYPE 6 = %%%%%
12 TYPE 7 = %%%%%
t77 Reserved
t78 1 CDM 1
t79 1 CDM 2
t80 1 C1
t81 1 C2
t82 1 RESET TO RETRACT AREA SUCCESSFUL
t83 1 RESET TO RETRACT AREA FAILED
t84 1 RESET TO REJECT AREA SUCCESSFUL
t85 1 RESET TO REJECT AREA FAILED
t86 1 CASH DISPENSE ERROR
t87 1 CASH ACCEPT ERROR
t88 <HARDCOPY BACKUP: NO CHEQUE IMAGE>
t89 1 INIT AFTER SETTLEMENT
t90 1 LAST TRANSACTION FLOW
t91 1 FIFTH CASSETTE INSERTED
t92 1 SNAPSHOTS COPIED TO %
t93 1 SNAPSHOTS DELETED
t94 1 EJ PRIVACY IS %
t95 1 BUNCH NOTE ACCEPTOR INITIALISED
t97 1 INIT BY EJ CUTOVER
t98 1 INIT BY EJ AGENT
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-61
Reserved Screens
‘T’ and ‘t’ Journal Trace Information
Column Position
Screen Row
Number Position 1 2 3 4
1234567890123456789012345678901234567890
t99 1 INIT BY EJ SCHEDULED INIT
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-62 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘U’ Cheque, EMV Smart Card and BNA
‘U’ Cheque, EMV Smart Card and
BNA A
The cheque, EMV Smart Card and BNA ‘U’ screens are as follows.
Table A-8 Column Position
Cheque, EMV Smart Card and BNA Screen Row
Screens Number Position 1 2 3
12345678901234567890123456789012345
U0000‐ Reserved
U0056
U0057 1 %%%%%% %%%%%%%%%%%%%%%%%%%%%%
CAPTURED %%/%%/%% %%/%%/%%
U0058 1 CHEQUE CAPTURED
2 TSN: %%%%
3 CARD: %%%%%%%%%%%%%%%%%%%%%%
U0059 1 CHEQUE CAPTURE FAILED
2 TSN: %%%%
3 CARD: %%%%%%%%%%%%%%%%%%%%%%
U0060‐ Reserved
U0066
U0067 1 EXTERNAL AUTHENTICATE: NO ARPC
U0068 1 EXTERNAL AUTHENTICATE: INVALID ARPC
U0069 1 SMART CARD READER NOT PRESENT
U0070 1 CARD INITIALISE ATTEMPT = X
U0071 1 COMPONENT VERSIONS
U0072 1 SCRW VERSION
U0073 1 SMART
U0074 1 **** CARD DETAILS UNKNOWN ****
U0075 1 **** AID NOT SELECTED ****
U0076‐ Reserved
U0079
U0080 1 CHIP NOT ATTEMPTED
U0081 1 ATR RECEIVED T=*
U0082 1 CANDIDATE LIST * APPS
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-63
Reserved Screens
‘U’ Cheque, EMV Smart Card and BNA
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012345
U0083 1 APPLICATION SELECTED
U0084 1 GENAC 1 : *
U0085 1 APP NOT USABLE
U0086 1 PROCESSING * SCRIPT
U0087 1 GENAC 2 : *
U0088 1 CHEQUE EJECT FAILED
2 TSN %
3 CARD: %
U0089‐ Reserved
U0099
U0100 1 BNA CASSETTE COUNTERS
2
3 DENOM %%%%% %%%%%
U0101 1 BNA AMOUNTS PER CASSETTE
2
3 DENOM %%%%% %%%%%
U0102 1 TOTAL AMOUNTS PER DENOM
2
3 DENOM TOTAL
U0103 1 TOTAL AMOUNTS PER CURRENCY
2
3 CURRENCY TOTAL
U0104‐ Reserved
U0105
U0106 1 TOO MANY ITEMS ENTERED
2
3 PRESS ENTER TO INSERT NOTE
4 OR
5 PRESS CANCEL TO EXIT
U0107 1 NO ITEMS ENTERED
2
3 PRESS ENTER TO INSERT NOTE
4 OR
5 PRESS CANCEL TO EXIT
U0108 1 CASHINACTIVE PERFORM INIT BNA
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-64 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘U’ Cheque, EMV Smart Card and BNA
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012345
U0109 1 TIMEOUT OCURRED
2
3 PRESS ENTER TO INSERT NOTE
4 OR
5 PRESS CANCEL TO EXIT
U0110 1 USER ERROR - TRY AGAIN
U0111 1 NOT SUPPORTED BY THIS DEVICE
U0112 1 CREATE SIGS SUCCESSFUL
U0113 1
2 PLEASE REMOVE NOTE
3
U0114 1 DEVICE NOT READY
U0115 1 CASHIN RECOVERY STARTED - %%%%%%%%%%
U0116 1 CASHIN COUNTS MAY BE INACCURATE
U0117 1 CASH IN RECOVERY OK
U0118 1 CASH IN RECOVERY FAILED - %%%%%%%%%%
U0119 1 SERIAL NUMBERS:
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
U0120 1 FAILED SERIAL NUMBER READS: %%%%
U0121 1 BNA CASSETTE RECONFIGURATION STARTED
U0122 1 BNA CASSETTE RECONFIGURATION COMPLETE
U0123 1 BNA CASSETTE RECONFIGURATION ERROR
U0124 FAILED SIGNATURES: CAT2: %%%%%
U0125 1 FAILED SIGNATURES: CAT3: %%%%%
U0126 1 MISRECOGNITION ERROR/NOTES IN REJECT
2 BIN
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-65
Reserved Screens
‘U’ Cheque, EMV Smart Card and BNA
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012345
U0127 1 *<TSN%>*<MessageClass%>*<ESC>(Iw<ESC
>(1*<TransCode%>,
M-<DiagnosticData%>, R-<SuppliesEx%>
2 A/C: <AccountNo%>
3 <Description%>
4 ESC: <EscrowedTotalCount%>
5 <EscrowedCounts%>
6 VAL: <VaultedTotalCount%>
7 <VaultedCounts%
8 REF: <RefundedTotalCount%>
9 <RefundedCounts%>
10 REJECTS:<RejectedTotalCount%>
11 <Cat2TotalCount%>
12 <Cat2Counts%>
13 <Cat3TotalCount%>
14 <Cat3Counts%>
15 <BS>*<ESC>(1
16 <ESC>(S
U0128 1 CASHIN ADD MORE NOTES SELECTED
U0129 1 CLOSE STATE WITH NOTES PRESENT -
2 REFUND
U0130 1 CLOSE STATE WITH NOTES PRESENT -
2 ENCASH
U0131 1 CLOSE STATE WITH NOTES PRESENT -
2 NOTES LEFT IN ESCROW
U0132 Reserved
U0133 1 RETRACT NO: %%%%%, TOT: %%%%% ITEMS:
2 %%%%%
U0134 ESC: %%%%%%%%%%%
%%%%%%%%%%%
VAL: %%%%%%%%%%%
%%%%%%%%%%%
REF: %%%%%%%%%%%
%%%%%%%%%%%
REJECTS: %%%%%%%%%%%
%%%%%%%%%%%
%%%%%%%%%%%
%%%%%%%%%%%
%%%%%%%%%%%
U0135 1 NOTES DETECTED AT EXIT SLOT
U0136 1 INIT BNA STARTED - %%%%%%%%%%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-66 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘U’ Cheque, EMV Smart Card and BNA
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012345
U0137 1 MONEY FOUND
U0138 1 MONEY FOUND (ENCASH AUTHORISED)
U0139 Reserved
U0140 1 CASHIN SUSPEND RECOVERY STARTED
U0141 1 *<ESC>(IW<ESC> (1*?,
M-%<DiagnosticData%>, R-<Supplies%>
2 A/C <AccountNo%>
3 COUNTERFEIT NOTES PRESENT
4 <ESC>(S
U0142 1 *<ESC>(IW<ESC>(1*@,
M-%<DiagnosticData%>, R-<Supplies%>
2 A/C <AccountNo%>
3 SUSPECT NOTES PRESENT
4 <ESC>(S
U0143 1 BNA %%%%%%%%%%%%%%% INSERTED
U0142 1 BNA %%%%%%%%%%%%%%% REMOVED
U0145 1 <ESC>(I *%%%%*1*P*6%%%%%%,M-<ESC>(1
U00146 1 MONEY FOUND (OFFLINE ENCASH)
U0147 ‐ Reserved
U0149
U0150 1 NOTE TYPE MAPPING ERROR
U0151 2 COUNTS MAY BE INACCURATE
U0152 1 CASHIN MESSAGE COUNTERS EXCEEDED
ERROR
U0153 1 CASHIN ECB6 SCREEN CONTINUE SELECTED
U0154 1 CASHIN ECB6 SCREEN CANCEL SELECTED
U0155 1 CASHIN DEPOSIT SELECTED
U0156 1 CASHIN REFUND SELECTED
U0157 1 CASHIN CONFIRMATION SCREEN TIMEOUT
U0158 1 CASHIN ECB6 SCREEN TIMEOUT
U0159 1 CASHIN NOTE INSERTION TIMEOUT
U0160 1 CIM-DEPOSIT COMPLETION FAILED
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-67
Reserved Screens
‘U’ Cheque, EMV Smart Card and BNA
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012345
U0161 1 CIM-DEPOSIT COMPLETED-ITEMS REFUND
2 FAILED
U0162 1 CIM-NO ITEMS TO DEPOSIT
U0163 1 CIM-NO ITEMS TO REFUND
U0164 1 CASHIN NOTE INSERTION CANCELLED
U0165 1 CASHIN NOTE INSERTION TIMEOUT
2 CANCELLED
U0166 CASHIN ADD MORE NOT ENABLED
U0167 1 REJECTED BUNCH ENTRY LIMIT REACHED
U0168 1 DATE/TIME: <DateTime%>
2 TERMINAL ID: <TerminalID%>
3 CARD NO: <ConsumerID%>
4 DEPOSITED:
5 <TxCounts%>
6 CAT2:
7 <Cat2Counts%>
8 CAT3:
910 <Cat3Counts%>
U0169 1 DATE/TIME: <DateTime%>
2 TERMINAL ID: <TerminalID%>
3 CARD NO: <ConsumerID%>
4 REFUNDED:
5 <TxCounts%>
6 CAT2:
7 <Cat2Counts%>
8 CAT3:
9 <Cat3Counts%>
U0170 1 DATE/TIME: <DateTime%>
2 TERMINAL ID: <TerminalID%>
3 CARD NO: <ConsumerID%>
4 REFUND FAILED NOTE COUNTS:
5 <TxCounts%>
6 CAT2:
7 <Cat2Counts%>
8 CAT3:
9 <Cat3Counts%>
U0171 1 NOTES DETECTED IN THE STACKER
U0172 1 RETRACTED TO <RetractArea%>
U0173 1 RETRACT SUCCESS
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-68 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘U’ Cheque, EMV Smart Card and BNA
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012345
U0174 1 RETRACT FAILURE
U0175 1 CAT2 NOTES: <FailedCAT2SNRCount%>
U0176 1 CAT3 NOTES: <FailedCAT3SNRCount%>
U0177 1 CAT4 NOTES: <FailedCAT4SNRCount%>
U0178 1 <CashHandlerOperationType%>
U0179 1 CASH OUT ERROR
2 TEST CASH STARTED FROM INIT BNA
U0180 1 CASH OUT ERROR
2 PERFORMING TEST CASH, PLEASE WAIT
U0181 1 INIT BNA FAILED-CASH OUT ERROR
U0182 1 *<TSN%>*<MessageClass%>*<ESC>(Iw<Esc
>(1*F, M-<DiagnosticData%>,
R-<SuppliesEx%>
2 A/C <AccountNo%>
3 BILLS CAPTURED DURING CASHIN RECOVERY
4 <ESC>(S
U0183‐ Reserved
U0299
U0300 1 TIMEOUT FROM TIMEOUT STATE
U0301 1 CANCEL FROM TIMEOUT STATE
U0302 Reserved
U0303 1 CUSTOMER CANCELLED
U0304 1 CONNECTIONS STATE STARTED
U0305 1 CONNECTIONS STATE COMPLETE–
REASON:<ExitReason>–<Next state
number>
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-69
Reserved Screens
‘d’ Supervisor Diagnostic Screens
‘d’ Supervisor Diagnostic Screens A
The following ‘d’ Supervisor Diagnostic screens are displayed:
Table A-9 Column Position
Supervisor Diagnostic Screens Screen Row
Number Position 1 2 3
12345678901234567890123456789012
d10 1 N/A
d11 1 GOOD
d12 1 ROUTINE
d13 1 WARNING
d14 1 SUSPEND
d15 1 FATAL
d16‐d1 Reserved
9
d20 1 CASH HANDLER 1
d21 1 CASH HANDLER 2
d22 1 COIN DISPENSER
d23 1 CARD READER
d24 1 NOTE ACCEPTOR
d25 1 ENVELOPE DEPOSITORY
d26 1 CHEQUE PROCESSOR
d27 1 PAPER JOURNAL PTR
d28 1 RECEIPT PRINTER
d29 1 STATEMENT PRINTER
d30 1 ENVELOPE DISPENSER
d31 1 ENCRYPTOR
d32 1 NIGHT SAFE
d33 1 BARCODE READER
d34‐d4 Reserved
9
d50 1 TEST TIMED OUT
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-70 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘d’ Supervisor Diagnostic Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
d51 1 TEST FAILED
d52 1 INITIALISING...
d53 1 SELF TEST...
d54 1 TEST COMPLETE
d55‐d5 Reserved
9
d60 1 ENTER CARD OR WAIT FOR TIMEOUT
d61 1 TAKE CARD
d62 1 CAPTURING CARD
d63 1 PRINT TEST
d64 1 DEPOSIT ENVELOPE
d65 1 ENV TEST PRINT
d66 1
2 SELECT
3
4 4 REPLENISH 5 CONFIGURE
5 6 ACCESS 7 DIAGNOSTIC
6 8 TRANSFER 9 EXIT
7 26 FAULT DISPLAY 27 MV DIAG
8 90 MISC FUNCS
d67 1 CASH RECYCLER
d68 1 ENTER CHEQUE
d69 1 TAKE CHEQUE OR
2 WAIT FOR CAPTURE
3 CODELINE =
4 [%]
d70 1 CHEQUE CAPTURE
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-71
Reserved Screens
‘i’ Supervisor TCP/IP
‘i’ Supervisor TCP/IP A
The following ‘i’ Supervisor TCP/IP screens are displayed:
Table A-10 Column Position
Supervisor TCP/IP Screens Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i00 1
2 CURRENT TCP/IP CONFIG
3
4 REMOTE IP ADDRESS:
5
i01 1
2 CURRENT TCP/IP CONFIG
3
4 REMOTE PORT NO:
5
i02 1
2 CURRENT TCP/IP CONFIG
3
4 LOCAL IP ADDRESS:
5
i03 1
2 CURRENT TCP/IP CONFIG
3
4 LOCAL PORT NO:
5
i04 1
2 CURRENT TCP/IP CONFIG
3
4 CONFIG AS SRVR:
5
i05 1
2 CURRENT TCP/IP CONFIG
3
4 MESSAGE FORMAT:
5
i06 1
2 CURRENT TCP/IP CONFIG
3
4 LENGTH SIZE:
5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-72 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor TCP/IP
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i07 1
2 CURRENT TCP/IP CONFIG
3
4 LENGTH FORMAT:
5
i08 1
2 CURRENT TCP/IP CONFIG
3
4 LENGTH ADJUST:
5
i09 1
2 CURRENT TCP/IP CONFIG
3
4 LENGTH OFFSET:
5
i10 1
2 CURRENT TCP/IP CONFIG
3
4 LENGTH EMBED:
5
i11 1
2 CURRENT TCP/IP CONFIG
3
4 RCVD TIMEOUT:
5
i12 1
2 CURRENT TCP/IP CONFIG
3
4 HRTBT INTERVAL:
5
i13 1
2 CURRENT TCP/IP CONFIG
3
4 DWNBT INTERVAL:
5
i14 1
2 CURRENT TCP/IP CONFIG
3
4 MAX ROUNDTRP:
5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-73
Reserved Screens
‘i’ Supervisor TCP/IP
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i15 1
2 CURRENT TCP/IP CONFIG
3
4 RECONN ON CLS:
5
i16 1
2 CURRENT TCP/IP CONFIG
3
4 MAXIMUM RETRYS:
5
i17 1
2 CURRENT TCP/IP CONFIG
3
4 KEEP ALIVE:
5
i18 1
2 CURRENT TCP/IP CONFIG
3
4 RETRY INTERVAL:
5
i29 1
2 CURRENT TCP/IP CONFIG
3
4 RETRY TIMER:
5
i39 1 CONFIGURE SSL
2 OPTIONAL PARAMETERS
3
4 1 ADD
5 2 EDIT
6 3 DELETE
7
i41 1 CONFIGURE SSL
2 OPTIONAL PARAMETERS
3
4
5 1 ADD/EDIT
6 2 DELETE
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-74 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor Dialup
‘i’ Supervisor Dialup A
The following ‘i’ Supervisor Dialup screens are displayed:
Table A-11 Column Position
Supervisor Dialup Screens Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i46 1
2 NETWORK ADDRESS
3
4 1 N/A OPTION 2 N/A DLY TMR
5 3 N/A RSP TMR 4 N/A STRING
i47 1 CHOOSE AN OPTION -
i48 1
2 CURRENT APPLICATION CONFIG
3 CURRENT BIN-
4 +--------------+
5 |1ABC|2DEF|3GHI|
6 ------+ |----|----|----| +------
7 %()*+,| |4JKL|5MNO|6PQR| |!"#$%&
8 ------+ |----|----|----| +------
9 ------+ |7STU|8VWX|9YZ.| +------
10 /;<]^_| +----|----|----+ |=>?@[\
11 ------+ |0- :| +------
12 +----+
13 ENTER BIN-
14
15 PRESS ENTER TO ACCEPT CHARACTER
16 PRESS ENTER AGAIN WHEN DONE
i49 1 CURRENT APPLICATION CONFIG
2 CURRENT TID -
3
4 +--------------+
5 |1ABC|2DEF|3GHI|
6 ------+ |----|----|----| +------
7 %()*+,| |4JKL|5MNO|6PQR| |!"#$%&
8 ------+ |----|----|----| +------
9 ------+ |7STU|8VWX|9YZ.| +------
10 /;<]^_| +----|----|----+ |=>?@[\
11 -----+ |0- :| +------
12 +----+'
13 ENTER 6 DIGIT TID-
14
15 PRESS ENTER TO ACCEPT CHARACTER
16 PRESS ENTER AGAIN WHEN DONE
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-75
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i50 1
2 CURRENT APPLICATION CONFIG
3
4 TRAN CMP MSG :
5
6
7
8 1 - ENABLED
9
10 0 - DISABLED
11
12
13
14
15 ENTER TRAN CMP MSG -
i51 1
2 CURRENT APPLICATION CONFIG
3
4 MSG SUPPRESS :
5
6
7
8 1 - ENABLED
9
10 0 - DISABLED
11
12
13
14
15 ENTER MSG SUPPRESS -
i52 1
2 CURRENT APPLICATION CONFIG
3
4 ACTIVITY TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 25500 SECONDS
10
11
12
13
14
15 ENTER ACTIVITY TIMER -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-76 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i53 1
2 CURRENT APPLICATION CONFIG
3
4 MSG ON CP:
5
6
7
8 1 - ENABLED
9
10 0 - DISABLED
11
12
13
14
15
16 ENTER MSG ON CP -
i54 1
2 CURRENT APPLICATION CONFIG
3
4 CP MSG TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 255 SECONDS
10
11
12
13
14
15 ENTER CP MSG TIMER -
i55 1
2 CURRENT APPLICATION CONFIG
3
4 ERROR REDIAL TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 2550 SECONDS'
10
11
12
13
14
15 ENTER ERROR REDIAL TMR -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-77
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i56 1
2 CURRENT SERIAL LINK CONFIG
3
4 COM PORT :
5
6
7
8
9
10
11
12
13
14
15 ENTER COM PORT -
i57 1
2 CURRENT SERIAL LINK CONFIG
3
4 BAUD RATE :
5
6
7 1 = 300 2 = 1200'
8
9
10 3 = 2400 4 = 4800'
11
12
13 5 = 96OO 6 = 14400'
14
15 CHOOSE AN OPTION -
i58 1
2 CURRENT SERIAL LINK CONFIG
3
4 DATA BITS :
5
6
7
8 ENTER A VALUE OF 7 OR 8
9
10
11
12
13
14
15 ENTER DATA BITS -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-78 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i59 1
2 CURRENT SERIAL LINK CONFIG
3
4 PARITY :
5
6
7 1 = NONE 2 = ODD
8
9
10 3 = EVEN 4 = MARK
11
12
13 5 = SPACE
14
15 CHOOSE AN OPTION -
i60 1
2 CURRENT SERIAL LINK CONFIG
3
4 STOP BITS :
5
6
7
8 ENTER A VALUE OF 1 OR 2
9
10
11
12
13
14
15 ENTER STOP BITS -
i61 1 CURRENT MODEM LINK CONFIG
2 PRIMARY NUMBER :
3
4 +-----------+
5 | 1 | 2 | 3 |
6 |---|---|---|
7 | 4 | 5 | 6 |
8 |---|---|---|
9 | 7 | 8 | 9 | +------'
10 +-----------+ |COMMA>'
11 | 0 | +------'
12 +---+
13
14 ENTER PRIMARY NUMBER-
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-79
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i62 1 MODEM LINK SECONDARY NUMBER
2
3 PRESS <ENTER> FOR NO VALUE
4 +-----------+
5 | 1 | 2 | 3 |
6 |---|---|---|
7 | 4 | 5 | 6 |
8 |---|---|---|
9 | 7 | 8 | 9 | +------
10 +-----------+ |COMMA>
11 | 0 | +------
12 +---+
13
14 ENTER SECONDARY NUMBER-
i63 1
2 CURRENT MODEM LINK CONFIG
3
4 MODEM CONNECT TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 255 SECONDS
10
11
12
13
14
15 ENTER CONNECT TIMER -
i64 1
2 CURRENT MODEM LINK CONFIG
3
4 DIAL MODE :
5
6
7
8 1 - TONE
9
10 0 - PULSE
11
12
13
14
15 ENTER DIAL MODE -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-80 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i65 1
2 CURRENT MODEM LINK CONFIG
3
4 MODEM COMMAND RESPONSE TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 1 AND 20 SECONDS
10
11
12
13
14
15 ENTER CMD RSP TIMER -
i66 1
2 CURRENT VISA 2 CONFIG
3
4 ENQ TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 255 SECONDS
10
11
12
13
14
15 ENTER ENQ TIMER -
i67 1
2 CURRENT VISA 2 CONFIG
3
4 MESSAGE RETRIES :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 9
10
11
12
13
14
15 ENTER MSG RETRIES -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-81
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i68 1
2 CURRENT VISA 2 CONFIG
3
4 ACK TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 255 SECONDS
10
11
12
13
14
15 ENTER ACK TIMER -
i69 1
2 CURRENT VISA 2 CONFIG
3
4 ENQ AFTER ACK :
5
6
7
8 1 - ENABLED
9
10 0 - DISABLED
11
12
13
14
15 ENTER ENQ AFTER ACK -
i70 1
2 CURRENT VISA 2 CONFIG
3
4 CONNECT LIFE TIME :
5
6
7 1 = NORMAL 2 = PREDIAL
8
9
10
11
12
13
14
15 CHOOSE AN OPTION -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-82 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i71 1
2 CURRENT VISA 2 CONFIG
3
4 DIAL ON SEND TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 255 SECONDS
10
11
12
13
14
15 ENTER DIAL ON SND TMR -
i72 1
2 CURRENT NETWORK ADDRESS CONFIG
3
4 NETWORK ADDRESS OPTION :
5
6
7
8 1 - ENABLED
9
10 0 - DISABLED
11
12
13
14
15 ENTER N/A OPTION -
i73 1
2 CURRENT NETWORK ADDRESS CONFIG
3
4 N/A DELAY TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 1000 MILLISECONDS
10
11
12
13
14
15 ENTER N/A DELAY TMR -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-83
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i74 1
2 CURRENT NETWORK ADDRESS CONFIG
3
4 N/A RESPONSE TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 0 AND 5000 MILLISECONDS
10
11
12
13
14
15 ENTER N/A RESPONSE TMR -
i75 1
2 COPY DIALUP CONFIG
3
4
5 DIALUP CONFIG
6
7 1 = COPY ON 2 = COPY OFF
8
9
10
11 APPLICATION SETTINGS
12
13 3 = COPY ON 4 = COPY OFF
14
15 CHOOSE AN OPTION -
i76 1 FILE OR DISK NOT PRESENT
i77 1 DISK NOT PRESENT IN DRIVE A
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-84 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i78 1 CURRENT MODEM STRING
2
3
4 |1ABC|2DEF|3GHI|
5 ------+ |----|----|----| +------'
6 %()*+,| |4JKL|5MNO|6PQR| |!"#$%&'
7 ------+ |----|----|----| +------'
8 ------+ |7STU|8VWX|9YZ.| +------'
9 /;<]^_| +----|----|----+ |=>?@[\'
10 ------+ 0- : +------'
11
12 ENTER STRING:
13
14
15 PRESS ENTER TO ACCEPT CHARACTER
16 PRESS ENTER AGAIN WHEN DONE
i79 1
2 CURRENT APPLICATION CONFIG
3
4 HOST MESSAGE HEADER :
5
6
7
8 1 - ENABLED
9
10 0 - DISABLED
11
12
13
14
15 ENTER HOST MSG HEADER -
i80 1 FILE COPIED
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-85
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i81 1 CURRENT NETWORK STRING
2
3
4 +--------------+
5 |1ABC|2DEF|3GHI|
6 ------+ |----|----|----| +------
7 %()*+,| |4JKL|5MNO|6PQR| |!"#$%&
8 ------+ |----|----|----| +------
9 ------+ |7STU|8VWX|9YZ.| +------
10 /;<]^_| +----|----|----+ |=>?@[\
11 -----+ |0- :| +------
12 +----+
13 ENTER STRING:
14
15 PRESS ENTER TO ACCEPT CHARACTER
16 PRESS ENTER AGAIN WHEN DONE
i82 1
2 DIALUP
3
4 1 APPL PARAM 2 SERIAL LINK
5 3 MODEM LINK 4 VISA 2
6 5 NETWORK ADD 6 COPY ON/OFF
7 7 DIAGNOSTICS
8
9
10
11
12
i83 1
2 APPLICATION PARAMETERS
3
4 1 BIN 2 TID
5 3 TRAN CMP MSG 4 HOST MSG HEAD
6 5 ACT TIMER 6 MSG SUPPRESS
7 7 MSG ON CP 8 CP MSG TMR
8 9 ERR REDIAL 10 SUPP CASH LOW
9
i84 1
2 MODEM LINK
3
4 1 PRIMARY NO 2 SECONDARY NO
5 3 CONNECT TMR 4 DIAL MODE
6 5 CMD RSP TMR 6 MODEM INI STR
7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-86 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor Dialup
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i85 1
2 SERIAL LINK
3
4 1 COM PORT 2 BAUD RATE
5 3 DATA BITS 4 PARITY
6 5 STOP BITS
7
i86 1
2 VISA 2
3
4 1 ENQ TMR 2 MSG RETRIES
5 3 ACK TIMER 4 ENQ AFTR ACK
6 5 CNT LIFE TIME 6 DIAL SND TMR
7 7 BACKOFF TMR
i87 1
2 CURRENT VISA 2 CONFIG
3
4 BACKOFF TIMER :
5
6
7
8 PLEASE ENTER A VALUE BETWEEN
9 100 AND 10000 MILLISECONDS
10
11
12
13
14
15 ENTER BACKOFF TIMER -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-87
Reserved Screens
‘i’ Supervisor BNA
‘i’ Supervisor BNA A
The following ‘i’ Supervisor Bunch Note Acceptor (BNA) screens
are displayed:
Table A-12 Column Position
Supervisor BNA Screens Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i19 1
2 BUNCH NOTE ACCEPTOR COUNTS
3
4 TYPE CONFIG DEPOSIT COUNT
5 %%%% %%%%%%%%% %%%%
6 %%%% %%%%%%%%% %%%%
7 %%%% %%%%%%%%% %%%%
8 %%%% %%%%%%%%% %%%%
9 %%%% %%%%%%%%% %%%%
10 %%%% %%%%%%%%% %%%%
11 %%%% %%%%%%%%% %%%%
12 %%%% %%%%%%%%% %%%%
i20 1
2 BUNCH NOTE ACCEPTOR COUNTS
3
4 LAST CLEARED : %%/%%/%% %%:%%
5
6 TYPE CONFIG COUNT
7 %%%% %%%%%% %%%%
8 %%%% %%%%%% %%%%
9 %%%% %%%%%% %%%%
10 %%%% %%%%%% %%%%
11 %%%% %%%%%% %%%%
12 %%%% %%%%%% %%%%
i21 1
2 BNA CNTRS
3
4 LAST CLEARED : %%/%%/%% %%:%%
5
6 COUNT
7 ENCASHED %%%%%
8 REJECTED %%%%%
9
10 ESCRW DEPS %%%%%
11 ESCRW RFND %%%%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-88 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor BNA
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i22 1
2 BUNCH NOTE ACCEPTOR CONFIG
3
4 TYPE CONFIG ACT/INACT
5
6 %% %%%%%%%% %%%%%%%%%
7 %% %%%%%%%% %%%%%%%%%
8 %% %%%%%%%% %%%%%%%%%
9 %% %%%%%%%% %%%%%%%%%
10 %% %%%%%%%% %%%%%%%%%
11 %% %%%%%%%% %%%%%%%%%
12 %% %%%%%%%% %%%%%%%%%
13 %% %%%%%%%% %%%%%%%%%
i23 1 COUNT
2 ENCASHED %%%%%
3 REJECTED %%%%%
4
5 ESCRW DEPS %%%%%
67 ESCRW RFND %%%%%
i24 1 %% %%%%%%%% %%%%%%%%%
2 %% %%%%%%%% %%%%%%%%%
3 %% %%%%%%%% %%%%%%%%%
4 %% %%%%%%%% %%%%%%%%%
5 %% %%%%%%%% %%%%%%%%%
6 %% %%%%%%%% %%%%%%%%%
7 %% %%%%%%%% %%%%%%%%%
8 %% %%%%%%%% %%%%%%%%%
9 %% %%%%%%%% %%%%%%%%%
10 %% %%%%%%%% %%%%%%%%%
11 %% %%%%%%%% %%%%%%%%%
12 %% %%%%%%%% %%%%%%%%%
i25 1
2 CARDS CAPTURED %%%%%
3 LAST CLEARED %%/%%/%% %%:%%
4
5 DEPOSITS MADE %%%%%
6 LAST CLEARED %%/%%/%% %%:%%
7
8 ACTIVITY COUNT = %%%%%%%
9 PKT 1 %%%%% CLRD %%/%%/%% %%:%%
10 PKT 2 / REJECT BIN
11 %%%%% CLRD %%/%%/%% %%:%%
12 PKT 3 %%%%% CLRD %%/%%/%% %%:%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-89
Reserved Screens
‘i’ Supervisor BNA
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i26 1
2 CARDS CAPTURED %%%%%
3 LAST CLEARED %%/%%/%% %%:%%
4
5
6
7
8 ACTIVITY COUNT = %%%%%%%
9 PKT 1 %%%%% CLRD %%/%%/%% %%:%%
10 PKT 2 / REJECT BIN
11 %%%%% CLRD %%/%%/%% %%:%%
12 PKT 3 %%%%% CLRD %%/%%/%% %%:%%
i27 1 CURRENT PATTERN - %%%%%%%
i28 1
2 CLEAR DEPOSITORY COUNTERS
3
4 0: ALL POCKETS/BINS
5 1: POCKET 1 = %%%%%
6 2: POCKET 2 / REJECT = %%%%%
7 3: POCKET 3 = %%%%%
i30–i32 Reserved
i33 1
2 CHECKSUM VALUE = %
i34–i36 Reserved
i37 1 TYPE CURR VALUE CUID DISP
2 % %%% %%%%% %%%% %%%%%
3 % %%% %%%%% %%%% %%%%%
4 % %%% %%%%% %%%% %%%%%
5 % %%% %%%%% %%%% %%%%%
6 % %%% %%%%% %%%% %%%%%
7 % %%% %%%%% %%%% %%%%%
8 % %%% %%%%% %%%% %%%%%
9
10 REJECT BIN THRESHOLD = %%
i38 1 ENTER START DATE (DDMMYY) / /
2 ENTER END DATE (DDMMYY) / /
3
i40 1 . . .
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-90 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor BNA
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i43 1 TYPE %%-%% %%%%%% %%%%%%
2 CASSETTE %%%%% %%%%%
3 +RETRACT %%%%% %%%%%
4 +RECYCLED %%%%% %%%%%
5 =DEPOSITED %%%%% %%%%%
6
7 TYPE %%-%% %%%%%% %%%%%%
8 CASSETTE %%%%% %%%%%
9 +RETRACT %%%%% %%%%%
10 +RECYCLED %%%%% %%%%%
11 =DEPOSITED %%%%% %%%%%
i76 1 FILE OR DISK NOT PRESENT
i88 1 CURRENT DAY - %%%%%%%%
i89 1 CURRENT CONFIG TIME - %%%%%%
i90 1 ( 0-SUN 1-MON 2-TUE
2 3-WED 4-THU 5-FRI 6-SAT)
i91 1
2 BNA CNTRS
3
4 LAST CLEARED : %%/%%/%% %%:%%
5
6 COUNT
7 ENCASHED %%%%%
8 REJECTED %%%%%
9 RETRACTED %%%%%
10 NOTES IN TRANSPORT %%%%%
11
12 ESCRW DEPS %%%%%
13 ESCRW RFND %%%%%
i92 1
2 CASSETTE MAPPING
3
4 CUR VALUE CUID
5 TYPE 1 %% %%%%% %%%%%
6 TYPE 2 %% %%%%% %%%%%
7 TYPE 3 %% %%%%% %%%%%
8 TYPE 4 %% %%%%% %%%%%
9 TYPE
10 1. TOP %% %%%%% %%%%% %
11 2. 2ND %% %%%%% %%%%% %
12 3. 3RD %% %%%%% %%%%% %
13 4. 4TH %% %%%%% %%%%% %
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-91
Reserved Screens
‘i’ Supervisor Settlement Screens
‘i’ Supervisor Settlement Screens A
The following ‘i’ Supervisor Settlement screens are displayed:
Table A-13 Column Position
Supervisor Settlement Screens Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i93 1
2 SETTLEMENT
3
4
5
6
7
8
9
10
11
12
13 FUNC-
i94 1
2 SETTLEMENT
3
4
5
6
7
8
9
10
11
12
13 ENTER BUFFER B-
i95 1
2 SETTLEMENT
3
4
5
6
7
8
9
10
11
12
13 ENTER BUFFER C-
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-92 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘i’ Supervisor Settlement Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i96 1
2 SETTLEMENT
3
4
5
6
7
8
9
10
11
12
13 ENTER PIN-
i97 1
2 SETTLEMENT
3
4
5
6
7
8
9
10
11
12
13 PLEASE WAIT...
i98 1
2 SETTLEMENT
3
4
5
6
7
8
9
10
11
12
13 CASH-
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-93
Reserved Screens
‘i’ Supervisor Settlement Screens
Column Position
Screen Row
Number Position 1 2 3
12345678901234567890123456789012
i99 1
2 SETTLEMENT
3
4
5
6
7
8
9
10
11
12
13 FAIL %
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-94 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
‘j’ Supervisor and Journal
Miscellaneous Screens A
The following ‘j’ Supervisor miscellaneous screens are displayed:
Table A-14
Supervisor Miscellaneous Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
j0000 1 % TYPE % TYPE %
2 CASSETTE %%%%% %%%%%
3 +REJECTED %%%%% %%%%%
4 =REMAINING %%%%% %%%%%
5 +DISPENSED %%%%% %%%%%
6 =TOTAL %%%%% %%%%%
7
8 TYPE %
9 CASSETTE %%%%%
10 +REJECTED %%%%%
11 =REMAINING %%%%%
12 +DISPENSED %%%%%
13 =TOTAL %%%%%
14 LAST CLEARED %%/%%/%% %%:%%
j0001 1 % TYPE % TYPE %
2 CASSETTE %%%%% %%%%%
3 +REJECTED %%%%% %%%%%
4 =REMAINING %%%%% %%%%%
5 +DISPENSED %%%%% %%%%%
6 =TOTAL %%%%% %%%%%
7
8 LAST CLEARED %%/%%/%% %%:%%
j0002 1 TYPE %
2 CASSETTE %%%%%
3 +REJECTED %%%%%
4 =REMAINING %%%%%
5 +DISPENSED %%%%%
6 =TOTAL %%%%%
7
8 LAST CLEARED %%/%%/%% %%:%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-95
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
j0003 1 *CONFIGURATION DATA*
2 STANDARD NOTE COUNTS
3 T1=%%%%% T2=%%%%%
4 T3=%%%%% T4=%%%%%
Note: If dual cash handlers are used with separated counters, the standard note counts are displayed with the
primary cash handler count first (P), then the secondary cash handler count (S), as follows:
T1=PPPPPP SSSSSS T2=PPPPPP SSSSSS
T3=PPPPPP SSSSSS T4=PPPPPP SSSSSS
j0004 1 *CONFIGURATION DATA*
2 STANDARD NOTE COUNTS
3 T1=%%%%% T2= %%%%%
4 T3=%%%%% T4= %%%%%
5 T5=%%%%% T6= %%%%%
6 T7=%%%%%
Note: If dual cash handlers are used with separated counters, the standard note counts are displayed with the
primary cash handler count first (P), then the secondary cash handler count (S), as follows:
T1=PPPPPP SSSSSS T2=PPPPPP SSSSSS
T3=PPPPPP SSSSSS T4=PPPPPP SSSSSS
If Enhanced Configuration option 76 is set to 001, the display will be as follows:
T1=PPPPPP SSSSSS T2=PPPPPP SSSSSS
T3=PPPPPP SSSSSS T4=PPPPPP SSSSSS
T5=PPPPPP SSSSSS T6=PPPPPP SSSSSS
T7=PPPPPP SSSSSS
j0005 Reserved
j0006 1 % TYPE % TYPE %
2 CASSETTE %%%%% %%%%%
3 +REJECTED %%%%% %%%%%
4 +DISPENSED %%%%% %%%%%
5 -DEPOSITED %%%%% %%%%%
6 =TOTAL %%%%% %%%%%
7
8 TYPE % TYPE %
9 CASSETTE %%%%% %%%%%
10 +REJECTED %%%%% %%%%%
11 +DISPENSED %%%%% %%%%%
12 -DEPOSITED %%%%% %%%%%
13 =TOTAL %%%%% %%%%%
14 LAST CLEARED %%/%%/%% %%:%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-96 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
j0007 1 % TYPE % TYPE %
2 CASSETTE %%%%% %%%%%
3 +REJECTED %%%%% %%%%%
4 +DISPENSED %%%%% %%%%%
5 -DEPOSITED %%%%% %%%%%
6 =TOTAL %%%%% %%%%%
7
8 TYPE %
9 CASSETTE %%%%%
10 +REJECTED %%%%% %%%%%
11 +DISPENSED %%%%% %%%%%
12 -DEPOSITED %%%%% %%%%%
13 =TOTAL %%%%%
14 LAST CLEARED %%/%%/%% %%:%%
j0008 1 % TYPE % TYPE %
2 CASSETTE %%%%% %%%%%
3 +REJECTED %%%%% %%%%%
4 +DISPENSED %%%%% %%%%%
5 -DEPOSITED %%%%% %%%%%
6 =TOTAL %%%%% %%%%%
7
8 LAST CLEARED %%/%%/%% %%:%%
j0009 1 % TYPE %
2 CASSETTE %%%%%
3 +REJECTED %%%%%
4 +DISPENSED %%%%%
5 -DEPOSITED %%%%%
6 =TOTAL %%%%%
7
8 LAST CLEARED %%/%%/%% %%:%%
j0010 1 CURRENT APPLICATION CONFIG
2
3 SUPPRESS CASH LOW:
4
5
6
7 PLEASE ENTER A VALUE BETWEEN
8 0 AND 9
9
10
11
12
13
14 ENTER SUPP CASH LOW -
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-97
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
j0011 ‐ j0019 Reserved
j0020 1 CONFIGURE
2
3 89 NO HOST CHG VG
4 91 ALPHANUMERIC MACHINE NUMBER
5 92 RECEIPT TOP MARGIN
6 93 CARDLESS TRANSACTIONS
7 99 MORE
j0021 1 CURRENT CONFIG - %%%%%%
2 PRESS KEY REPEATEDLY TO
3 CYCLE THROUGH VALUES
4 PRESS ENTER TO ACCEPT CHARACTER
5 PRESS ENTER AGAIN WHEN DONE
6 +--------------+
7 |QZ.1|ABC2|DEF3|
8 |----+----+----|
9 |GHI4|JKL5|MNO6|
10 |----+----+----|
11 |PRS7|TUV8|WXY9|
12 +----+----+----+
13 |<SPACE>_-0|
14 +----------+
15
16 ENTER MACHINE NO-
j0022 NOTES RETRACTED %%%%
TYPE 1 = %%%%% TYPE 2 = %%%%%
TYPE 3 = %%%%% TYPE 4 = %%%%%
UNKNOWN= %%%%%
TOTAL RETRACTED= %
TOTAL REJECTED = %
LAST CLEARED %%/%%/%% %%:%%
j0023 NOTES RETRACTED %%%%
TYPE 1 = %%%%% TYPE 2 = %%%%%
TYPE 3 = %%%%% TYPE 4 = %%%%%
TYPE 5 = %%%%% TYPE 6 = %%%%%
TYPE 7 = %%%%% UNKNOWN= %%%%%
TOTAL RETRACTED= %
TOTAL REJECTED = %
LAST CLEARED %%/%%/%% %%:%%
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-98 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
j0024 1 NOTES RETRACTED %%%%
2 TYPE 1 = %%%%% TYPE 2 = %%%%%
3 TYPE 3 = %%%%% TYPE 4 = %%%%%
4 UNKNOWN= %%%%%
5
6 TOTAL RETRACTED= %
7 TOTAL REJECTED = %
j0025 1 NOTES RETRACTED %%%%
2 TYPE 1 = %%%%% TYPE 2 = %%%%%
3 TYPE 3 = %%%%% TYPE 4 = %%%%%
4 TYPE 5 = %%%%% TYPE 6 = %%%%%
5 TYPE 7 = %%%%% UNKNOWN= %%%%%
6
7 TOTAL RETRACTED= %
8 TOTAL REJECTED = %
j0026 1 LAST DISPENSED COUNTS ARE UNKNOWN
2 CAUTION-CASH COUNTS MAY BE INACCURATE
j0027 1 CASH TOTAL %%%% TYPE1 TYPE2 TYPE3 TYPE4
j0028 1 CASH TOTAL %%%% TYPE5 TYPE6 TYPE7
j0029 1 DENOMINATION %%%%% %%%%% %%%%% %%%%%
j0030 1 DISPENSED %%%%% %%%%% %%%%% %%%%%
j0031 1 REJECTED %%%%% %%%%% %%%%% %%%%%
j0032 1 REMAINING %%%%% %%%%% %%%%% %%%%%
j0033 1 OPCODE = %%%%%
j0034 1 ENTER RECEIPT TOP MARGIN -%%
j0035 1 CARDLESS TRANSACTIONS
2
3 CURRENT STATUS = %%%%%%%%
4 NEXT STATE NUMBER = %%%
5
6 0 DISABLE
7 1 ENABLE
8 2 CHANGE NEXT STATE NUMBER
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-99
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
j0036 1 CURRENT NEXT STATE NUMBER: %%%
2 +--------------+
3 |1ABC|2DEF|3GHI|
4 |----+----+----|
5 |4JKL|5MNO|6PQR|
6 |----+----+----|
7 |7STU|8VWX|0YZ |
8 +----+----+----+
9 | 0 |
10 +----+
11 ENTER STRING:
12
13 PRESS ENTER TO ACCEPT CHARACTER
14 PRESS ENTER AGAIN WHEN DONE
15
j0037 1 ENTER NEXT STATE NUMBER-
j0038 1 CARDLESS TRANSACTIONS %%%%%%%%
j0039 1 CARDLESS NEXT STATE NUMBER = %%%
j0040 1 LOCAL CASH DISPENSE STATE
j0041 1 DISPENSE AND PRINT
j0042 1 CARD BEFORE CASH
j0043 1 CARD BEFORE DISPENSE AND PRINT
j0044 1 FAST CASH
j0045 1 REQUESTED COINS CANNOT BE DISPENSED
j0046 1 NO NOTES AND NO COINS REQUESTED
j0047 1 CARD EJECTED
j0048 1 CARD READER TAMPERING
j0049 1 NOTES PURGED
j0050 1 NOTES PARTIALLY PRESENTED %% %% %% %%
j0051 1 CASH DISPENSER TAMPERING
j0052 1 COIN DISPENSER TAMPERING
j0053 1 GOOD DISPENSE EXIT
j0054 1 SHORT DISPENSE EXIT
j0055 1 NO DISPENSE EXIT
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-100 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
j0056 1 UNKNOWN DISPENSE EXIT
j0057 1 COINS PRESENTED %% %% %% %% %% %% %% %%
j0058 1 COINS PARTIALLY PRESENTED %% %% %% %% %% %% %% %%
j0059 1 REJECT/RETRACT BIN COUNTERS%
2
3 REJECT BIN 1 = %
4 REJECT BIN 2 = %
5 RETRACT BIN = %
6
7 LAST CLEARED %%/%%/%% %%:%%
j0060 1 REJECT/RETRACT BIN COUNTERS%
2
3 REJECT BIN 1 = %
4 REJECT BIN 2 = %
5 RETRACT BIN = %
j0061 1 Reserved
j0062 1 REJECT BIN % INSERTED
j0063 1 REJECT BIN % REMOVED
j0064 1 RETRACT BIN INSERTED
j0065 1 RETRACT BIN REMOVED
j0066 1 RESET FAILED
j0067 1 NOTES RETRACTED %%%%
2 TYPE 1 = %%%%% TYPE 2 = %%%%%
3 TYPE 3 = %%%%% TYPE 4 = %%%%%
4 UNKNOWN= %%%%%
5 TOTAL RETRACTED= %
j0068 1 NOTES RETRACTED %%%%
2 TYPE 1 = %%%%% TYPE 2 = %%%%%
3 TYPE 3 = %%%%% TYPE 4 = %%%%%
4 TYPE 5 = %%%%% TYPE 6 = %%%%%
5 TYPE 7 = %%%%% UNKNOWN= %%%%%
6 TOTAL RETRACTED= %
J0069 1 CASH IN ERROR
2 INIT BNA STARTED FROM TEST CASH
j0070 1 CASH IN ERROR
2 PERFORMING INIT BNA, PLEASE WAIT
j0071 1 TEST CASH FAILED-CASH IN ERROR
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-101
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
j0072‐j3999 Reserved
j4000 2 MACHINE NO =%
j4001 3 DATE-TIME =%
j4010 1 %
j4011 ‐ j4012 Reserved
j4013 1 <Title%>
2 <LabelLink1%> :<Item1%>'
3 <LabelLink2%> :<Item2%>'
4
<LabelLink3%> :<Item3%>'
5
<LabelLink4%> :<Item4%>'
6
7 <LabelLink5%> :<Item5%>'
8 <LabelLink6%> :<Item6%>'
9 <LabelLink7%> :<Item7%>'
10 <LabelLink8%> :<Item8%>'
11 <End%>'
12
j4014 1 <Title%>
2 <LabelLink1%> :<Item1%>'
3 <LabelLink2%> :<Item2%>'
4
<LabelLink3%> :<Item3%>'
5
<LabelLink4%> :<Item4%>'
6
7 <LabelLink5%> :<Item5%>'
8 <LabelLink6%> :<Item6%>'
9 <LabelLink7%> :<Item7%>'
10 <LabelLink8%> :<Item8%>'
11 <End%>'
12
j4015 1 TCPIP ENABLED
j4016 2 PCCM ENABLED
j4017 2 DIALUP VISA2 ENABLED
j4018 1 CIM-DEPOSIT ACTIVATED
j4019 1 CIM-SHUTTER OPENED
j4020 1 CIM-ITEMS INSERTED
j4021 1 CIM-INPUT REFUSED, REASON %%%%%%%%%%%
j4022 1 CIM-ITEMS PRESENTED
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-102 APTRA™ Advance NDC, Reference Manual
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
Column Position
Screen Number Row Position
1 2 3 4
1234567890123456789012345678901234567890
j4023 1 CIM-ITEMS TAKEN
j4024 1 CIM-DEPOSIT COMPLETED
j4025‐ Reserved
j4031
j4032 1
2 CONFIGURE NHC VG
3
4 0 DISABLE'
5 1 ENABLE'
6
7
8 CURRENT = %
9
10
11
12
13
14
15 PRESS 1 TO ENABLE/0 TO DISABLE
j4035 1 CIM-DEPOSIT COMPLETED - ITEMS REFUNDED
j4036‐ Reserved
j4054
j4055 CASH DEPOSIT HANDLING - ENCASH STARTED
j4056 CASH DEPOSIT HANDLING - REFUND STARTED
j4057 CASH DEPOSIT HANDLING - ENCASH SUCCESS
j4058 CASH DEPOSIT HANDLING - ENCASH FAILED
j4059 CASH DEPOSIT HANDLING - REFUND SUCCESS
j4060 CASH DEPOSIT HANDLING - REFUND FAILED
j4061 CASH DEPOSIT HANDLING - REFUND TIMEOUT
j4067 CONTACTLESS CARD TAPPED
j4068 PRIMARY CARD READER ACTIVATED
j4069 SECONDARY CARD READER ACTIVATED
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual A-103
Reserved Screens
‘j’ Supervisor and Journal Miscellaneous Screens
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
A-104 APTRA™ Advance NDC, Reference Manual
Table of Contents
Character Sets
Appendix B
Character Sets
Overview B‐1
Character Sets B‐2
USB Printers and Downloadable Character Sets B‐4
Statement Code Sets B‐5
Code Pages B‐7
OS/2 Code Pages B‐7
USB Receipt and Journal Code Pages B‐7
Mapping Files B‐8
Font ID Mapping Table B‐12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Character Sets
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Character Sets
B
Overview
Overview B
This appendix gives details of the default character sets provided
for printers and cardholder screens. It also describes the following:
? Code page character sets for the thermal printer
? Using a mapping file to assign an unknown character set to one
that is recognised
? Common Character Sets and ISO 8859 character sets with font
IDs
If you wish, you can also create or use your own fonts. For
guidelines on font definition, refer to the APTRA Advance NDC,
Developer’s Guide.
Note: To enable an EMV Integrated Circuit Card (ICC or ‘smart
card’) to be used, additional fonts and font designators are provided
with Advance NDC. If you wish to use an EMV ICC, refer to the
EMV Integrated Circuit Card (ICC) Reference Manual provided with
the EMV/CAM2 Exits for APTRA Advance NDC product. The
publication lists the additional EMV fonts and font designators.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual B-1
Character Sets
Character Sets
Character Sets B
For forms‐based printing on Universal Serial Bus (USB) printers,
you can use the Windows True Type font files provided with
Advance NDC. They are provided for character sets Alpha 1
(NDCAlpha1.ttf) to Alpha 6 (NDCAlpha6.ttf) and Arabic 1
(NDCArabic1.ttf) to Arabic 6 (NDCArabic6.ttf), and located in
C:\windows\fonts.
For details of the supported characters sets for raw data printing,
refer to the APTRA on‐line documentation for your printer under
APTRA XFS | Programmers Reference | XFS Service Providers.
Figure B-1
Alpha 1
! " # $ % & ’ ( ) + , - . /
X
2
3 0 1 2 3 4 5 6 7 8 9 : ; < = > ?
4 @A B C D E F G H I J K L M N O
5 P Q R S T U V WX Y Z [ \ ] ^ _
_ _ _
6 £Æø Å Ä N / Ö Ë Ê É
O A Ç C G
_ _
7 ÔÓ Ï Ü n E E S/ ¤ S G I cr dr r
0 1 2 3 4 5 6 7 8 9 A B C D E F
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-2 APTRA™ Advance NDC, Reference Manual
Character Sets
Character Sets
Table B-1 Character Set Designator Number Of Characters Supported
Character Sets
CRT PPD R/J
Single Size Alpha 1/ ‘1’ 96 96 96
Single Size Arabic 1
Single Size Alpha 2/ ‘2’ 96 ‐ 96
Single Size Arabic 2
Single Size Alpha 3/ ‘7’ 64 ‐ 96
Single Size Arabic 3
Single Size Alpha 4/ ‘I’ ‐ ‐ 96
Single Size Arabic 4
Single Size Alpha 5/ ‘J’ ‐ ‐ 96
Single Size Arabic 5
Single Size Alpha 6/ ‘Q’ ‐ ‐ 1
Single Size Arabic 6
Standard Graphics 1 ‘3’ 64 ‐ ‐
Standard Graphics 2 ‘4’ 64 ‐ ‐
Standard Graphics 3 ‘5’ 64 ‐ ‐
Double Size Alpha 1/ ‘>’ 96 ‐ 96
Double Size Arabic 1
Double Size Alpha 2/ ‘?’ 96 ‐ 96
Double Size Arabic 2
Double Size Alpha 3/ ‘B’ 64 ‐ 96
Double Size Arabic 3
Double Size Alpha 4/ ‘K’ ‐ ‐ 96
Double Size Arabic 4
Double Size Alpha 5/ ‘L’ ‐ ‐ 96
Double Size Arabic 5
Double Size Alpha 6/ ‘R’ ‐ 1 1
Double Size Arabic 6
Condensed Size Alpha 1/ ‘C’ ‐ ‐ 96
Condensed Size Arabic 1
Condensed Size Alpha 2/ ‘D’ ‐ ‐ 96
Condensed Size Arabic 2
Condensed Size Alpha 3/ ‘E’ ‐ ‐ 96
Condensed Size Arabic 3
Condensed Size Alpha 4/ ‘M’ ‐ ‐ 96
Condensed Size Arabic 4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual B-3
Character Sets
Character Sets
Character Set Designator Number Of Characters Supported
CRT PPD R/J
Condensed Size Alpha 5/ ‘N’ ‐ ‐ 96
Condensed Size Arabic 5
Condensed Size Alpha 6/ ‘S’ ‐ ‐ 1
Condensed Size Arabic 6
Chinese 1 ‘:’ 64 ‐ ‐
Chinese 2 ‘;’ 64 ‐ ‐
Note 1: Condensed print is not supported for the receipt and
journal printers. It is supported for the thermal receipt in sideways
mode only.
Note 2: Double size sets are not supported by the receipt printer in
sideways printing mode and receipt of these designators will not
change the current selected code set.
Note 3: For printing raw data, the USB receipt and journal printers
use code pages that are mapped to the character set. For details of
the mapping file, see “Mapping Files” on page B‐8.
Note 4: Standard Graphics 2 (designator ‘4’) maps to Customer
Graphics 2 (designator ‘7’) and is a display‐only font, reflecting the
range and look of characters that are required in an SST application.
For more information, see “Formatting Rules for Cardholder
Display Screens” on page 3‐14.
NCR recommends the use of forms‐based printing with a Windows
USB Printers and font file representing the required fonts on USB receipt and journal
Downloadable Character printers. For more information, see “Character Sets” on page B‐2
Sets B
However, user‐defined downloadable character sets can be used to
print raw data, and are sent as actual bits to the printer.
Existing downloadable character sets must be modified to allow for
the resolution change from 150 dpi to 203 dpi. This change results in
a larger character cell size on 203 dpi printers.
The font definition for the downloadable character set should be
updated for 203 dpi, as follows:
1 Change the number of bytes for a character cell from 2 x x to
3 x x
2 Change the header from 1D 26 02 to 1D 26 03
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-4 APTRA™ Advance NDC, Reference Manual
Character Sets
Character Sets
3 Change the number of columns value preceding each character
definition as follows:
— For standard pitch, from 0B to 0E
— For compressed pitch, from 08 to 0A.
The statement printer (SDC) supports either six International Alpha
Statement Code Sets B
sets or six Arabic sets. You can select these by a hardware switch.
Note: This does not apply to the open document and USB
statement printer variants as forms‐based printing uses the
Windows fonts supplied with Advance NDC.
Table B-2 Character Sets Designator Number Of Characters Supported
Statement Printer Character Sets
Single Size Alpha 1/ ‘1’ 96
Single Size Arabic 1
Single Size Alpha 2/ ‘2’ 96
Single Size Arabic 2
Single Size Alpha 3/ ‘7’ 96
Single Size Arabic 3
Single Size Alpha 4/ ‘I’ 96
Single Size Arabic 4
Single Size Alpha 5/ ‘J’ 96
Single Size Arabic 5
Single Size Alpha 6/ ‘Q’ 1
Single Size Arabic 6
Double Size Alpha 1/ ‘>’ 96
Double Size Arabic 1
Double Size Alpha 2/ ‘?’ 96
Double Size Arabic 2
Double Size Alpha 3/ ‘B’ 96
Double Size Arabic 3
Double Size Alpha 4/ ‘K’ 96
Double Size Arabic 4
Double Size Alpha 5/ ‘L’ 96
Double Size Arabic 5
Double Size Alpha 6/ ‘R’ 1
Double Size Arabic 6
Condensed Size Alpha 1/ ‘C’ 96
Condensed Size Arabic 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual B-5
Character Sets
Character Sets
Character Sets Designator Number Of Characters Supported
Condensed Size Alpha 2/ ‘D’ 96
Condensed Size Arabic 2
Condensed Size Alpha 3/ ‘E’ 96
Condensed Size Arabic 3
12cpi Size Alpha 1 ‘F’ 96
12cpi Size Alpha 2 ‘G’ 96
12cpi Size Alpha 3 ‘H’ 96
Condensed Size Alpha 4/ ‘M’ 96
Condensed Size Arabic 4
Condensed Size Alpha 5/ ‘N’ 96
Condensed Size Arabic 5
12cpi Size Alpha 4 ‘O’ 96
12cpi Size Alpha 5 ‘P’ 96
Condensed Size Alpha 6/ ‘S’ 1
Condensed Size Arabic 6
12cpi Size Alpha 6 ‘T’ 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-6 APTRA™ Advance NDC, Reference Manual
Character Sets
Code Pages
Code Pages B
For details of supported characters sets on other vendors’ SSTs, refer
to the vendor’s printer documentation.
For NCR SSTs, refer to the APTRA on‐line documentation for your
printer, under APTRA XFS | Programmers Reference | XFS
Service Providers.
The following control sequence allows the selection of one of the
OS/2 Code Pages B
supported OS/2 code pages and sets the printer to code page mode:
Control Code: 1BH 25H 3xH 3yH 3zH
where 3xH 3yH 3zH represents the three‐byte ASCII value of the
code page.
Valid code pages are: 000, 437, 850, 851, 852, 855, 857, 860, 861, 862,
863, 864 and 866.
Code page 000 is the user‐defined downloadable character set code
page. The “Define Downloadable Character Set” control sequence
described in Chapter 5 must be issued before the “Select OS/2 Code
Page” control sequence.
Code pages 851, 855 and 866 cannot be used in condensed print
mode.
For further information about code pages, refer to the Self Service
Platform Software Programmer’s Manual for the 40 Column Printer and
the APTRA on‐line documentation under APTRA XFS |
Programmers Reference | XFS Service Providers.
USB receipt and journal printers support code pages rather than
USB Receipt and Journal character sets. However, the code pages contain the same
Code Pages B
characters.
When character mapping is enabled, and the host requests an
Arabic or International character set, the corresponding section is
located in the mapping file. If found, the specified character set is
used, otherwise the control sequence is sent directly to the printer.
For details of the mapping file, see “Mapping Files”.
Valid code pages are 437, 737, 850, 851, 852, 855, 857, 858, 860, 861,
862, 863, 864, 865, 866, and 1251
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual B-7
Character Sets
Mapping Files
Mapping Files B
For raw data printing, Advance NDC can use mapping files to
translate an unknown character to a known character.
Note: Forms‐based printing does not use mapping files.
The supplied mapping file to use depends on your printer, and
requirements, as follows:
? For USB receipt or journal printers when character mapping is
enabled, user‐defined fonts and Arabic and International
character sets are selected using the UniversalCharSets.txt
mapping file. This file is located in C:\Program Files\NCR
APTRA\Advance NDC\Config.
? For other receipt or journal printers, user‐defined fonts are
selected using the PersonasCharSets.txt mapping file. This file is
located in C:\Program Files\NCR APTRA\Advance NDC\data.
These files can be edited as required to define user‐specified
character mapping.
The name of the mapping file to use is held in the following registry
key:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\
CHAR_MAP_FILENAME
By default, the value is UniversalCharSets.txt.
When a character set is requested, it is identified using the file
definition file. Whether the mapping file is checked for a
corresponding section is set using the MAP_REQUIRED registry
setting under HKLM\SOFTWARE\NCR\Advance
NDC\PRINTING\<printer>, where <printer> is RECEIPT, or
JOURNAL.
Note: Character mapping is not available for statement printers. If
you required a font for use with forms on the statement printer, you
must create the font. For details of creating fonts, refer to Appendix
D, “Font Definition” in the APTRA Advance NDC, Developer’s Guide.
Valid values are as follows:
? 0 = mapping is not required. The mapping file is never checked
? 1 = mapping is required. The mapping file is always checked.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-8 APTRA™ Advance NDC, Reference Manual
Character Sets
Mapping Files
If the section is located, the Select Codepage control sequence is
used to map the printable data. If the section is not located, the
request is passed directly to the printer.
For information on the printer control codes, see “Printer Control
Characters” on page 5‐6.
The character designator sent by the host to select user‐defined fonts
must match that held in the appropriate registry key for the printer
type, as follows:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\
RECEIPT\CHAR_MAP_DESIGNATOR
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\
JOURNAL\CHAR_MAP_DESIGNATOR
By default, these registry keys are blank, so no user‐specified
character mapping occurs.
The mapping file, illustrated in Figure B‐2, uses the conventions
described in Table B‐3.
Table B-3
Mapping File Conventions
Convention Example
If the character does not require mapping, it does not If character is the same whether mapped or not,
need to be included in the mapping file there is no need to include a line converting it, as
follows:
20H=20H
The source character, or range of characters, is given on 20H=
the left of the equals sign 6A‐6D=
This is the character that you want to map from
The target character is given on the right of the equals =20H
sign
This is the character that you want to map to
Source characters must be within the defined range For International and Arabic character sets, 20H to
7FH
Out of range characters are ignored
For user‐defined character sets, 20H to FFH
Target characters must be within the defined range 20H to FFH
Out of range characters are ignored
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual B-9
Character Sets
Mapping Files
Convention Example
Any line starting with a ‘/’ is a comment /Mapping file for International character set 1
Text within square brackets identifies a section [International1]
The mapping file will have sections for each character set
in both Arabic and International character types, plus
any sections for user‐defined fonts.
A line starting with ‘CP=’ is setting the default code page CP=437
A line with ‘aa=bb’ converts character 0xaa to 0xbb using 60=9C
the default code page
A line with ‘aa=bb,ccc’ converts character 0xaa to 65=83,737
character 0xbb using code page ccc
A line with ‘aa1‐aa2=bb’ converts the range of characters 60‐62=9D
0xaa1 to 0xaa2 to the character 0xbb using the default
code page
A line with ‘aa1‐aa2=bb, ccc’ converts the range of 6A‐6D=8F, 852
characters 0xaa1 to 0xaa2 to the character 0xbb using
code page ccc
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-10 APTRA™ Advance NDC, Reference Manual
Character Sets
Mapping Files
Figure B-2 /Mapping file for the international character set 1
Example Mapping File [International]
CP=437
60=9C
61=92
62=9B
63=8F
64=8E
65=83,737
.
.
.
6A=8F,852
6C=99,852
6D=D3,852
6E=D3,850
6F=90,852
.
.
.
7F=72
/Mapping file for the user‐defined character set R
[UserR]
60=9D
61=88
62=94
63=91
64=82
.
.
.
7F=9E
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual B-11
Character Sets
Font ID Mapping Table
Font ID Mapping Table B
The following table maps character sets, including ISO 8859
character sets 2 ‐ 9, to the font IDs supported by APTRA Advance
NDC.
Table B-4 Font ID
Font Size
Font ID Mapping Table Character Set/Type face (decimal value)
Lucida Console Single ` (96)
Latin 1 (West European)
Double a (97)
Lucida Console Single b (98)
Latin 1 (West European)
Double c (99)
ISO 8859-2 Single d (100)
Latin 2 (Central European)
Double e (101)
ISO 8859-3 Single f (102)
Latin 3 (South European)
Double g (103)
ISO 8859-4 Single h (104)
Latin 4 (North European)
Double i (105)
ISO 8859-5 Single j (106)
Latin/Cyrillic
Double k (107)
ISO 8859-6 Single l (108)
Latin/Arabic
Double m (109)
ISO 8859-7 Single n (110)
Latin/Greek
Double o (111)
ISO 8859-8 Single p (112)
Latin/Hebrew
Double q (113)
ISO 8859-9 Single r (114)
Latin 5 (Turkish)
Double s (115)
NDC Alphanumeric 1 Single t (116)
Double u (117)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
B-12 APTRA™ Advance NDC, Reference Manual
Table of Contents
Cardholder Screen Graphics
Appendix C
Cardholder Screen Graphics
Overview C‐1
Cardholder Example Graphics C‐2
Insert Card (g00.png) C‐3
Press Key (g01.png) C‐4
Make a Deposit (g03.png) C‐5
Take Receipt (g04.png) C‐6
Take Cash (g05.png) C‐7
Take Statement (g06.png) C‐8
Scan Barcode (g10.png) C‐9
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Cardholder Screen Graphics
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Cardholder Screen Graphics
C
Overview
Overview C
Two sets of cardholder screen graphics are provided with Advance
NDC: files with names in the format of g<nn>.png and the same files
with names in the format of PIC0<nn>.png. The variable nn
represents a number in the range 01 to 10.
This appendix lists the example cardholder screen graphics for the
g<nn>.png set of graphics.
Note: These graphics are provided as examples only; you will
probably need to replace or amend them as required.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual C-1
Cardholder Screen Graphics
Cardholder Example Graphics
Cardholder Example Graphics C
All the examples of cardholder graphics used by Advance NDC are
located as follows:
? On the development PC in
<install drive:>\<global>\final\xfs\dll
<install drive:>\<global>\test\xfs\dll
? On the SST in
C:\Program Files\NCR APTRA\Advance NDC\Media
The following cardholder graphic files (*.png) are provided with
Advance NDC and shown in this appendix:
? Insert Card (Screen G00)
? Press Key (Screen G01)
? Make a Deposit (Screen G03)
? Take Receipt (Screen G04)
? Take Cash (Screen G05)
? Take Statement (Screen G06)
? Scan Barcode (Screen G10).
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
C-2 APTRA™ Advance NDC, Reference Manual
Cardholder Screen Graphics
Cardholder Example Graphics
Insert Card (g00.png) C
Figure C-1
Insert Card (g00.png)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual C-3
Cardholder Screen Graphics
Cardholder Example Graphics
Press Key (g01.png) C
Figure C-2
Press Key (g01.png)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
C-4 APTRA™ Advance NDC, Reference Manual
Cardholder Screen Graphics
Cardholder Example Graphics
Make a Deposit (g03.png) C
Figure C-3
Make a Deposit (g03.png)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual C-5
Cardholder Screen Graphics
Cardholder Example Graphics
Take Receipt (g04.png) C
Figure C-4
Take Receipt (g04.png)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
C-6 APTRA™ Advance NDC, Reference Manual
Cardholder Screen Graphics
Cardholder Example Graphics
Take Cash (g05.png) C
Figure C-5
Take Cash (g05.png)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual C-7
Cardholder Screen Graphics
Cardholder Example Graphics
Take Statement (g06.png) C
Figure C-6
Take Statement (g06.png)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
C-8 APTRA™ Advance NDC, Reference Manual
Cardholder Screen Graphics
Cardholder Example Graphics
Scan Barcode (g10.png) C
Figure C-7
Scan Barcode (g10.png)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual C-9
Cardholder Screen Graphics
Cardholder Example Graphics
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
C-10 APTRA™ Advance NDC, Reference Manual
Table of Contents
Quick Reference to Message Types
Appendix D
Quick Reference to Message Types
Overview D‐1
Quick Reference to Message Types D‐2
Transaction Request D‐3
Unsolicited Status Messages D‐7
Solicited Status Messages D‐8
Encryptor Initialisation Data D‐9
Upload EJ Data Message D‐10
Terminal Commands D‐10
Customisation Data Commands D‐12
Transaction Reply D‐15
Acknowledge EJ Upload Block Command D‐21
Acknowledge and Stop EJ Command D‐21
EJ Options and Timers Command D‐21
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Quick Reference to Message Types
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
D
Overview
Overview D
This appendix is for programmers designing the host control
application, also known as Central. It provides a quick reference to
the types of message sent between the host and the terminal. For
each message type, the message class and sub‐class are shown, and
each field within the message. This will help you to quickly identify
the messages that pass to and from the host.
This appendix does not include information on the
protocol‐dependent headers and trailers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-1
Quick Reference to Message Types
Quick Reference to Message Types
Quick Reference to Message Types D
Table D-1
Quick Reference to Message Types
FS FS Fields
Message Message
(See Table LUNO (See Table (See Table Message Destination
Class Sub-Class
Note 1) Note 1) Note 2)
1 1 ~ 000 ~~~ ... Transaction Request Host
1 2 ~ 000 ~~ ... Unsolicited Status Host
2 2 ~ 000 ~~ ... Solicited Status Host
2 3 ~ 000 ~~ ... Encryptor Initialisation Data Host
3 ‐ ~ ‐ ~~ ... TM‐Alert Host
(Not supported)
6 1 ~ ~ ~~ ... Upload EJ Data Host
1 ‐ ~ ‐ ~~ ... Terminal Commands Terminal
3 1 ~ ‐ ~~ ... Customisation Data Commands Terminal
3 2 ~ ‐ ~~ ... Interactive Transaction Response Terminal
See Table Note 3
3 3 ~ ‐ ~~ ... Encryption Key Change Terminal
See Table Note 3
3 4 ~ ‐ ~~ ... Extended Encryption Key Change Terminal
See Table Note 3
4 ‐ ~ 000 ~ ... Transaction Reply Terminal
5 ‐ ~ ‐ ~~ ... TM‐Alert Terminal
(Not supported)
6 1 ~ ~ ~ ... Acknowledge EJ Upload Block Terminal
6 2 ~ ~ ~ ... Acknowledge and Stop EJ Terminal
6 3 ~ ~ ~ ... EJ Options and Timers Terminal
Table Note 1: Each tilda character (~) represents a field separator.
Table Note 2: The fields are identified in the message format tables
in the remainder of this appendix.
Table Note 3: The Interactive Transaction Response, Encryption
Key Change and Extended Encryption Key Change messages are
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-2 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
described in Table D‐11, “Customisation Data Command Fields”
on page D‐12.
Transaction Request D
Table D-2 Transaction Request 11~000~~~...
Transaction Request Message Format
Field Description Length
f Top of receipt transaction flag: 1
0 ‐ will not print data at the top of receipt
1 ‐ will print data at the top of receipt
g Message co‐ordination number 1
FS Field separator 1
h Track 2 data Var (39)
FS Field separator 1
i Track 3 data Var (106)
FS Field separator 1
j Operation code data 8
FS Field separator 1
k Amount entered 8 or 12
FS Field separator 1
l PIN buffer A Var (32)
FS Field separator 1
m General purpose buffer B. Var (32)
Minimum data length is 3 digits.
FS Field separator 1
n General purpose buffer C Var (32)
FS Field separator 1
o Track 1 identifier 1
p Track 1 data Var (78)
FS Field separator 1
q Transaction status data identifier 1
r Last transaction status data Var (65)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-3
Quick Reference to Message Types
Quick Reference to Message Types
Transaction Request 11~000~~~...
Field Description Length
FS Field separator 1
av1 CSP Data ID ‘U’ 1
av2 CSP Data Var (16)
FS Field separator 1
aw1 Confirmation CSP Data ID ‘V’ 1
aw2 Confirmation CSP Data Var (16)
FS Field separator 1
ax1 VC data ID ‘W’ 1
ax2 VC data 1
FS Field separator 1
ay1 VC data ID ‘X’ 1
ay2 VC data 1
FS Field separator 1
az1 VC data ID ‘Y’ 1
az2 VC data 1
FS Field separator 1
ba1 VC data ID ‘Z’ 1
ba2 VC data 1
FS Field separator 1
bb1 VC data ID ‘[‘ 1
bb2 VC data ID 1
FS Field separator 1
bc1 VC data ID ‘\’ 1
bc2 VC data 1
FS Field separator 1
bd1 Smart Card data ID ‘5’(EMV/CAM2) 1
bd2 Smart Card data 1
FS Field separator 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-4 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
Transaction Request 11~000~~~...
Field Description Length
ca1 Device ID ‘w’ for BNA/GBRU 1
ca2* Note Type in hex (01‐32); up to 50 types 2
ca3** Number of notes in escrow for ca2 2 or 3
* ca2 and ca3 may be repeated for up to 50
** the length depends on option 45 configuration.
FS Field separator 1
cb1 Single Cheque Deposit Data ID ‘a’ 1
cb2 Codeline detected 1
cb3 Codeline value Var(256)
FS Field Separator 1
ce1 Field ID ‘e’ shows that barcode data is 1
being reported
ce2 Barcode Format identifier given in ASCII 4
hex. If not known field is set to ‘0’
ce4 Scanned barcode data Var
cf1* Field id ‘f’. The value ‘f’ in this field shows 1
that more than four coin hopper types are
being reported.
*Note: The cf fields are only present when buffer
‘f’ is used because more than four hopper types are
configured. Otherwise, counts are shown in field
‘r’
cf2 Number of coins dispensed from hopper 2
type 1
cf3 Number of coins dispensed from hopper 2
type 2
cf4 Number of coins dispensed from hopper 2
type 3
:
The field is repeated for each hopper type specified in the Transaction
Reply message
:
cf<n Number of coins dispensed from hopper 2
+1> type n
FS Field separator 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-5
Quick Reference to Message Types
Quick Reference to Message Types
Transaction Request 11~000~~~...
Field Description Length
cg1 Field ID ‘g’ for a bunch cheque deposit 1
cg2 Total Cheques to Return 3
cg3 Must be ‘0000’ 4
cg4 Deposit Currency 3
cg5 Amount Exponent Sign 1
cg6 Amount Exponent Value 2
cg7 Total Customer Amount 12
cg8 Total Derived Amount 12
cg9 Must be ‘0000’ 4
cg10 Cheque Identifier 3
cg11 Customer Cheque Amount 12
cg12 Derived Cheque Amount 12
cg13 Codeline Length 3
cg14 Codeline Data var
cg15 Group separator 1
cg16 Group separator 1
FS Field Separator 1
ch1 Passbook Data ID ‘h’ 1
ch2 Page Number at Which Passbook is Open 2
ch3 Line Number of Next Printable Line 3
FS Field Separator 1
ci1 Data ID ʹ<ʹ Voice Guidance 1
ci2 Voice Guidance Language Identifier 1
GS Group separator 1
w Field separator 1
Data identifier 1
Data Var
FS Field separator 1
x Message Authentication Code data 8
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-6 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
Unsolicited Status
Messages D
Table D-3 Unsolicited Status Messages 12~000~~(e1)...
Unsolicited Status Message Format
Field Description Length
e1 Status identifier 1
A ‐ Time‐of‐day clock
B ‐ Power failure
D ‐ Card reader/writer
E ‐ Cash handler
F ‐ Depository
G ‐ Receipt printer
H ‐ Journal printer
H ‐ Electronic journal printer
K ‐ Night safe depository
L ‐ Encryptor
M ‐ Camera
N ‐ Door access (not supported)
P ‐ Sensors
Q ‐ Touch screen keyboard
R ‐ Supervisor keys
V ‐ Statement printer
X ‐ Passbook
Y ‐ Coin dispenser
\ ‐ Envelope dispenser
q ‐ Cheque processor
w ‐ Bunch Note Acceptor (BNA)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-7
Quick Reference to Message Types
Quick Reference to Message Types
Solicited Status Messages D
Table D-4 Solicited Status Messages 22~000~~f~(g1)...
Solicited Status Message Fields
Field Description Length
f Status descriptor 1
g Status information 1
Table D-5 f g1 Description
Solicited Status Message Field Values
8 Device fault
D Card reader/writer
E Cash handler
F Depository
K Night safe depository
V Statement printer
X Passbook
Y Coin dispenser
\ Envelope dispenser
q Cheque processor
w Bunch Note Acceptor (BNA)
9 Ready
A Command reject
B Ready (transaction reply)
C Specific command reject
1 MAC failure
2 Time variant number failure
3 Security terminal number mismatch
A Message format error
B Field value error
C Illegal message type
D Hardware failure
E Not supported
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-8 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
f g1 Description
F Terminal state
1 Send configuration information
2 Send supply counters
3 Send tally information
4 Send error log information
5 Send date/time information
6 Send configuration ID
F EKC retrieve hallmark key (unsupported)
H Hardware configuration data
I Supplies data
J Fitness data
K Tamper and sensor status data
L Software ID and release number data
M Local configuration option digits
Encryptor Initialisation
Data D
Table D-6 Encryptor Initialisation Data
Encryptor Initialisation Data
Field Description Length
e Information Identifier 1
1 ‐ EPP serial number and signature
2 ‐ EPP public key and signature
3 ‐ New Key Verification Value (KVV)
4 ‐ Keys status
5 ‐ Key loaded
6 ‐ Key entry mode
7 ‐ RSA encryption KVV
8 ‐ SST certificate
9 ‐ SST random number
A ‐ PKCS7 key loaded
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-9
Quick Reference to Message Types
Quick Reference to Message Types
Encryptor Initialisation Data
Field Description Length
B ‐ Encryptor capabilities and state
C ‐ Key deleted
D ‐ EPP attributes
E ‐ Variable‐length EPP serial number and
signature
f Encryptor Information Var
Upload EJ Data Message D
Table D-7 Upload EJ Data Message 61~~~~d
Upload EJ Data Message
Field Description Length
d Machine Number 6
e Date 6
f Time 6
g Last Character Previous Block 6
h Last Character This Block 6
i Block Length 3
j Response Data Var (1 to
350)
Terminal Commands D
Table D-8 Terminal Commands 1~~~fg
Terminal Command Fields
Field Description Length
f Command code 1
g Command modifier 1
Table D-9 f g Description
Field Values for Terminal Commands
1 Go in‐service
2 Go out‐of‐service
0 Standard out‐of‐service screen displayed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-10 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
f g Description
1 ‘Temporary’ out‐of‐service screen displayed
3 Send configuration ID
4 Send supply counters
None Send basic supply counters message
1 Send basic supply counters message
2 Send extended supply counters message
5 Send tally information
A Processor and system
B Communications
C System disk
D Card reader/writer
E Cash handler
F Depository
G Receipt printer
H Journal printer
I Reserved
J Reserved
K Night safe
L Encryptor
M Camera
N Door access (not supported)
O Off‐line disk
V Statement printer
X Passbook
Y Coin dispenser
\ Envelope dispenser
w Bunch note acceptor
q Cheque acceptor
6 Send error log information
A Processor and system
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-11
Quick Reference to Message Types
Quick Reference to Message Types
f g Description
B Communications
C SST devices
7 Send configuration information
0 Send configuration information
1 Send hardware information only
2 Send supplies data only
3 Send fitness data only
4 Send tamper and sensor status data only
5 Send software ID and release number data only
6 Send enhanced configuration data
7 Send local configuration option digits
8 Send BNA note definitions
8 Send date and time information
9 Reserved
: Reserved
; Reserved
= EKC retrieve hallmark key (not supported)
< Reserved
> Enable FREE JDATA
? Enable image dumping (not supported)
0 Do not allow access to ‘Dump Images’
1 Allow access to ‘Dump Images’
Customisation Data
Commands D
Table D-10 Customisation Data Commands 3~~~fg
Customisation Data Command Fields
Field Description Length
f Message sub‐class 1
g Message identifier 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-12 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
Table D-11 f g Description
Field Values for Data Commands
1 Customisation data
1 Screen and/or keyboard data load
2 State tables load
3 Configuration parameters load
4 Reserved
5 FIT data load
6 Configuration ID number load
A Enhanced configuration parameters load
B MAC field selection load
C Date and time load
D Reserved
E Dispenser currency cassette mapping table
F Initialise EKC (not supported)
G Override reserved screens command
2 Interactive transaction response
0 Do not display cardholder keyboard entry
1 Display cardholder keyboard entry
2 Display ‘*’ for cardholder keyboard entry
3 Encryption key change
1 Decipher new master key with current master key
2 Decipher new communications key with current
master key
3 Decipher new communications key with current
communications key
4 Use locally entered communications key (‘B’ key) as
current MAC key
5 Decipher new MAC key with current master key
6 Decipher new MAC key with current
communications key
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-13
Quick Reference to Message Types
Quick Reference to Message Types
f g Description
7 Use locally entered communications key (‘B’ key) as
current MAC key
8 Decipher new VISA master key with current VISA
master key
9 Key data is new VISA key table
4 Extended encryption key change
1 Decipher new master key with current master key
2 Decipher new communications key with current
master key
3 Decipher new communications key with current
communications key
4 Use locally entered communications key (‘B’ key) as
current MAC key
5 Decipher new MAC key with current master key
6 Decipher new MAC key with current
communications key
7 Use locally entered communications key (‘B’ key) as
current MAC key
8 Decipher new VISA master key with current VISA
master key
9 Key data is new VISA key table
A Decipher new VISA master key with current master
key
B Load Host Security Module (HSM) public key and
signature
C Load initial master key (A‐key) with RSA key
D Load new initial communications key (B‐key) with
RSA key
E Load new initial VISA master key (V‐key) with RSA
key
F Send Encrypting PIN Pad (EPP) serial number
G Send EPP public key
H Send all Key Verification Values (KVVs)
I Reserved
J Set key entry mode
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-14 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
f g Description
K Send current key entry mode
N Send random ATM number
Q Send encryptor capabilities and state
R Load NCR Sub public key and signature
S Delete HSM public key
T Delete NCR Sub public key
U Send EPP attributes
V Send variable length EPP serial number
Transaction Reply D
Table D-12 Transaction Reply 4~000~...
Transaction Reply
Field Description Length
e Message sequence number 3 or 8
FS Field separator 1
f Next state identifier 3
FS Field separator 1
g1 Number of type 1 notes to dispense 2
g2 Number of type 2 notes to dispense 2
g3 Number of type 3 notes to dispense 2
g4 Number of type 4 notes to dispense 2
g5 Number of type 5 notes to dispense 2
g6 Number of type 6 notes to dispense 2
g7 Number of type 7 notes to dispense 2
GS Group separator 1
j1 Number of hopper 1 coins to dispense 2
j2 Number of hopper 2 coins to dispense 2
j3 Number of hopper 3 coins to dispense 2
j4 Number of hopper 4 coins to dispense 2
j5 Number of hopper 5 coins to dispense 2
...
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-15
Quick Reference to Message Types
Quick Reference to Message Types
Transaction Reply 4~000~...
Field Description Length
jn Number of hopper n coins to dispense 2
FS Field separator 1
k Transaction serial number 4
l Function identifier: 1
1 ‐ Deposit and print
2 ‐ Dispense and print
3 ‐ Display and print
4 ‐ Print immediate
5 ‐ Set next state and print
6 ‐ Night safe deposit and print
7 ‐ Deposit and print
8 ‐ Dispense and print
9 ‐ Display and print
A ‐ Eject card, dispense and print
B ‐ Parallel dispense, print and card eject
C ‐ Parallel dispense, print and card eject
E ‐ Reserved
F ‐ Card before parallel dispense and print
O ‐ Reserved
P ‐ Print statement and wait
Q ‐ Print statement and set next state
R ‐ Reserved
S ‐ Process document with cash (Not
supported)
T ‐ DPM deposit envelope (Not supported)
* ‐ Refund notes and print
‐ ‐ Deposit notes and print
‘ ‐ Deposit notes and wait
: ‐ Process cheque
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-16 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
Transaction Reply 4~000~...
Field Description Length
b ‐ Dispense cash first during valuable
media exchange
c ‐ Process multiple cheques
f ‐ Deposit media first during valuable
media exchange
m Screen number 3
n Screen display update Var
FS Field Separator 1
o Message co‐ordination number 1
p Card return/retain flag: 1
0 ‐ Return card during Close state
1 ‐ Retain card during Close state
q Printer flag: 1
0 ‐ Do not print
1 ‐ Print on journal only
2 ‐ Print on receipt only
3 ‐ Print on receipt and journal
4 ‐ Print on PPD if Function ID is ‘1’ or ‘7’
5 ‐ Print on PPD and journal if Function ID
is ‘1’ or ‘7’
8 ‐ Print on statement only
9 ‐ Reserved
: ‐ Reserved
= ‐ Sideways printing on receipt if
Function ID is ‘P’ or ‘Q’
‘>’ or ‘w’ ‐ Identifies audio data for a
voice‐guided session
a ‐ Stamp cheque, without printer data, if
the Function ID is ‘:’ (Process cheque).
b ‐ Endorse cheque, with printer data, if
the Function ID is ‘:’ (Process cheque)
r Printer data Var (500)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-17
Quick Reference to Message Types
Quick Reference to Message Types
Transaction Reply 4~000~...
Field Description Length
GS Group separator 1
s Printer flag 1
t Printer data Var (500)
GS Group separator 1
u Printer flag 1
v Printer data Var (500)
GS Group separator 1
v1 Printer flag 1
v2 Printer data Var (500)
GS, v1 and v2 may be repeated up to nine
further times
FS Field separator 1
w Buffer identifier 1
x Track 3 data Var (106)
FS Field separator 1
ak1 Buffer identifier K 1
ak2 Track 1 Data Var (78)
FS Field Separator 1
al1 Buffer identifier L 1
al2 Track 2 Data Var (39)
FS Field Separator 1
am1 VC data ID ‘M’. 1
am2 VC data Var
FS Field Separator 1
an1 VC data ID ‘N’. 1
an2 VC data Var
FS Field Separator 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-18 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
Transaction Reply 4~000~...
Field Description Length
ao1 VC data ID ‘O’. Var
ao2 VC data Var
FS Field Separator 1
ap1 VC data ID ‘P’. 1
ap2 VC data Var
FS Field Separator 1
aq1 VC data ID ‘Q’. 1
aq2 VC data Var
FS Field Separator 1
ar1 VC data ID ‘R’. 1
ar2 VC data Var
FS Field Separator 1
as1 Buffer identifier S (Reserved for internal use) 1
as2 Cash handler number (0 or 1) 1
as3 1st cassette type in specified cash handler 3
as4 Number of bills to dispense from 1st type 3
as5 2nd cassette type in specified cash handler 3
as6 Number of bills to dispense from 2nd type 3
as7 3rd cassette type in specified cash handler 3
as8 Number of bills to dispense from 3rd type 3
as9 4th cassette type in specified cash handler 3
as10 Number of bills to dispense from 4th type 3
...
as(n) Last cassette type in specified cash handler 3
as(n+1) Number of bills to dispense from last type 3
FS Field Separator 1
at1 Smart card data ID ‘5’ 1
at2 Smart card data 1
FS Field Separator 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-19
Quick Reference to Message Types
Quick Reference to Message Types
Transaction Reply 4~000~...
Field Description Length
ba1 Cheque(s) destination data ID ‘a’ 1
ba2 Cheque(s) destination data 1
1 ‐ Deposit cheque(s) into pocket 1
2 ‐ Deposit cheque(s) into pocket 2
3 ‐ Deposit cheque(s) into pocket 3
4 to 9 ‐ Deposit cheque(s) into pocket 4 to 9
(Not supported)
a to f ‐ Deposit cheque(s) into pocket 10 to
15 (Not supported)
E ‐ Eject the cheque(s)
FS Field Separator 1
bb1 Buffer identifier B 1
bb2 Cheque identifier 3
bb3 Cheque destination 2
bb4 Cheque stamp 1
bb5 Reserved 4
bb6 Cheque endorse text Var
GS Group Separator 1
FS Field Separator 1
bc EMV dynamic currency conversion 1
FS Field Separator 1
bd1 Buffer Identifier ‘d’ 1
bd2 Reserved 10
bd3 Customer/Transaction Data Element 3
Identifier
bd4 Customer/Transaction Data Element Var
Buffer
bd5 Group separator (GS) 1
y MAC data 8
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-20 APTRA™ Advance NDC, Reference Manual
Quick Reference to Message Types
Quick Reference to Message Types
Acknowledge EJ Upload
Block Command D
Table D-13 Acknowledge EJ Upload Block command 6~~~1d.
Acknowledge EJ Upload Block Command
Field Description Length
d Last Character Received 6
Acknowledge and Stop EJ
Command D
Table D-14 Acknowledge and Stop EJ command 6~~~2d.
Acknowledge and Stop EJ Command
Field Description Length
d Last Character Received 6
EJ Options and Timers
Command D
Table D-15 EJ Options and Timers command 6~~~3d.
EJ Options and Timers Command
Field Description Length
d Option Number 2
e Option Value 3
f Timer Number 2
g Timer Value 3
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual D-21
Quick Reference to Message Types
Quick Reference to Message Types
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
D-22 APTRA™ Advance NDC, Reference Manual
Table of Contents
Device Identifiers
Appendix E
Device Identifiers
Overview E‐1
Hardware Configuration Data E‐2
Supplies Data E‐12
Cash Acceptor Supplies (DIG ‘w’) E‐17
Cash‐In Cassettes and Bit 3 = 0 E‐17
Cash‐In Cassettes and Bit 3 = 1 E‐19
No Change Reporting E‐19
Fitness Data E‐20
Cash Acceptor Fitness (DIG ‘w’) E‐25
Tamper Data E‐27
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual
Table of Contents
Device Identifiers
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
E
Overview
Overview E
Device identifiers are generally known as DIGs (device identifier
graphics). They are returned in the Status Information field of
solicited or unsolicited device status messages and indicate the
device to which the data in the message applies.
The tables in this appendix show which SST device the DIGs relate
to, the values they can take and the data accompanying them.
For more information about the Status Information field, see the
following sections in Chapter 9, “Terminal to Central Messages”:
For solicited status information, “Device Fault Status
Information Field” on page 9‐79
“Unsolicited Status Information Field” on page 9‐94.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-1
Device Identifiers
Hardware Configuration Data
Hardware Configuration Data E
The following table summarises the hardware configuration data
associated with each device.
Note: Although the Passbook Printer is not supported in Advance
NDC, the application can be extended for it.
Table E-1
Device Hardware Configuration Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
A 41 Time‐of‐Day Clock
This DIG is never returned in the configuration field
B 42 Communications
This DIG is never returned in the configuration field
C 43 System Disk var (2)
00 Hard disk drive present
01 Reserved
02 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-2 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Hardware Configuration Data
ASCII Value
DIG Device Name and Associated Configuration Data (Continued) Data Length
(Hex)
D 44 Magnetic Card Reader/Writer var (2)
00 No card reader attached
01 Track 2 (read only)
02 Reserved
03 Track 1/2/3 MCRW (write on track 3 only)
(Also returned if the card reader cannot be identified)
04 Reserved
05 PC Dip Reader
06 Reserved
07 3 Track Write MCRW
08 Track 2 Smart Card Reader
09 Track 1/2/3 Smart Card Reader
0A 3 Track Write Smart Card Reader
0B Track 1/2 and Track 2/3 Dip MSR
0C Track 1/2/3 CIM86 MCRW
0D Reserved
0F Reserved
10 Track 1/2 Dip MSR
11 Track 1/2 Swipe Reader
1D DASH Reader
1E Track 1/2/3 with MM
1F Track 1/2/3 Smart with MM
20 Track 3 Smart with MM
47 Contactless Card Reader (Magnetic Stripe Data only)
48 Contactless Card Reader (Magnetic Stripe Data and
Contactless EMV Transactions)
See Table Note 6
E 45 Cash Handler var (2)
00 Not configured See Table
01 Stacking cash handler Note 5
02 Spray dispenser
03 Stacking cash handler with recycle capabilities. On
NCR SSTs, this is known as the GBRU
04 Stacking cash handler capable of recycling but the
recycle capabilities are disabled. On NCR SSTs, this is
known as the GBRU.
Note 1: Whether recycling is enabled or disabled, the
M‐Status values reported in device status messages for
the GBRU are compatible with the GBXX family.
Note 2: For a dual dispenser system, what is reported
here is the same as DIG ʹdʹ — the primary dispenser
If extended cassettes are supported, the following is also reported:
Maximum Items Dispense var (3)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-3
Device Identifiers
Hardware Configuration Data
ASCII Value
DIG Device Name and Associated Configuration Data (Continued) Data Length
(Hex)
040‐070 The total number of notes that can be dispensed for a
transaction.
F 46 Envelope Depository var (2)
00 Not configured
01 Reserved
02 Programmable printing depository
03 Reserved
04 Reserved
G 47 Receipt Printer var (2)
00 Not configured
01 Plain paper
02 Black dot paper
03 Sideways printing, no black mark
04 Sideways printing, black mark
05 Thermal printer ‐ no black mark
06 Thermal printer ‐ black mark
07 Thermal printer ‐ sideways printing, no black mark
08 Thermal printer ‐ sideways printing, black mark
H 48 Journal Printer var (2)
00 Not configured
01 Integral journal printer
02 Reserved
03 Thermal printer
80 Electronic journal
81 Electronic journal and integral journal printer
82 Reserved
83 Electronic journal and thermal journal printer
99 Reserved
I 49 Reserved
This DIG is never returned in the configuration field
J 4A Reserved
This DIG is never returned in the configuration field
K 4B Night Safe Depository var (2)
00 Not configured
01 Configured
02 Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-4 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Hardware Configuration Data
ASCII Value
DIG Device Name and Associated Configuration Data (Continued) Data Length
(Hex)
L 4C Encryptor var (2)
00 Not configured
?1 BAPE encryptor
02 Reserved
03 Reserved
04 Reserved
05 Reserved
06 Reserved
?7 EPP encryptor
? = SST key entry mode (0, B, C or D) where:
0 = single‐length keys without XOR key entry
B = single‐length keys using XOR key entry
C = double‐length keys
D = double‐length keys, restricted mode
For example,
C7 = double‐length key entry with an EPP encryptor.
M 4D Security Camera var (2)
00 Not configured
01 Fixed format
02 Variable format
03 Reserved
04 Digital
N 4E Door Access System (Not supported) var (2)
00 Not configured
O 4F Off‐Line Flex Disk var (2)
00 Not configured
01 1.44 MB flex disk drive
02 2.88 MB flex disk drive
P 50 TI Bins (Alarms) var (2)
01 Secure cash, insecure cards, and either
insecure deposit bin or no depository
Q 51 Cardholder Keyboard var (2)
00 Reserved
01 Standard (BAPE) keyboard
02 EPP keyboard
R 52 Operator Keyboard var (2)
00 Not configured
01 Standard keyboard (basic)
02 Keyboard plus FDKs (enhanced)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-5
Device Identifiers
Hardware Configuration Data
ASCII Value
DIG Device Name and Associated Configuration Data (Continued) Data Length
(Hex)
S 53 Cardholder Display/Voice var (2)
BIT 0 Always zero
BIT 1 Always zero
BIT 2 0 ‐ no voice
BIT 2 1 ‐ voice supported if digital audio is present
BIT 3 0 ‐ standard FDKs
BIT 3 1 ‐ touch screen
BITs 4‐7 0 ‐ (reserved — always zero)
T 54 Reserved
This DIG is never returned in the configuration field
U 55 Reserved
This DIG is never returned in the configuration field
V 56 Statement Printer var (2)
00 Not configured
01 Configured
02 Reserved
03 Reserved
04 Reserved
05 Reserved
09 80‐column thermal (SDC+)
W 57 Reserved
This DIG is never returned in the configuration field
X 58 Passbook (Not supported) var (4)
BIT 0 1 = Passbook printer present
BIT 1 1 = Passbook printer can read magnetic stripe
BIT 2 1 = Passbook printer can write magnetic stripe
BIT 3 1 = Passbook printer can read page number
BIT 4 1 = Passbook printer can scan for next blank line
BIT 5 1 = Passbook printer can turn pages
BITs 6—16 Reserved
Y 59 Coin Dispenser var (7)
Byte Description
1‐2 00 ‐ Not configured See Table
01 ‐ Reserved Note 1
02 ‐ Coin dispenser with up to four hopper types
03 ‐ Coin dispenser with more than four hopper types
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-6 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Hardware Configuration Data
ASCII Value
DIG Device Name and Associated Configuration Data (Continued) Data Length
(Hex)
Byte Description
3‐4 Number of hopper types. This is a two‐digit decimal
number.
5‐7 Total number of coins that can be dispensed per
transaction. This is a three‐digit decimal number.
Z 5A System Display var (2)
00 Not configured
01 Reserved
02 Configured (16 x 32)
[ 5B Media Entry Indicators var (2)
00 Not configured
01 Configured
\ 5C Envelope Dispenser var (2)
00 Not configured
01 Configured
02 Reserved
03 Reserved
a 61 Voice Guidance var (2)
00 Not present
01 Audio present or Standard audio present
02 Enhanced audio
d 64 Cash Handler 0 var (5)
00 Not configured
01 Stacking cash handler
02 Spray dispenser
03 Stacking cash handler with recycle capabilities. On
NCR SSTs, this is known as the GBRU
04 Stacking cash handler capable of recycling but the
recycle capabilities are disabled. On NCR SSTs, this is
known as the GBRU.
Note: Whether recycling is enabled or disabled, the
M‐Status values reported in device status messages for
the GBRU are compatible with the GBXX family.
Maximum Items Dispense
040‐070 The total number of notes that can be dispensed for a
transaction.
This DIG is only reported when extended cassette types are
supported.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-7
Device Identifiers
Hardware Configuration Data
ASCII Value
DIG Device Name and Associated Configuration Data (Continued) Data Length
(Hex)
e 65 Cash Handler 1 var (5)
00 Not configured
01 Stacking cash handler
02 Spray dispenser
03 Stacking cash handler with recycle capabilities. On
NCR SSTs, this is known as the GBRU
04 Stacking cash handler capable of recycling but the
recycle capabilities are disabled. On NCR SSTs, this is
known as the GBRU.
Note: Whether recycling is enabled or disabled, the
M‐Status values reported in device status messages for
the GBRU are compatible with the GBXX family.
Maximum Items Dispense
040‐070 The total number of notes that can be dispensed for a
transaction.
This DIG is only reported when extended cassette types are
supported.
f 66 Barcode Reader var (4)
0001 Barcode reader configured
J 70 UPS var (2)
00 Not configured
01 UPS configured
q 71 Cheque Processor var (4)
Configuration data length var(4) is an ASCII representation of a
hexadecimal number.
0000 Not configured
00xx Configured
When Enhanced Configuration option 83 is ‘000’ the following is
returned:
Bit 0 = 1 MICR reader is supported
Bit 1 = 1 Rear printer is supported
Bit 2 = 0 Is currently reserved and is always 0
Bit 3 = 1 Front scanner is supported
Bit 4 = 1 Rear scanner is supported
Bits 5 to 6 Number of bins (1‐3), with bit 5 as low bit.
Bits 7 to 15 Reserved and are always 0
For example, ‘006B’ indicates CPM configured with MICR reader,
rear printer, front scanner and three bins.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-8 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Hardware Configuration Data
ASCII Value
DIG Device Name and Associated Configuration Data (Continued) Data Length
(Hex)
When Enhanced Configuration option 83 is ‘001’ the following is
returned:
Bit 0 = 1 MICR reader is supported
Bit 1 = 1 Rear printer is supported
Bit 2 = 1 Cheque stamper is supported
Bit 3 = 1 Front scanner is supported
Bit 4 = 1 Rear scanner is supported
Bits 5 to 8 Contains the number of bins. Bit 8 is the high bit and
bit 5 is the low bit
Bit 9 = 1 Device is a bunch cheque acceptor (if not set, device is
a CPM)
Bit 10 = 1 Device is a bunch cheque acceptor that can also accept
cash. Either cash or cheques can be accepted in a single See Table
transaction, but not both. Note 2
Bit 11 = 1 Device is a bunch cheque acceptor that can also accept and Table
cash. Cash and cheques can be accepted together as Note 3
part of a single transaction (Not supported).
Bit 12 = 1 Optical Character Recognition (OCR) codeline read is
supported
Bit 13 = 1 MICR reader supports E13B
Bit 14 = 1 MICR reader supports CMC7
Bit 15 Reserved
For example, ‘20AB’ indicates CPM configured with E13B MICR
reader with 5 bins, front scanner and rear printer.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-9
Device Identifiers
Hardware Configuration Data
ASCII Value
DIG Device Name and Associated Configuration Data (Continued) Data Length
(Hex)
w 77 Note Acceptor var
See Table Note 4 (2 or 6)
00 Not configured
03 Bunch Note Acceptor See Table
04 Bunch Note Acceptor with recycle capabilities. For Note 5
NCR SSTs, this is either a GBRU or BRM. See Table
Note 7
05 Bunch Note Acceptor. For NCR SSTs this is known as See Table
the GBNA; it can also be reported when a GBRU or Note 7
BRM is present with recycling disabled.
06 Bunch Note Acceptor that can also accept cheques.
Either cash or cheques can be accepted in a single
transaction but not both. The NCR SDM can be
configured as this type of device.
07 Device is a bunch cheque acceptor that can also accept See Table
cash. Cash and cheques can be accepted together as Note 2
part of a single transaction. (Not supported).
08 Single note acceptor
y 79 Secondary Card Reader var (2)
47 Contactless Card Reader (Magnetic Stripe Data only)
48 Contactless Card Reader (Magnetic Stripe Data and
Contactless EMV Transactions)
Advance NDC supports only a contactless card reader
as the secondary card reader.
See Table Note 6
Table Note 1: If Option 79 is set to 000, only the first two bytes are
reported. If Option 79 is set to 001, all seven bytes are reported.
Table Note 2: You can configure an NCR scalable deposit module
(SDM) either as a cheque processor that can accept cash and cheques
or as a cash acceptor that can accept either cash or cheques but not
both in a single transaction.
Table Note 3: Bits 10 and 11 are mutually exclusive.
Table Note 4 The data length depends on whether Advance NDC
is configured to report characters 3 to 6 for additional information
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-10 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Hardware Configuration Data
about the direct deposit capabilities of the device. For details, see
“Note Acceptor Capabilities” on page 9‐51.
Table Note 5: For a recycling unit, the cash handler variant is
reported as 03 and the cash acceptor variant is reported as 04 only if
recycling mode is enabled.
Table Note 6 The variant of contactless card reader is reported to
host as:
47 and supports only the Magnetic Stripe Data in Advance NDC
4.03.
48 and supports both Magnetic Stripe Data and contactless EMV
in Advance NDC 4.04.
Table Note 7 The M‐Status values reported in device status
messages are specific to the device.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-11
Device Identifiers
Supplies Data
Supplies Data E
The following table summarises the supplies data associated with
each device.
Note: For the 40‐column journal printer, only three values (paper,
ribbon and print‐head) are returned in a supplies response, unlike
unsolicited status messages, which always include a value of OK for
the knife.
Table E-2
Device Supplies Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
A 41 Time‐of‐Day Clock
This DIG is never returned in the supplies field
B 42 Communications
This DIG is never returned in the supplies field
C 43 System Disk
This DIG is never returned in the supplies field
D 44 Magnetic Card Reader/Writer var (1)
Card Capture bin 1
E 45 Cash Handler var (5)
Cash handler reject bin 1
Cash handler cassette type 1 1
Cash handler cassette type 2 1
Cash handler cassette type 3 1
Cash handler cassette type 4 1
If extended cassettes are supported, this is extended to include the
following:
Cash handler cassette type 5 1
Cash handler cassette type 6 1
Cash handler cassette type 7 1
See Table
Note 10
F 46 Envelope Depository var (1)
Envelope deposit bin 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-12 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Supplies Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
G 47 Receipt Printer var (5)
Receipt printer paper 1
Receipt printer ribbon 1 See Table
Note 8
Receipt printer print‐head 1
Receipt printer knife 1
Receipt printer capture bin 1 See Table
Note 9
H 48 Journal Printer var (3)
Journal printer paper 1
Journal printer ribbon 1 See Table
Note 8
Journal printer print‐head 1
I 49 Reserved
This DIG is never returned in the supplies field
J 4A Reserved
This DIG is never returned in the supplies field
K 4B Night Safe Depository var (1)
Night safe bin 1
L 4C Encryptor
This DIG is never returned in the supplies field
M 4D Security Camera var (1)
Security camera film 1
N 4E Door Access System (Not supported)
O 4F Off‐Line Disk
This DIG is never returned in the supplies field
P 50 TI Bins (Alarms)
This DIG is never returned in the supplies field
Q 51 Cardholder Keyboard
This DIG is never returned in the supplies field
R 52 Operator Keyboard
This DIG is never returned in the supplies field
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-13
Device Identifiers
Supplies Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
S 53 Cardholder Display
This DIG is never returned in the supplies field
T 54 Reserved
This DIG is never returned in the supplies field
U 55 Reserved
This DIG is never returned in the supplies field
V 56 Statement Printer var (5)
Statement printer paper 1
Statement printer ribbon 1
Statement printer print‐head 1
Statement printer knife 1
Statement printer capture bin 1
W 57 Reserved
This DIG is never returned in the supplies field
X 58 Passbook Printer (Not supported) var (5)
Reserved 1
Passbook printer ribbon 1
Passbook printer print‐head 1
Reserved 1
Passbook printer capture bin 1
Y 59 Coin Dispenser* var (4)
Coin dispenser hopper type 1 1
Coin dispenser hopper type 2 1
Coin dispenser hopper type 3 1
Coin dispenser hopper type 4 1
:
Coin dispenser hopper typen 1
See Table
Note 13
Z 5A System Display
This DIG is never returned in the supplies field
[ 5B Media Entry Indicators
This DIG is never returned in the supplies field
\ 5C Envelope Dispenser var (1)
Envelope dispenser hopper 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-14 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Supplies Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
d 64 Cash Handler 0 var (29)
Reject bin 1
Cassette type 1 3
Cassette type 1 supplies status 1
Cassette type 2 3
Cassette type 2 supplies status 1
Cassette type 3 3
Cassette type 3 supplies status 1
Cassette type 4 3
Cassette type 4 supplies status 1
Cassette type 5 3
Cassette type 5 supplies status 1
Cassette type 6 3
Cassette type 6 supplies status 1
Cassette type 7 3
Cassette type 7 supplies status 1
See Table
This DIG is only reported when extended cassette types are Note 10 and
supported. Table Note
11
e 65 Cash Handler 1 var (29)
Reject bin 1
Cassette type 1 3
Cassette type 1 supplies status 1
Cassette type 2 3
Cassette type 2 supplies status 1
Cassette type 3 3
Cassette type 3 supplies status 1
Cassette type 4 3
Cassette type 4 supplies status 1
Cassette type 5 3
Cassette type 5 supplies status 1
Cassette type 6 3
Cassette type 6 supplies status 1
Cassette type 7 3
Cassette type 7 supplies status 1
See Table
This DIG is only reported when extended cassette types are Note 10 and
supported. Table Note
11
q 71 Cheque Processor var(1)
When Option 83 is ‘000’ supplies information is not reported to
the host for the cheque processor. DIG ‘q’ will not be present.
When Option 83 is ‘001’ or ‘002’ the following is returned:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-15
Device Identifiers
Supplies Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
Endorse printer 1
Stamper 1
Reserved 1
Reserved 1
Bin 1 1
Bin 2 1
: :
Bin n 1
See Table Note 12
w 77 Bunch Note Acceptor (BNA) var (1)
BNA Cash Bin
For details of the supplies status of all cassettes, see “Cash
Acceptor Supplies (DIG ‘w’)” on page E‐17
y 79 Secondary Card Reader var (1)
As Advance NDC supports only a contactless card reader as the 1
secondary card reader, this DIG is never returned in the supplies
field
Table Note 8: Always 1 (Good State) for Thermal printers.
Table Note 9: If the printer does not have a capture bin but the
registry is configured to send the receipt capture bin status, the
value is 0.
If the receipt printer has a capture bin but the registry is not
configured to send the receipt capture bin status, this value is not
reported in the status message.
For details, refer to Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC Developer’s
Guide.
Table Note 10: When extended cassette types are supported, using
Enhanced Configuration option 76, DIG ‘E’ reports the combined
supplies status. Separate cash handler supplies status is given in
DIG ‘d’ and DIG ’e’.
Table Note 11: The reject bin supplies status reports the combined
status for both the reject bin and the retract bin, where present. The
status takes the value of the fullest bin, as an overfill on either will
prevent further use of the SST.
Table Note 12: A supplies value is reported for the number of bins
reported within the cheque processor data in the hardware
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-16 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Supplies Data
configuration message. In addition to the standard supplies values
‘0’ to ‘4’, the following supplies value is also possible:
Supplies Status Data Value Description
‘5’ Media high (almost full)
Table Note 13: Hopper positions 1 to 4 are always present, hopper
positions 5 to n are only present when more than four hopper types
are configured.
The reporting of the status of a cash acceptor is configured using
Cash Acceptor Supplies enhanced configuration option 45. For details of the settings, see
(DIG ‘w’) E
“Option 45 – BNA Settings” on page 7‐15.
The states reported for all cassettes in the cash acceptor are as
follows:
Table E-3 Code Description
Supplies Status of all Cash Acceptor
Cassettes ‘0’ Not configured (terminal command responses)
No change (device status messages)
‘1’ Good state
‘2’ Bin out (missing or removed)
‘3’ Media high (nearly full)
‘4’ Media full (overfill)
The message format depends on the extended message format
setting (bit 3), as described in the following sections.
Cash‐In Cassettes and Bit 3 = 0 E
If option 45 specifies that the extended message format is not to be
used, how the status is reported depends on the option 45 setting for
note reporting (bit 4). When the extended message format is not
used, the BNA data is a single byte. For more information, see the
“Option 45: BNA Settings Bit Values” on page 7‐15 in Chapter 7,
“Configuration Parameters”.
Bit 4 = 0 If option 45 specifies that a supplies status is to be 5
reported when the first cassette is full or nearly full, the most severe
status of any cassette is reported. The most severe supplies status is
calculated as described in Table E‐4.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-17
Device Identifiers
Supplies Data
Table E-4 Overall Status Description
Most Severe BNA Cassette Supplies
Status Reporting Good All cassettes have a supplies status of Good
Overfill Any cassette has a supplies status of Overfill
Bin Out Any cassette has a supplies status of Bin Out and none
have a supplies status of Overfill
Nearly Any cassette has a supplies status of Nearly Full and none
Full have a supplies status of Overfill or Bin Out
Bit 4 = 1 If option 45 specifies that a supplies status is to be 5
reported when one retract bin or all cash‐in cassettes are full, the
following are compared and the most severe status reported:
The least severe status of any cash‐in cassette, calculated as
described in Table E‐5. Supplies severities from least to most
severe are: Good; Nearly Full; Bin Out; Overfill
The overall retract status, calculated as described in Table E‐8.
Table E-5 Overall Status Description
Least Severe BNA Cassette Supplies
Status Reporting Good Any cassette has a supplies status of Good
Overfill All cassettes have a supplies status of Overfill or Bin Out
Bin Out All cassettes have a supplies status of Bin Out
Nearly Any cassette has a supplies status of Nearly Full and none
Full have a supplies status of Good
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-18 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Supplies Data
Cash‐In Cassettes and Bit 3 = 1 E
With option 45 set to enable the extended message format, the BNA
data is extended to report a variable number of cassettes for the cash
acceptor as follows:
Table E-6 Character Description
Cash Acceptor Supplies:
Extended Message Format 0 Retract/Reject/Level 2 Bin
The “level 2” bin is for ECB6 category 2 notes;
also referred to as the counterfeit bin
This is always reported
1 ‐ 3 The first CIM NDC cassette type to be reported
in the range ʹ001ʹ ‐ ʹ999ʹ
n‐m Logical cassette type identifier where n is the
first character and m is the last character of the
three‐digit logical cassette type in the range ʹ001ʹ
‐ ʹ999ʹ
This is repeated as necessary to report all CIM
NDC cassette type
See Table Note 14
y Supplies state of the cassette type identified by
the previous three characters
Table Note 14 Every CIM NDC cassette type that has been inserted
in the device will be reported, whether or not that cassette type is
currently present.
For more information about the reporting of CIM NDC cassette
types, see “Reporting of CIM NDC Cassette Types” on page 9‐24.
No Change Reporting E
In the BNA device status message, a supplies status of ‘0’ No
Change is reported in the following situations:
When a threshold or cash unit error has occurred, the extended
message format is enabled, and the cash‐in cassette or retract bin
was not used in the last transaction
When no threshold or cash unit error has occurred and the
cash‐in cassette or retract bin was not used in the last
transaction.
Note: For a BRM device, if ECB6 is not enabled, the Upper
Exception Bin can not be used as a retract destination due to
platform limitations.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-19
Device Identifiers
Fitness Data
Fitness Data E
The following table summarises the fitness data associated with
each device. Where a device has multiple severities, they are given
in the order in which they appear in the message.
Table E-7
Device Fitness Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
A 41 Time‐of‐Day Clock var (1)
Fitness Time of Day Clock 1
B 42 Communications var (1)
Fitness Communications 1
C 43 System Disk var (1)
Fitness system disk 1
D 44 Magnetic Card Reader/Writer var (1)
Fitness magnetic card 1
Fitness Contactless Card Reader 1
DIG ‘D’ is reported for Primary Card Reader
E 45 Cash Handler var (5)
Fitness cash handler 1
Fitness cassette type 1 1
Fitness cassette type 2 1
Fitness cassette type 3 1
Fitness cassette type 4 1
If extended cassettes are supported, this is extended to include the
following:
Cash handler cassette type 5 1
Cash handler cassette type 6 1
Cash handler cassette type 7 1
See Table
Note 15
F 46 Envelope Depository var (1)
Fitness depository 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-20 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Fitness Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
G 47 Receipt Printer var (2)
Fitness receipt printer 1
Fitness capture bin 1
See Table
Note 16
H 48 Journal Printer var (1)
Fitness journal printer 1
I 49 Reserved
This DIG is never returned in the fitness field
J 4A Reserved
This DIG is never returned in the fitness field
K 4B Night Safe Depository var (1)
Fitness night safe depository 1
L 4C Encryptor var (1)
Fitness encryptor 1
M 4D Security Camera var (1)
Fitness security camera 1
N 4E Door Access System (Not supported)
O 4F Off‐Line Flex Disk var (1)
Fitness off‐line flex disk 1
P 50 TI Bins (Alarms)
This DIG is never returned in the fitness field
Q 51 Cardholder Keyboard var (1)
Fitness cardholder keyboard 1
R 52 Operator Keyboard
This DIG is never returned in the fitness field
S 53 Cardholder Display var (1)
Fitness cardholder display 1
See Table
Note 17
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-21
Device Identifiers
Fitness Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
T 54 Reserved
This DIG is never returned in the fitness field
U 55 Reserved
This DIG is never returned in the fitness field
V 56 Statement Printer var (1)
Fitness statement printer 1
W Reserved
This DIG is never returned in the fitness field
X 58 Passbook (Not supported) var (1)
Fitness passbook printer
Y 59 Coin Dispenser var (5)
Fitness coin dispenser 1
Fitness hopper 1 1
Fitness hopper 2 1
Fitness hopper 3 1
Fitness hopper 4 1
Fitness hopper 5 1
Fitness hopper n 1
Hopper refers to a single hopper or a logical combination of
physical hoppers (a hopper type) depending on the hardware
configuration.
Hopper positions 1 to 4 are always present, hopper positions 5 to n
are only present when more than four hopper types are configured.
Z 5A System Display
This DIG is never returned in the fitness field
[ 5B Media Entry Indicators
This DIG is never returned in the fitness field
\ 5C Envelope Dispenser var (1)
Fitness envelope dispenser 1
a 61 Voice Guidance var (1)
The audio device returns the following fitness statuses:
0 No Errors
2 Warning
4 Fatal
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-22 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Fitness Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
d 64 Cash Handler 0 var (29)
Fitness cash acceptor 1
Cassette type 1 (in the range 001‐999) 3
Cassette type 1 fitness status 1
Cassette type 2 (in the range 001‐999) 3
Cassette type 2 fitness status 1
Cassette type 3 (in the range 001‐999) 3
Cassette type 3 fitness status 1
Cassette type 4 (in the range 001‐999) 3
Cassette type 4 fitness status 1
Cassette type 5 (in the range 001‐999) 3
Cassette type 5 fitness status 1
Cassette type 6 (in the range 001‐999) 3
Cassette type 6 fitness status 1
Cassette type 7 (in the range 001‐999) 3
Cassette type 7 fitness status 1
This DIG is only reported when extended cassette types are See Table
supported. Note 15
e 65 Cash Handler 1 var (29)
Fitness cash acceptor 1
Cassette type 1 (in the range 001‐999) 3
Cassette type 1 fitness status 1
Cassette type 2 (in the range 001‐999) 3
Cassette type 2 fitness status 1
Cassette type 3 (in the range 001‐999) 3
Cassette type 3 fitness status 1
Cassette type 4 (in the range 001‐999) 3
Cassette type 4 fitness status 1
Cassette type 5 (in the range 001‐999) 3
Cassette type 5 fitness status 1
Cassette type 6 (in the range 001‐999) 3
Cassette type 6 fitness status 1
Cassette type 7 (in the range 001‐999) 3
Cassette type 7 fitness status 1
This DIG is only reported when extended cassette types are See Table
supported. Note 15
f 66 Barcode Reader var (1)
Fitness barcode reader 1
q 71 Cheque Processor var (1)
When Option 83 is ‘000’ the following is returned:
Fitness cheque processor 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-23
Device Identifiers
Fitness Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
When Option 83 is ‘001’ the following is returned:
Fitness cheque processor 1
Endorse printer 1
Stamper 1
Escrow/Rebuncher 1
Reserved 1
Bin 1 1
Bin 2 1
Bin n 1
See Table Note 18
w 77 Bunch Note Acceptor (BNA) var (1)
Fitness bunch note acceptor 1
See “Cash Acceptor Supplies (DIG ‘w’)” on page E‐17
y 79 Secondary Card Reader var (1)
Contactless Card Reader 1
Table Note 15: When extended cassette types are supported, using
Enhanced Configuration option 76, DIG ‘E’ reports the combined
fitness status. Separate cash handler fitness status is given in DIG ‘d’
and DIG ’e’.
Table Note 16 By default, the registry is configured to exclude this
value from the fitness status message.
If the receipt printer has a capture bin but the registry is not
configured to send the receipt capture bin status, this value is not
reported in the status message.
If the printer does not have a capture bin but the registry is
configured to send the receipt capture bin status, the value is 0.
For details, refer to Chapter 5, “Configuring Advance NDC and
Associated Components” in the APTRA Advance NDC Developer’s
Guide.
Table Note 17: By default, the registry is configured to exclude this
value from the fitness status message. If required, it can be included
by editing the registry.
For details, refer to Chapter 5, “Configuring Advance NDC and
Associated Components” of the APTRA Advance NDC Developer’s
Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-24 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Fitness Data
Table Note 18: A fitness value is reported for the number of bins
reported within the cheque processor data in the hardware
configuration message.
The reporting of the status of a cash acceptor is configured using
Cash Acceptor Fitness enhanced configuration option 45. For details of the settings, see
(DIG ‘w’) E
“Option 45 – BNA Settings” on page 7‐15.
If the device contains intelligent cassettes, the communications
connection is dropped when the inner cover is opened. This is done
to protect the on‐board processors. It means, however, that the
fitness of the cassettes cannot be determined.
Whatever the settings of option 45, the overall fitness status is
calculated as follows:
If the cash accept service is not available, the overall fitness is a
fatal condition
If any cash‐in cassette has a fitness of Fatal but this is not due to
a cassette being either full or missing, the overall fitness is a
warning condition
If the cash accept service is reported as available and a
transaction code 3 is reported in a status message, the overall
fitness is a warning condition.
With option 45 set to disable the extended message format, this field
is a single byte and reports the overall fitness.
With option 45 set to enable the extended message format, this field
is extended to report a variable number of cassettes as follows:
Table E-8 Character Description
Cash Acceptor Fitness:
Extended Message Format 0 Retract/Reject/Level 2 Bin and overall fitness
This is always reported
1 ‐ 3 The first CIM NDC cassette type to be reported
in the range ʹ001ʹ ‐ ʹ999ʹ
See Table Note 19
4 Fitness of the cassette type
n‐m Logical cassette type identifier where n is the
first character and m is the last character of the
three‐digit logical cassette type in the range
ʹ001ʹ ‐ ʹ999ʹ
This is repeated as necessary to report all
logical cassette types
See Table Note 19
y Fitness of the cassette type identified by the
previous three characters
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-25
Device Identifiers
Fitness Data
Table Note 19: Every CIM NDC cassette type that has been
inserted in the device will be reported, whether or not that cassette
type is currently present.
For more information about the reporting of CIM NDC cassette
types, see “Reporting of CIM NDC Cassette Types” on page 9‐24.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-26 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Tamper Data
Tamper Data E
The following table summarises the tamper data associated with
each device when enhanced configuration option 24 is set to send
extended tamper data.
For details of option 24, see “Option 24 – Enhanced/TI Sensor Status
Unsolicited Message” on page 7‐9.
Table E-9
Device Tamper Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
D 44 Magnetic Card Reader/Writer var (1)
Card Capture bin 1
This is reported as zero when the contactless card reader is the
primary card reader.
E 45 Cash Handler var (0)
This is not reported.
Cash handler 0 is reported using DIG ‘d’, described in Cash
Handler 0 on page E‐29
Cash handler 1 is reported using DIG ‘e’, described in Cash
Handler 1 on page E‐29
F 46 Envelope Depository var (4)
Envelope Deposit Module Identifier. Always ‘001’ ‐ Envelope 3
Deposit Bin
Envelope Deposit Module State 1
G 47 Receipt Printer var (102)
Number of Retract positions. This is in the range 00 to 99 2
Retract position 1 1
:
Retract position n 1
K 4B Night Safe Depository var (4)
Night Safe Module Identifier. Always ‘001’ ‐ Night Safe Bin 3
Night Safe Module State 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-27
Device Identifiers
Tamper Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
P 50 TI Bins (Alarms) var (240)
See Table Note 20, Table Sensor Type 1 3
Note 21, Table Note 22 Sensor State 1. Always ‘001’ 3
Sensor Type n 3
Sensor State n 3
V 56 Statement Printer var (102)
Number of Retract positions. This is in the range 00 to 99 2
Retract position 1 1
:
Retract position n 1
X 58 Passbook (Not supported) var
Number of Retract position. This is in the range 00 to 99 2
Retract position 1 1
:
Retract position n 1
Y 59 Coin Dispenser var
See Table Note 23 and Number of Reject positions. This is in the range 00 to 99 2
Table Note 24 Reject position 1 1
:
Reject position n 1
Number of Retract positions. This is in the range 00 to 99 2
Retract position 1 1
:
Retract position n 1
Number of Hopper positions. This is in the range 00 to 99 2
Hopper position 1 1
:
Hopper position n 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-28 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Tamper Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
d 64 Cash Handler 0 var
See Table Note 25, Number of Reject positions. This is in the range 00 to 99 2
Reject position 1 1
:
Reject position n 1
Number of Retract positions. This is in the range 00 to 99 2
Retract position 1 1
:
Retract position n 1
Number of Cassette positions. This is in the range 00 to 99 2
Cassette position 1 1
:
Cassette position n 1
e 65 Cash Handler 1 var
See Table Note 25, and Number of Reject positions. This is in the range 00 to 99 2
Table Note 26 Reject position 1 1
:
Reject position n 1
Number of Retract positions. This is in the range 00 to 99 2
Retract position 1 1
:
Retract position n 1
Number of Cassette positions. This is in the range 00 to 99 2
Cassette position 1 1
:
Cassette position n 1
w 77 Cash Acceptor
See Table Note 27, Table Number of Retract positions. This is in the range 00 to 99 2
Note 28, Table Note 29, Retract position 1 1
Table Note 30, Table Note :
31, Table Note 32, Table Retract position n 1
Note 33and Table Note 34
Number of Cassette positions. This is in the range 00 to 99 2
Cassette position 1 1
:
Cassette position n 1
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-29
Device Identifiers
Tamper Data
ASCII Value
DIG Device Name and Associated Configuration Data Data Length
(Hex)
q 71 Cheque Processor var (102)
See Table Number of bins. This is in the range 00 to 99 2
Note 35 Bin position 1 1
:
Bin position n 1
y 79 Secondary Card Reader
Contactless Card Reader
Card Capture bin 1
As Advance NDC supports only a contactless card reader as the
secondary card reader when two card readers are configured, the
Card Capture bin is reported as zero.
Table Note 20: Only the alarms and sensors are reported using this
field.
Table Note 21: Sensor types 001, 002, 003, and 004 must be reported
within this field, as defined in Table E‐10.
Table Note 22: Sensor states can be either ‘000’ ‐ no alert (normal),
or ‘001’ alert.
Table Note 23: The coin dispenser field contains an ordered list of
coin containers, including hoppers, retract and reject bins. The list is
ordered by physical type then physical position. The reporting
order is: reject bins, retract bins, then hoppers. The limit on the
number of physical containers within each category is the maximum
possible message length.
Table Note 24: If the coin dispense is part of a compound dispense
or deposit device, this field reports the state of all physical cassettes,
including deposit.
Table Note 25: The cash handler field contains an ordered list of
cassettes and bins. The list is ordered by physical type then physical
position. The reporting order is: reject bins, retract bins, then
cassettes. The limit on the number of physical containers within
each category is the maximum possible message length.
Table Note 26: The cash handler 1 field is only reported as part of a
dual cash handler system.
Table Note 27: The cash acceptor must have removable cassettes
with corresponding sensors.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-30 nAPTRA™ Advance NDC, Reference Manual
Device Identifiers
Tamper Data
Table Note 28: The cash acceptor field contains an ordered list of
cassettes and bins. The list is ordered by physical type then physical
position. The reporting order is retract bins followed by cassettes.
The limit on the number of physical containers within each category
is the maximum possible message length.
Table Note 29: If the cash handler is part of a compound device
with dispense and deposit features, this field includes tamper
indication data for all physical cassettes, including deposit.
Table Note 30: Cassette status is reported as accurately as possible,
depending on the capability of the cash acceptor to report tamper
indication.
Table Note 31 In a BRM device, if one of the cassettes is not
configured at XFS, then this cassette will not be mapped to the NDC
cassette. Then, the next cassette if configured at XFS but not
physically present, will be mapped to the previous NDC cassette.
This cassette will be reported incorrectly. For example, if cassette 2
is not configured at XFS, and the next cassette i.e, cassette 3 is
configured at XFS but physically not present will be mapped to
NDC physical cassette 2. The cassette 3 will be reported incorrectly
as cassette 2 and not as cassette 3.
Table Note 32 Tamper indication messages are not supported for
two or more physical cassettes mapped to one logical cassette.
Table Note 33 For a BRM device, the number of cassettes reported
is equal to the number of cassettes that are configured at XFS.
Whereas for GBRU the number of cassettes reported is always 04.
Table Note 34: Tamper indication is not supported for cash
acceptors during diagnostics.
Table Note 35: On bunch cheque acceptors, the insertion or
removal of a bin is reported as well as the opening or closure of the
bin door. A single unsolicited message is sent when the bin door is
opened to report the bins as removed. A single unsolicited message
is sent when the bin door is closed to report the bins as inserted.
These events are also journaled using reserved screens t58 and t59.
Table E-10 Sensor Type Description
TI Bins (Alarms) Sensor Types
‘001’ Vibration and/or heat sensor
‘002’ Door contact sensor
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
nAPTRA™ Advance NDC, Reference Manual E-31
Device Identifiers
Tamper Data
Sensor Type Description
‘003’ Silent signal sensor
‘004’ Electronics enclosure sensor
‘005’ to ‘009’ Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
E-32 nAPTRA™ Advance NDC, Reference Manual
Table of Contents
ASCII/EBCDIC Conversion Table
Appendix F
ASCII/EBCDIC Conversion Table
Overview F‐1
Code Conversion Table F‐2
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manuall
Table of Contents
ASCII/EBCDIC Conversion Table
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manuall
ASCII/EBCDIC Conversion Table
F
Overview
Overview F
This appendix provides a conversion table showing the mapping of
ASCII character codes to EBCDIC and ASCII hexadecimal codes.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manuall F-1
ASCII/EBCDIC Conversion Table
Code Conversion Table
Code Conversion Table F
The following table lists the ASCII control codes and characters and
their equivalent in EBCDIC and ASCII hexadecimal codes:
Table F-1 ASCII Control Codes EBCDIC ASCII
ASCII to EBCDIC Code Conversion and Characters (Hex) (Hex)
NUL 00 00
SOH 01 01
STX 02 02
ETX 03 03
EOT 37 04
ENQ 2D 05
ACK 2E 06
BEL 2F 07
BS 08 08
HT 05 09
LF 25 0A
VT 0B 0B
FF 0C 0C
CR 0D 0D
SO 0E 0E
SI 0F 0F
DLE 10 10
DC1 11 11
DC2 12 12
DC3 13 13
DC4 3C 14
NAK 3D 15
SYN 32 16
ETB 26 17
CAN 18 18
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
F-2 APTRA™ Advance NDC, Reference Manuall
ASCII/EBCDIC Conversion Table
Code Conversion Table
ASCII Control Codes EBCDIC ASCII
and Characters (Hex) (Hex)
EM 19 19
SUB 3F 1A
ESC 27 1B
FS 1C 1C
GS 1D 1D
RS 1E 1E
US 1F 1F
SP 40 20
! 4F 21
ʺ 7F 22
# 7B 23
$ 5B 24
% 6C 25
& 50 26
ʹ 7D 27
(apostrophe or single quote)
( 4D 28
) 5D 29
* 5C 2A
+ 4E 2B
, 6B 2C
‐ 60 2D
. 4B 2E
/ 61 2F
0 F0 30
1 F1 31
2 F2 32
3 F3 33
4 F4 34
5 F5 35
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manuall F-3
ASCII/EBCDIC Conversion Table
Code Conversion Table
ASCII Control Codes EBCDIC ASCII
and Characters (Hex) (Hex)
6 F6 36
7 F7 37
8 F8 38
9 F9 39
: 7A 3A
; 5E 3B
< 4C 3C
= 7E 3D
> 6E 3E
? 6F 3F
@ 7C 40
A C1 41
B C2 42
C C3 43
D C4 44
E C5 45
F C6 46
G C7 47
H C8 48
I C9 49
J D1 4A
K D2 4B
L D3 4C
M D4 4D
N D5 4E
O D6 4F
P D7 50
Q D8 51
R D9 52
S E2 53
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
F-4 APTRA™ Advance NDC, Reference Manuall
ASCII/EBCDIC Conversion Table
Code Conversion Table
ASCII Control Codes EBCDIC ASCII
and Characters (Hex) (Hex)
T E3 54
U E4 55
V E5 56
W E6 57
X E7 58
Y E8 59
Z E9 5A
[ 4A 5B
\ EO 5C
] 5A 5D
^ 5F 5E
(caret or circumflex)
_ 6D 5F
` 79 60
(grave accent)
a 81 61
b 82 62
c 83 63
d 84 64
e 85 65
f 86 66
g 87 67
h 88 68
i 89 69
j 91 6A
k 92 6B
l 93 6C
m 94 6D
n 95 6E
o 96 6F
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manuall F-5
ASCII/EBCDIC Conversion Table
Code Conversion Table
ASCII Control Codes EBCDIC ASCII
and Characters (Hex) (Hex)
p 97 70
q 98 71
r 99 72
s A2 73
t A3 74
u A4 75
v A5 76
w A6 77
x A7 78
y A8 79
z A9 7A
{ C0 7B
| 6A 7C
(vertical bar)
} D0 7D
~ A1 7E
(tilde)
DEL 07 7F
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
F-6 APTRA™ Advance NDC, Reference Manuall
Table of Contents
Related Documentation
Appendix G
Related Documentation
Overview G‐1
Advance NDC Documentation G‐2
APTRA Author Documentation G‐3
NDC+ Documentation G‐5
Other NCR Documentation G‐6
Miscellaneous Documentation G‐7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Table of Contents
Related Documentation
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Related Documentation
G
Overview
Overview G
This appendix lists the following documentation:
Documentation provided on the Advance NDC CD‐ROM
Documentation that is historically linked to Advance NDC, but
not provided on the Advance NDC CD‐ROM
Other documentation related to Activate NDC
Documentation from other sources, such as optional
components and standards bodies. This documentation is not
provided on the Advance NDC CD‐ROM.
On a development system, the documentation can be installed alone
or installed with the Advance NDC software. The documentation is
not installed on a runtime system.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual G-1
Related Documentation
Advance NDC Documentation
Advance NDC Documentation G
The following publications are provided on the Advance NDC
CD‐ROM. They are available from NCR on request.
Table G-1
Advance NDC Documentation
Title Format Description
APTRA Advance NDC, Overview PDF/Paper Provides an introduction to Advance NDC,
B006‐6597 including overviews of the components
contained in the Advance NDC product and
provided as part of the ANDC Package on
CD‐ROM.
APTRA Advance NDC, Developer’s Guide PDF/Paper Describes how to configure Advance NDC;
B006‐6046 upgrade from previous releases and migrate
from NDC+. It also identifies the functionality
offered by Advance NDC and how to enhance it.
APTRA Advance NDC, Reference Manual PDF/Paper Provides application programmers with
B006‐6180 reference information for Advance NDC,
including States, Screens, and the message
formats between Central and the terminal.
APTRA Advance NDC, Multi‐Vendor Support PDF/Paper Provides users with information about running
Reference Manual the Advance NDC application on other vendors’
B006‐6344 SSTs, describing the differences between
Advance NDC on NCR SSTs and other vendors’
SSTs.
APTRA Advance NDC, Supervisor’s Guide PDF/Paper Describes the Supervisor interface, how to set up
B006‐6062 the terminal’s local configuration parameters,
and how to replenish the terminal.
APTRA Advance NDC, Extending the Product PDF/Paper Describes how to modify Advance NDC to
B006‐6926 enhance or extend its functionality.This
publication replaces NCR Direct Connect (NDC),
Using NDC Exits, B006‐5102
APTRA Advance NDC, User Guide for PDF/Paper Describes how to use the Display Manager for
Display Manager HTML pages to replace or overlay NDC screens
B006‐6796
APTRA Advance NDC, Payment Application PDF/Paper Provides information on implementing an
Data Security Standard Advance NDC solution in compliance with PCI
Implementation Guide DSS
B006‐6861
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
G-2 APTRA™ Advance NDC, Reference Manual
Related Documentation
APTRA Author Documentation
APTRA Author Documentation G
The titles listed in Table G‐2 are provided on the Advance NDC
CD‐ROM as part of the APTRA Author, which is used in the
development of Advance NDC and can be used to modify the
application.
A printed version of the PDF files can be ordered from the NCR
Publications web site.
Table G-2
Provided APTRA Author Documentation
Title Format Description
APTRA Author, User’s Guide PDF/Paper Describes how to install and use the Author and Runtime
B006‐6038 Components to design, develop and maintain a self‐service
application.
APTRA Author Help Windows Context‐sensitive help for the Author user interface and
Help authoring errors.
Runtime Core Help Windows Context‐sensitive help for the Runtime Core Authoring
Help components and runtime errors.
GUI Help Windows Context‐sensitive help for the GUI Authoring components.
Help
Self‐Service Core Help Windows Context‐sensitive help for the Self‐Service Core Authoring
Help components.
ActiveX™ Help Windows Context‐sensitive help for the ActiveX™ Authoring
Help components and runtime errors.
Basic Self‐Service Help Windows Context‐sensitive help for the Authoring components and
Help runtime errors provided with Basic Self‐Service.
ATM Help Windows Context‐sensitive help for the Authoring components and
Help runtime errors provided with ATM.
Special Self‐Service Help Windows Context‐sensitive help for the Authoring components and
Help runtime errors provided with Special Self‐Service.
Statement Printer Help Windows Context‐sensitive help for the Authoring components and
Help runtime errors provided with Statement Printer.
Advance NDC Help Windows Context‐sensitive help for the Advance NDC Authoring
Help components (excluding Application Core components).
Advance NDC Application Core Windows Context‐sensitive help for the Application Core/Supervisor
Help Help Authoring components.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual G-3
Related Documentation
APTRA Author Documentation
The PDF publications in Table G‐3 below are not provided on the
Advance NDC CD‐ROM. These publications have not been
updated, but may be useful if you are using the authoring
environment to extend Advance NDC. Printed versions can be
ordered from the NCR Publications web site.
Note: NCR recommends the use of C Exits to extend Advance
NDC.
Table G-3
Other Authoring Environment
Documentation
Title Format Description
APTRA Advance ADE, Programmer’s PDF/Paper Describes how application programmers should create
Guide their own C++ Worker Classes. It also contains
B006‐6042 information on using C routines to manipulate data.
APTRA Advance ADE, C++ Class PDF/Paper Provides application programmers with definitions for
Reference a number of C++ Runtime and Utility Worker Classes
B006‐6043 provided by NCR.
APTRA Advance ADE, Local Language PDF/Paper Describes how to customise the APTRA Advance ADE
Customisation Guide product into a local language.
B006‐6037
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
G-4 APTRA™ Advance NDC, Reference Manual
Related Documentation
NDC+ Documentation
NDC+ Documentation G
The publications in the following table are not provided on the
Advance NDC CD‐ROM. Printed versions can be ordered from the
NCR Publications web site.
Table G-4
Additional NDC+ Documentation
Title Format Description
NDC, Programmer’s Overview PDF/ Provides an introduction to, and overview
B006‐2485 Paper of, the NDC software.
NDC+, Programmer’s Reference Manual PDF/ Aimed at programmers who write host or
B006‐2486 Paper switch applications to support NDC+
terminals, or who create the terminal
configuration that customises NDC+.
NDC, Message Formats For Host Application PDF/ Designed for Central control application
Developers Paper developers working with NDC RMX,
B006‐4201 NDCxa or NDC+. Intended to help in
creating a control program that handles all
the NDC variants.
NDC+, Supervisor’s Reference Manual PDF/ Designed for those people who are
B006‐2487 Paper responsible for setting up the terminal’s
local configuration parameters, or for
routine replenishment of the terminal.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual G-5
Related Documentation
Other NCR Documentation
Other NCR Documentation G
The publications in the following table are provided with the
software product or component to which they refer and are in
Adobe Portable Document Format (PDF) or Microsoft compiled
HTML help (CHM) format.
Printed versions of the PDFs can be ordered from the NCR
Publications web site.
Table G-5
Other NCR Documentation
Product/Component Title Format Description
APTRA XFS NCR APTRA XFS Overview PDF/Paper Provides information about APTRA XFS, its
B006‐6166 features and functionality, and the
requirements for its use.
EMV/CAM2 EMV Integrated Circuit Card PDF/Paper Provides reference information for any
Exits for APTRA (ICC) Reference Manual Advance NDC developer who wishes to add
Advance NDC B006‐6297 EMV Integrated Circuit Card (ICC) Card
Authentication Method (CAM) functionality
to their Advance NDC application.
NCR XFS XFS Simulator for APTRA CHM Context‐sensitive help and reference for the
Simulator for NCR XFS Simulator.
APTRA
ActiveXFS ActiveXFS Controls CHM Context‐sensitive help and reference for
Controls On‐line Documentation ActiveXFS Controls
40 Column Self Service Platform Software PDF/Paper Provides information about code pages for
Printer Programmer’s Manual for the the 40‐column printer.
40 Column Printer
B006‐4612
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
G-6 APTRA™ Advance NDC, Reference Manual
Related Documentation
Miscellaneous Documentation
Miscellaneous Documentation G
This section lists any third‐party publications and documents that
are referenced in the text.
Information about CEN‐XFS specifications is available at
http://www.cen.eu/cen/pages/default.aspx.
Table G-6
CEN-XFS Documentation
Title Format Description
Extensions for Financial Services (XFS) interface PDF or zipped PDF Provides reference information for
specification release 3.0x of the CEN‐XFS
(CWA 14050) specifications (3.10 for the Item
Processing Module).
Information about ISO standards is available at http://www.iso.org.
Table G-7
ISO Documentation
Title Reference
Banking ‐ Personal Identification Number Management and Security ISO 9564‐1
(Part 1: PIN Protection Principles and Techniques)
Information Technology ‐ Identification Cards ‐ Financial Transaction Cards ISO/IEC 7813:2006
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual G-7
Related Documentation
Miscellaneous Documentation
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
G-8 APTRA™ Advance NDC, Reference Manual
Glossary 0
.NET In software products, a set of capabilities that enables people,
Symbols information, systems, and devices to connect and exchange
information seamlessly through the use of Web services.
ABA American Bankers Association.
A
ActiveX Control A type of COM component which implements
standard interfaces, and can be included in a web page and used in
languages such as VBScript.
Advance NDC NCR’s implementation of NDC for a Windows
environment.
AID Application Identifier: Used to uniquely identify each EMV
application that an SST supports.
AID Application Identifier: Used to uniquely identify each EMV
application that a terminal supports.
API Application Programming Interface.
APTRA The brand name for a family of self‐service software
solutions from NCR, based on the Windows operating system.
Application Core In Advance NDC, an authored application that
performs the SST mode handling and message processing functions.
APTRA Author Tool that allows you to visually design and develop a
self‐service application.
ARPC Authorisation Response Cryptogram. An ICC application
cryptogram produced by the host application for submission to the
ICC, to prove it is a genuine host.
ASCII American Standard Code for Information Interchange. This is
a computer code for representing alphanumeric characters.
ATM Automated Teller Machine. See SST.
ATR Answer to Reset. Used in chip processing for smart cards.
Audio Guidance See Voice Guidance.
Authored application In the APTRA Author, a collection of Workers
that can be built to create an executable.
See also Self-Service Application.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual Glossary-1
BAPE Basic Alpha PINpad and Encryptor. Combined PINpad and
B encryptor. Supports single length DES encryption with various local
and remote PIN verification schemes.
Basic Remote Key Protocol A minimum command set for remote key
management.
Bills Alternative term for currency notes.
BNA Bunch Note Acceptor. An NCR device variant reported using
the BNA set of mStatus values. Allows a consumer to deposit a
number of bank notes in a bunch. This is also used as a generic term
for cash acceptors, for example on many Supervisor menu options.
See also Cash acceptor.
BOP Basic Operator Panel. Not supported by Advance NDC.
See also EOP.
BRM Bunch Recycling Module. An NCR device that is reported
using the BRM set of mStatus values. A BRM allows a consumer to
deposit a number of bank notes in a bunch. The device can also
dispense notes and recycle deposited notes as configured.
CAM Card Authentication Method.
C
Cardholder See Consumer.
Cash acceptor A generic term for any SST device that accepts bank
note deposits.
See also BNA, GBNA, GBRU and SNA.
Cash recycler A generic term for any SST device that accepts and
dispenses the same bank notes. Also known as a Recycling unit.
Cash recycling The process of re‐using deposited cash for dispense
operations on a single SST.
Catalog In the APTRA Author, a means of organising workers or
applications into manageable groups.
CDM Cash Dispenser Module. CEN‐XFS class name for the Cash
Dispenser service.
CEN Comité Européen de Normalisation (European Committee for
Standardization). Responsible for the XFS interface specification.
Central The control application on the host or switch that sends
commands to the SST and responds to requests from the SST.
Cheque Processor CPM and bunch cheque acceptor.
CIM Cash In Module. CEN‐XFS class name for the Cash Accept
service.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Glossary-2 APTRA™ Advance NDC, Reference Manual
CMC-7 An MICR font that is used on cheques.
See also MICR and E13B.
Codec Short form of COder/DECoder. Software that compresses
and decompresses a digital video signal such as MPEG.
Codeline The set of characters printed on a cheque in an MICR font.
Coin Hopper A physical container holding coins.
Coin Hopper Type A logical representation of one or more Coin
Hoppers containing the same type of coin. A Coin Hopper Type
maps to one logical XFS CDM Cash Unit.
Cold Start The first time an SST is powered up, with no previously
downloaded software.
COM Common Object Model. An open architecture for
cross‐platform development of client/server applications based on
object‐oriented technology. Clients have access to an object through
interfaces implemented on the object (for example, access to
Methods, Properties and Events).
Contact Card Reader A card reader that reads data from a card when
the card is inserted into or passed through a slot in a card reader
such as a Magnetic Card Reader/Writer (MCRW), Integrated
Magnetic Card Reader/Writer (IMCRW) or Dip And Smart
Hardware (DASH).
Contactless Card Reader A card reader that reads data from a card
when the card is held near to or tapped on the card reader.
Control file A file that tells Advance NDC which Supervisor
functions or states are NDC standard, which are user written, and
where the user‐written routines are to be found. A control file also
gives information about the chaining of Virtual Controllers and
Hooks.
Consumer The customer of a bank, or other financial institution,
who has one or more accounts and uses SSTs to access and manage
their money.
Counterfeit note A note with authentication features missing or out
of tolerance, which the cash deposit device classifies as a potential
forgery. This is the same as a category 2 note, as defined in the ECB
6 regulation.
cpi Characters per inch.
CPM Cheque Processing Module. Used for single cheques.
See also Cheque Processor.
CR Carriage Return.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual Glossary-3
CRM Customer Relationship Management.
CROPF Card Return on Power Fail.
CRT Cathode‐ray tube. A type of screen used for cardholder
display on the front interface of an SST.
CSP Customer Selectable PIN.
Currency Medium of exchange in a country, for example American
dollars (USD) or British pounds (GBP).
Customisation Layer In Advance NDC, the Customisation Layer
performs the ‘In Service’ activities associated with the consumer.
DAPI Direct Application Programming Interface.
D
DASH Dip And Smart Hardware. Supported in Dip emulation
mode only.
DCC Dynamic Currency Conversion.
DCS Digital Camera Service (not supported in Advance NDC)
DEA2 Data Encryption Algorithm 2.
Denomination The values of the monetary units in a series.
DES Data Encryption Scheme.
DES encryption, Triple See Triple DES encryption.
Device ID Device identifier. Another term for DIG.
DIG Device Identifier Graphic.
Direct Deposit Deposit mode where cash is deposited directly to the
cassettes without being held in the escrow. Cash cannot be refunded
to the cardholder.
DLL Dynamically Linked Library.
Dynamic Condition The result of an operation that can only be
determined at runtime by the application. The operation result is an
index into an array of screen fragments used to inform the
cardholder of the exact conditions that have occurred.
E13B An MICR font that is used on cheques.
E See also MICR and CMC-7.
EBCDIC Extended Binary‐Coded Decimal Interchange Code. An
eight‐bit character code.
EEKC Extended Encryption Key Change.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Glossary-4 APTRA™ Advance NDC, Reference Manual
EID Encryption Initialisation Data.
EJ Electronic Journal. The EJ log emulates the printed journal. All
the data normally recorded on the journal printer is written to the EJ
log on the terminal’s system disk.
EKC Encryptor Keyboard Controller. A more complex and secure
version of the BAPE, fitted to some terminals. (Not supported in
Advance NDC.)
EMV Europay, Mastercard, VISA. A consortium responsible for the
the EMV standard for smart cards.
Encryption Certificate A certificate used to encrypt data. In the NDC
context, a certificate is used to authenticate and secure
communication between the host security module and the EPP.
See also Verification Certificate.
Encash Another term for Vault.
Enhanced Remote Key Protocol A command set for remote key
management that allows the financial institution to implement some
of the best practices recommended but not required in X9.24.2004
part 2.
EOP Enhanced Operator Panel.
EPP Encrypting PIN Pad. A new combined PINpad and encryptor,
supporting triple DES encryption.
Escrow The area in an SST where notes are held after validation and
before being vaulted or returned to the cardholder.
Exit A general term covering user‐defined states, Supervisor
functions, virtual controllers and special synchronisation routines
called hooks.
Exit state A state defined and programmed by the user.
Exit Supervisor A Supervisor function defined and programmed by
the user.
Facia The front of an SST.
F
FDK Function Display Key. These keys are located on each side of
the facia screen and enable various options to be chosen. Some
screens have touch screen areas which emulate FDK functions.
FIID Financial Institution IDentification number.
FIT Financial Institution Table. This contains details of where and
how information is stored on the card and how a transaction should
be processed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual Glossary-5
Flex drive Diskette drive.
Forms-based printing Forms‐based printing utilises the Windows
printing environment, removing the need to know details of the
printer, and is implemented using XFS forms, which are generated
dynamically by the application.
GBNA Global Bunch Note Acceptor. An NCR device variant that
G allows a consumer to deposit a number of bank notes in a bunch.
See also Cash acceptor.
GBRU Global Bill Recycling Unit. An NCR device that is reported
using the GBNA set of mStatus values. Allows a consumer to
deposit a number of bank notes in a bunch. The device can also
dispense notes and recycle deposited notes.
See also Recycler, Recycling unit and GBXX.
GBXX An NCR term for a cash accep tor or a recycling unit where
the specific device is not significant. Used when the information
applies to both the GBNA and GBRU and/or equivalent devices.
See also GBNA and GBRU.
GIF Graphics Interchange format.
Hex Short form of hexadecimal.
H
HRI Human‐Readable Interpretation of a bar code.
Hooks General term for miscellaneous user‐defined routines
detailed in the MISCONT file.
See also Exit.
HSM Host Security Module.
ICC Integrated Circuit Card. A card containing an integrated
I circuit. Also known as a ‘smart card’.
ID Identifier.
IMCRW Integrated Magnetic Card Reader/Writer.
Intercept routine Another name for virtual controller.
Invalid notes See Rejected items.
IQA Image Quality Assessment.
ISO International Standards Organisation.
ITR Interactive Transaction Response.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Glossary-6 APTRA™ Advance NDC, Reference Manual
JIF JPEG Interchange Format.
J
JPEG Joint Photographic Experts Group.
lpi lines per inch.
L
LUNO Logical Unit Number.
MAC Message Authentication Code. A method of protecting
M messages passing between the terminal and Central from
tampering.
MCN Message Coordination Number.
MCRW Magnetic Card Reader/Writer. This is used to read data from
a standard magnetic stripe card and, depending on the MCRW
variant, write data to one of the tracks on the card’s magnetic stripe.
MDM Media Dispenser Module.
MEI Media Entry/Exit Indicator.
MICR Magnetic Ink Character Recognition. A character recognition
technology used, for example, to read the codeline printed on
cheques.
MISCONT A control file detailing miscellaneous Exits or Hooks.
See also Control file.
MSR Magnetic Stripe Reader. This is used to read data from the
tracks of a magnetic stripe card. It provides a sub‐set of the features
of the Magnetic Card Reader/Writer.
Multiple EJ Backup Alternative setting for EJ backup. Allows
multiple EJ backup files to be retained, as defined by the number of
multiple backup settings.
NDC NCR Direct Connect. An NCR application that works in
N conjunction with a central application (the host) to perform financial
transactions on SSTs.
Nibble The first or second four bits of a byte (that is, half of a byte).
Can be represented by one hexadecimal digit.
Note type The currency, value and version of a note. For example,
an English five‐pound note and a Scottish five‐pound note have the
same currency identifier (GBP) and denomination (unit value of 5),
but different versions. Also known as bill type.
NVRAM See Persistent memory.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual Glossary-7
OCR Optical Character Recognition.
O
OpCode Short form of Operation Code.
PAN Primary Account Number.
P
PCI DSS Payment Card Industry Data Security Standard.
PCX PiCture Exchange. Advance NDC does not support this file
format for graphics.
PDF Portable Document Format. The Adobe file format for
documents viewable in Adobe Reader.
Persistent memory Memory that retains information when power is
switched off or lost. Also known as persistent storage.
PIN Personal Identification Number. A secret identification number
that is issued to each cardholder.
PNG Portable Network Graphics.
PPD Programmable Printing Depository. One of the types of printer
supported by Advance NDC.
Problem determination The generic term problem determination,
without initial capitals, is used to refer to the process of identifying
the cause of a software problem.
Problem Determination With initial capitals, the software developed by
NCR to collect and analyse data that will assist with the task of
characterizing and resolving software issues.
PVKI PIN Verification Key Indicator. Part of the PIN offset data
used in VISA PIN verification.
PVV PIN Verification Value. Another part of the PIN offset data
used in VISA PIN verification.
Raw data printing A method of printing where printer‐specific
R control codes are sent directly to the printer.
Recycler Another term for a recycling unit.
Recycling unit A generic term for a device that allows a consumer to
deposit a number of bank notes in a bunch. The device can also
dispense notes and recycle deposited notes.
See also GBRU and GBXX.
Refundable deposit Deposit mode when cash is held in the escrow,
from where it can be refunded to the consumer before the deposit is
completed.
Refused notes Another term for rejected items.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Glossary-8 APTRA™ Advance NDC, Reference Manual
Rejected items Items that are not recognized as notes; either they are
not ntoes or cannot be recognized as notes. Such items cannot be
accepted for deposit and are returned immediately to the consumer.
RKM Remote Key Management.
RSA encryption An asymmetric encryption scheme using private
and public keys, devised by Rivest, Shamir and Adleman.
Rule file See Control file.
Scheme A term used in cryptography for the algorithms used to
S secure information.
Screen Base The screen number of the first screen in the screen
group for each language.
Screen Group The range of screens that are specific to a single
language.
SCRW Smart Card Reader Writer. A device which can interact with
an ICC.
SDA Single Note Divert. A reject bin that collects all the pick failure
notes.
SDC Serial Distributed Control.
SDM Scalable Deposit Module. An NCR device that is reported
using the same set of mStatus vales as a BNA. Allows a consumer to
deposit cash or cheques.
Self-Service Application The application that runs on an SST and
processes all the necessary transactions.
Self-Service Support A 32‐bit open software platform supplied by
NCR for use on SSTs.
Smart card Common name for a card which uses an integrated
circuit (microchip) rather than a magnetic stripe.
See also ICC.
SMS Short Message Service.
SNA Single Note Acceptor. An NCR device variant that is reported
using the same set of mStatus values as a BNA. Allows a consumer
to deposit a single bank note.
See also BNA and Cash acceptor.
SNMP Simple Network Management Protocol. A widely‐used
network monitoring and control protocol.
SO Shift Out.
SST Self‐Service Terminal. Also known as a terminal or an ATM.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual Glossary-9
Stacking Dispenser A cash dispenser that feeds media out of a safe
and stacks it in a temporary-stacking section before presenting the
media to the cardholder.
Standard Cash Handler A four‐cassette stacking dispenser.
See also Stacking Dispenser.
Standard EJ Backup The default setting for EJ backup. Creates a
single electronic journal backup file.
Standard Output The destination to which output is sent. Unless
redirected, for example to a file, standard output is the command
window from which the program was initiated.
STCONT A control file defined by Exits when user defined states are
added.
See also Control file.
SUPCTR A control file used by Exits when user‐defined Supervisor
features are added.
See also Control file.
Supervisor The Supervisor application performs the out‐of‐service
operations needed to maintain and run SSTs.
Suspect note A note with recognised authentication features but
quality and/or tolerance deviations. In most cases, this means a
damaged or soiled bank note. This is the same as a category 3 note,
as defined in the ECB 6 regulation.
SWF ShockWave Flash. A file format from Adobe for displaying
multimedia files and animated vector graphics.
TCM Terminal Control Module.
T
TI Tamper Indication.
TIFF Tagged Image File Format.
ToD Time of Day.
TPA Transaction Processing Application (NDC Application).
Triple DES encryption DES encryption performed three times
successively, for greater security.
TSN Transaction Serial Number.
TVN Time Variant Number.
USB Universal Serial Bus. A hardware interface for attaching
U peripheral devices, such as disk drives and printers.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Glossary-10 APTRA™ Advance NDC, Reference Manual
UPS Uninterruptible Power Supply. A device that provides battery
backup when mains power fails or drops to an unacceptable voltage
level.
Valuable Media Printed items with a monetary value, such as a
V coupon.
Vault To deposit notes in a cassette or bin as the final stage in a
transaction, after which the notes can no longer be returned to the
cardholder.
VC Virtual Controller. Also known as an intercept routine. A
user‐written routine to intercept and respond to messages.
See also Exit.
VCCONT A control file used by Exits when virtual controllers are
added.
See also Control file.
VDM Vendor Dependent Mode.
Verification Certificate A certificate used to authenticate an
encryption certificate.
Voice Guidance Term used to describe the use of speech to guide a
consumer through a transaction.
WAVE WAVE or .WAV (Waveform Audio). A standard Windows‐
W based sound format.
Windows XP Microsoft Windows XP Professional operating system.
Work Group In the APTRA Author, a work group contains a
collection of Workers with similar roles in the worker hierarchy.
Workers Graphical building blocks used in the APTRA Author to
develop a self‐service application.
Worker class Every worker belongs to a worker class, which defines
the characteristics and functions that any given worker will have.
XFS EXtensions for Financial Services. Application and service
X provider interface specifications from CEN.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual Glossary-11
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Glossary-12 APTRA™ Advance NDC, Reference Manual
Index
Index 0
Abbreviations used in the manual xlv
A Acknowledge and Stop EJ 10‐98
Acknowledge EJ Upload Block 10‐97
Activity timer in dialup 13‐5
Advance NDC
documentation G‐2
Alphanumeric state numbers 2‐5
Amount check state 2‐29
Amount entry state 2‐25
Animation 3‐44
Application timers for dialup 13‐3
Audience for this manual xli
Auto voice (option 2) 10‐18
Background colour control commands 3‐28
B BANKSYS PIN block 11‐7
BAPE security 11‐2
Barcode reader
Option 48 7‐18, 10‐19
state 2‐192
Base 94 encoding and decoding 11‐30
Baud rate for dialup connection 13‐2
Blinking commands 3‐27
BNA See Bunch Note Acceptor
BRM ‐xlvi, Glossary‐2
Buffer validation state 2‐163
Buffers
Amount 2‐25
FDK 2‐85
FDK switch state 2‐84
General purpose 2‐35
Operation code 2‐20, 2‐88
Track 3 data 2‐55, 2‐57
Bunch cheque amount display control sequence 3‐37
Bunch cheque codeline display sequence 3‐37
Bunch cheque image display control 3‐35
Bunch cheque image display sequence 3‐35
Bunch cheque value display control sequence 3‐38
Bunch Note Acceptor
Cash accept state 2‐105
Close state 2‐47
Encash 10‐81
Encash, print and set next state 10‐80
fitness reporting E‐25
Journal notes count (option 44) 7‐14
Journal vaulted notes count (option 44) 10‐19
Message settings (option 45, bit 1) 9‐126
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Reference Manual Index-1
Index
Message settings (option 45) 7‐15, 9‐6
Note definitions solicited status message 9‐59
Option 45 in Enhanced Configuration Parameters Load message 10‐19
Refund and set next state 10‐79
supplies reporting E‐17
Bunch Recycling Module ‐xlvi, Glossary‐2
Bunched cheques
format of amount display 3‐38
Camera control state 2‐60
C Card before cash function 10‐74
Card before parallel dispense and print function 10‐76
Card read state 2‐7
Card reader/writer (solicited/unsolicited message) 9‐97
Card write state 2‐55
Cardholder display reserved screens 3‐6
International currency display format 3‐45
Cardholder verification state 2‐61
Cardless transactions (option 77) 10‐19
Cash Accept
deposit imits 2‐106
Cash accept state 2‐105
Cash Deposit Handling state 2‐177
Cash Deposit Retract Destination (option 74) 10‐19
Cash handler (solicited/unsolicited message) 9‐99
Cash handlers
(option 76) 10‐19
CCM VISA2 dialup system 13‐1
CellBody
BITs 4‐7 E‐6
Central to SST
Dialup messages 13‐7
Central to terminal messages
Customisation data commands 10‐7
EJ commands 10‐96
Acknowledge and Stop EJ 10‐98
Acknowledge EJ Upload Block 10‐97
EJ Options and Timers 10‐96
Message exception handling 10‐102
NDC configuration command 10‐7
Terminal commands 10‐3
Changing display in idle 3‐30
Character sets B‐2
downloadable B‐4
ISO 8859 B‐12
Cheque image control 3‐35
Cheque Processor
Cheque accept state 2‐125
Option 83 10‐19
Close state 2‐45
Coin dispenser
option 79 9‐6
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-2 APTRA Advance NDC, Reference Manual
Index
solicited/unsolicited message 9‐135
Command reject causes 10‐102
Communications
CCM VISA2 dialup 13‐1
Compare operations in the Data Copy and Compare state 2‐176
Configuration ID number load message 10‐24
Configuration parameters
Configuration parameters load message 10‐15
Configuration parameters load message
Logical unit number ‐ LUNO 7‐3
millisecond ticks per timer field 7‐4
Control characters
CRT screen activity 3‐16
Digital audio control 3‐23
Copy operations in the Data Copy and Compare state 2‐175
CRT display characters 3‐14
Customer screen groups 3‐3
Customer/Transaction Data Element Buffer 10‐65
Customer/Trasaction Data Elements, reject reasons’ 10‐68
Customer‐selectable PIN state 2‐93
Customisation data commands
Configuration ID number load 10‐24
Configuration parameters load 10‐15
Date and time load 10‐33
Dispenser currency cassette mapping table 10‐46
Encryption key change 10‐34
Enhanced configuration parameters load 10‐17
FIT data load 10‐22
Message authentication field selection load 10‐26
Screen/keyboard data load 10‐11
State tables load 10‐9
Types of command 10‐7
Customised screens definition 3‐3
DAPI‐7 and rear settlement 3‐54
D DASH card reader 2‐69
Data Copy and Compare state 2‐173
Date and time load message 10‐33
Date format (option 3) 10‐18
Decoding, Base 94 11‐30
Defining a keyboard
Example 4‐16
Defining Dynamic Text for Contactless Tap Error 2‐13
Delay Latch/Smart Delay Functionality 2‐70
Deposit and print function 10‐70
Deposit limits for Cash Accept 2‐106
Depository (solicited/unsolicited message) 9‐104, 9‐131
DES key format, RSA encrypted 11‐29
Device faults 9‐78
Device fitness state 2‐76
Device identifiers
Fitness data E‐20
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Reference Manual Index-3
Index
Hardware configuration data E‐2
Supplies data E‐12
Device status information
Barcode Reader (solicited/unsolicited) 9‐137
Camera (unsolicited) 9‐113
Card reader/writer (solicited/unsolicited) 9‐97
Cash acceptor (solicited/unsolicited) 9‐122
Cash handler (solicited/unsolicited) 9‐99
Cheque Processor (solicited/unsolicited) 9‐131
Cheque processor (solicited/unsolicited) 9‐131
Coin dispener (solicited/unsolicited) 9‐135
Depository (solicited/unsolicited) 9‐104
Electronic journal printer (unsolicited) 9‐108
Encryptor (unsolicited) 9‐112
Envelope dispenser (unsolicited) 9‐129
Journal printer (unsolicited) 9‐106
Night safe depository (solicited/unsolicited) 9‐111
Note Acceptor (solicited/unsolicited) 9‐122
Power failure (unsolicited) 9‐96
Receipt printer (solicited/unsolicited) 9‐104
Sensors (unsolicited) 9‐114
Statement printer (solicited/unsolicited) 9‐119
Supervisor keys (unsolicited) 9‐117
Time‐of‐day clock (unsolicited) 9‐96
Touch screen keyboard (unsolicited) 9‐116
Voice guidance (solicited/unsolicited) 9‐121
Dialup
Message on CP 13‐6
Message suppression 13‐6
System setup 13‐2
Transaction completion 13‐6
Dialup message header format 13‐4, 13‐7
Dialup messages
Central to SST 13‐7
SST to Central 13‐4
Dialup timers 13‐2
Digital audio control 3‐23
Screen update in a transaction reply 3‐25
Using a nested screen 3‐25
using dynamic placeholder data 3‐26
Direct Deposit
error screen 2‐106
Direct deposit
error screen 2‐106
Dispense and print function 10‐71
Dispenser currency cassette mapping table message 10‐46
Display and print function 10‐72
Display controls
Lift cheque image 3‐35
Display dynamic text dictionary sequence 3‐39
Display image files control 3‐34
Dynamic buttons control 3‐42
Dynamic text definition 3‐43
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-4 APTRA Advance NDC, Reference Manual
Index
Dynamic text dictionary sequence
Bunch Cheque Accept refuse reason 2‐138
Bunch Cheque Accept reject reason 2‐138
Cash Accept refuse reason 2‐124
e5 9‐105
E Eight FDK selection function state 2‐88
EJ commands
Acknowledge and Stop EJ 10‐98
Acknowledge EJ Upload Block 10‐97
EJ Options and Timers 10‐96
EJ Options and Timers 10‐96
EJ Upload D‐2
EJ Upload Message 9‐90
EJ upload, dialup 13‐3
Electronic journal printer (unsolicited message) 9‐108
EMV message class 10‐2, 10‐102
EMV smart card (option 70) 10‐19
EMV smart card extended status (option 69) 10‐19
Encoding, Base 94 11‐30
Encryption key change message 10‐34
Encryption key entry 4‐13
Encryptor initialisation data 9‐82
Enhanced amount entry state 2‐62
Enhanced configuration parameters load
option numbers, enhanced configuration parameter load 10‐17
Enhanced configuration parameters load message
Alphanumeric State Entry 7‐21
Auto voice 7‐7
Barcode Reader 7‐18
BNA Journal Notes Count 7‐14
BNA Message Settings 7‐15
Cash Handlers 7‐19
cheque processor 7‐21
coin dispenser 7‐21
Date format 7‐7
EMV Smart Card Extended Status option 7‐18
EMV Smart Card option 7‐18
Enhanced card device security option 7‐17
Enhanced EJ backup 7‐13
Envelope dispenser status option 7‐9
GBRU m‐status and variant reporting 7‐20
Journal printer backup print operations option 7‐8
Journal printer backup time option 7‐8
Left column 7‐7
MCN Range 7‐11
Media entry indicators flash rate option 7‐10
Number of seconds per timer field 7‐22
Print Track 2 to Journal 7‐13, 7‐15
Remote relay option 7‐10
Report dual mode EJ and hardcopy backup unsolicited messages 7‐13
Roll width 7‐7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Reference Manual Index-5
Index
Send enhanced/TI sensor status unsolicited message option 7‐9
Simulate supervisor mode entry/exit option 7‐11
Specific command reject option 7‐8
Track 1 format 7‐8
Transaction status information option 7‐8
Enhanced EJ backup (option 36) 10‐19
Enhanced PIN entry state 2‐57
Enhanced Printer Control Codes
Define Downloadable Bit Image 5‐16
Define Downloadable Character Set 5‐15
Print Barcode 5‐12
Print Downloadable Bit Image 5‐10
Print Epson Graphics 5‐13
Select Arabic Character Sets 5‐10
Select Horizontal Height of Barcode 5‐18
Select International Character Set 5‐9
Select OS/2 Code Page 5‐9
Select Printing Position of HRI Characters 5‐17
Select Width of Barcode 5‐17
Set Left Margin 5‐7
Set Right Margin 5‐8
Enhanced Remote Key Loading scheme
DES key message sequence 11‐28
key deletion 11‐29
Enhanced TI/sensor status (option 24) 10‐18
Envelope dispenser (unsolicited message) 9‐129
Envelope dispenser state 2‐19
Envelope dispenser status (option 23) 9‐129, 10‐18
EPP authentication process 11‐21
EPP security 11‐3
Error Redial timer 13‐6
Example messages
digital audio control in a transaction reply 3‐25, 3‐26
Exit states 2‐1, 2‐96
Explicit Shutter Control 2‐121
Extended encryption key change message 10‐37
Extended screen controls reserved screens ‐ ‘K’ 3‐8
Extension states 2‐6
Extension to State Y 2‐92
FDK information entry state 2‐85
F FDK switch state 2‐84
Financial Institution Tables
Data 8‐2
Fields 8‐4
Introduction 8‐1
FIT data load message 10‐22
FIT fields 11‐4
Algorithm/bank ID index (PAGDX) 8‐4
Decimalisation table (PDCTB) 8‐9
Encrypted PIN key (PEKEY) 8‐9
Index reference point (PINDX) 8‐9
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-6 APTRA Advance NDC, Reference Manual
Index
Indirect next state index (PSTDX) 8‐4
Institution ID (PFIID) 8‐4
Institution ID index (PIDDX) 8‐4
Language code index (PLNDX) 8‐11
Maximum PIN digits checked (PCKLN) 8‐5
Maximum PIN digits entered (PMXPN) 8‐4
MM sensor flag (PMMSR) 8‐11
PAN data index (PANDX) 8‐7
PAN data length (PANLN) 8‐7
PAN pad (PANPD) 8‐8
PIN block format (PBFMT) 8‐11
PIN offset data (POFDX) 8‐9
PIN pad (PINPD) 8‐6
Track 3 PIN (PRCNT) 8‐8
FIT switch state 2‐52
Font ID mapping table B‐12
Foreground colour control commands 3‐28
Foreign currencly exchange trasnactions
Local Cash Dispense state 2‐166
Four FDK selection function state 2‐23
Function IDs
Function ID ‘‐‘ 10‐55, 10‐105, D‐16
Function ID ‘*‘ 10‐55, 10‐105, D‐16
Function ID ‘1‘ 10‐54, 10‐58, 10‐105, D‐16, D‐17, D‐20
Function ID ‘2‘ 10‐54, D‐16
Function ID ‘3‘ 10‐54, D‐16
Function ID ‘4‘ 10‐54, D‐16
Function ID ‘5‘ 10‐55, D‐16
Function ID ‘6‘ 10‐55, D‐16
Function ID ‘7‘ 10‐54, 10‐58, D‐16, D‐17, D‐20
Function ID ‘8‘ 10‐54, D‐16
Function ID ‘9‘ 10‐54, 10‐105, D‐16
Function ID ‘A‘ 10‐55, 10‐57, 10‐105, D‐16
Function ID ‘B‘ 10‐55, 10‐57, 10‐58, 10‐105, D‐16
Function ID ‘C‘ 10‐55, 10‐57, 10‐58, 10‐105, D‐16
Function ID ‘E‘ 10‐55, D‐16
Function ID ‘F‘ 10‐55, 10‐105, D‐16
Function ID ‘O‘ 10‐55, 10‐105, D‐16
Function ID ‘P‘ 10‐55, 10‐58, 10‐105, D‐16
Function ID ‘Q‘ 10‐55, 10‐58, 10‐105, D‐16
Function ID ‘R‘ 10‐55, D‐16
Function ID ‘S‘ 10‐55, 10‐105, D‐16
Function ID ‘T‘ 10‐55, 10‐105, D‐16
Function ID ’ 10‐55, 10‐105, D‐16
Function ID ’c’ 10‐55
Function ID ’colon’ 10‐55, 10‐58, 10‐105, D‐16, D‐17
GBRU
G Option 78 7‐20
Graphic pictures reserved screens ‐ ‘G’ 3‐8
Graphics pictures C‐2
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Reference Manual Index-7
Index
I’m Alive message 13‐5
I Image display controls
Bunch cheque 3‐35
Information entry state 2‐34
Insert Card State 2‐156
International currency display format 3‐45
ISO 8859 character sets B‐12
Journal printer (unsolicited message) 9‐106
J Journal printer backup 11‐39
Journal printer backup log tamper (option 22) 9‐107
Journal printer backup print operations (option 17) 10‐18, 11‐39
Journal printer backup time (option 16) 10‐18, 11‐39
Key entry mode ’D’ 9‐42
K Key loading, RSA initial for signatures 11‐21
Key verification values 11‐17
Keyboard data
Encryption key entry 4‐13
Introduction 4‐2
Secure key entry 4‐13
States and keyboards 4‐8
Supervisor mode 4‐12
Traditional keyboard layouts 4‐10
Transaction processing 4‐10, 4‐11
Keyboards
Full touch screens 4‐16
in states 4‐8
Nested (not supported) 4‐2
Operation 4‐9
Operator 4‐14
physical 4‐2
Secure PIN entry 4‐9
Supervisor mode 4‐12
Touch screen 4‐2
Transaction processing 4‐10
Language code switch state 2‐65
L Language select from card state 2‐82
Left margin control 3‐32
Left print column (option 5) 10‐18
Lift cheque image control 3‐35
Linked FITs 8‐12
Local Cash Dispense state
foreign currency exchange transactions 2‐166
message handling 2‐170
Logo control 3‐33
Logos reserved screens 3‐12
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-8 APTRA Advance NDC, Reference Manual
Index
MCN range (option 34) 10‐19
M MCRW ECD security jitter (option 46) 10‐19
Media entry/exit indicators flash rate (option 25) 10‐18
Message authentication 11‐10
Full message authentication 11‐12
Selective message authentication 11‐13
Sending the MAC field from Central to the terminal 11‐11
Sending the MAC field from the terminal to Central 11‐11
Time variant number 11‐11
Message authentication code
Generation 11‐10
Message authentication field selection load message 10‐26
Message coordination number 10‐92
Message exception handling
Reasons for a command reject 10‐102
Message handling
Local Cash Dispense state 2‐170
Message on CP option in dialup 13‐6
Message suppression in dialup 13‐6
Message types
Quick reference D‐2
Acknowledge and stop command D‐21
Acknowledge EJ upload block command D‐21
Customisation data commands D‐12
EJ options and timers command D‐21
Solicited status D‐8
Terminal commands D‐10
TM‐Alert D‐2
Transaction reply D‐15
Transaction request D‐3
Unsolicited status D‐7
Upload EJ data D‐10
Messages
I’m Alive 13‐5
Messages received in wrong operational mode
Action taken 10‐110
Customisation data commands 10‐110
Terminal commands 10‐112
Transaction reply command 10‐111
Modem timers 13‐2
Multi‐language screens 3‐48
Navigating the publication xlv
N NCR documentation, other G‐6
NCR XFS simulator G‐6
Nested keyboards, not supported 4‐2
Night safe
Deposit and print function 10‐73
Night safe depository (solicited/unsolicited message) 9‐111
Note acceptor capabilities 9‐51
Note mix selection state 2‐180
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Reference Manual Index-9
Index
Operator interface display characters 3‐15
O Operator Keyboard 4‐14
Option numbers
EJ option 60 10‐97
EJ option 61 10‐97, 10‐100
Enhanced configuration parameters load options
Option 0 (camera control) 7‐2
Option 1 (ready/supply/amount buffer) 10‐18
Option 12 (specific command reject) 7‐8, 10‐18
Option 15 (transaction status information) 7‐8, 10‐18
Option 16 (journal printer backup time) 7‐8, 10‐18, 11‐39
Option 17 (journal printer backup print operations) 7‐8, 10‐18,
11‐39
Option 2 (auto voice) 7‐7, 10‐18
Option 22 (journal printer backup log tamper) 9‐107
Option 23 (envelope dispenser status) 7‐9, 9‐129, 10‐18
Option 24 (enhanced TI/sensor status) 7‐9, 10‐18
Option 25 (media entry/exit indicators flash rate) 7‐10, 10‐18
Option 27 (remote relay) 7‐10, 10‐18
Option 3 (date format) 7‐7, 10‐18
Option 33 (simulate supervisor mode entry/exit) 7‐11, 10‐19
Option 34 (MCN range) 7‐11, 10‐19
Option 35 (report dual mode EJ) 7‐13, 9‐110, 10‐19
Option 36 (enhanced EJ backup) 7‐13, 10‐19
Option 37 (print track 2 to journal) 7‐13, 10‐19
Option 4 (roll width) 7‐7, 10‐18
Option 44 (BNA journal notes count) 7‐14
Option 44 (BNA journal vaulted notes count) 10‐19
Option 45 (BNA message settings) 9‐6, 9‐126, 10‐19
Option 45 (BNA settings) 7‐15
Option 46 (MCRW ECD security jitter) 7‐17, 10‐19
Option 48 (barcode reader) 7‐18, 10‐19
Option 5 (left print column) 7‐7, 10‐18
Option 69 (EMV smart card extended status) 7‐18, 10‐19
Option 7 (track 1 format) 7‐8, 10‐18
Option 70 (EMV smart card) 10‐19
Option 76 (cash handlers) 7‐19, 10‐19
Option 77 (Cardless transactions next state) 10‐19
Option 77 (next state number) 10‐19
Option 78 (GBRU variant reporting) 7‐20
Option 79 (coin dispenser) 7‐21, 9‐6
Option 80 (alphanumeric state entry) 7‐21
Option 83 (cheque processor) 7‐21, 10‐19
PAGDX 8‐4
P PAN block 11‐7
PANDX 8‐7
PANLN 8‐7
PANPD 8‐8
Parallel eject/dispense and print (fast cash) function 10‐75
PBFMT 8‐11
PCKLN 8‐5
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-10 APTRA Advance NDC, Reference Manual
Index
PDCTB 8‐9
PEKEY 8‐9
PFIID 8‐4
Physical keyboards 4‐2
Picture control 3‐33
PIDDX 8‐4
PIN blocks
BANKSYS 11‐6
ISO format 0 (ANSI) 11‐5
ISO format 3 11‐6
PIN Entry
enabled in the T state 2‐69
PIN entry
disabled in the T state 2‐69
PIN entry state 2‐16
PINDX 8‐9
PINPD 8‐6
PLNDX 8‐11
PMXPN 8‐4
POFDX 8‐9
Power failure (unsolicited message) 9‐97
PPD default print
Eight character amount buffer 5‐4
Twelve character amount buffer 5‐5
PRCNT 8‐8
Pre‐Dial and Normal options for dialup 13‐3
Pre‐set operation code buffer state 2‐20
Print immediate function 10‐72
Print statement and set next state function 10‐78
Print track 2 to journal (option 37) 10‐19
Printer data
Character sets 5‐20
PPD default print 5‐4
Printer control characters 5‐6
Printer types supported by Advance NDC 5‐2
Simulated pre‐printed receipt messages 5‐25
PSTDX 8‐4
Read condition values 2‐13
R Ready (’B’) 9‐26
Ready/supply/amount buffer (option 1) 10‐18
Rear settlement restrictions 3‐54
Receipt printer
first line position 5‐37
screen K01 3‐9
top margin 3‐10
Receipt printer (solicited/unsolicited message) 9‐104
Related documentation
overview G‐1
Remote PIN block 11‐4
Remote relay (option 27) 10‐18
Report dual mode EJ (option 35) 9‐110, 10‐19
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Reference Manual Index-11
Index
Reserved 7‐29
Reserved parameters
Configuration Parameters Load message 7‐5
Reserved screens
Cardholder display 3‐6
Definition 3‐4
Extended screen controls 3‐8
Graphic pictures 3‐8
Logos 3‐12
Supervisor menus 3‐12
Types of 3‐5
Reserved screens default text
‘A’ Acknowledgements A‐3
‘d’ Diagnostic A‐70
‘E’ Errors A‐5
‘i’ BNA A‐88
‘I’ Information A‐18
‘i’ Settlement A‐92
‘i’ TCP/IP A‐72, A‐75
‘j’ Misc A‐95
‘M’ Menus A‐25
‘P’ Prompts A‐43
‘S’ Information lines A‐49
‘T’ Trace A‐53
’U’ EMV Smart Card A‐63
Reserved timers
Enhanced Configuration Parameters Load message 7‐29
Roll width (option 4) 10‐18
RSA encrypted DES key format 11‐29
RSA initial key loading
Signatures 11‐21
Screens
S Calculating touch screen positions 4‐17
Customised 3‐2
Definition 3‐2
invalid control sequence in name display 3‐20
Multi‐language screens 3‐48
Reserved 3‐4
screen blinking and colour control 3‐27
Screen display considerations 3‐52
Screen/keyboard data load message 10‐11
special features 3‐20
Secure key entry 4‐13
Secure PIN Entry
Keyboards 4‐9
Security features
BANKSYS PIN block 11‐7
BAPE security 11‐2
EPP security 11‐3
Journal printer backup 11‐39
Key verification values 11‐17
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-12 APTRA Advance NDC, Reference Manual
Index
Message authentication 11‐10
Full 11‐12
Selective 11‐13
Message authentication code (MAC) 11‐10
Remote PIN block 11‐4
RSA initial key loading for signatures 11‐21
Select primary character set 3‐31
Select secondary character set 3‐31
Sensors (unsolicited message) 9‐114
Set next state and print function 10‐73
Signature format 11‐30
Simulate supervisor mode entry/exit (option 33) 10‐19
Simulated pre‐printed receipt messages 5‐25
Simulator for APTRA G‐6
Smart card handling 12‐1
Smart FIT Check state 2‐97
SMS ‐style data entry 2‐35
Solicited status messages
Encryptor initialisation data 9‐82
Exits 9‐22
Fitness data 9‐54
Hardware configuration data 9‐48
Introduction 9‐22
Local configuration option digits 9‐59
Ready (’B’) 9‐26
Send configuration ID 9‐77
Send configuration information 9‐34
Send date/time information 9‐76
Send enhanced configuration information 9‐58
Send supply counters 9‐61
Send tally information 9‐75
Software ID and release number data 9‐58
Specific command reject 9‐28
Status descriptor field 9‐22
Status information field 9‐22
Supplies data 9‐52
Tamper and sensor status data 9‐56
Special features
Animation 3‐43, 3‐44
Bunch cheque amount display 3‐37
Bunch cheque codeline display 3‐37
Bunch cheque image display 3‐35
Bunch cheque value display 3‐38
Changing display in idle 3‐30
Digital audio control 3‐23
Display dynamic text dictionary 3‐39
Display image files control 3‐34
Dynamic text dictionary
Bunch Cheque Accept refuse reason 2‐138
Bunch Cheque Accept reject reason 2‐138
Cash Accept refuse reason 2‐124
Cheque acceptance states 2‐149
Left margin control 3‐32
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Reference Manual Index-13
Index
Lift cheque image control 3‐35
Logo control 3‐33
Picture control 3‐33
Screen blinking and colour control 3‐27
Select primary character set 3‐31
Select secondary character set 3‐31
Set display mode control 3‐32
Specific command reject 9‐28
Specific command reject (option 12) 10‐18
SST to Central dialup messages 13‐4
State numbers 2‐5
State tables 2‐2
Amount check state 2‐30
Barcode reader state 2‐192
Buffer Validation state 2‐163
Bunch Cheque Accept state 2‐133
Bunch Cheque Handling state 2‐140
Camera control state 2‐60
Card read ‐ PIN entry initiation state 2‐68
Card read state 2‐7
Card write state 2‐55
Cash accept state 2‐105
Cheque accept state 2‐125
Cheque Detail Display state 2‐144
Close state 2‐45
Customer selectable PIN state 2‐93
Device fitness 2‐76
Display Cheque Summary state 2‐150
Eight FDK selection function state 2‐88
Enhanced amount entry state 2‐61, 2‐63, 2‐181
Enhanced PIN entry state 2‐57
Envelope dispenser state 2‐19
Exit States 2‐96
Expanded FIT switch state 2‐53
FDK information entry state 2‐85
FDK switch state 2‐84
FIT switch state 2‐52
Four FDK selection state 2‐23
Information entry state 2‐34
Language code switch state 2‐65
Language select from card state 2‐82
Local Cash Dispense 2‐166
Master Expansion state 2‐132
PIN entry state 2‐16
Pre‐set operation code buffer state 2‐20
Smart FIT Check state 2‐97
Time‐out state 2‐201
Transaction request state 2‐39
Types of 2‐3
State tables load message 10‐9
Statement printer (solicited/unsolicited message) 9‐119
Statement printer controls
Left margin control 5‐23
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-14 APTRA Advance NDC, Reference Manual
Index
Lines/inch control 5‐24
Margin control use 5‐24
Right margin control 5‐23
States and keyboards 4‐8
States, user‐written 2‐1
Status descriptor field 9‐23, 10‐102–10‐109
Supervisor and Journal Miscellaneous Screens ‐ j A‐95
Supervisor keys (unsolicited message) 9‐117
Supervisor menus reserved screens 3‐12
Supervisor messages
Automatic screen editing 6‐4
Character sets 6‐2
Control codes 6‐2
CRT layout 6‐3
Introduction 1‐4
Media status messages 6‐4
Printer layout 6‐4
Screen size limitations 6‐3
Test cash report 6‐4
Support information xlviii
System setup for dialup connections 13‐2
Tamper and sensor status data message 9‐56
T Terminal
Command format 10‐3, 10‐50
How the terminal operates 1‐2
Terminal commands
Disconnect message 13‐7
No Op message 13‐8
Terminal to Central messages
EJ Upload message 9‐90
Transaction request message 9‐2
Unsolicited status messages 9‐93
Time‐of‐day clock (unsolicited message) 9‐96
Time‐out state 2‐201
Time‐Out State entry (option 71) 10‐19
Timers
adjusting for voice guidance 7‐24
reserved in Enhanced Configuration Parameters Load message 7‐29
Timer 00 2‐201, 7‐4, 7‐24, 7‐30, 10‐19
Timer 01 7‐4, 7‐24, 10‐19
Timer 02 2‐8, 2‐45, 3‐7, 7‐4, 7‐25, 10‐20, 10‐70, 10‐71, 10‐74, 10‐75, 10‐76
Timer 03 2‐39, 7‐4, 7‐25, 10‐20
Timer 04 2‐129, 2‐201, 7‐4, 10‐20, 10‐70
Timer 05 7‐4, 7‐25, 10‐20, 10‐71, 10‐74, 10‐75
Timer 06 7‐4, 7‐26, 10‐20
Timer 07 7‐4, 7‐26, 10‐20, 10‐71, 10‐72, 10‐75, 10‐77
Timer 08 2‐201, 7‐4, 7‐26, 9‐112, 10‐20, 10‐73
Timer 09 2‐8, 2‐45, 2‐47, 7‐4, 7‐27, 10‐20, 10‐70, 10‐74, 10‐76
Timer 10 7‐4, 7‐27, 10‐71
Timer 60 9‐91, 10‐97
Timer 61 2‐201, 7‐4, 7‐27
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Reference Manual Index-15
Index
Timer 63 7‐27
Timer 68 7‐4, 7‐28, 10‐20
Timer 69 7‐4, 7‐28
Timer 72 2‐72, 2‐73, 7‐4, 7‐28, 10‐20
Timer 77 2‐113, 2‐121, 7‐4, 7‐28
Timer 78 7‐4
Timer 87 2‐128, 7‐4, 7‐28, 10‐20
Timer 91 7‐4, 7‐30
Timer 92 7‐4, 7‐29, 7‐30, 10‐20
Timer 94 2‐49, 2‐129, 7‐4, 10‐21, 10‐81, 10‐86
Timer 95 2‐45, 7‐4, 10‐21
Timer 96 7‐4, 10‐21, 10‐78
Timer 97 (unsupported) 7‐4, 7‐30
Timers for dialup
Application 13‐3
Modem 13‐2
Timers, unsupported 7‐30
Touch screen FDK emulation
Amount entry state 2‐26
Eight FDK selection function state 2‐88
FDK information entry state 2‐85
Four FDK selection state 2‐23
Information entry state 2‐35
PIN entry state 2‐16
Time‐out state 2‐203
Touch screen keyboards 4‐2
Amount entry state 2‐27
Eight FDK selection function state 2‐88
FDK information entry state 2‐85
Four FDK selection function state 2‐23
Information entry state 2‐35
Reset considerations 3‐53
Time‐out state 2‐203
Unsolicited message 9‐116
Touch‐screen emulation in ITRs 10‐91
Track 1 format (option 7) 10‐18
Track 1 name display
ABA format cards 3‐20
Auto select backwards search 3‐19
Auto select forwards search 3‐20
Formats 3‐18
ISO format cards 3‐19
Name display 3‐20
VISA format cards 3‐19
Transaction Completion option in dialup 13‐6
Transaction processing keyboard 4‐10
Transaction reply commands
Interactive transaction response 10‐91
Transaction reply format 10‐52
Transaction reply functions
BNA encash 10‐81
BNA refund and set next state 10‐79
Card before cash 10‐74
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-16 APTRA Advance NDC, Reference Manual
Index
Card before parallel dispense and print 10‐76
Deposit and print 10‐70
Dispense and print 10‐71
Display and print 10‐72
Night safe deposit and print 10‐73
Parallel eject/dispense and print (fast cash) 10‐75
Print immediate 10‐72
Print statement and set next state 10‐78
Print statement and wait 10‐77
Set next state and print 10‐73
Transaction request message
Format 9‐2
Introduction 9‐2
Transaction request state 2‐39
Transaction status information (option 15) 10‐18
Triple Zero Key on PINpad 2‐26
Unsolicited status messages
U Conditions for sending 9‐93
Format 9‐94
Unsupported parameters
Configuration Parameters Load message 7‐5
Enhanced Configuration Parameters Load message 7‐22
Unsupported timers 7‐30
Upload EJ Data 9‐90
Using the publication xliv
Voice guidance, adjusting timers 7‐24
V Voice‐guided sessions in ITRs 10‐91
XFS Simulator for APTRA G‐6
X
z008 Insert Card state 2‐156
Z z010 – Local Cash Dispense state’ Local Cash Dispense state 2‐166
z013 – Data Copy and Compare state 2‐173
compare operations 2‐176
copy operations 2‐175
z014 ‐ Cash Deposit Handling state 2‐177
z024 ‐ Prepare Dispense State 2‐191
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA Advance NDC, Reference Manual Index-17
Index
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Index-18 APTRA Advance NDC, Reference Manual
User Feedback Form
Title: APTRA™ Advance NDC, Reference Manual
Number: B006‐6180‐R000 Release: Issue 1 Date: October 2015
NCR welcomes your feedback on this publication. Your comments can be of great value in helping us improve
our information products.
Cut
You may send your comments to us electronically. See over for details.
Circle the numbers below that best represent your opinion of this publication.
Ease of use 5 4 3 2 1 0 5 = Excellent
4 = Good
Accuracy 5 4 3 2 1 0
3 = Adequate
Clarity 5 4 3 2 1 0 2 = Fair
1 = Poor
Completeness 5 4 3 2 1 0
Organisation 5 4 3 2 1 0 0 = Not applicable
Appearance 5 4 3 2 1 0
Examples 5 4 3 2 1 0
Illustrations 5 4 3 2 1 0
Job performance 5 4 3 2 1 0
Question resolution 5 4 3 2 1 0
Overall satisfaction 5 4 3 2 1 0
Indicate the ways you feel we could improve this publication.
Improve the table of contents Add more/better quick reference aids
Improve the overview/introduction Add more examples
Improve the organisation Add more illustrations
Improve the index Add more step‐by‐step procedures
Make it less technical Add more troubleshooting information
Make it more concise/brief Add more detail
Write any additional comments you may have below and on additional sheets, if necessary. Include page
numbers where applicable.
Use the following addresses to send your comments to us electronically:
E‐mail ‐ [email protected]
Cut
Fold
If we may contact you concerning your comments, please fill in the information below:
Name:
Organisation:
Company:
Address:
Phone: Fax:
Thank you for your evaluation of this publication. Fold the form where indicated, tape (please do not staple),
and drop in the mail.
F 8763‐0695
Fold
Affix
Postage
Stamp
Here
NCR Financial Solutions Group Ltd
Product Management Feedback
Discovery Centre
3 Fulton Road
Dundee, Scotland
DD2 4SW
You might also like
- S2 Media Dispenser MStat 25 Pick Sensor Fault100% (1)S2 Media Dispenser MStat 25 Pick Sensor Fault4 pages
- Wincor Nixdorf's NDC - Diebold D91x Message Format Extension For ChequeIn V1.3 PDFNo ratings yetWincor Nixdorf's NDC - Diebold D91x Message Format Extension For ChequeIn V1.3 PDF69 pages
- NDC+ and APTRA Advance NDC: EMV Integrated Circuit Card (ICC) Reference ManualNo ratings yetNDC+ and APTRA Advance NDC: EMV Integrated Circuit Card (ICC) Reference Manual224 pages
- Supervisory Policy Manual: TM-E-1 Risk Management of E-BankingNo ratings yetSupervisory Policy Manual: TM-E-1 Risk Management of E-Banking37 pages
- Initiate Business Checking: Important Account InformationNo ratings yetInitiate Business Checking: Important Account Information4 pages
- AANDC Preliminary Discontinution For AANDC v04.04.xx100% (1)AANDC Preliminary Discontinution For AANDC v04.04.xx9 pages
- ProCash NDC-DDC V3021 InstallationManual en100% (4)ProCash NDC-DDC V3021 InstallationManual en432 pages
- ProCash NDC V2000 ProConsult NDC V2000 UserGuide enNo ratings yetProCash NDC V2000 ProConsult NDC V2000 UserGuide en420 pages
- b006-6297-c000 NCR NDC+ and Aandc Emv Icc Reference ManualNo ratings yetb006-6297-c000 NCR NDC+ and Aandc Emv Icc Reference Manual204 pages
- Aptra Advance NDC - EMV-ICC-Reference-Manual - 2018100% (1)Aptra Advance NDC - EMV-ICC-Reference-Manual - 2018312 pages
- Programming Apt Ra Advance NDC Course Outline100% (1)Programming Apt Ra Advance NDC Course Outline4 pages
- EMV/CAM2 Exits For APTRA Advance NDC: NCR University CourseNo ratings yetEMV/CAM2 Exits For APTRA Advance NDC: NCR University Course11 pages
- 3-DeS Fix NCR Install-User Manual 12-02-05No ratings yet3-DeS Fix NCR Install-User Manual 12-02-0546 pages
- NCR SelfServ 84 ATM Service Manual B006 7602 B000 Jan 05,2022No ratings yetNCR SelfServ 84 ATM Service Manual B006 7602 B000 Jan 05,20221,620 pages
- ProCash NDC V1400 ProConsult NDC V1200 UserGuide en100% (1)ProCash NDC V1400 ProConsult NDC V1200 UserGuide en398 pages
- s2 Media Dispense Module Brochure - English UsNo ratings yets2 Media Dispense Module Brochure - English Us7 pages
- Americas APTRA Advance NDC 3.00.10 CE Bring Live Guide Ghosting100% (4)Americas APTRA Advance NDC 3.00.10 CE Bring Live Guide Ghosting82 pages
- S2 Media Dispenser Presenter and Pick Module Gears100% (1)S2 Media Dispenser Presenter and Pick Module Gears2 pages
- 445-0797328C - 6684-K497-V001 Installation InstructionsNo ratings yet445-0797328C - 6684-K497-V001 Installation Instructions12 pages
- Opteva 740 Operating Guide TP 820896 001FNo ratings yetOpteva 740 Operating Guide TP 820896 001F74 pages
- Guidance Document: Central Drugs Standard Control OrganizationNo ratings yetGuidance Document: Central Drugs Standard Control Organization12 pages
- Registration Form: International Conference On Petroleum Engineering (ICPE 2016)No ratings yetRegistration Form: International Conference On Petroleum Engineering (ICPE 2016)3 pages
- Agreement For Your Stay With SereneServicedApartments - 240-484-179No ratings yetAgreement For Your Stay With SereneServicedApartments - 240-484-1798 pages
- Princeton University Press: Cognitive Science 2013100% (4)Princeton University Press: Cognitive Science 201316 pages
- Best Finacle Step by Step Finacle Steps PDFNo ratings yetBest Finacle Step by Step Finacle Steps PDF13 pages
- U3A2 - Recording Transactions in A Journal - TemplateNo ratings yetU3A2 - Recording Transactions in A Journal - Template3 pages
- JAMES A. HALL - Accounting Information System ch05No ratings yetJAMES A. HALL - Accounting Information System ch0541 pages
- T.D.S./Tcs Tax Challan: Tax Deducted/Collected at Source From (0020) COMPANY (0021) NON-COMPANY Deductees DeducteesNo ratings yetT.D.S./Tcs Tax Challan: Tax Deducted/Collected at Source From (0020) COMPANY (0021) NON-COMPANY Deductees Deductees2 pages
- Wincor Nixdorf's NDC - Diebold D91x Message Format Extension For ChequeIn V1.3 PDFWincor Nixdorf's NDC - Diebold D91x Message Format Extension For ChequeIn V1.3 PDF
- NDC+ and APTRA Advance NDC: EMV Integrated Circuit Card (ICC) Reference ManualNDC+ and APTRA Advance NDC: EMV Integrated Circuit Card (ICC) Reference Manual
- Supervisory Policy Manual: TM-E-1 Risk Management of E-BankingSupervisory Policy Manual: TM-E-1 Risk Management of E-Banking
- Initiate Business Checking: Important Account InformationInitiate Business Checking: Important Account Information
- AANDC Preliminary Discontinution For AANDC v04.04.xxAANDC Preliminary Discontinution For AANDC v04.04.xx
- ProCash NDC V2000 ProConsult NDC V2000 UserGuide enProCash NDC V2000 ProConsult NDC V2000 UserGuide en
- b006-6297-c000 NCR NDC+ and Aandc Emv Icc Reference Manualb006-6297-c000 NCR NDC+ and Aandc Emv Icc Reference Manual
- Aptra Advance NDC - EMV-ICC-Reference-Manual - 2018Aptra Advance NDC - EMV-ICC-Reference-Manual - 2018
- EMV/CAM2 Exits For APTRA Advance NDC: NCR University CourseEMV/CAM2 Exits For APTRA Advance NDC: NCR University Course
- NCR SelfServ 84 ATM Service Manual B006 7602 B000 Jan 05,2022NCR SelfServ 84 ATM Service Manual B006 7602 B000 Jan 05,2022
- ProCash NDC V1400 ProConsult NDC V1200 UserGuide enProCash NDC V1400 ProConsult NDC V1200 UserGuide en
- Americas APTRA Advance NDC 3.00.10 CE Bring Live Guide GhostingAmericas APTRA Advance NDC 3.00.10 CE Bring Live Guide Ghosting
- S2 Media Dispenser Presenter and Pick Module GearsS2 Media Dispenser Presenter and Pick Module Gears
- 445-0797328C - 6684-K497-V001 Installation Instructions445-0797328C - 6684-K497-V001 Installation Instructions
- Guidance Document: Central Drugs Standard Control OrganizationGuidance Document: Central Drugs Standard Control Organization
- Registration Form: International Conference On Petroleum Engineering (ICPE 2016)Registration Form: International Conference On Petroleum Engineering (ICPE 2016)
- Agreement For Your Stay With SereneServicedApartments - 240-484-179Agreement For Your Stay With SereneServicedApartments - 240-484-179
- Princeton University Press: Cognitive Science 2013Princeton University Press: Cognitive Science 2013
- U3A2 - Recording Transactions in A Journal - TemplateU3A2 - Recording Transactions in A Journal - Template
- JAMES A. HALL - Accounting Information System ch05JAMES A. HALL - Accounting Information System ch05
- T.D.S./Tcs Tax Challan: Tax Deducted/Collected at Source From (0020) COMPANY (0021) NON-COMPANY Deductees DeducteesT.D.S./Tcs Tax Challan: Tax Deducted/Collected at Source From (0020) COMPANY (0021) NON-COMPANY Deductees Deductees