APTRA™ Advance NDC
Reference Manual
B006‐6180‐P000
Issue 1
January 2013
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
The product described in this book is a licensed product of NCR Corporation.
NCR, APTRA and 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.
It is the policy of NCR Corporation (NCR) to improve products as new technology, components, software, and firmware
become available. NCR, therefore, reserves the right to change specifications without prior notice.
All features, functions, and operations described herein may not be marketed by NCR in all parts of the world. In some
instances, photographs are of equipment prototypes. Therefore, before using this document, consult with your NCR
representative or NCR office for information that is applicable and current.
To maintain the quality of our publications, we need your comments on the accuracy, clarity, organization, and value
of this book.
Address correspondence to:
NCR Financial Solutions Group Ltd
Information Solutions Feedback
Discovery Centre
3 Fulton Road
Dundee, Scotland
DD2 4SW
© 2000 ‐ 2013
By NCR Corporation
Duluth, Georgia U.S.A.
All Rights Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Federal Communications Commission (FCC) Radio Frequency Interference Statement
Federal Communications
Commission (FCC) Radio Frequency
Interference Statement
Note: This equipment has been tested and found to comply with
the limits for a Class A digital device, pursuant to Part 15 of the
FCC Rules. These limits are designed to provide reasonable
protection against harmful interference when the equipment is
operated in a commercial environment. This equipment
generates, uses, and can radiate radio frequency energy and, if not
installed and used in accordance with the instruction manual,
may cause harmful interference to radio communications.
Operation of this equipment in a residential area is likely to cause
harmful interference in which case the user will be required to
correct the interference at his own expense.
Canadian Class A Device
Declaration
This digital apparatus does not exceed the Class A limits for radio
noise emissions from digital apparatus set out in the Radio
Interference Regulations of the Canadian Department of
Communications.
Le présent appareil numérique n’émet pas de bruits
radioélectriques dépassant les limites applicables aux appareils
numériques de la classe A prescrites dans le Réglement sur le
brouillage radioélectrique édicté par le ministère des
Communications du Canada.
This equipment must be installed and used in strict accordance with
the manufacturer’s instructions. However, there is no guarantee
that interference to radio communications will not occur in a
particular commercial installation. If this equipment does cause
interference, which can be determined by turning the equipment off
and on, the user is encouraged to consult an NCR service
representative immediately.
Information to User
Caution
NCR Corporation is not responsible for any radio or television
interference caused by unauthorised modifications of this
equipment or the substitution or attachment of connecting cables
and equipment other than those specified by NCR. Such
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
Federal Communications Commission (FCC) Radio Frequency Interference Statement
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
iv
APTRA™ Advance NDC, Reference Manual
Revision Record
Revision Record
Date
Page
Jan 2013
Description of Change
New revision for Advance NDC 4.02
lviii
Added section on the terms used to describe cash
acceptors
2‐4
Added states z010, z013, z014 and z017 to the
standard state types
2‐5
Added section on screen number parameters in
state tables, with the range updated from 000‐999
to 000‐Z99
2‐21
Added a cross‐reference to state z017 if amount
entry is to be accompanied by note mix selection
2‐29, 2‐30
and 2‐32
Added that the parameters defined in table entry 9
of the Information Entry state can be overridden by
a local XML file
2‐36
In the Interactive Transaction Request state, added
bit values to table entry 6, Send Optional Data, for
note type counts of counterfeit and suspect notes
2‐39
Described how receipts of different length are
handled
2‐40
Added a note on why the Receipt Delivered Screen
is not displayed
2‐42, 2‐45
Minor amendments to table entries
2‐44
Added that the setting of extension state entry 8 is
ignored if retract to escrow has occurred
2‐44
Added that if returned notes are taken late, after
the retract operation has started, no w7 message is
sent
2‐62
Restructured the information as PIN entry
initiation is now optional
2‐63
Clarified how PIN entry is handled through use of
the length parameters in the FIT
2‐65
Added that if the PIN entry screen is not required,
extension table entry 2 must be set to 000
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
2‐73, 2‐79, Added information on language selection during
voice‐guided sessions
2‐74
Added information on extended screen group size
and multi‐language screens
2‐83, 2‐94
Added information on extended screen base size
and multi‐language screens
2‐97
Added note explaining Advance NDC behaviour
when rejected notes are taken as the retract
operation starts
2‐105
Added that if ECB 6 support is enabled, Enhanced
Configuration option 45 must be set to allow more
than 90 notes
2‐144
Added state z017 to the examples of states that
require data entry
2‐145
Amended example rule set
2‐147
Added state z010, Local Cash Dispense, for local
cash dispensing
2‐154
Added a state to handle data copying and
comparison
2‐154
Added state z013, Data Copy and Compare to
validate data locally without host interaction
2‐158
Added state z014, Cash Deposit Handling to
handle offline deposit and refund operations for
cash‐in transactions without host interaction
2‐161
Added z017, Note Mix Selection state, to handle
amount entry allowing the consumer to select note
denominations for the cash to be dispensed
3‐3
Updated description of screen groups
3‐4
Added note to emphasise that consumer screens
must not be defined in resrvd.def
3‐10
Added note that the receipt top margin registry
entry will be overridden if set through the
Supervisor
3‐33
Clarified that the PCX file format is not supported
and explained how legacy graphics files are
handled
3‐35
Added that the display of cheque images for both
single and bunched cheques can be controlled
locally
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
3‐38
Added details of configurable format for the
display of bunch cheque amounts
3‐45
Clarified how currency amounts are displayed
3‐48
Updated examples for multi‐language screens
3‐52
Added information about the use of the SWF file
format on SSTs
5‐37
Added a table note that the registry entry for the
first‐line position printer control is overridden by
any valid value entered using the Receipt Top
Margin option in Supervisor
7‐6, 7‐22
Added sections for Enhanced Configuration option
01 and field ‘k’
7‐7
option codes 003 and 004 as not supported for
Enhanced Configuration option 03
7‐11
Added bit values for additional configuration for
TREP/ITR handling
7‐13
Clarified that the print format for journaling track 2
card data is defined using reserved screen t15
7‐14
Added details of Enhanced Configuration option
41
7‐15
Updated note in table to indicate that number of
notes must be set to more than 90 if ECB 6 support
is enabled
7‐19
Added that Enhanced Configuration option 77
does not require the SST to be restarted
7‐26
Updated the default value for Timer 6 to 204
seconds.
7‐26
Restructured Timer 7, Note 2 for readability
9‐3
Added ITR and Enhanced Configuration option 34
details to field ‘g’ description for reply message
handling
9‐5
Added a cross‐reference and Table Note 6 on the
treatment of the Last Transaction counts following
a power failure
9‐5
In the table entry for field ‘r’ added cross‐reference
to Table Note 7 explaining when coin counts are
reported in Last Transaction Status messages
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
vii
Date
Page
Description of Change
9‐10
In the message format for Transaction Requests,
added details of the optional fields (cc1 to cc4 and
cd1 to cd4) to include note type counts for ECB 6
compliant institutions (suspect and counterfeit
notes)
9‐10
Provided further information for cb2 and cb3 fields
9‐23, 9‐24
Added sections on sub‐field ‘g3’ to clarify cassette
mapping for recycling
9‐25
Updated the valid CIM NDC cassette type range
9‐25
Updated to indicate rejected notes count is
returned in Ready ‘B’ message
9‐27
Added Specific Command Reject 11 for an invalid
dispense mix
9‐29
Clarified that Specific Command Reject E01
indicates that the function is not supported by the
software
9‐35, 9‐44
Added SelfServ 14 to the list of product classes
9‐50
moved table note cross‐reference from field g4 for
values GS, DIG and Tamper Status as these fields
are optional Added a table note cross‐reference to
the values for field g5
9‐59
Updated Table Note 64 to clarify that it applies
only to basic message GS fields
9‐59
Added an example of message analysis for a
solicited status message
9‐65
Increased number of characters for field g48 from 1
to 5
9‐89
Added details of the extra fields used to include
track data when a card is retracted
9‐94
Clarified the reporting of a recycling cassette that
has been replenished during a deposit transaction
9‐96
Added configuration information to report receipt
capture bin status in receipt printer status
messages
9‐106
Added that byte 8 in a sensor’s unsolicited status
message always returns a value of 0
9‐113
Added details of the note counts returned in status
messages for note acceptors
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
viii
APTRA™ Advance NDC, Reference Manual
Date
Page
Description of Change
9‐114
Added description of a scenario when an
unsolicited message reports that counts may be
inaccurate
9‐114
Added explanation of how direct deposit and
escrow deposit counts are reported in unsolicited
ECB 6 messages
9‐115
Added cross‐reference and Table Note 113 for
refunded notes taken late
9‐115 to
9‐116
Added cash acceptor transaction error codes that
are used only in legacy software implementations
(‘2’, ‘9’ and ‘A’ to ‘D’)
9‐115
Added cross‐reference and Table Note 111 for w3
message not sent
9‐115
Added cross‐reference and Table Note 112 that if
notes are retracted to the escrow, the cash acceptor
will be reported as fatal
9‐115
Added cross‐reference and Table Note 113 for w7
message not sent
10‐42
Added details of encryption key data for
certificates
10‐43
Updated the table note for modifiers ‘C’, ‘D’, and
‘E’ to include details of the data and algorithm
used for the key data. Add that all of the data
returned in the SST random number must be used.
10‐57
Updated field ‘p’ Card Return/Retain Flag, for
dispense and deposit operations during valuable
media exchange
10‐61
Added that buffer S is reserved for internal use
10‐65
Added function IDs ‘b’, Dispense Cash First
During Valuable Media Exchange, and ‘f’, Deposit
Media First During Valuable Media Exchange
10‐75
Added Table Note 93 for refunded notes taken late
10‐76, 10‐77 Updated the names of the function ID tables for the
‘‐’ and ‘’’ function identifiers in the Transaction
Reply
10‐77
Updated the Process Cheque function for
endorsement on single cheque acceptors
10‐78
Added table for function ID ‘b’, Dispense Cash
First During Valuable Media Exchange
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
ix
Date
Page
Description of Change
10‐82
Added table for function ID ‘f’, Deposit Media First
During Valuable Media Exchange
10‐87,
10‐96
Added details of the MCN in ITRs
10‐96
Added incomplete ITR as an example of Specific
Command Reject A02
10‐102
Added to status qualifier E01 that the requested
action is not supported by the software
11‐21 to
11‐28
Updated all sections to include more information
about enhanced signature remote key load.
11‐33 to
11‐36
Added details of RSA initial key load for
certificates
A‐1
Improved the introduction to the reserved screens
and added information on formatting used for
dynamic .NET data
A‐14, A‐23, Added new screens (E1910, I45 and j0021 to j0058)
A‐98 to
for enabling/disabling cardless functionality
A‐100
A‐19
Updated screen I10 to show six digits for KVVs
A‐22
Added screen used to identify cash handler 2 with
separated counters
A‐26
Added options 52 and 60 to the Supervisor
Replenish menu (M07)
A‐28
Added option 20 to the TCP/IP Configuration
menu (m00) for the Internet protocol version
A‐29
Updated screen m02 to include the BNA CASS
CFG option
A‐29, A‐38 Added software update option to the Supervisor
Misc Funcs menu (m05) and new menu (m48)
A‐38
Added the update service provider cash unit
identifier screen (m50)
A‐39
Added the update cash unit identifier screen (m51)
A‐40
Added new screen (m57) for IP version
configuration
A‐41
Added screen m64 for separated counters in the
Clear Cash option and screen m65 for separated
counters in the Standard Cash option
A‐48
Added the update cash unit identifier screen (p65)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
x
APTRA™ Advance NDC, Reference Manual
Date
Page
Description of Change
A‐68
Added screen U0167 to journal that the limit has
been reached for the number of times note
insertion can be attempted
A‐68
Added new journal screens (U0168 to U0170) used
to record off‐line printing
A‐68
Added screens U0171 and U0172 used when notes
are detected in the escrow and retracted
A‐68
Added new journal screens (U0300 to U0303) to
record time‐outs and cardholder cancel
A‐90
Updated the update note type screen (i37)
A‐91
Updated the cash acceptor counts screen (i43)
A‐91
Updated the cassette mapping screen (i92)
A‐99
Added screen j0026 to journal that the last
dispensed note counts are unknown
A‐99
Added screens j0027 to j0032 used to journal cash
counts
A‐99
Added screen j033 to journal the operation code
(OpCode) and updated chapter title
A‐100
Added journaling screens j0040 to j0058 for local
cash dispensing transactions
A‐102
Added screens j4055 to j4061 for the Cash Deposit
Handling state
D‐2
Added Table Note 1 to Table Note 3 to explain the
formatting conventions used in the appendix and a
cross‐reference to details of the ITR, Encryption
Key Change and Extended Encryption Key Change
D‐9
Added the information identifiers to the Encryptor
Initialisation Data message
D‐18
Updated to add values ‘b’ and ‘f’ to function l
(letter ell)
D‐20
Added that buffer S is reserved for internal use
E‐5, E‐25,
E‐29
Updated values returned for TI BINS (Alarms)
(DIG ‘P’)
E‐15
Updated Table Note 6 to add configuration
information for supplies status reporting of the
capture bin for the receipt printer (DIG G)
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xi
Date
Page
Description of Change
E‐20, E‐23 Updated table and Table Note 13 to add
configuration information for fitness status
reporting of the cardholder display (DIG S)
E‐23
Updated Table Note 12 to add configuration
information for fitness status reporting of the
capture bin for the receipt printer (DIG G)
E‐28
Updated Table Note 21 and Table Note 22 for
recyclers and retract/reject cassettes (cash handler
DIGs d and e)
Glossary
Added EEKC, EID, encryption certificate, HSM,
RKM, screen base, screen group and verification
certificate
Updated definitions for all cash acceptor terms
Jul 2011
New revision for Advance NDC 4.01
2‐43
Added information about screen U0088 for cheque
eject failure
2‐44
Updated the Close state for direct deposits
2‐98, 2‐100, Updated the Cash Accept state for direct deposits
2‐102,
2‐104, 2‐105
2‐99
Removed unsupported statement as selection of
the Add More Notes FDK is now journaled
2‐104
Clarified the Counterfeit Notes Retained Screen
table entry in the Cash Accept state
2‐106
Updated the information about the confirmation
screen in the Cash Accept state
2‐121
Updated field 7 of table z001 – Bunch Cheque
Accept State
2‐173
Updated the Time‐Out state
3‐11
Added reference to XFS on‐line document for
control sequences for USB printers
7‐14
Added that more than 90 notes must be accepted if
the SST is configured for direct deposit mode
7‐19
Clarified the description of Enhanced
Configuration option 76
7‐22
ClarifiedOption Code 001 and 002 of Option 83 ‐
Cheque Processor
7‐27
Updated the description of the default value of
timer 63
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xii
APTRA™ Advance NDC, Reference Manual
Date
Page
Description of Change
7‐28
Timer 78 updated as it now applies on any
hardware
9‐4
Added table note cross‐reference for FS preceding
fields ‘o’ and ’q’ in “Transaction Request Message
Format” table
9‐10
Updated the ‘ca3’ field of the Transaction Request
message for direct deposits
9‐33
BNA and CPM, added cross‐references to table
note explaining when their details are returned in
configuration information
9‐35
Added product classes for SelfServ 16, SelfServ 42,
SelfServ 4 and SelfServ 8
9‐37
table note added for double‐length restricted entry
mode
9‐40
Added single note acceptor variant to the
hardware configuration sub‐field
9‐80
Amended details of the fields for information
identifier ‘E’ in solicited Encryptor Initialisation
Data messages
9‐86
Added field ‘e6’ in “Unsolicited Status: Status
Information Field” table
9‐105
Updated information for Supervisor mode entry
and exit status messages (P20 and P21)
9‐113
Updated the Bunch Note Acceptor status message
for ECB 6 support
9‐118
Added that deposited notes are reported as escrow
counts regardless of their physical position.
10‐38
Added that the host must ensure that any required
Extended Encryption Key Change messages are
sent
10‐61
Added that smart card data other than
EMV/CAM2‐specific data may be returned in field
‘at2’
10‐75, 10‐77 Updated the cash acceptor terminal functions for
direct deposits
10‐90
Updated field ‘j1’ and added field ‘j2’ in table
‘Interactive Transaction Response’
11‐38
Added details of error if an attempt is made to
import a key that is already loaded
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xiii
Date
Page
Description of Change
A‐8, A‐9, Updated screens to use FOURTH instead of BOTTOM
A‐31, A‐49, in cassette descriptions
A‐53
A‐26
Removed details of screen M03 as it has been
replaced by screen m03.
A‐48
Added screen ‘p64’ for Supervisor mode change
message
A‐52, A‐57, Added screens ‘s40’, ‘t09’ and ‘t91’ for 5th cassette
A‐61
handling for TI
A‐58
Updated the screen journaled when the escrow
becomes full
A‐58
Updated the screen used to record an error during
a cash‐in transaction
A‐58
Updated the screen used to record the failure of the
note type configuration
A‐64
Added screen U0088 for cheque eject failure
A‐64
Removed screens U0104 and U0105 as they are no
longer used
A‐65
Added and updated the screens used to journal
failed signatures under the ECB 6 regulations
A‐65
Updated the screens used when reading serial
numbers from notes
A‐67
Added screens used to journal points in a cash
deposit transaction
A‐66
Added screen used to journal the selection of the
Add More Notes FDK
A‐66
Added screen used to journal notes detected in the
cash acceptor during the Close state
A‐66
Added screen used to journal that notes are
detected at the exit during AER on cash acceptors
A‐67
Added screen used to journal suspend condition
handling for cash acceptors
Added screens to journal notes identified as
counterfeit or suspect under the ECB 6 regulations
A‐67
Added screens for journaling the insertion and
removal of BNA cassettes
A‐67
Added screens used in cash‐in extended journaling
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xiv
APTRA™ Advance NDC, Reference Manual
Date
Page
Description of Change
A‐74
Added screens ‘i39’ and ‘i41’ for configuration of
SSL optional parameters
A‐91
Updated screen ‘i92’
A‐98
Added screens for journaling retract notes in
recycling mode
C‐1
Supplied graphics have PNG format.
D‐20
Updated field ‘at2’ to be more generic
E‐10
Added device variant for a single note acceptor
Glossary‐4 Added direct deposit to the glossary
Glossary‐5 Added escrow deposit to the glossary
Oct 2010
New revision for Advance NDC 4.00
All
Replaced all references to “device identification
graphic” with “device identifier graphic” as the
full form of DIG and aligned usage of the term and
acronym
Chapter 1 Restructured following the removal of conceptual
information, including the relocation of
information on clearing persistent memory and
SNMP traps to the Developer’s Guide
Chapter 2 Standardized references to EMV and EMV/CAM2
2‐3
Removed ‘U’ from the list of reserved states as it is
now used for the Device Fitness Flow Control State
2‐5
Added information on the use of Extension States
2‐8
Added information about error handing when a
card jam occurs
2‐12
Removed the note about touch FDKs clearing the
PIN buffer as it does not apply
2‐15
Added that Advance NDC does not attempt to
dispense envelopes unless envelopes are present in
the envelope dispenser
2‐30
Added explanation of what happens when general
purpose buffer B data exceeds the limit during the
Information Entry state
2‐37
Updated description of EMV/CAM2 processing
flag and its values
2‐42
Added automatic error recovery information for
cash acceptor recovery
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xv
Date
Page
Description of Change
2‐44
Added that a cardholder cancellation or a time‐out
during a transaction involving more than a cash
deposit is journaled during the Close state
2‐67
Added details of the Device Fitness Flow Control
State
2‐96
Added that reserved screen U0128 is journaled
when Add More is selected during cash acceptance
(unsupported in Advance NDC 4.00)
2‐103
Removed note from the Device Error Next State
table entry, as all relevant information is included
in the table
Added note on functionality if Cancel is selected
after Add More Notes
2‐106
Updated the description of the basic confirmation
screens as reserved screens are no longer used
2‐121
Updated the Cancel Next State Number and
Timeout Next State Number fields for the Bunch
Cheque State
2‐140
Added details of z008 ‐ Insert Card State
2‐144
Added details of z009 ‐ Buffer Validation state
3‐11
Noted that changes to the default value of Set First
Line Position must be a multiple of 18
3‐42, 3‐43
Added details of controls for dynamic buttons and
dynamic text definition
3‐44
Updated details of support for multi‐media file
formats
3‐52
Updated details of support for image files
4‐3
Added that a beep can be configured for emulated
FDKs
4‐5 to 4‐7
Updated Table 4‐2 to clarify the physical layout
and CEN‐XFS literal keys. Updated Table 4‐3 to
clarify it is the key code which is altered. Added
clarification that if a keyboard does not enable the
required number of keys the default keyboard is
used.Completely updated the Keyboard Mapping
examples to show the message contents and FDK
keys reassignments
4‐14
Added details on the remapping of keyboard
layouts for secure key entry
5‐4, 5‐5
Amended details of date format
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xvi
APTRA™ Advance NDC, Reference Manual
Date
Page
Description of Change
5‐33
Removed reference to Table Note 17 from Set First
Line Position Control Code as this information was
incorrect
5‐34
Added that the CHEQUE registry entry is the same
regardless of printer type
7‐9
Removed mention of remote status indicator and
remote relay control from Enhanced Configuration
option 23 as it only controls the sending of
envelope dispenser messages
7‐9
Updated information for value 002 in table
“Enhanced/TI Sensor Status Unsolicited Message
Values”
7‐18
Standardised references to EMV/CAM2 and
removed details of Enhanced Configuration option
70 as it is not supported in Advance NDC
7‐19
Clarified use of Enhanced Configuration option 77
7‐21
Added that for option 80, the Enhanced
Configuration Load Parameters message should be
sent before the State Tables Load message
7‐25
Amended usage of timer 05
7‐26
Added further information about the use of timer
07
9‐5
Added cross‐reference in field ‘r’ and updated data
details for Last Transaction Status Data
9‐12
Updated field cg2 and added a table note
cross‐reference
9‐14
Added a table note cross‐reference for fields ‘o’
and ’p’ and the preceding field separator
9‐14
Clarified use of the field separator
9‐16
Added details to table note of message field sent
when all cheques are to be returned to the
cardholder
9‐19
Added note explaining what happens when
general purpose buffer B data exceeds the limit
during an interactive transaction response
9‐31
Amended table note on message mode options
9‐31
Added that the device and module fitness data
returned in sub‐field g3 provides an overall view
of the state of the SST
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xvii
Date
Page
Description of Change
9‐33
Added that the journal printer will be reported as
fatal if it runs out of paper, even in dual mode
9‐37
Added information on the reporting of Restricted
Mode
9‐40, E‐9
Added new variants for the BNA and cheque
processor DIG
9‐52
Added a section for the Enhanced Configuration
Data solicited message to clarify the content when
command code 7 is sent with a command modifier
of 6
9‐74
Amended the description of the status data in a
solicited device fault message returned for an EPP
9‐77
Updated descriptions for fields ‘C’, ‘D’ and ‘E’.
9‐79
Added information on EPP Variable Length Serial
Number Capability and Information Identifier E.
9‐94
Added that all cassettes supply statuses are
reported following a retract operation
9‐96
Updated fields e3 and e5 of table ‘Receipt Printer
Status’
9‐101
Clarified that an H0 message is sent when the
journal printer paper runs out
9‐106 and
9‐107
Added byte 19 for Unsolicited Sensors message
and updated statement about Extended Tamper
Indication data
9‐87 to
9‐127
Clarified when solicited and unsolicited messages
are sent to report device status
Chapter 10 Standardised references to EMV and EMV/CAM2.
Removed section on host to Exit messages
10‐10 and
10‐21
Added additional Table Notes to explain the
relationship between State Tables Load and
Enhanced Configuration Parameters Load
messages
10‐12
Removed restriction on keyboard definition
numbers in field ‘j1’ as Advance NDC only
recognises FDK mappings
10‐41
Added information on modifier ‘U’.
10‐43
Added description in table note for modifier ‘S’,
‘T’, ‘U’ and ‘V’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xviii
APTRA™ Advance NDC, Reference Manual
Date
Page
Description of Change
10‐55 to
10‐58 and
10‐65
Updated Transaction Reply description fields ‘m’,
’q’ and ‘r’ for voice data description and added a
table note reference.
10‐70
Updated note for timer 05 functionality
10‐70
Updated number of lines for a complete page in
table “Card Before Parallel Dispense and Print”.
10‐93
Updated field ‘d’ as it is now
mandatory; updated details of resending the last EJ
data block.
10‐106
Removed row in table 10‐40 for BNA Retrieve Note
Definitions command as this is processed as a
Configuration Information Request command
11‐3
Updated EPP information. Added cross references
to the APTRA Advance NDC, Multi‐Vendor Support
Reference for other vendors’ EPP information
11‐10
Amended the MAC verification format, which is
always ASCII
11‐21
Clarified that RSA initial key loading is supported
on all SSTs that can run Advance NDC
12‐4
Standardised references to EMV and EMV/CAM2
A‐14
Amended message E1902 from UNKNOWN
ERROR to POSSIBLE JAM
A‐19
Updated screen I06 for EJ level
A‐26
Removed screens M10, M11, M13 and M14 as the
cash‐in component is no longer using them as basic
confirmation screens
A‐29, A‐35 Updated reserved screens m02 and m38
A‐35, A‐37 Added reserved screens m36, m37 and m45
A‐46
Added reserved screen P97
A‐48
Added reserved screen S29
A‐50
Added reserved screen S29
A‐58
Updated screens t15 from resrvd.def
A‐61
Added reserved screen t90
A‐63
Updated screens U0057, U0058, and U0059 from
resrvd.def
A‐65‐A‐67, Updated screens used by the Cash‐In component
A‐101
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xix
Date
Page
Description of Change
A‐100
Added reserved screens j0020 and j4032
A‐98
Added reserved screen j0021
B‐8
Amended the path for the UniversalCharSets.txt
mapping file
D‐6
Updated description of field cg2
D‐16
Updated descriptions of modifiers ‘K’ and ‘N’, and
‘Q’ to ‘V’.
E‐3, E‐7
Removed references to BNA from cash handler
section of table
E‐5
Added “BITs 4‐7
0 ‐ (reserved ‐ always zero)”
E‐6, E‐13, Added details of DIG ‘X’ for the passbook printer
E‐21, E‐26
E‐19
Updated table “Device Fitness Data”; added
information about DIGs and their fitness data.
E‐24
Updated the methods used to calculate the overall
fitness for a cash acceptor
E‐27
Added a table note on values 010 to 020.
F‐2
Added 25h to the code conversion table
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xx
APTRA™ Advance NDC, Reference Manual
Table of Contents
Contents
Preface
Audience ...........................................................................................liii
How to Use This Publication ................................................................liv
Contents of the Publication ............................................................liv
Roadmap to the Publication ...........................................................lvi
Navigating the Publication........................................................... lvii
Conventions and Abbreviations Used in the Publication........ lvii
What Else Should I Read?...............................................................lix
Support Information ............................................................................... lx
Chapter 1
Introducing the Advance NDC System
Overview ................................................................................................1‐1
How the SST Operates ..........................................................................1‐2
Creating the 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
Reserved States................................................................................2‐3
Exit States .........................................................................................2‐3
Standard State Types......................................................................2‐3
State Numbers .................................................................................2‐4
Screen Numbers ..............................................................................2‐5
Extension States...............................................................................2‐5
A ‐ Card Read State ...............................................................................2‐7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xxi
Table of Contents
Read Condition Values ..................................................................2‐9
B ‐ PIN Entry State...............................................................................2‐12
C ‐ Envelope Dispenser State.............................................................2‐15
D ‐ Pre‐Set Operation Code Buffer State ..........................................2‐16
E ‐ Four FDK Selection Function State .............................................2‐19
F ‐ Amount Entry State .......................................................................2‐21
Voice‐Guided Sessions and Data Entry .....................................2‐21
State Processing.............................................................................2‐21
Buffer Clearing and AppendBuffer.xml ........................................2‐21
Touch‐Screen Emulation..............................................................2‐21
G ‐ Amount Check State .....................................................................2‐24
H ‐ Information Entry State................................................................2‐29
Data Entry ......................................................................................2‐29
Exiting the Information Entry State ...........................................2‐29
Clear Function Key and General‐Purpose Buffers...................2‐30
I ‐ Transaction Request State..............................................................2‐33
J ‐ Close State ........................................................................................2‐39
Function Operations .....................................................................2‐39
K ‐ FIT Switch State .............................................................................2‐46
_ ‐ Expanded FIT Switch State ...........................................................2‐47
L ‐ Card Write State.............................................................................2‐49
M ‐ Enhanced PIN Entry State...........................................................2‐51
N ‐ Camera Control State ...................................................................2‐54
R ‐ Enhanced Amount Entry State ....................................................2‐56
S ‐ Language Code Switch State ........................................................2‐59
T ‐ Card Read ‐ PIN Entry Initiation State .......................................2‐62
PIN Entry Enabled ........................................................................2‐63
PIN Entry Disabled.......................................................................2‐63
Audio Support...............................................................................2‐63
Smart Dip Card Reader ................................................................2‐63
U – Device Fitness Flow Select State.................................................2‐67
Supported Devices ........................................................................2‐69
V ‐ Language Select From Card State ...............................................2‐73
W ‐ FDK Switch State..........................................................................2‐75
X ‐ FDK Information Entry State .......................................................2‐76
Y ‐ Eight FDK Selection Function State ............................................2‐79
Language Selection in Voice‐Guided Sessions .........................2‐79
b ‐ Customer‐Selectable PIN State.....................................................2‐84
d ... g and z ‐ Exit States ......................................................................2‐87
k ‐ Smart FIT Check State ...................................................................2‐88
m ‐ PIN & Language Select State.......................................................2‐89
Considerations for Voice‐Guided Sessions ...............................2‐90
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxii
APTRA™ Advance NDC, Reference Manual
Table of Contents
> ‐ Cash Accept State...........................................................................2‐96
Confirmation Screen...................................................................2‐106
Dynamic Text Definitions..........................................................2‐107
w ‐ Cheque Accept State...................................................................2‐109
z – Master Expansion State ..............................................................2‐116
z001 – Bunch Cheque Accept State .................................................2‐117
Defining Dynamic Text for Cheque Rejection ........................2‐122
Defining Dynamic Text for Cheque Refusal ...........................2‐122
z002 – Bunch Cheque Handling State ............................................2‐124
z003 – Cheque Detail Display State ................................................2‐128
Defining Dynamic Data for Cheque Deposit Status ..............2‐133
z004 – Display Cheque Summary State..........................................2‐134
Current Cheque Index................................................................2‐135
z008 – Insert Card State ....................................................................2‐140
z009 – Buffer Validation State..........................................................2‐144
Date Validation Scenario ...........................................................2‐145
z010 – Local Cash Dispense State....................................................2‐147
Cardless Transactions.................................................................2‐147
Dispense Functionality...............................................................2‐147
Foreign Currency Exchange Transactions...............................2‐147
State Flow after a Successful Dispense ....................................2‐147
State Flow after a Short Dispense .............................................2‐148
State Flow after a Failed Dispense............................................2‐148
State Flow after an Unknown Dispense ..................................2‐149
State Flow on Card Ejection ......................................................2‐149
State Operation............................................................................2‐149
Message Handling ......................................................................2‐151
z013 – Data Copy and Compare State ............................................2‐154
Copy Operations .........................................................................2‐156
Compare Operations ..................................................................2‐157
z014 – Cash Deposit Handling State...............................................2‐158
z017‐ Note Mix Selection State ........................................................2‐161
& ‐ Barcode Read State .....................................................................2‐168
Time‐Out State ...................................................................................2‐173
Chapter 3
Screen Data
Overview ................................................................................................3‐1
The Screen Interface ..............................................................................3‐2
Customer Screens............................................................................3‐2
Reserved Screens.............................................................................3‐4
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xxiii
Table of Contents
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
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxiv
APTRA™ Advance NDC, Reference Manual
Table of Contents
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
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xxv
Table of Contents
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
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxvi
APTRA™ Advance NDC, Reference Manual
Table of Contents
Option 45 – BNA Settings ............................................................7‐14
Option 46 – MCRW Enhanced Card Device Security Jitter ....7‐17
Option 48 – Barcode Reader ........................................................7‐17
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 – Field ‘k’ ............................................................7‐22
Number of Seconds per Timer Field – Field ‘l’.........................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
Chapter 8
Financial Institution Tables
Overview ................................................................................................8‐1
FIT Data...................................................................................................8‐2
FIT Fields..........................................................................................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
Solicited Status Messages ...................................................................9‐20
Content of Solicited Status Messages.........................................9‐20
Status Information ........................................................................9‐22
Solicited Device Fault Status..............................................................9‐72
Device Fault Status Responses....................................................9‐72
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xxvii
Table of Contents
Device Fault Status Information Field .......................................9‐73
Other Solicited Messages....................................................................9‐76
Encryptor Initialisation Data .......................................................9‐76
Upload EJ Data Message..............................................................9‐81
Unsolicited Status Messages ..............................................................9‐84
Conditions for Sending Unsolicited Messages .........................9‐84
Unsolicited Status Information Field .........................................9‐85
Device Status Information..................................................................9‐87
Time‐Of‐Day Clock (Unsolicited)...............................................9‐87
Power Failure (Unsolicited).........................................................9‐87
Card Reader/Writer (Solicited/Unsolicited)..............................9‐88
Cash Handler (Solicited/Unsolicited) ........................................9‐90
Depository (Solicited/Unsolicited) .............................................9‐95
Receipt Printer (Solicited/Unsolicited).......................................9‐96
Journal Printer (Unsolicited) .......................................................9‐97
Electronic Journal Printer (Unsolicited).....................................9‐99
Night Safe Depository (Solicited/Unsolicited)........................9‐102
Encryptor (Unsolicited)..............................................................9‐103
Camera (Unsolicited)..................................................................9‐104
Sensors (Unsolicited) ..................................................................9‐105
Touch Screen Keyboard (Unsolicited) .....................................9‐107
Supervisor Keys (Unsolicited)...................................................9‐108
Cardholder Display Alarm (Unsolicited) ................................9‐110
Statement Printer (Solicited/Unsolicited) ................................9‐110
Voice Guidance (Unsolicited)....................................................9‐112
Note Acceptor (Solicited/Unsolicited) .....................................9‐113
Envelope Dispenser (Unsolicited) ............................................9‐120
Cheque Processor (Solicited/Unsolicited) ...............................9‐121
Coin Dispenser (Solicited/Unsolicited)....................................9‐125
Barcode Reader (Unsolicited)....................................................9‐127
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxviii
APTRA™ Advance NDC, Reference Manual
Table of Contents
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‐45
XML Configuration Download .......................................................10‐48
Transaction Reply Command..........................................................10‐51
Terminal Functions for Transaction Completion ...................10‐65
Interactive Transaction Response ...................................................10‐86
Support for Touch‐Screen Emulation ......................................10‐86
Support for Voice‐Guided Sessions .........................................10‐86
Message Coordination Number (MCN)..................................10‐87
EJ Commands.....................................................................................10‐91
EJ Options and Timers ...............................................................10‐91
Acknowledge EJ Upload Block.................................................10‐92
Acknowledge and Stop EJ .........................................................10‐93
Continuous and Batch Upload Methods .................................10‐94
Message Validation ...........................................................................10‐96
Valid Message Classes ...............................................................10‐96
Command Reject Causes ...........................................................10‐96
Other Invalid Parameters ........................................................10‐102
Messages Received in Wrong Operational Mode.......................10‐104
Customisation Data Commands.............................................10‐104
Transaction Reply Command .................................................10‐105
Terminal Commands................................................................10‐106
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xxix
Table of Contents
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
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxx
APTRA™ Advance NDC, Reference Manual
Table of Contents
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
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xxxi
Table of Contents
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
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‐13
Transaction Reply ........................................................................D‐16
Acknowledge EJ Upload Block Command ..............................D‐21
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxii
APTRA™ Advance NDC, Reference Manual
Table of Contents
Acknowledge and Stop EJ Command ......................................D‐22
EJ Options and Timers Command ............................................D‐22
Appendix E
Device Identifiers
Overview ............................................................................................... E‐1
Hardware Configuration Data ........................................................... E‐2
Supplies Data ...................................................................................... E‐11
Cash Acceptor Supplies (DIG ‘w’) ............................................ E‐16
Fitness Data ......................................................................................... E‐19
Cash Acceptor Fitness (DIG ‘w’) ............................................... E‐24
Tamper Data........................................................................................ E‐25
Appendix F
ASCII/EBCDIC Conversion Table
Overview ................................................................................................F‐1
Code Conversion Table ........................................................................F‐2
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.
APTRA™ Advance NDC, Reference Manual
xxxiii
Table of Contents
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxiv
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‐11
Chapter 3
Screen Data
Figure 3‐1
Cardholder/EOP Screen Layout...................................3‐2
Chapter 4
Keyboard Data and Layouts
Figure 4‐1
Figure 4‐2
Emulated FDKs: Touch Areas ......................................4‐3
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
xxxv
List of Figures
Figure 4‐12 Calculate Co‐ordinate ..................................................4‐20
Chapter 5
Printer Data
Figure 5‐1
Figure 5‐2
Screen Text Interlacing ................................................5‐26
Final Simulated Pre‐printed Receipt .........................5‐28
Chapter 11
Security Features
Figure 11‐1
Figure 11‐2
Figure 11‐3
Figure 11‐4
Figure 11‐5
Figure 11‐6
Figure 11‐7
Figure 11‐8
Figure 11‐9
Diebold PIN Block........................................................11‐5
ISO PIN Block Format 0 ..............................................11‐5
ISO PIN Block Format 1 ..............................................11‐6
ISO PIN Block Format 3 ..............................................11‐6
BANKSYS PIN Block ...................................................11‐7
PAN Block .....................................................................11‐7
Obtain Key Status Message Exchange ....................11‐17
Identify EPP and Determine EPP Capabilities.......11‐19
HSM ‐ EPP A‐key Message Exchange in Standard
Mode ..........................................................................11‐22
Figure 11‐10 Authentication of EPP/HSM Public Keys in Standard
Mode ..........................................................................11‐23
Figure 11‐11 HSM/EPP Signature Verification in Standard Mode .....
11‐23
Figure 11‐12 EPP Authentication Message Sequence in Standard
Mode ..........................................................................11‐24
Figure 11‐13 Authentication of EPP/HSM Public Keys in Enhanced
Mode ..........................................................................11‐25
Figure 11‐14 EPP Authentication Message Sequence in 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
Figure 11‐21 Load a Certificate DES Key.......................................11‐35
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxvi
APTRA™ Advance NDC Reference Manual
List of Figures
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
Figure B‐2
Alpha 1............................................................................ B‐2
Example Mapping File ............................................... B‐11
Appendix C
Cardholder Screen Graphics
Figure C‐1
Figure C‐2
Figure C‐3
Figure C‐4
Figure C‐5
Figure C‐6
Figure C‐7
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
xxxvii
List of Figures
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xxxviii
APTRA™ Advance NDC Reference Manual
List of Tables
List of Tables
Preface
Table Pref‐1 Navigation Aids ..............................................................lix
Table Pref‐2 Abbreviations Used in the Publication ......................... lx
Chapter 1
Introducing the Advance NDC System
Table 1‐1
Table 1‐2
Customisation Data .......................................................1‐4
Central Control Commands and Messages................1‐5
Chapter 2
State Tables
Table 2‐1
Table 2‐2
Table 2‐3
Table 2‐4
Table 2‐5
Table 2‐6
Table 2‐7
Table 2‐8
Table 2‐9
Table 2‐10
Table 2‐11
Table 2‐12
Table 2‐13
Table 2‐14
Table 2‐15
Table 2‐16
Table 2‐17
Table 2‐18
State Table Types............................................................2‐3
Buffers Initialised for State A .......................................2‐7
A ‐ Card Read State........................................................2‐9
Read Condition Bit Information ..................................2‐9
B ‐ Pin Entry State ........................................................2‐12
C ‐ Envelope Dispenser State .....................................2‐15
D ‐ Pre‐set Operation Code Buffer State ...................2‐16
Extension to State D .....................................................2‐17
E ‐ Four FDK Selection Function State ......................2‐20
F ‐ Amount Entry State................................................2‐22
G ‐ Amount Check State..............................................2‐25
Amount Check Error State..........................................2‐26
Amount Check Error State — DCCMT.....................2‐27
H ‐ Information Entry State ........................................2‐31
I ‐ Transaction Request State ......................................2‐33
Track 2 Data Send Modifier........................................2‐34
Track 1/3 Data Send Modifier.....................................2‐34
Table Entry 8 for Buffer A...........................................2‐35
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 2‐19
Table 2‐20
Table 2‐21
Table 2‐22
Table 2‐23
Table 2‐24
Table 2‐25
Table 2‐26
Table 2‐27
Table 2‐28
Table 2‐29
Table 2‐30
Table 2‐31
Table 2‐32
Table 2‐33
Table 2‐34
Table 2‐35
Table 2‐36
Table 2‐37
Table 2‐38
Table 2‐39
Table 2‐40
Table 2‐41
Table 2‐42
Table 2‐43
Table 2‐44
Table 2‐45
Table 2‐46
Table 2‐47
Table 2‐48
Table 2‐49
Table 2‐50
Table 2‐51
Table 2‐52
Table 2‐53
Table 2‐54
Table 2‐55
Table 2‐56
Table 2‐57
Table 2‐58
Table 2‐59
Table 2‐60
Extension 1 to State I....................................................2‐35
Extension 2 to State I....................................................2‐38
J ‐ Close State.................................................................2‐40
Extension State 1 to State J ..........................................2‐42
Extension State 2 (J ‐ Close State) ...............................2‐45
K ‐ FIT Switch State......................................................2‐46
_ ‐ Expanded FIT Switch State....................................2‐47
Extension to State _ ......................................................2‐48
L ‐ Card Write State......................................................2‐50
M ‐ Enhanced PIN Entry State ...................................2‐52
Security Camera Image Filename Format ................2‐54
N ‐ Camera Control State ............................................2‐55
R ‐ Enhanced Amount Entry State.............................2‐57
Extension to State R......................................................2‐57
S ‐ Language Code Switch State.................................2‐59
Extension to State S ......................................................2‐61
T ‐ Card Read ‐ PIN Entry Initiation State................2‐64
Extension to State T......................................................2‐65
U – Device Fitness Flow Select State .........................2‐67
State ‘U’ ‐ Supported Devices.....................................2‐69
Cash Handler Fitness Examples.................................2‐72
V ‐ Language Select from Card State.........................2‐73
W ‐ FDK Switch State...................................................2‐75
X ‐ FDK Information Entry State................................2‐76
Extension to State X......................................................2‐78
Y ‐ Eight FDK Selection Function State.....................2‐80
Extension 1 to State Y...................................................2‐82
Extension 2 to State Y...................................................2‐83
b ‐ Customer‐Selectable PIN State .............................2‐84
Extension to State b ......................................................2‐86
k ‐ Smart FIT Check State ............................................2‐88
m ‐ PIN & Language Select State ...............................2‐90
PIN & Language FDK Active Mask...........................2‐92
Extension 1 to State m..................................................2‐92
Extension 2 to State m..................................................2‐93
Extension 3 to State m..................................................2‐94
> ‐ Cash Accept State....................................................2‐97
Extension 1 to State > (Cash Accept) .........................2‐99
Extension 2 to State > (Cash Accept) .......................2‐101
Extension 3 to State > (Cash Accept) .......................2‐103
Extension 4 to State > (Cash Accept) .......................2‐105
Rejected Notes Dynamic Text...................................2‐107
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xl
APTRA™ Advance NDC, Reference Manual
List of Tables
Table 2‐61
Table 2‐62
Table 2‐63
Table 2‐64
Table 2‐65
Table 2‐66
Table 2‐67
Table 2‐68
Table 2‐69
Table 2‐70
Table 2‐71
Table 2‐72
Table 2‐73
Table 2‐74
Table 2‐75
Table 2‐76
Table 2‐77
Table 2‐78
Table 2‐79
Table 2‐80
Table 2‐81
Table 2‐82
Table 2‐83
Table 2‐84
Table 2‐85
Table 2‐86
Table 2‐87
Table 2‐88
Table 2‐89
Table 2‐90
Table 2‐91
Table 2‐92
Table 2‐93
Table 2‐94
Table 2‐95
Table 2‐96
Table 2‐97
Table 2‐98
Table 2‐99
Table 2‐100
w ‐ Cheque Accept State ...........................................2‐109
Extension 1 to State w................................................2‐112
Extension 2 to State w................................................2‐114
z ‐ Master Expansion State........................................2‐116
z001 ‐ Bunch Cheque Accept State ..........................2‐117
Extension 1 to State z001 ...........................................2‐119
Extension 2 to State z001 ...........................................2‐120
Extension 3 to State z001 ...........................................2‐121
Rejected Reasons ........................................................2‐122
Refused Reasons.........................................................2‐122
z002 ‐ Bunch Cheque Handling State......................2‐124
Extension 1 to State z002 ...........................................2‐125
Extension 2 to State z002 ...........................................2‐126
z003 ‐ Cheque Detail Display State..........................2‐129
Extension 1 to State z003 ...........................................2‐131
Extension 2 to State z003 ...........................................2‐132
Cheque Acceptance States ........................................2‐133
z003 ‐ Cheque Detail Display State..........................2‐135
Extension 1 to State z004 ...........................................2‐136
Extension 2 to State z004 ...........................................2‐137
Extension 3 to State z004 ...........................................2‐138
z008 ‐ Insert Card State .............................................2‐141
Extension to State z008 ..............................................2‐142
z009 ‐ Buffer Validation State ..................................2‐145
z010 – Local Cash Dispense State ............................2‐151
Extension 1 to State z010 ...........................................2‐152
z013 – Data Copy and Compare State.....................2‐154
Extension 1 to State z013 ...........................................2‐155
z014 – Offline Encash/Refund State.........................2‐159
Extension 1 to State z014 ...........................................2‐160
z017‐ Note Mix Selection State .................................2‐161
Extension 1 to State z017 ...........................................2‐162
Extension 2 to State z017 ...........................................2‐164
Extension 3 to State z017 ...........................................2‐166
Extension 4 to State z017 ...........................................2‐167
& ‐ Barcode Reader State...........................................2‐168
Extension 1 to State & ................................................2‐170
Extensions 2—8 to State & ........................................2‐171
Entry Conditions for the Time‐Out State................2‐173
Action Taken on Selection of FDK B for Each Entry
Condition...................................................................2‐174
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xli
List of Tables
Table 2‐101 Action Taken on Selection of the Cancel Key for Each
Entry Condition........................................................2‐175
Chapter 3
Screen Data
Table 3‐1
Table 3‐2
Table 3‐3
Table 3‐4
Table 3‐5
Table 3‐6
Table 3‐7
Table 3‐8
Table 3‐9
Table 3‐10
Table 3‐11
Table 3‐12
Table 3‐13
Table 3‐14
Table 3‐15
Table 3‐16
Table 3‐17
Table 3‐18
Table 3‐19
Table 3‐20
Table 3‐21
Table 3‐22
Table 3‐23
Table 3‐24
Table 3‐25
Table 3‐26
Table 3‐27
Table 3‐28
Table 3‐29
Table 3‐30
Table 3‐31
Table 3‐32
Table 3‐33
Table 3‐34
Table 3‐35
K – Extended Screen Controls: Restoring Settings ....3‐9
Screen Contents ‘K01’ ....................................................3‐9
Screen Contents ‘K09’ ..................................................3‐10
Screen Contents ‘K02’ ..................................................3‐10
Screen Contents ‘K010’ ................................................3‐10
Screen Contents ‘K07’ ..................................................3‐11
Screen Contents ‘K08’ ..................................................3‐11
Screen Contents ‘K03’ ..................................................3‐11
Cardholder Screen: Character Sets ............................3‐14
Character Sets with Customer‐Defined Characters 3‐15
Enhanced Operator Interface: Character Set ............3‐15
Cardholder Screen: Control Character Functions ...3‐16
Track 1 Data Formats...................................................3‐18
Screen Display Special Features.................................3‐20
Digital Audio Control in Screen Display..................3‐22
Digital Audio Control for Voice Guidance...............3‐23
Screen Blinking and Colour Control .........................3‐27
Blinking Commands ....................................................3‐27
Foreground Colour Commands.................................3‐28
Background Colour Commands ................................3‐28
Default Foreground Colour Commands...................3‐29
Default Background Colour Commands ..................3‐29
Change Display While Idle .........................................3‐30
Select Primary Character Set ......................................3‐31
Select Secondary Character Set ..................................3‐31
Set Left Margin Position ..............................................3‐32
Select Logo.....................................................................3‐33
Picture Control Command..........................................3‐34
Display Image File Command....................................3‐34
Display Lifted Cheque Image Command.................3‐35
Bunch Cheque Image Display Control .....................3‐36
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...............3‐40
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xlii
APTRA™ Advance NDC, Reference Manual
List of Tables
Table 3‐36
Table 3‐37
Table 3‐38
Table 3‐39
Table 3‐40
Table 3‐41
Table 3‐42
Dynamic Button Definition.........................................3‐42
Syntax of Conditional Expressions............................3‐43
Dynamic Text Definition.............................................3‐44
Video and Animation File Formats ...........................3‐45
Currency Echo Example..............................................3‐46
Default Echo Display Format .....................................3‐47
Field Definitions for Screens C09–C19 ......................3‐56
Chapter 4
Keyboard Data and Layouts
Table 4‐1
Table 4‐2
Table 4‐3
Table 4‐4
Table 4‐5
Table 4‐6
Table 4‐7
Table 4‐8
Table 4‐9
Table 4‐10
Table 4‐11
Emulated FDKs: Touch Area Measurements.............4‐3
FDKs, Key Codes and CEN‐XFS equivalents ............4‐5
Mapping CEN‐XFS Keys...............................................4‐5
Mapping CEN‐XFS Example........................................4‐7
Numeric Autoactivators (PIN)...................................4‐11
Non‐Numeric Autoactivators (PIN)..........................4‐11
Supervisor Mode Autoactivators (PIN) ....................4‐12
Encryption Key Entry Autoactivators (PIN) ............4‐13
Encryption Key Entry Autoactivators (TTU) ...........4‐13
Non‐Numeric Autoactivators (TTU).........................4‐15
Touch Area Definition .................................................4‐16
Chapter 5
Printer Data
Table 5‐1
Table 5‐2
Table 5‐3
Table 5‐4
Table 5‐5
Table 5‐6
Table 5‐7
Table 5‐8
Table 5‐9
Table 5‐10
Table 5‐11
Table 5‐12
Table 5‐13
Printer Control Characters............................................5‐6
Maximum Printed Lines ...............................................5‐7
Set Left Margin Position................................................5‐8
Set Right Margin Position .............................................5‐8
Select OS/2 Code Page ...................................................5‐9
Select International Character Sets ............................5‐10
Select Arabic Character Sets .......................................5‐10
Print Downloadable Bit Image...................................5‐11
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xliii
List of Tables
Table 5‐14
Table 5‐15
Table 5‐16
Table 5‐17
Table 5‐18
Table 5‐19
Table 5‐20
Table 5‐21
Table 5‐22
Table 5‐23
Table 5‐24
Table 5‐25
Table 5‐26
Table 5‐27
Table 5‐28
Table 5‐29
Table 5‐30
Select HRI Character Printing Position .....................5‐17
Select Barcode Width ...................................................5‐17
Select Barcode Horizontal Height..............................5‐18
Select Dual‐sided Printing ..........................................5‐18
Character Set Designators ...........................................5‐20
Select Primary Print Page............................................5‐22
Select Secondary Print Page........................................5‐22
Set Left Margin (Statement Printer)...........................5‐23
Set Right Margin (Statement Printer) ........................5‐23
Switch Lines Per Inch (6/8)..........................................5‐24
Line Spacing Values.....................................................5‐24
Invalid Control Sequences for Screen R01................5‐26
Screen R00 Data ............................................................5‐27
Screen R01 Data and Interlaced Data from Central 5‐27
Printer Control Sequences and Registry Settings ....5‐30
Print Cheque Image Variable Data ............................5‐35
USB Receipt and Journal Printer: Barcode Types,
Length, and Data........................................................5‐36
Chapter 6
Supervisor Messages
Table 6‐1
Table 6‐2
Screen Size Limits...........................................................6‐3
Display Positions............................................................6‐3
Chapter 7
Configuration Parameters
Table 7‐38
Table 7‐39
Table 7‐40
Table 7‐41
Table 7‐42
Table 7‐43
Table 7‐44
Table 7‐45
Table 7‐46
Values for Camera Control ...........................................7‐2
Values for Supply Mode, Ready Status and Amount
Buffer Length ................................................................7‐2
Summary of Timers........................................................7‐4
Option 02: Auto Voice Values ......................................7‐7
Option 03: Date Formats ...............................................7‐7
Option 07: Track 1 Format Values ...............................7‐8
Option 12: Specific Command Reject Values .............7‐8
Option 15: Transaction Status Information Values ...7‐8
Option 23: Envelope Dispenser Status Values ...........7‐9
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xliv
APTRA™ Advance NDC, Reference Manual
List of Tables
Table 7‐47
Table 7‐48
Table 7‐49
Table 7‐50
Table 7‐51
Table 7‐52
Table 7‐53
Table 7‐54
Table 7‐55
Table 7‐56
Table 7‐57
Table 7‐58
Table 7‐59
Table 7‐60
Table 7‐61
Table 7‐62
Table 7‐63
Table 7‐64
Table 7‐65
Table 7‐66
Table 7‐67
Table 7‐68
Table 7‐69
Table 7‐70
Table 7‐71
Table 7‐72
Option 24: Enhanced/TI Sensor Status Unsolicited
Message Values ............................................................7‐9
Option 24: 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‐11
Option 33: Simulate Supervisor Mode Entry/Exit
Values ..........................................................................7‐11
Option 34: MCN Range Values ..................................7‐11
Option 34: MCN Range Option Code Examples .....7‐12
Option 35: Report Dual Mode & Hardcopy B/U
Unsolicited Message Values.....................................7‐13
Option 36: Enhanced EJ Backup Values ...................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 Values ..............................................................7‐14
Option 45: BNA Settings Bit Values ..........................7‐15
Example Option 45: BNA Settings Values................7‐17
Option 46: MCRW Enhanced Card Device Security
Jitter Values.................................................................7‐17
Option 48: Barcode Reader Values ............................7‐18
Option 71: Time‐Out State Entry ...............................7‐18
Option 74: Destination Values for Retracted Notes
During Cash Deposit .................................................7‐18
Option 76: Cash Handlers...........................................7‐19
Option 77: Next State Number Values......................7‐20
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
Unsupported Parameters ............................................7‐22
Chapter 8
Financial Institution Tables
Table 8‐1
Table 8‐2
Table 8‐3
Table 8‐4
Table 8‐5
FIT Fields .........................................................................8‐2
PIN Block Type Selection ..............................................8‐5
PINPD Bit Encoding Significance ................................8‐6
PINPD First Digit Coding .............................................8‐6
PINDX Index Reference Point ....................................8‐10
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xlv
List of Tables
Table 8‐6
PINDX Digit Assignment............................................8‐10
Chapter 9
Terminal to Central Messages
Table 9‐1
Table 9‐2
Table 9‐3
Table 9‐4
Table 9‐5
Table 9‐6
Table 9‐7
Table 9‐8
Table 9‐9
Table 9‐10
Table 9‐11
Table 9‐12
Table 9‐13
Table 9‐14
Table 9‐15
Table 9‐16
Table 9‐17
Table 9‐18
Table 9‐19
Table 9‐20
Table 9‐21
Table 9‐22
Table 9‐23
Table 9‐24
Table 9‐25
Table 9‐26
Table 9‐27
Table 9‐28
Table 9‐29
Table 9‐30
Table 9‐31
Table 9‐32
Table 9‐33
Table 9‐34
Transaction Request Message Format.........................9‐2
E13B Codeline Encoding .............................................9‐17
CMC7 Codeline Encoding ..........................................9‐17
Transaction Request in Reply to an Interactive
Transaction Response ................................................9‐19
Solicited Status Message Format................................9‐20
Ready (‘B’) ‐ Status Information.................................9‐23
Cash Deposit: Recycle Data ........................................9‐24
Recycle Cassette: Dispense Data ................................9‐25
Specific Command Reject ‐ Status Information .......9‐26
Terminal State ‐ Status Information Sub‐Field ‘g1’ .9‐29
Send Configuration Information Response..............9‐30
Hardware Fitness Sub‐Field ‘g3’................................9‐32
Hardware Fitness Severity Values.............................9‐33
Hardware Configuration Data: Sub‐Field ‘g4’.........9‐34
Supplies Status Sub‐Field ‘g5’ ....................................9‐41
Supplies Status Values.................................................9‐42
Hardware Configuration Data Response .................9‐43
Supplies Data Response ..............................................9‐45
Fitness Data Response .................................................9‐48
Tamper and Sensor Data Response ...........................9‐49
Software ID and Release Number Data Response ..9‐52
Local Configuration Option Digits Response ..........9‐53
Note Definitions (BNA) Response .............................9‐54
Send Supply Counters Response ...............................9‐56
Status Message Description ........................................9‐60
Send Supply Counters: Extended Response ............9‐61
Send Tally Information Response..............................9‐68
Send Error Log Information Response......................9‐69
Send Date/Time Information Response ....................9‐70
Send Configuration ID Response...............................9‐71
Device Fault Status in Response to Transaction Reply
Commands ..................................................................9‐72
Device Fault Status Information Field ......................9‐73
Encryptor Initialisation Data Response ....................9‐76
Format of the Upload EJ Data Message ....................9‐82
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xlvi
APTRA™ Advance NDC, Reference Manual
List of Tables
Table 9‐35
Table 9‐36
Table 9‐37
Table 9‐38
Table 9‐39
Table 9‐40
Table 9‐41
Table 9‐42
Table 9‐43
Table 9‐44
Table 9‐45
Table 9‐46
Table 9‐47
Table 9‐48
Table 9‐49
Table 9‐50
Table 9‐51
Table 9‐52
Table 9‐53
Table 9‐54
Table 9‐55
Table 9‐56
Table 9‐57
Table 9‐58
Table 9‐59
Table 9‐60
Table 9‐61
Unsolicited Status: Message Format..........................9‐85
Unsolicited Status: Status Information Field............9‐86
Time‐Of‐Day Clock Status ..........................................9‐87
Power Failure Status ....................................................9‐88
Card Reader/Writer Status..........................................9‐88
Additional Track Data on Card Retract ....................9‐89
Cash Handler Status ....................................................9‐90
Depository Status .........................................................9‐95
Receipt Printer Status ..................................................9‐96
Journal Printer Status...................................................9‐98
Electronic Journal Printer Status ..............................9‐100
Unsolicited Message Sequences for Option 35 (EJ Dual
Mode).........................................................................9‐101
Night Safe Depository Status ...................................9‐102
Encryptor Status .........................................................9‐103
Camera Status .............................................................9‐104
Sensors Status .............................................................9‐105
Touch Screen Keyboard Status.................................9‐107
Supervisor Keys Status..............................................9‐108
Cardholder Display Alarm Status ...........................9‐110
Statement Printer Status............................................9‐110
Voice Guidance Status...............................................9‐112
Bunch Note Acceptor Status.....................................9‐115
Additional Cardholder Data ....................................9‐119
Envelope Dispenser Status .......................................9‐120
Cheque Processor Status ...........................................9‐121
Coin Dispenser Status................................................9‐125
Barcode Reader Status ...............................................9‐128
Chapter 10
Central to Terminal Messages
Table 10‐1
Table 10‐2
Table 10‐3
Table 10‐4
Table 10‐5
Table 10‐6
Table 10‐7
Table 10‐8
Table 10‐9
Terminal Commands ...................................................10‐3
Customisation Data Commands................................10‐7
State Tables Load .........................................................10‐9
Screen/keyboard Data Load .....................................10‐11
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xlvii
List of Tables
Table 10‐10
Table 10‐11
Table 10‐12
Table 10‐13
Table 10‐14
Table 10‐15
Table 10‐16
Table 10‐17
Table 10‐18
Table 10‐19
Table 10‐20
Table 10‐21
Table 10‐22
Table 10‐23
Table 10‐24
Table 10‐25
Table 10‐26
Table 10‐27
Table 10‐28
Table 10‐29
Table 10‐30
Table 10‐31
Table 10‐32
Table 10‐33
Table 10‐34
Table 10‐35
Table 10‐36
Table 10‐37
Table 10‐38
Table 10‐39
Table 10‐40
Table 10‐41
Table 10‐42
Data and Time Load ..................................................10‐33
Encryption Key Change ............................................10‐35
Extended Encryption Key Change ..........................10‐38
Dispenser Currency Cassette Mapping ..................10‐45
XML Configuration Download Message Format ..10‐49
Transaction Reply Command: Message Format....10‐51
Deposit and Print (Function ID ‘1’ or ‘7’) ...............10‐66
Dispense and Print (Function ID ‘2’ or ‘8’) .............10‐67
Display and Print (Function ID ‘3’ or ‘9’) ...............10‐68
Print Immediate (Function ID ‘4’)............................10‐69
Set Next State and Print (Function ID ‘5’)...............10‐69
Night Safe Deposit and Print
(Function ID ‘6’)........................................................10‐69
Card Before Cash (Function ID ‘A’) ........................10‐70
Parallel Eject/Dispense and Print ‐
Fast Cash (Function ID ‘B’ or ‘C’) ..........................10‐71
Card Before Parallel Dispense and Print
(Function ID ‘F’) .......................................................10‐72
Print Statement and Wait
(Function ID ‘P’) .......................................................10‐73
Print Statement and Set Next State
(Function ID ‘Q’) ......................................................10‐74
Refund Notes and Set Next State
(Function ID ‘*’) ........................................................10‐75
Deposit Notes and Print ............................................10‐76
Deposit Notes and Wait ............................................10‐77
Process Cheque (Function ID ‘:’)..............................10‐77
Dispense Cash First During Valuable Media Exchange
(Function ID ‘b’) .......................................................10‐78
Dispense Cash First During Valuable Media Exchange:
Operational Flow .....................................................10‐80
Process Multiple Cheques (Function ID ‘c’) ...........10‐81
Deposit Media First During Valuable Media Exchange
(Function ID ‘f’) ........................................................10‐82
Deposit Media First During Valuable Media Exchange:
Operational Flow .....................................................10‐84
Interactive Transaction Response ............................10‐87
EJ Options and Timers...............................................10‐91
Acknowledge EJ Upload Block ................................10‐93
Acknowledge and Stop EJ.........................................10‐94
Specific Command Reject Value/Qualifier
Combinations............................................................10‐97
Actions for Customisation Data Commands .......10‐104
Actions for Transaction Reply Commands ..........10‐105
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
xlviii
APTRA™ Advance NDC, Reference Manual
List of Tables
Table 10‐43 Actions for Terminal Commands ..........................10‐106
Chapter 11
Security Features
Table 11‐1
Table 11‐2
Table 11‐3
Table 11‐4
Table 11‐5
Table 11‐6
Table 11‐7
Table 11‐8
Table 11‐9
Table 11‐10
Table 11‐11
PINPD First Digit Bit Significance .............................11‐8
PINPD FIT Field ...........................................................11‐8
Message Authentication Configuration Flag 1 ......11‐12
Message Authentication Configuration Flag 2 ......11‐12
Message Authentication Configuration Flag 8 ......11‐12
Message Authentication Configuration Flag 9 ......11‐13
Message Authentication Configuration Flag 10 ....11‐13
MAC Field Selection: Solicited Status Message.....11‐14
MAC Field Selection ‐ Other Messages...................11‐14
MAC Field Selection ‐ Track 1, Track 2, Track 3....11‐15
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
Table 13‐2
Table 13‐3
Table 13‐4
Table 13‐5
Table 13‐6
Table 13‐7
Modem Timers .............................................................13‐2
Application Timer Settings for Dialup......................13‐3
SST Messages Header Format ....................................13‐4
I’m Alive Message Format ..........................................13‐5
Central Messages Header Format..............................13‐7
Disconnect Message Format .......................................13‐7
No‐Op Message Format ..............................................13‐8
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
xlix
List of Tables
Appendix A
Reserved Screens
Table A‐1
Table A‐2
Table A‐3
Table A‐4
Table A‐5
Table A‐6
Table A‐7
Table A‐8
Table A‐9
Table A‐10
Table A‐11
Table A‐12
Table A‐13
Table A‐14
Supervisor Acknowledgement Screens .....................A‐3
Error Screens ..................................................................A‐5
Supervisor Information Screens................................A‐18
Supervisor Menu Screens...........................................A‐25
Supervisor Prompts Screens ......................................A‐43
Supervisor Information Lines Screens .....................A‐49
Journal Trace Screens..................................................A‐53
Cheque, EMV Smart Card and BNA Screens..........A‐63
Supervisor Diagnostic Screens ..................................A‐70
Supervisor TCP/IP Screens ........................................A‐72
Supervisor Dialup Screens.........................................A‐75
Supervisor BNA Screens ............................................A‐88
Supervisor Settlement Screens ..................................A‐92
Supervisor Miscellaneous Screens ............................A‐95
Appendix B
Character Sets
Table B‐1
Table B‐2
Table B‐3
Table B‐4
Character Sets ................................................................ B‐3
Statement Printer Character Sets ................................ B‐5
Mapping File Conventions .......................................... B‐9
Font ID Mapping Table .............................................. B‐12
Appendix D
Quick Reference to Message Types
Table D‐1
Table D‐2
Table D‐3
Table D‐4
Table D‐5
Table D‐6
Table D‐7
Table D‐8
Table D‐9
Quick Reference to Message Types ............................D‐2
Transaction Request Message Format........................D‐3
Unsolicited Status Message Format............................D‐7
Solicited Status Message Fields...................................D‐8
Solicited Status Message Field Values .......................D‐8
Encryptor Initialisation Data .......................................D‐9
Upload EJ Data Message ............................................D‐10
Terminal Command Fields ........................................D‐10
Field Values for Terminal Commands .....................D‐10
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
l
APTRA™ Advance NDC, Reference Manual
List of Tables
Table D‐10
Table D‐11
Table D‐12
Table D‐13
Table D‐14
Table D‐15
Customisation Data Command Fields .....................D‐13
Field Values for Data Commands.............................D‐14
Transaction Reply .......................................................D‐16
Acknowledge EJ Upload Block Command .............D‐21
Acknowledge and Stop EJ Command......................D‐22
EJ Options and Timers Command............................D‐22
Appendix E
Device Identifiers
Table E‐1
Table E‐2
Table E‐3
Table E‐4
Table E‐5
Table E‐6
Table E‐7
Table E‐8
Table E‐9
Table E‐10
Table E‐11
Device Hardware Configuration Data....................... E‐2
Device Supplies Data.................................................. E‐11
Supplies Status of all BNA Cassettes ....................... E‐16
Overall BNA Retract Bin Status Reporting ............. E‐16
Most Severe BNA Supplies Status Reporting ......... E‐17
Least Severe BNA Supplies Status Reporting......... E‐17
BNA Supplies: Extended Message Format.............. E‐18
Device Fitness Data..................................................... E‐19
BNA Fitness: Extended Message Format................. E‐24
Device Tamper Data ................................................... E‐25
TI Bins (Alarms) Sensor Types .................................. E‐29
Appendix F
ASCII/EBCDIC Conversion Table
Table F‐1
ASCII to EBCDIC Code Conversion............................F‐2
Appendix G
Related Documentation
Table G‐1
Table G‐2
Table G‐3
Table G‐4
Table G‐5
Table G‐6
Table G‐7
Advance NDC Documentation ...................................G‐2
Provided APTRA Author Documentation ................G‐3
Other Authoring Environment Documentation.......G‐4
Additional NDC+ Documentation..............................G‐5
Other NCR Documentation .........................................G‐6
CEN‐XFS Documentation ............................................G‐7
ISO Documentation.......................................................G‐7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
li
List of Tables
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lii
APTRA™ Advance NDC, Reference Manual
Preface
Purpose and Audience
Purpose and Audience
The publication provides reference data for standard NDC state
tables, screen, keyboard and printer data, Supervisor messages,
configuration parameters, Financial Institution Tables (FITs),
terminal to Central/ Central to terminal messages, security features
and reserved screens.
Audience
The publication is intended for the following:



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.
Advance NDCAPTRA™ Advance NDC, Reference Manual
liii
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.
Contents of the Publication
The publication contains the following information:
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.
liv
Advance NDCAPTRA™ 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.
Advance NDCAPTRA™ Advance NDC, Reference Manual
lv
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.
Roadmap to the
Publication
If you are a programmer creating the terminal configuration that
customises the Advance NDC software, see chapters 2 to 8 for
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.
lvi
Advance NDCAPTRA™ Advance NDC, Reference Manual
Preface
How to Use This Publication
Navigating the Publication
The publication can be viewed on‐screen or printed with the Adobe
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
Navigation Aids
Conventions and
Abbreviations Used in the
Publication
Element
Description
“Revision
Record”
Lists updates for 4.0x releases in page order with
page references. The most recent revision is listed
first. The page references for the current revision
are hyperlinked; page references for earlier
revisions are not always hyperlinked.
“Table of
Contents”
Lists the first two heading levels in page order with
page references.
Table of Contents
for chapter or
appendix
Lists the first three heading levels in page order
with page references.
“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
Form”
Allows you to comment on the publication by:
— 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
to devices running on the NCR range of SelfServ SSTs.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
Advance NDCAPTRA™ Advance NDC, Reference Manual
lvii
Preface
How to Use This Publication
Abbreviations
The following abbreviations are used throughout the publication:
Table Pref-2
Abbreviations Used in the Publication
Full Form
Abbreviated Form
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
Professional, Microsoft Windows 7
and POSReady7
Windows
For a list of terms and abbreviations used in the publication, see the
Glossary.
Terms for Cash Acceptors
There are different types of cash acceptors as follows:





Devices that allow only single notes to be deposited
Devices that allow bunches of notes to be deposited
Devices that allow bunches of notes and/or cheques to be
deposited
Devices that allow 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:
Term
Refers to...
Cash acceptor
Generic term for any device that accepts note
deposits
See Note 1:
Recycling
unit/Recycler
Generic terms for any device that can accept note
deposits 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:
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
lviii
Advance NDCAPTRA™ Advance NDC, Reference Manual
Preface
How to Use This Publication
Term
Refers to...
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
GBXX
An NCR term used when referring to both the GBNA
and GBRU devices
See Note 3:
Note 1: Some cash acceptors can also accept cheques.
Note 2: Whenever a BNA is mentioned, the information also
applies to the SNA and SDM unless explicitly stated.
Note 3: Occasionally BNA and GBXX are used to refer to all
vendors’ devices, such as in some Supervisor menu options. When a
term is used generically, this is explained in the associated text.
What Else Should I Read?
NCR recommends you first read the APTRA Advance NDC,
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.
Advance NDCAPTRA™ Advance NDC, Reference Manual
lix
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.
lx
Advance NDCAPTRA™ Advance NDC, Reference Manual
Table of Contents
Introducing the Advance NDC System
Chapter 1
Introducing the Advance NDC
System
Overview
1‐1
How the SST Operates
1‐2
Creating the 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
Overview
A
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
How the SST Operates
How the SST Operates
1
When the SST is switched on, after loading it with the Advance
NDC software, a power‐up message is sent to Central. Central
downloads any necessary data to the SST in a series of messages.
After each message is sent, the SST sends an acknowledgement to
Central. When Central has sent all the data successfully, it puts the
SST into service, as shown in Figure 1‐1 “Start‐up Sequence”.
Figure 1-1
Start-up Sequence
Host
SST
Power-up Unsolicited Status Message
Terminal Command to Request Config ID
Solicited Status with Config ID
Extended Encryption Key Change Message
Encryptor Initialisation Data Message
Data Load Message
Ready Solicited Status Message
Continue until required customisation data
has been downloaded to the SST
Data Load Message
Ready Solicited Status Message
Go In Service Command Message
Ready Solicited Status Message
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
How the SST Operates
When a transaction is processed, the following operations are
completed:
1
The SST gathers details from the consumer and card (if a card is
used).
2
The SST sends the information in a Transaction Request
message to Central.
3
Central sends a Transaction Reply command.
4
The SST completes the transaction.
If a fault occurs, the SST sends a message to Central 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 Central 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
Creating the Customisation Data
Creating the Customisation Data
Table 1‐1, “Customisation Data” below, describes the types of
customisation data 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
1
Introducing the Advance NDC System
Role of the Central Control Application
Role of the Central Control
Application
1
Table 1‐2 “Central Control Commands and Messages” below
describes the commands and messages sent by Central.
Table 1-2
Central Control Commands and Messages
Command/Message
Description
Terminal Commands
Instructions sent to the SST.
See “Terminal Commands” on page 10‐3.
Transaction Reply Commands
Responses from Central to a Transaction Request message from the SST,
telling the SST how to complete the transaction.
See “Transaction Reply Command” on page 10‐51.
Customisation Data Commands
Customisation data sent to the SST.
See “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‐86.
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
Invalid State Handling
Customising States
Unsupported State Types
Reserved States
Exit States
Standard State Types
State Numbers
Screen Numbers
Extension States
Table Entry Value 255
Table Entry Value 000
2‐2
2‐2
2‐2
2‐2
2‐3
2‐3
2‐3
2‐4
2‐5
2‐5
2‐5
2‐6
A ‐ Card Read State
Read Condition Values
2‐7
2‐9
B ‐ PIN Entry State
2‐12
C ‐ Envelope Dispenser State
2‐15
D ‐ Pre‐Set Operation Code Buffer State
2‐16
E ‐ Four FDK Selection Function State
2‐19
F ‐ Amount Entry State
Voice‐Guided Sessions and Data Entry
State Processing
Buffer Clearing and AppendBuffer.xml
Touch‐Screen Emulation
2‐21
2‐21
2‐21
2‐21
2‐21
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
G ‐ Amount Check State
2‐24
H ‐ Information Entry State
2‐29
Data Entry
2‐29
Overriding Entry Mode, Buffer and Display Parameters 2‐29
Data Entry and Voice Guidance
2‐29
Exiting the Information Entry State
2‐29
Emulated FDKs and Touch‐screen Keyboards
2‐30
Clear Function Key and General‐Purpose Buffers
2‐30
I ‐ Transaction Request State
2‐33
J ‐ Close State
Function Operations
Receipts, Statements and Envelopes
Cards
Cardless Transactions
Audio
2‐39
2‐39
2‐39
2‐39
2‐40
2‐40
K ‐ FIT Switch State
2‐46
_ ‐ Expanded FIT Switch State
2‐47
L ‐ Card Write State
2‐49
M ‐ Enhanced PIN Entry State
2‐51
N ‐ Camera Control State
2‐54
R ‐ Enhanced Amount Entry State
2‐56
S ‐ Language Code Switch State
2‐59
T ‐ Card Read ‐ PIN Entry Initiation State
2‐62
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
PIN Entry Enabled
PIN Entry Disabled
Audio Support
Smart Dip Card Reader
2‐63
2‐63
2‐63
2‐63
U – Device Fitness Flow Select State
Supported Devices
Cash Handlers
2‐67
2‐69
2‐72
V ‐ Language Select From Card State
2‐73
W ‐ FDK Switch State
2‐75
X ‐ FDK Information Entry State
2‐76
Y ‐ Eight FDK Selection Function State
Language Selection in Voice‐Guided Sessions
2‐79
2‐79
b ‐ Customer‐Selectable PIN State
2‐84
d ... g and z ‐ Exit States
2‐87
k ‐ Smart FIT Check State
2‐88
m ‐ PIN & Language Select State
Considerations for Voice‐Guided Sessions
2‐89
2‐90
> ‐ Cash Accept State
Confirmation Screen
Refundable Deposits
Direct Deposits
Dynamic Text Definitions
Defining Reasons for Note Refusal
2‐96
2‐106
2‐107
2‐107
2‐107
2‐107
w ‐ Cheque Accept State
2‐109
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
z – Master Expansion State
2‐116
z001 – Bunch Cheque Accept State
Defining Dynamic Text for Cheque Rejection
Defining Dynamic Text for Cheque Refusal
2‐117
2‐122
2‐122
z002 – Bunch Cheque Handling State
2‐124
z003 – Cheque Detail Display State
Defining Dynamic Data for Cheque Deposit Status
2‐128
2‐133
z004 – Display Cheque Summary State
Current Cheque Index
2‐134
2‐135
z008 – Insert Card State
2‐140
z009 – Buffer Validation State
Date Validation Scenario
2‐144
2‐145
z010 – Local Cash Dispense State
Cardless Transactions
Dispense Functionality
Foreign Currency Exchange Transactions
State Flow after a Successful Dispense
Successful Dispense Examples
State Flow after a Short Dispense
State Flow after a Failed Dispense
State Flow after an Unknown Dispense
State Flow on Card Ejection
State Operation
CDI Stores
Journaling and Printing
Status Updates and Counts
Message Handling
Unsolicited Status Messages
Counts
2‐147
2‐147
2‐147
2‐147
2‐147
2‐148
2‐148
2‐148
2‐149
2‐149
2‐149
2‐149
2‐150
2‐150
2‐151
2‐151
2‐151
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
z013 – Data Copy and Compare State
Copy Operations
Compare Operations
2‐154
2‐156
2‐157
z014 – Cash Deposit Handling State
Journaling
Data Printing
2‐158
2‐158
2‐158
z017‐ Note Mix Selection State
2‐161
& ‐ Barcode Read State
2‐168
Time‐Out State
2‐173
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
State Tables
Overview
B
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
A state table is made up of the state number, state type and 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”.
Invalid State Handling
2
If the next state specified is invalid or undefined, due to either the
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.
Customising States
2
You customise a state by assigning values to its parameters. To
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.
Unsupported State Types
The following states are not supported in Advance NDC:
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
2
State Tables
Introduction to State Tables
The following states are reserved:
Reserved States
2
‘c’ – Device Test state
‘z010’ to ‘z899’ (Master expansion state ‘z’ with sub‐state range)


Exit States
2
Standard State Types
Table 2-1
State Table Types
2
As well as states ‘d’ to ‘g’, sub‐states ‘z900’ to ‘z999’ are reserved for
Exit states.
The following table lists each of the supported standard state types
that control transaction processing:
State Table Type
Description
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
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
V
Language Select From Card
W
FDK Switch
X
FDK Information Entry
Y
Eight FDK Selection Function
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
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
&
Barcode Reader 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
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
z900 to z999
Available as identifiers for Exit States
Note 1: 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.
State Numbers
2
Alphanumeric (base 36) numbers in state table entries are supported
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
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
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.
Screen Numbers
2
Up to 999 screens can be specified in state table entries for screens
using the range 000 to 999. Using an upper‐case alphanumeric
character in the range A to Z instead of the first digit extends
support to more than 999 screens, including multi‐language screens,
without changing the table entry length.
Screen numbers are in the range ‘000’ to ‘Z99’.
The alphanumeric 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 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 more 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.
Extension States
2
Many state types allow the use of extension states (state type ‘Z’).
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.
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
Table Entry Value 000
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
2
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
Buffers Initialised for State A
Buffer
Initialised to...
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.
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
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
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


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.
Note: If the chip connect bit is to be set for use with the
ʹEMV/CAM2 Exits for Advance NDCʹ product, NCR recommends
this is set in the final read condition used, 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.
If the magnetic read conditions all fail and the chip connect bit is set,
no FIT match is attempted and the application proceeds to the No
FIT Match Next State.
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
Table 2-3
A - Card Read State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘A’
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to enter
the card. While the SST is waiting for card entry,
this screen is displayed.
3
3
Good Read Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes:
1. Following a good read of the card if FITs are not
used (Table entry 9 = 000)
or
2. If the Financial Institution number on the card
matches a Financial Institution number in a FIT.
4
3
Error (Misread) Screen Number
(Range 000‐Z99)
If the read conditions are not satisfied due to a bad
card or a mechanism error, the card is ejected and
this screen is displayed.
5
3
Read Condition 1
6
3
Read Condition 2
7
3
Read Condition 3
These three entries specify which card track(s)
and/or chip data will be read. The possible values
for these entries are shown in Table 2‐4 in the next
section.
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 command message.
9
3
No FIT Match Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if either the
Financial Institution number on the card does not
match any FIT, or if the card reader is a smart card
reader and the read condition being evaluated has
the chip connect bit set (bit 3).
If FITs are not used, this entry must be 000.
Read Condition Values
Table 2-4
Read Condition Bit Information
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”.
Bit Number
Binary
Decimal
Meaning
0
0001
001
Read Track 3
1
0010
002
Read Track 2
1 and 0
0011
003
Read Track 2 and 3
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
Bit Number
Binary
Decimal
Meaning
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.
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‐11. For read condition operations
where the chip connect bit is set in one or more read conditions, see
Chapter 12, “EMV Smart Card Handling”.
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
Figure 2-1
Read Condition Flow
Evaluate Read
Condition 1
Y
Satisfied?
N
Evaluate Read
Condition 2
Y
Good Read Next State Number
(table entry 3)
Satisfied?
N
Evaluate Read
Condition 3
Y
Satisfied?
N
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-11
State Tables
B - PIN Entry State
B ‐ PIN Entry State
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-5
B - Pin Entry State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘B’
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to enter
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
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
does not enter the PIN within the permitted time
limit. Enter 255 if the time‐out function is not
required.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-12
APTRA™ Advance NDC, Reference Manual
2
State Tables
B - PIN Entry State
Table
Entry
Number of
Characters
4
Contents
Description
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
presses the Cancel key before the maximum number
of digits specified for the PIN have been entered.
5
3
Local PIN Check Good PIN
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
See Table Note 2.
State number to which the SST goes after
verification of a correct PIN entry. A Pre‐Set
Operation Code Buffer state (clearing the function
key buffer before Transaction Selection) usually
follows a correct PIN entry.
6
3
Local PIN Check Maximum Bad
PINs Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
See Table Note 1, Table Note 2.
State number to which the SST goes if the correct
PIN has not been entered after the number of
attempts allowed by table entry 9. The SST
normally enters a Close state if this occurs.
7
3
Local PIN Check Error Screen
Number
(Range 000‐Z99)
See Table Note 1, Table Note 2.
Display screen that prompts the consumer to
re‐enter the PIN. This screen is displayed after each
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.
8
3
Remote PIN Check Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes when local PIN
verification is not performed.
9
3
Local PIN Check Maximum PIN
retries
(Range 001‐009)
See Table Note 1, Table Note 2.
Maximum number of incorrect PIN entries allowed
before the SST enters the state determined by table
entry 6.
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-13
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-14
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-6
C - Envelope Dispenser State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘C’
2
3
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST enters immediately or
after an envelope is presented.
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-15
State Tables
D - Pre-Set Operation Code Buffer State
D ‐ Pre‐Set Operation Code Buffer
State
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-7
D - Pre-set Operation Code Buffer State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘D’
2
3
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes after
pre‐setting the Operation Code buffer.
3
3
Clear Mask
(Range 000‐255)
Specifies bytes of Operation Code buffer to be
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
(Range 000‐255)
The buffer contains eight bytes. This entry sets the
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
(Range 000‐255)
The buffer contains eight bytes. This entry sets the
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
(Range 000‐255)
The buffer contains eight bytes. This entry sets the
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-16
APTRA™ Advance NDC, Reference Manual
2
State Tables
D - Pre-Set Operation Code Buffer State
Table
Entry
Number of
Characters
7
Contents
Description
3
‘D’ Pre‐Set Mask
(Range 000‐255)
The buffer contains eight bytes. This entry sets the
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
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number of the Extension state containing
information on how the other operation codes are
pre‐set.
For more information about extension states, see
“Extension States” on page 2‐5.
Table 2-8
Extension to State D
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
‘F’ Pre‐Set Mask
(Range 000‐255)
The buffer contains eight bytes. This entry sets the
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
(Range 000‐255)
The buffer contains eight bytes. This entry sets the
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
(Range 000‐255)
The buffer contains eight bytes. This entry sets the
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
(Range 000‐255)
The buffer contains eight bytes. This entry sets the
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-17
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-18
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‐9, “E ‐ Four FDK Selection Function State” on page 2‐20,
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-19
State Tables
E - Four FDK Selection Function State
Table 2-9
E - Four FDK Selection Function State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘E’
2
3
Screen Number
(Range 000‐Z99)
Display screen that requests the consumer to
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” section in
Chapter 3, “Screen Data”.
3
3
Time‐Out Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
does not respond to the screen message within the
permitted time limit. Enter 255 if the time‐out
function is not required.
4
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Cancel
key is pressed.
5
3
FDK ‘A’ (or ‘I’)
Next State Number
6
3
FDK ‘B’ (or ‘H’)
Next State Number
State number to which the SST goes if the specified
FDK or touch area is pressed.
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or 256‐ZZZ)
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
(Range 000‐007)
Defines the Operation Code buffer byte in which
the keycode for the selected FDK is stored.
Entry Value
Position in Buffer
‘000’
‘001’
‘002’
‘003’
‘004’
‘005’
‘006’
‘007’
1st byte
2nd byte
.
.
.
.
.
8th byte
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-20
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
standard field length for this buffer is eight digits, or twelve if
Enhanced Configuration Parameter option 1 is used; but the buffer
length can also be configured for any number of characters up to a
maximum of twelve, through a parameter in AppendBuffer.xml.
Note: If you require multi‐lingual support for amount entry, see “R
‐ Enhanced Amount Entry State” on page 2‐56. If you want to allow
the consumer to select the note mix to be dispensed, see “z017‐ Note
Mix Selection State” on page 2‐161.
Voice‐Guided Sessions and
Data Entry
State Processing
2
2
For details of the issues to be considered when a a consumer selects
a voice‐guided session, see “Data Entry and Voice Guidance” on
page 2‐29.
The SST exits from the Amount Entry state once the consumer
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, it has the same effect as
pressing FDK ‘A’ (or FDK ‘I’ if Message Mode option digit 7a is set).
For more information, see “E ‐ Four FDK Selection Function State”
on page 2‐19.
If the consumer presses the Clear key, which is always active, the
amount buffer and the screen echo field are cleared one character at
a time. This allows the consumer to re‐enter the correct amount.
Buffer Clearing and
AppendBuffer.xml
2
Once the configured number of characters is reached, the next key
clears the buffer, resetting the value to 0 and restarting the entry
from the beginning. A parameter in AppendBuffer.xml can be
conLfigured 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‐48 or installed locally. For
details of AppendBuffer.xml, refer to the APTRA Advance NDC,
Developer’s Guide.
Touch‐Screen Emulation
2
If the SST supports touch‐screen FDK emulation instead of physical
FDKs, eight fixed touch areas are defined on the screen, which the
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-21
State Tables
F - Amount Entry State
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”.
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-10
F - Amount Entry State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘F’
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to enter
an amount. This screen is displayed when the SST
enters the Amount Entry state.
3
3
Time‐Out Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the amount
entry is not made within the permitted time limit.
Enter 255 if the time‐out function is not required.
4
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Cancel
key is pressed.
5
3
FDK ‘A’ (or ‘I’)
Next State Number
6
3
FDK ‘B’ (or ‘H’)
Next State Number
7
3
FDK ‘C’ (or ‘G’)
Next State Number
8
3
FDK ‘D’ (or ‘F’)
Next State Number
State number to which the SST goes if the consumer
presses an FDK or touch area. Normally one FDK
or touch area is designated for correct amount
entries and another for incorrect amount entries.
The remaining two FDKs or touch areas are
inactive.
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or 256‐ZZZ)
Enter 255 to deactivate an FDK or touch area.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-22
APTRA™ Advance NDC, Reference Manual
State Tables
F - Amount Entry State
Table
Entry
Number of
Characters
9
3
Contents
Description
Amount Display Screen
Number
(Range 000‐Z99)
Overlay screen for setting the consumer screen
cursor position. 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.
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.
APTRA™ Advance NDC, Reference Manual
2-23
State Tables
G - Amount Check State
G ‐ Amount Check State
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‐26 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‐45). 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.
2-24
APTRA™ Advance NDC, Reference Manual
2
State Tables
G - Amount Check State
Table 2-11
G - Amount Check State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘G’
2
3
Amount Check Condition True
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes when the
amount check condition indicated by table entry 8
evaluates to TRUE.
3
3
Amount Check Condition False
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes when the
amount check condition indicated by table entry 8
evaluates to FALSE.
4
3
Buffer to be checked
(Range 000 ‐ 002)
This field specifies which buffer is to be checked:
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
(Range 000 ‐ 999)
Integer multiple value used in checking specified
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
(Range 000 ‐ 004)
Number of decimal places used in specified buffer.
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.
APTRA™ Advance NDC, Reference Manual
2-25
State Tables
G - Amount Check State
Table
Entry
Number of
Characters
7
Contents
Description
3
Currency Type
(Range 001 ‐ 255)
Currency type of amount in specified buffer.
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
(Range 000 ‐ 003)
Amount check condition required.
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-12
Amount Check Error State
Error Message
Cause(s)
Amount Check State FAILED ‐ Non‐whole
amount entered
1) A non‐whole amount has been 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
entered = 0
Amount entered is 0
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-26
APTRA™ Advance NDC, Reference Manual
State Tables
G - Amount Check State
Error Message
Cause(s)
Amount Check State FAILED ‐ Buffer B
contains more than 12 digits
The length of buffer B is more than 12 digits in length
Amount Check State FAILED ‐ Buffer C
contains more than 12 digits
The length of buffer C is more than 12 digits in length
Amount Check State FAILED ‐ X is not a
whole number multiple of Y
X is not a whole number multiple of Y, where X is the amount
entered, and Y is the Integer Multiple Value specified in table
entry 5
Amount Check State FAILED ‐ Currency
Type ‘X’ not found in Dispenser Currency
Cassette Mapping Table ‐ Proceeding to
Default Close State
The Currency Type X was not found in the Dispenser Currency
Cassette Mapping Table, where X is the Currency Type specified
in table entry 7. Possible causes are:
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
requested cannot be satisfied from physical
cassette types present
A Note Mix for the amount requested cannot be created because:
1) More than 50 notes are required
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
entries found in the Dispenser Currency
Cassette Mapping Table
There are no Cassette Types specified in the Dispenser Currency
Cassette Mapping Table which are in the currently supported
range of 1 ‐ 4
Amount Check State FAILED ‐ Cash
Handler device error
The Cash Handler has a status of FATAL or SUSPEND
You may also see the following errors, associated with the
Dispenser Currency Cassette Mapping Table:
Table 2-13
Amount Check Error State — DCCMT
Error Message
Cause(s)
ERROR ‐ Invalid length error found in Dispenser
Currency Cassette Mapping Table
The specific command reject received by Central
indicates a message length error
ERROR ‐ Invalid Value ‘< field h1 value >’ found in
field h1 of Dispenser Currency Cassette Mapping
Table
The value of sub‐field h1 must be a two digit ASCII hex
value in the range ‘01’ to ‘FF’ inclusive. If it is not, the
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.
APTRA™ Advance NDC, Reference Manual
2-27
State Tables
G - Amount Check State
Error Message
Cause(s)
ERROR ‐ Invalid Value ‘< field h2 value >’ found in
field h2 (at position <value>) of Dispenser
Currency Cassette Mapping Table
The value of sub‐field h2 must be a two digit ASCII hex
value in the range ‘01’ to ‘FF’ inclusive. If it 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.
ERROR ‐ Invalid Value ‘< field h3 value >’ found in
field h3 (at position <value>) of Dispenser
Currency Cassette Mapping Table
The value of sub‐field h3 must be a single digit ASCII hex
value in the range ‘0’ to ‘F’ inclusive. If it 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.
ERROR ‐ Invalid Value ‘<field h4 value>’ found in
field h4 (at position <value>) of Dispenser
Currency Cassette Mapping Table
The value of sub‐field h4 must be a five digit ASCII
numeric value in the range ʹ00000ʹ to ʹ99999ʹ inclusive. If it
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.
2-28
APTRA™ Advance NDC, Reference Manual
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:




Data Entry
2
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
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:



Exiting the Information
Entry State
2
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
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. If
the consumer presses the Enter key, it has the same effect as
pressing FDK ‘A’ (or FDK ‘I’ if option digit 7a is set). For details, see
“E ‐ Four FDK Selection Function State” on page 2‐19.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-29
State Tables
H - Information Entry State
Emulated FDKs and Touch‐screen Keyboards
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.
Clear Function Key and
General‐Purpose Buffers
2
The Clear function key is always active. If the consumer presses the
key, the general‐purpose buffer and the echo field displayed on the
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.
2-30
APTRA™ Advance NDC, Reference Manual
2
State Tables
H - Information Entry State
Table 2-14
H - Information Entry State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘H’
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to enter
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
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
does not respond to the consumer screen message
within the permitted time limit. Enter 255 if the
time‐out function is not required. See Table Note 6.
4
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Cancel key is
pressed.
5
3
FDK ‘A’ (or ‘I’)
Next State Number
6
3
FDK ‘B’ (or ‘H’)
Next State Number
7
3
FDK ‘C’ (or ‘G’)
Next State Number
State number to which the SST goes if the consumer
presses an FDK or touch area. Enter 255 to make an
FDK or touch area inactive while the SST is in the
Information Entry state.
(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
Entry Mode, Buffer and
Display Parameters
(Format NND,
Range NN = 00 and 01 ‐ 32,
Range D = 0 ‐ 3)
Entry Mode:
NN = 00 ‐ Numeric key entry, maximum input size 32.
NN = 01 ‐ 32: SMS‐style, PC‐keyboard and
touch‐screen keyboard alphanumeric entry. Maximum
input size is NN. See Table Note 7.
Buffer:
Defines which buffer to use for storage ‐
general‐purpose buffer B or 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.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-31
State Tables
H - Information Entry State
Table
Entry
Number of
Characters
Contents
Description
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‐48. 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.
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-32
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-15
I - Transaction Request State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘I’
2
3
Screen Number
(Range 000‐Z99)
Display screen shown on the consumer screen
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
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if Central fails
to reply to the Transaction Request within the
permitted time interval (timer 03).
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-33
State Tables
I - Transaction Request State
Table
Entry
Number of
Characters
Contents
Description
7
3
Send Amount Data
See Table Note 11.
8
3
Send PIN Buffer (Buffer A) Data/
Select Extended format
See Table Note 11 and Table Note 13.
9
3
Send General Purpose Buffer B
and/or General Purpose Buffer C
or
Extension State Number
(Base 10 range 000‐003 or
000‐254, 256‐999)
(Base 36 range 000‐003 or
000‐254, 256‐ZZZ)
To send the general purpose buffer, the following
values apply:
000 ‐ Send no buffers
001 ‐ Send Buffer B.
002 ‐ Send Buffer C
003 ‐ Send Buffers B and C
004‐007 ‐ Reserved
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‐5.
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-16
Track 2 Data Send Modifier
Value
Send Data
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-17
Track 1/3 Data Send Modifier
Value
Track 1 Data
Track 3 Data
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-34
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-18
Table Entry 8 for Buffer A
Value
Description
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-19
Extension 1 to State I
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Send General Purpose Buffers B
and/or C
To send the general purpose buffers, these values
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
‘A’ ‐ ‘H’
(Range 000‐255)
This entry is bit‐encoded to control the sending of
individual optional data fields in the Transaction
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
Field ID
1
2
3
4
5
6
7
8
‘A’ (Reserved)
‘B’ (Reserved)
‘C’
‘D’
‘E’
‘F’
‘G’
‘H’
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-35
State Tables
I - Transaction Request State
Table
Entry
Number of
Characters
4
3
5
6
3
3
Contents
Description
Send Optional Data Fields
‘I’ ‐ ‘L’
(Range 000‐015)
This entry is as for table entry 3 but the data fields
are as follows:
Send Optional Data Fields ‘Q’ to
V, ‘w’ and ‘a’
(Range 000‐255)
Send Optional Data.
(Range 000‐255)
Bit
Field ID
1
2
3
4
5
6
7
8
‘I’
‘J’
‘K’
‘L’
Reserved for ‘M’
Reserved for ‘N’
Reserved for ‘O’
Reserved for ‘P’
This entry is as for table entry 3 but the data fields
are as follows:
Bit
Field ID
1
2
3
4
5
6
7
8
‘Q’
‘R’
‘S’
Reserved for ‘T’
‘U’
‘V’
‘w’ (Cash Deposit Data)
‘a’ (Cheque processor ‐ MICR/codeline)
See Table Note 14 and Table Note 15
This entry is as for table entry 3 but the data fields
are as follows:
Bit
Field ID
1
2
‘User Data Fields’
‘b’ (Count of good notes and suspect notes
in escrow or directly deposited to cassette)
‘c’ (Note type counts for suspect notes)
‘d’ (Note type counts for counterfeit notes)
‘e’ (Barcode data)
‘g’ (Bunch cheque deposit data)
See Table Note 14
Reserved
Reserved
3
4
5
6
7
8
7
3
Must be 000
Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-36
APTRA™ Advance NDC, Reference Manual
State Tables
I - Transaction Request State
Table
Entry
Number of
Characters
8
3
9
3
Contents
Description
EMV/CAM2 Processing Flag
(Range 000‐003)
This entry is bit‐encoded to control the level of
EMV/CAM2 processing to be performed, as
follows:
Extension State Number
(Base 10 range 000‐254, 256‐999)
(Base 36 range 000‐254,
256‐ZZZ)
Bit
Field ID
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
3
4
5
6
7
8
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
State number of Extension state 2.
A value of 000 disables this extension.
If a value of 255 is used for this entry, the
application goes to the default Close state.
For more information about extension states, see
“Extension States” on page 2‐5.
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-37
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 2-20
Extension 2 to State I
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Offline Decline Next State
Number
Base 10 range 000‐254, 256‐999)
(Base 36 range 000‐254,
256‐ZZZ)
State number the SST goes to if, during a
chip‐based transaction, the chip or SST chooses not
to go online but requests that the transaction is
declined offline.
3‐9
21
Must be 000
Reserved
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-38
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.
Function Operations
2
Processing of the Close state depends on the functional operations
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‐21, “J ‐ Close State” on
page 2‐40, 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 (described on
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-39
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 is 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-21
J - Close State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘J’
2
3
Receipt Delivered Screen
Number
(Range 000‐Z99)
Screen displayed on entry to the Close state. This is
only displayed if a receipt is delivered in the 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 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-40
APTRA™ Advance NDC, Reference Manual
State Tables
J - Close State
Table
Entry
Number of
Characters
3
4
Contents
Description
3
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes after the state
is completed.
3
No Receipt Delivered Screen
Number
(Range 000‐Z99)
Screen displayed on entry to the Close state. This is
only displayed if no receipt is delivered in the
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
(Range 000‐Z99)
Screen displayed on entry to the Close state,
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
Number
(Range 000‐Z99)
Display screen to be overlaid when either the
receipt is delivered (entry 2) or there is no receipt
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
Number
(Range 000‐Z99)
Screen displayed on entry to the Close state,
informing the consumer that the Bunch Note
Acceptor (BNA) notes are being returned.
9
3
Extension State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
The state number of the optional extension state 1.
For more information about extension states, see
“Extension States” on page 2‐5.
See Table Note 17.
Table Note 17: 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.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-41
State Tables
J - Close State
For details of ‘Card Before Cash’, ‘Fast Cash’ and ‘Process
Document With Cash’ transactions, see the “Terminal Functions for
Transaction Completion” section in Chapter 10, “Central to
Terminal Messages”.
Table 2-22
Extension State 1 to State J
Table
Entry
Number Of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Cheque Processor Take
Document Screen Number
(Range 000‐Z99)
Screen number required for the error recovery
actions which may take place in this state if the
cheque processor is present and the Cheque
Processor Document Return/Retain Flag is set to
either 001 or 002.
3
3
Cheque Processor Document
Return/Retain Flag
(Range 000‐002)
This flag controls the error recovery actions which
may take place in this state if the cheque processor
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 18.
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‐5.
See Table Note 19.
6‐7
6
Must be 000
Reserved
8
3
BNA Notes Return/Retain/
Leave Flag
(Range 000‐002)
This flag controls the error recovery actions which
may take place in this state if a BNA is present.
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 20, Table Note 21 and Table Note 22.
9
3
Musts be 000
Reserved.
Table Note 18: On entry to the Close state, the application
determines whether a cheque processor is configured, and if so,
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-42
APTRA™ Advance NDC, Reference Manual
State Tables
J - Close State
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
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 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-43
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 19: 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 20: 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 21: 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-44
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 22: If AER is enabled and notes are left in the escrow in
the Close state, the notes will be processed as part of AER. To make
sure notes are 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-23
Extension State 2 (J - Close State)
Table
Entry
Number Of
Characters
Contents
Description
1
1
State Type
‘Z’ ‐ Extension type
2
3
Cheque Processor Wait for
Cheques Screen Number (range
000‐Z99)
This screen is used to ask the customer to wait for
additional cheques to be returned when more than
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 Number (range 000‐Z99)
Screen displayed if media presented within this
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-45
State Tables
K - FIT Switch State
K ‐ FIT Switch State
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-24
K - FIT Switch State
Table
Entry
Index
1
Number
of Chars
Contents
Description
1
State Type
‘K’
State to which the SST goes depending on the next
state index stored in the FIT.
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or 256‐ZZZ)
2
0
3
Next State Number
3
1
3
Next State Number
4
2
3
Next State Number
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-46
APTRA™ Advance NDC, Reference Manual
2
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-25
_ - Expanded FIT Switch State
Table
Entry
Index
1
Number
of Chars
Contents
Description
1
State Type
‘_’
State to which the SST goes depending on the next
state index stored in the FIT.
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or 256‐ZZZ)
2
0
3
Next State Number
3
1
3
Next State Number
4
2
3
Next State Number
5
3
3
Next State Number
6
4
3
Next State Number
7
5
3
Next State Number
8
6
3
Next State Number
3
Extension State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
9
State number of the mandatory Extension state.
For more information about extension states, see
“Extension States” on page 2‐5.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-47
State Tables
_ - Expanded FIT Switch State
Table 2-26
Extension to State _
Table
Entry
Index
1
Number
of Chars
Contents
Description
1
State Type
‘Z’
State to which the SST goes depending on the next
state index stored in the FIT.
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or 256‐ZZZ)
2
7
3
Next State Number
3
8
3
Next State Number
4
9
3
Next State Number
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-48
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 SST’s track data buffer.
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 while writing takes
place.
Writing only takes place if the Track data buffers contain data
obtained from a successful Track 3 read during a Card Read state, or
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 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 will be 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. 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 must 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-49
State Tables
L - Card Write State
Table 2-27
L - Card Write State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘L’
2
3
Screen Number
(Range 000‐Z99)
Screen displayed during a Card Write operation.
3
3
Good Write Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes after a
satisfactory Track write operation.
4
3
Bad Write Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Track
write is unsuccessful.
5
3
No Write Attempted Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if no data or
invalid data is present in the Track buffer. This
state is also used if a start and/or end sentinel is
missing, or the Track data buffers are too long.
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-50
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-51
State Tables
M - Enhanced PIN Entry State
Table 2-28
M - Enhanced PIN Entry State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘M’
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to enter
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
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
does not enter the PIN within the permitted time
limit. Enter state number 255 if the time‐out
function is not required.
4
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
presses the Cancel key before the maximum
number of digits specified for the PIN have been
entered.
5
3
Local PIN Check Good PIN
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes after
verification of a correct PIN entry. A Pre‐Set
Operation Code buffer state (clearing the function
key buffer before Transaction Selection) usually
follows a correct PIN entry. See Table Note 25.
6
3
Local PIN Check Maximum Bad
PINs Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the correct
PIN has not been entered after the number of
attempts allowed by table entry 9. This could be a
Card Write state in order to update the Track 3 PIN
retry field.
See Table Note 23, Table Note 24, and Table Note
25.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-52
APTRA™ Advance NDC, Reference Manual
State Tables
M - Enhanced PIN Entry State
Table
Entry
Number of
Characters
7
Contents
Description
3
Local PIN Check Error Screen
Number
(Range 000‐Z99)
Display screen that prompts the consumer to
re‐enter the PIN. This screen is displayed after each
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 23 and Table Note 25.
8
3
Remote PIN Check Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes when local PIN
verification is not performed.
9
3
Local PIN Check Maximum PIN
Check Retries
(Range 001‐009)
Maximum number of incorrect PIN entries before
the SST enters the state determined by table entry 6.
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 23 and Table Note 25.
Table Note 23: 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 24: 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 25: 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-53
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 the APTRA Advance NDC,
Developer’s Guide.
The default location 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-29
Security Camera Image Filename Format
Filename Variable
Description
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
On an SST without a camera, this state does not perform any action
and the application flow goes to the next state.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-54
APTRA™ Advance NDC, Reference Manual
State Tables
N - Camera Control 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-30
N - Camera Control State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘N’
2
3
Picture Type
(Range 000‐001)
Specifies the SST‐supplied data to superimpose on
the image
000 ‐ picture type 0
001 ‐ picture type 1
See Table Note 26 and Table Note 27
3
3
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes after taking the
picture
4‐9
18
Must be 000 for each table entry
Reserved
Table Note 26: In Advance NDC, there is no difference in the two
picture types.
Table Note 27 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-55
State Tables
R - Enhanced Amount Entry State
R ‐ Enhanced Amount Entry State
Use this state if you wish to use multi‐language screens for
enhanced amount entry. The standard field length for this 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.
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‐161.
This state reads the amount entered by the consumer, displays it on
the consumer screen, and saves it in the buffers specified by the
state table. Exit from the Enhanced Amount Entry state occurs when
an active FDK is pressed, the Cancel key is pressed or a time‐out
occurs. The Enter key is equivalent to FDK ‘A’ (or FDK ‘I’, if the
option which enables the keys to the left of the screen is set). The
Clear key is always active and clears the amount entered and the
screen echo filled to allow data entry retries within the Amount
Entry state.
Once the configured number of digits is reached, the next key clears
the buffer, resetting the value to 0 and restarting the entry form the
beginning. 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‐48, 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-56
APTRA™ Advance NDC, Reference Manual
2
State Tables
R - Enhanced Amount Entry State
Table 2-31
R - Enhanced Amount Entry State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘R’
2
3
Screen Number
(Range 000‐Z99)
Number of display screen prompting an amount
entry.
3
3
Time‐Out Next State Number
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the application goes if the
consumer fails to enter the amount within the
specified time limit. Enter 255 if the time‐out
function is not required.
4
3
Cancel Next State Number
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the application goes if the
consumer presses the Cancel key.
5
3
FDK ‘A’ (or ‘I’)
Next State Number
6
3
FDK ‘B’ (or ‘H’)
Next State Number
7
3
FDK ‘C’ (or ‘G’)
Next State Number
State number to which the SST goes if the consumer
presses the specified FDK. Normally one FDK is
used to specify whether the amount entry is correct
and another to specify incorrect. The other keys are
inactive. Enter 255 to deactivate any FDK or touch
area.
(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
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number of the Extension state.
For more information about extension states, see
“Extension States” on page 2‐5.
Table 2-32
Extension to State R
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Document Amount Buffer
(Range 000‐002)
This field determines which buffer the amount
entered will be stored in:
000 ‐ Amount buffer
001 ‐ Buffer B.
002 ‐ Buffer C
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-57
State Tables
R - Enhanced Amount Entry State
Table
Entry
Number of
Characters
3
3
Contents
Description
Amount Display Screen
Number
(Range 000‐Z99)
See Table Note 28.
Overlay screen for setting the cursor position on
the consumer screen. 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‐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
(Range 000‐001)
Not used by Advance NDC.
5
3
Language Dependent Screen
Flag
(Range 000‐001)
This flag determines if the screen defined in table
entry 3 of this extension state is language
dependent:
000 ‐ Not language dependent
001 ‐ Language dependent, regardless of language
group size.
6‐9
12
Must be 000
Reserved
Table Note 28: 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-58
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-33
S - Language Code Switch State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘S’
2
3
No Language Code Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is illegal or cannot be read.
3
3
Language Code = 0 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 0.
4
3
Language Code = 1 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 1.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-59
State Tables
S - Language Code Switch State
Table
Entry
Number of
Characters
5
Contents
Description
3
Language Code = 2 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 2.
6
3
Language Code = 3 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 3.
7
3
Language Code = 4 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 4.
8
3
Language Code = 5 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 5.
9
3
Extension state number
(Range 000‐999 or 000‐ZZZ)
State number of the Extension state containing the
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‐5.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-60
APTRA™ Advance NDC, Reference Manual
State Tables
S - Language Code Switch State
Table 2-34
Extension to State S
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Language Code = 6 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 6.
3
3
Language Code = 7 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 7.
4
3
Language Code = 8 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 8.
5
3
Language Code = 9 Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the language
code is 9.
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-61
State Tables
T - Card Read - PIN Entry Initiation State
T ‐ Card Read ‐ PIN Entry Initiation
State
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-62
APTRA™ Advance NDC, Reference Manual
2
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, processing continues to
the next state.
PIN Entry Enabled
2
If PIN entry initiation is enabled, the next state must be a PIN Entry
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.
PIN Entry Disabled
Audio Support
2
2
Smart Dip Card Reader
2
If PIN entry initiation is disabled, there are no restrictions on the
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,
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
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.
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.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-63
State Tables
T - Card Read - PIN Entry Initiation State
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.
For more information about smart card handling in Advance NDC,
see Chapter 12, “EMV Smart Card Handling”.
Table 2-35
T - Card Read - PIN Entry Initiation State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘T’
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to enter
a card. While the SST is waiting for a card entry,
this screen will be displayed.
3
3
Good Read Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes:
1. Following a good read of the card if FITs are not
used (Table Entry 3 in Extension state = 000)
or
2. If the Financial Institution number on the card
matches a Financial Institution number in a FIT.
4
3
Error (Misread) Screen Number
(Range 000‐Z99)
Screen that is displayed if an unsuccessful read
occurs; or for a smart dip card, the consumer fails
to take the card before timer 72 expires.
5
3
Read Condition 1
6
3
Read Condition 2
7
3
Read Condition 3
These three entries specify which card track(s) and
/ or chip data will be read. The possible values for
these entries are the same as for the ‘A’ Card Read
state in Table 2‐4 on page 2‐9.
8
3
Reserved
This field is not used. The early card eject feature is
not supported by this state.
9
3
Extension State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number of the Extension state containing
information for parallel PIN entry.
For more information about extension states, see
“Extension States” on page 2‐5.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-64
APTRA™ Advance NDC, Reference Manual
State Tables
T - Card Read - PIN Entry Initiation State
Table 2-36
Extension to State T
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to enter a PIN.
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
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the financial institution
number on the card does not match any FIT. If FITs are not
used, this entry must be 000. The No FIT match exit is also
taken if the SST has a smart dip reader, one of the chip
connect bits is set, and the ATR succeeds.
4
3
Clear Key Mask
(Range 000‐255)
A binary‐encoded value specifying the FDKs or touch areas
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 29.
5
3
Accept Key Mask
(Range 000‐255)
A binary encoded value which specifies the FDKs or touch
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 29.
6
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to remove the card
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.
7
3
Reserved
Must be 000
8
3
Reserved
Must be 000
9
3
Reserved
Must be 000
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-65
State Tables
T - Card Read - PIN Entry Initiation State
Table Note 29: 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-66
APTRA™ Advance NDC, Reference Manual
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‐69.
Table 2-37
U – Device Fitness Flow Select State
Table
Entry
Number of
Characters
Contents
Description
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‐69
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 30, Table Note 31 and Table Note 32
3
3
Device Available Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the device
and optional sub‐component are in a good
condition
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-67
State Tables
U – Device Fitness Flow Select State
Table
Entry
Number of
Characters
Contents
Description
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‐69
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 30, Table Note 31 and Table Note 32
5
3
Device Unavailable Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the device is
in a fatal or suspend condition or is not present
See Table Note 32
6
3
Device Sub‐Component
Identifier
Index of the sub‐component as reported within the
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 31 and Table Note 32
7
3
000
Reserved
8
3
000
Reserved
9
3
000
Reserved
Table Note 30: 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.
2-68
APTRA™ Advance NDC, Reference Manual
State Tables
U – Device Fitness Flow Select State
Table Note 31: 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 32: 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.
Supported Devices
2
The following table lists the supported devices and the associated
Device Number and DIG for use in the Device Fitness Flow Select
state:
Table 2-38
State ‘U’ - Supported Devices
Device
Device Number
(table entry 2)
Decimal Value of DIG (table entry 4) and Subcomponent Index (table entry 6)
Card Reader/Writer
003
068 = D
Cash Handler
See Table Note 33
004
069 = E
Envelope Depository
005
070 = F
Receipt Printer
006
071 = G
Journal Printer
See Table Note 34
007
072 = H
Night Safe
010
075 = K
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-69
State Tables
U – Device Fitness Flow Select State
Device
Cassette Type 1
See Table Note 35
Device Number
(table entry 2)
015
Decimal Value of DIG (table entry 4) and Subcomponent Index (table entry 6)
Depending on device configuration, as follows:
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
See Table Note 35
016
Depending on device configuration, as follows:

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
See Table Note 35
017
Depending on device configuration, as follows:
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
See Table Note 35
018
Depending on device configuration, as follows:
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
See Table Note 35
095
Depending on device configuration, as follows:
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.
2-70
APTRA™ Advance NDC, Reference Manual
State Tables
U – Device Fitness Flow Select State
Device Number
(table entry 2)
Device
Cassette Type 6
See Table Note 35
096
Decimal Value of DIG (table entry 4) and Subcomponent Index (table entry 6)
Depending on device configuration, as follows:
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
See Table Note 35
097
Depending on device configuration, as follows:

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 33: 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 34: 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.
APTRA™ Advance NDC, Reference Manual
2-71
State Tables
U – Device Fitness Flow Select State
Table Note 35: This is available only when Enhanced
Configuration option 76 is set to 001
Cash Handlers
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-39
Cash Handler Fitness Examples
Table Entry 2
(Device Number)
Table Entry 4
(DIG)
Table Entry 6
(Sub-Component
Identifier)
000
069
000
000
017
017
000
069
000
100
100
001
000
004
003
Description
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
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
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
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
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.
2-72
APTRA™ Advance NDC, Reference Manual
2
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-40
V - Language Select from Card State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘V’
2
3
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes after selecting
the screen group.
3
3
Language Code
(Range 0‐9)
Decimal number in the range 0‐9 identifying the
code for screen group 1.
4
3
Language Code
(Range 0‐9)
Decimal number in the range 0‐9 identifying the
code for screen group 2.
5
3
Language Code
(Range 0‐9)
Decimal number in the range 0‐9 identifying the
code for screen group 3.
6
3
Language Code
(Range 0‐9)
Decimal number in the range 0‐9 identifying the
code for screen group 4.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-73
State Tables
V - Language Select From Card State
Table
Entry
Number of
Characters
7
Contents
Description
3
Language Code
(Range 0‐9)
Decimal number in the range 0‐9 identifying the
code for screen group 5.
8
3
Language Code
(Range 0‐9)
Decimal number in the range 0‐9 identifying the
code for screen group 6.
9
3
Screen Group Size
(Range 000‐400)
Number of screens in each language group.
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.
2-74
APTRA™ Advance NDC, Reference Manual
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-41
W - FDK Switch State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘W’
2
3
FDK ‘A’ Next State Number
3
3
FDK ‘B’ Next State Number
4
3
FDK ‘C’ Next State Number
State number to which the SST goes depending on
the key code stored in the FDK buffer
(Base 10 range 000‐254 or 256‐999)
(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.
APTRA™ Advance NDC, Reference Manual
2-75
State Tables
X - FDK Information Entry State
X ‐ FDK Information Entry State
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 function, for example, when a screen offers 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-42
X - FDK Information Entry State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘X’
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts key selection by
consumer.
3
3
Time‐Out Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
fails to respond to the message within the
permitted time limit. Enter 255 if the time‐out
function is not required.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-76
APTRA™ Advance NDC, Reference Manual
2
State Tables
X - FDK Information Entry State
Table
Entry
Number of
Characters
4
Contents
Description
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Cancel
key is pressed.
5
3
FDK Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if an FDK or
touch area is pressed.
6
3
Extension State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number of Extension state containing
assigned values for the eight FDKs or touch areas.
For more information about extension states, see
“Extension States” on page 2‐5.
7
3
Buffer ID
(Range 010‐039)
Identifies which buffer is to be edited and the
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 37 and
Table 2‐30.
X specifies the number of zeros in the range 0‐9
8
3
FDKs Active Mask
(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. See Table Note 36.
9
3
Must be 000
Reserved
Table Note 36: 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.
APTRA™ Advance NDC, Reference Manual
2-77
State Tables
X - FDK Information Entry State
Table Note 37: 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 38: 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‐48, or can be installed locally.
Table 2-43
Extension to State X
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Value stored if FDK ‘A’ or FDK
‘A’ touch area pressed
3
3
Value stored if FDK ‘B’ or FDK
‘B’ touch area pressed
Each table entry contains a value that is stored in
the buffer specified in the associated FDK
Information Entry state table (table entry 7) if the
specified FDK or touch area is 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.
2-78
APTRA™ Advance NDC, Reference Manual
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.
Language Selection in
Voice‐Guided Sessions
2
No language selection is required in this state if the consumer
previously selected a language when initiating a voice‐guided
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.
APTRA™ Advance NDC, Reference Manual
2-79
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-44
Y - Eight FDK Selection Function State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Y’
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to select
keys.
3
3
Time‐Out Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
does not respond to the message within the
specified time limit. Enter 255 if the time‐out
function is not required.
4
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
presses the Cancel key.
5
3
FDK Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
presses an FDK or touch area.
6
3
Extension State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number of Extension state containing
assigned operation codes for the eight FDKs or
touch areas. If there is no Extension state, enter 255.
For more information about extension states, see
“Extension States” on page 2‐5.
7
3
Buffer positions
(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’.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-80
APTRA™ Advance NDC, Reference Manual
State Tables
Y - Eight FDK Selection Function State
Table
Entry
Number of
Characters
Contents
Description
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
(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.
See Table Note 39.
9
3
Multi‐Language Screens
Selection Extension State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
If the state selects the multi‐language screen base,
this contains the Extension state number. If there is
no Extension state, enter 000 or 255.
For more information about extension states, see
“Extension States” on page 2‐5.
Table Note 39: 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.
APTRA™ Advance NDC, Reference Manual
2-81
State Tables
Y - Eight FDK Selection Function State
Table 2-45
Extension 1 to State Y
Table
Entry
Number of
Characters
Contents
Description
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.
5
3
Operation Code stored if FDK
‘D’ or FDK ‘D’ touch area is
pressed.
6
3
Operation Code stored if FDK
‘F’ or FDK ‘F’ touch area is
pressed.
7
3
Operation Code stored if FDK
‘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.
Each table entry contains the Operation Code
characters to be written to the Operation Code
buffer if the specified FDK or touch area is pressed.
Three characters are specified for each code, which
must be in the range ‘A’ ‐ ‘I’. They are written, in
order, to the three positions specified in the
associated Eight FDK Selection Function state table
(table entry 7). Enter ‘@’ if no character is to be
written to a specified position in the buffer.
See Table Note 40
Table Note 40: 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.
2-82
APTRA™ Advance NDC, Reference Manual
State Tables
Y - Eight FDK Selection Function State
Table 2-46
Extension 2 to State Y
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Screen Base if FDK ‘A’ or FDK
‘A’ touch area is pressed
3
3
Screen Base if FDK ‘B’ or FDK
‘B’ touch area is pressed
Each table entry contains the screen number of the
first screen of each language group. The initial base
is 000, and all unused fields should contain this
value.
See Table Note 41
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 41: 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.
APTRA™ Advance NDC, Reference Manual
2-83
State Tables
b - Customer-Selectable PIN State
b ‐ Customer‐Selectable PIN State
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-47
b - Customer-Selectable PIN State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘b’
2
3
First Entry Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to enter
the PIN the first time.
3
3
Time‐Out Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
does not make a CSP entry within the specified
time limit. Enter 255 if the time‐out function is not
required.
4
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
presses the Cancel key to stop the CSP transaction.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-84
APTRA™ Advance NDC, Reference Manual
2
State Tables
b - Customer-Selectable PIN State
Table
Entry
Number of
Characters
5
6
Contents
Description
3
Good Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
enters a matching pair of new PIN values.
3
CSP Fail Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
fails to enter a matching pair of new PIN digits or
the maximum number of retries for local PIN
checking is reached.
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
(Range 000‐Z99)
Display screen used to ask for confirmation of the
CSP.
8
3
Mis‐Match First Entry Screen
Number
Range (000‐Z99)
Display screen that replaces the screen for table
entry 2 on each attempt after a CSP pair attempt
did not match or an error has occurred and there
are still further retries allowed.
9
3
Extension State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number of the Extension state.
For more information about extension states, see
“Extension States” on page 2‐5.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-85
State Tables
b - Customer-Selectable PIN State
Table 2-48
Extension to State b
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Number of attempts allowed to
enter a matching CSP pair
(Range 000‐010)
Limits the number of attempts the consumer may
make to select a new PIN. A value of 0 is no limit.
3
3
Use local verification of new
PIN pair attempts
(Range 000‐001)
Specifies which attempts are to be verified locally:
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 42
4‐9
18
Must be 000
Reserved.
Table Note 42: 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.
2-86
APTRA™ Advance NDC, Reference Manual
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‐116.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-87
State Tables
k - Smart FIT Check State
k ‐ Smart FIT Check State
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-49
k - Smart FIT Check State
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘k’ (6BH)
2
3
Reserved (000)
Not used ‐ set to 0.
3
3
Good Read Next
State Number
(Base 10 range
000‐254 or 256‐999)
(Base 36 range
000‐254 or 256‐ZZZ)
State number to which the SST goes if the Financial Institution number
on the card matches a Financial Institution number in the FIT.
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 Number
State taken if the FIT check fails.
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.
2-88
APTRA™ Advance NDC, Reference Manual
2
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‐12. For more information about Eight FDK
Selection Function state, see “Y ‐ Eight FDK Selection Function
State” on page 2‐79.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-89
State Tables
m - PIN & Language Select State
Considerations for
Voice‐Guided Sessions
2
If the consumer has selected a voice‐guided session, this state is
used only for PIN entry and not for language selection. For details
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-50
m - PIN & Language Select State
Table
Entry
No of
Chars
Contents
Description
1
1
State Type
‘m’ (ASCII 6d, EBCDIC 94)
2
3
Screen Number
(Range 000‐Z99)
Display screen that prompts the consumer to enter the PIN and
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
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer does not
enter the PIN within the permitted time limit. If the time‐out
function is not required, enter state number 255.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-90
APTRA™ Advance NDC, Reference Manual
State Tables
m - PIN & Language Select State
Table
Entry
No of
Chars
4
Contents
Description
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer presses the
Cancel key before the maximum number of digits specified for
the PIN have been entered.
5
3
Next State Options
Extension State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number of Extension state containing the PIN options;
the Next State numbers that the SST enters after the PIN is
entered; and the FDKs ʹEnterʹ Key Mask.
For more information about extension states, see “Extension
States” on page 2‐5.
6
3
Operation Codes Extension
State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This entry is the same as state ‘Y’, table entry 6.
State number of the Extension state containing assigned
operation codes for the eight FDKs or touch areas.
If there is no Extension state, enter 255.
For more information about extension states, see “Extension
States” on page 2‐5.
7
3
Buffer Positions
(Range 000‐777)
This entry is the same as state ‘Y’, table entry 7.
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
(Range 000‐255)
This entry is the same as state ‘Y’, table entry 8.
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 43.
9
3
Multi‐Language Screens
Selection Extension State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This entry is the same as State ‘Y’, table entry 9.
If the state selects the multi‐language screen base, this contains
the Extension state number. If there is no Extension state, enter
000 or 255.
For more information about extension states, see “Extension
States” on page 2‐5.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-91
State Tables
m - PIN & Language Select State
Table Note 43: 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-51
PIN & Language FDK Active Mask
b7
b6
b5
b4
b3
b2
b1
b0
0
0
1
1
1
1
0
0
Table 2-52
Extension 1 to State m
Table
Entry
No of
Chars
Contents
Description
1
1
State type
‘Z’ (ASCII 5a, EBCDIC E9)
2
3
No PIN Entered Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer does
not enter a PIN, but selects a language from an active FDK
or touch area. The SST normally enters the PIN Entry state
(state ʹBʹ or ʹMʹ) if this occurs.
3
3
Local PIN Check ‐Good PIN
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This entry is the same as state ‘B’, table entry 5.
State number to which the SST goes after verification of a
correct PIN entry.
4
3
Local PIN Check ‐ Maximum
Bad PINs Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This entry is the same as state ‘B’, table entry 6.
State number to which the SST goes if the correct PIN has
not been entered after the number of attempts allowed by
table entry 7. The SST normally enters a Close state if this
occurs.
See Table Note 44.
5
3
Local PIN Check Error Next
State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if an incorrect PIN is
entered. The SST normally enters the PIN Entry state (state
ʹBʹ or ʹMʹ) in the language selected from this state as you
cannot go back to the ʹmʹ state, since there is no error screen
for bad PIN entry. This state type should match the state
type identified in table entry 8 below.
6
3
Remote PIN Check Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This entry is the same as state ‘B’, table entry 8.
State number to which the SST goes when local PIN
verification is not performed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-92
APTRA™ Advance NDC, Reference Manual
State Tables
m - PIN & Language Select State
Table
Entry
No of
Chars
7
Contents
Description
3
Local PIN Check Maximum
PIN Retries (Range 001‐009)
This entry is the same as state ‘B’, table entry 9.
Maximum number of incorrect PIN entries allowed before
the SST enters the state determined by table entry 4.
See Table Note 44.
8
3
State ʹBʹ or ʹMʹ Option
(Range 000 ‐ 001)
Specifies whether to use Track 3 retries on the card or from
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
(Range 000 ‐ 128)
Specifies the FDK or touch area that is the default language
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 44: 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-53
Extension 2 to State m
Table
Entry
No of
Chars
Contents
Description
1
1
State Type
ʹZʹ (ASCII 5a, EBCDIC E9)
2
3
Operation Code stored if FDK ʹAʹ
or FDK ʹAʹ touch area pressed
3
3
Operation Code stored if FDK ʹBʹ
or FDK ʹBʹ touch area pressed
4
3
Operation Code stored if FDK ʹCʹ
or FDK ʹCʹ touch area pressed
5
3
Operation Code stored if FDK ʹDʹ
or FDK ʹDʹ touch area pressed
Each table entry contains the Operation Code characters to
be written to the Operation Code buffer if the specified
FDK or touch area is pressed.
Three characters are specified for each code, which must be
in the range ʹAʹ ‐ ʹIʹ. They are written, in order, to the three
positions specified in the associated Eight FDK Selection
Function state table (table entry 7). Enter ʹ@ʹ if no character
is to be written to a specified position in the buffer.
Note: 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.
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.
APTRA™ Advance NDC, Reference Manual
2-93
State Tables
m - PIN & Language Select State
Table
Entry
No of
Chars
Contents
Description
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-54
Extension 3 to State m
Table
Entry
No of
Chars
Contents
Description
1
1
State Type
ʹZʹ (ASCII 5a, EBCDIC E9)
2
3
Screen Base if FDK ʹAʹ or FDK ʹAʹ
touch area is pressed
3
3
Screen Base if FDK ʹBʹ or FDK ʹBʹ
touch area is pressed
Each table entry contains the screen number of the first
screen of each language group. The initial base is 000, and
all unused fields should contain this value.
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
See Table Note 45
Table Note 45: This Extension state is the same as the Extension 2
to state Y, Table 2‐46 on page 2‐83.
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.
2-94
APTRA™ Advance NDC, Reference Manual
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.
APTRA™ Advance NDC, Reference Manual
2-95
State Tables
> - Cash Accept State
> ‐ Cash Accept State
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
following:
1
Activates and de‐activates acceptable note types according to
the state parameters (Set NDC note type 1‐12...49‐50) in
Table 2‐58 “Extension 3 to State > (Cash Accept)” on page 2‐103.
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‐59, “Extension 4 to State > (Cash Accept)” on
page 2‐105.
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 (suspect) or
category 3 (counterfeit).
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.
2-96
APTRA™ Advance NDC, Reference Manual
2
State Tables
> - Cash Accept State
8
If the cash acceptor has retract capabilities and retract is enabled,
retracts returned notes that have not been taken within the time
specified by 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.
Table 2-55
> - Cash Accept State
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘>’ (6EH)
2
3
Cancel Key Mask
Specifies the Cancel FDK which is active when the Please Enter
Notes screen, Confirmation screen, Counterfeit Notes Retained
screen or Escrow Full screen is displayed.
See Table Note 46, Table Note 47 and Table Note 48
3
3
Deposit Key Mask
Specifies the Deposit FDK which is active when the Confirmation
screen, Counterfeit Notes Retained screen or Escrow Full screen is
displayed.
See Table Note 46 and Table Note 51
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 46 and Table Note 50
For direct deposits, this value is ignored
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-97
State Tables
> - Cash Accept State
Table
Entry
No. of
Chars
6
3
7
8
9
3
3
3
Contents
Description
Extension State 1
Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254
or 256‐ZZZ)
State number for extension 1
See “Extension 1 to State > (Cash Accept)”
Extension State 2
Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254
or 256‐ZZZ)
State number for extension 2
See “Extension 2 to State > (Cash Accept)” on page 2‐101
Extension State 3
Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254
or 256‐ZZZ)
State number for extension 3
See “Extension 3 to State > (Cash Accept)” on page 2‐103
Extension State 4
Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254
or 256‐ZZZ)
State number for extension 4
See “Extension 4 to State > (Cash Accept)” on page 2‐105
For more information about extension states, see “Extension States”
on page 2‐5.
For more information about extension states, see “Extension States”
on page 2‐5.
For more information about extension states, see “Extension States”
on page 2‐5.
For more information about extension states, see “Extension States”
on page 2‐5.
Table Note 46: 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 Cancel, Deposit, Add More and Refund functions
should each activate a different key.
Table Note 47: 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 48: If direct deposit is configured, the Cancel key is not
enabled in the Confirmation or Escrow Full screens. This is the case
whether the Cancel key is configured as an FDK or PINPad key.
Table Note 49: If direct deposit is configured, the Add More key can
be enabled but is not required.
Table Note 50: If direct deposit is configured, the Refund key is not
enabled.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-98
APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
Table Note 51: 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-56
Extension 1 to State > (Cash Accept)
Table
Entry
No of
Chars
Contents
Description
1
1
State type
‘Z’
2
3
Please Enter Notes Screen
(Range 000‐Z99)
This screen is displayed when the cash acceptor has been
successfully enabled (or re‐enabled) to accept a cash deposit
from the consumer.
See Table Note 52
3
3
Please Remove Notes
Screen
(Range 000‐Z99)
This screen is displayed when the cash acceptor has refunded or
rejected notes to the consumer.
See Table Note 53
4
3
Confirmation Screen
(Range 000‐Z99)
This screen is displayed when all the notes have been processed
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, it 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 54 and “Confirmation Screen” on page 2‐106
5
3
Hardware Error Screen
(Range 000‐Z99)
This screen is displayed for the time specified by timer 63 (by
default, 15 seconds) when a hardware error (for example a note
jam) occurs, so that the transaction cannot continue.
See Table Note 55
6
3
Escrow Full Screen
(Range 000‐Z99)
This screen is displayed when the maximum number of notes
that can be held in the escrow is reached.
If direct deposit is configured, this is displayed when the direct
deposit limit is reached.
See Table Note 56
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-99
State Tables
> - Cash Accept State
Table
Entry
No of
Chars
7
Contents
Description
3
Processing Notes Screen
(Range 000‐Z99)
This screen is displayed while notes are being processed after
entry to the cash acceptor.
8
3
Please Remove More than
90 Notes Screen (Range
000‐Z99)
This screen is displayed when the cash acceptor refunds notes to
the consumer because the number notes in the escrow exceeds
the set capacity. This screen is displayed when all the notes are
refunded to the consumer because more than 90 notes have been
inserted but support for more than 90 notes is not enabled as
described in “Option 45: BNA Settings Bit Values” on
page 7‐15.
See Table Note 57
9
3
Please Wait Screen (Range
000 ‐ Z99)
This screen is displayed as follows:

Until the cash acceptor is ready to accept notes.

When the Refund key is selected and until the notes are
ready to be taken

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 52: 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 53: If the Remove Refused Notes screen is defined (see
table entry 8 in “Extension 3 to State > (Cash Accept)” on
page 2‐103) 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 54: 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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-100
APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
depending on the configuration described in the Add More Key
Mask field of the “> ‐ Cash Accept State” on page 2‐97, the cash
acceptor is enabled while the screen is displayed. For more
information about the configuration of dynamic data, refer to the
APTRA Advance NDC Developer’s Guide, chapter 5, “Configuring
Advance NDC and Associated Components”.
Table Note 55: 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 table entry is taken.
Table Note 56: 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 key is not enabled. If direct deposit is configured, notes
cannot be refunded so not all keys in the screen will be enabled.
Table Note 57: If direct deposit is configured, this screen is not
used.
Table 2-57
Extension 2 to State > (Cash Accept)
Table
Entry
No of
Chars
Contents
Description
1
1
State type
‘Z’
2
3
Good Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to when the Deposit key is selected.
3
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to if the consumer presses the Cancel
key to stop the Cash Deposit transaction or selects Refund on
the Confirmation screen and takes the notes or the notes are
retracted.
See Table Note 58 and Table Note 59
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-101
State Tables
> - Cash Accept State
Table
Entry
No of
Chars
4
Contents
Description
3
Device Error Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to if an error occurs that may require
subsequent action by Central.
5
3
Timeout Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to if the consumer fails to enter notes
into the BNA before timer 77 expires, or fails to respond to the
prompts on the Timeout screen.
See Table Note 60
6
3
Notes at Refund Slot Next
State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to if the notes remain at the refund
slot after timer 78 expires. Applicable only if the retract option is
not configured.
7
3
Reserved (000)
Reserved for future use.
8
3
Reserved (000)
Reserved for future use.
9
3
Retracting Notes Screen
(Range 000 ‐ Z99)
This screen is displayed when retract operations are enabled by
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 58: 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 59: 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.
2-102
APTRA™ Advance NDC, Reference Manual
State Tables
> - Cash Accept State
Table Note 60: 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-58
Extension 3 to State > (Cash Accept)
Table
Entry
No of
Chars
Contents
Description
1
1
State type
‘Z’
2
3
Set NDC note type
1 ‐ 12
The three ASCII characters represent 4‐bit nibble hexadecimal
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 61 and Table Note 62
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 63
3
3
Set NDC note type
13 ‐ 24
The three ASCII characters represent three bitmaps, starting
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 62
4
3
Set NDC note type
25 ‐ 36
The three ASCII characters represent three bitmaps, starting
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 62
5
3
Set NDC note type
37 ‐ 48
The three ASCII characters represent three bitmaps, starting
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 62
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-103
State Tables
> - Cash Accept State
Table
Entry
No of
Chars
6
Contents
Description
3
Set NDC note type
49 ‐ 50
The three ASCII characters represent three bitmaps, starting
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 62
7
3
Reserved (000)
Reserved for future use.
8
3
Remove Refused Notes
Screen
(Range 000 ‐ Z99)
Displayed when notes are refused by the device and returned to
the consumer.
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‐107
See Table Note 64
9
3
Counterfeit Notes Retained
Screen
(Range 000 ‐ Z99)
Displayed to provide extra information to the consumer about
how to proceed when counterfeit or suspect notes are retained
under ECB 6 regulations. The screen can be customised. For
example, it could 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 this is 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‐106).
See Table Note 65 and Table Note 66
Table Note 61: 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 62: If Extension 3 to state > is set to all zeros, it is
ignored and the previous download is retained.
Table Note 63: There is a dependency on which notes are reported
through the SST Command, ‘Send Configuration ‐ Note Definitions’
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
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 64: 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 65: 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 66: 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‐14.
Table 2-59
Extension 4 to State > (Cash Accept)
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’
2
3
Reserved (000)
Reserved for future use.
3
3
Reserved (000)
Reserved for future use.
4
3
Reserved (000)
Reserved for future use.
5
3
Direct Deposit Control
(Range 000 ‐ 001)
Determines whether notes are placed in the escrow or deposited
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 68 and Table Note 67
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
6
3
Direct Deposit Limit
(Range 000 ‐ 999)
Defines the number of notes that can be inserted when notes are
deposited directly into the cassettes.
Once this limit is reached, 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.
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 67: 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 68: 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‐101.
Confirmation Screen
2
The Confirmation screen (defined in table entry 4 in “Extension 1 to
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‐55, “> ‐ Cash Accept State” on page 2‐97) 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
State > (Cash Accept)” is displayed only if the value of Add More
Key Mask is 000 and the CashInAutoEnabled property is true.
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
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.
Dynamic Text Definitions
2
The following dynamic text definitions can be used in the Cash
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‐60 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-60
Rejected Notes Dynamic Text
Enumerated Value
Definition
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
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
Enumerated Value
Definition
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
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-108
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-61
w - Cheque Accept State
Table
Entry
No. of
Chars
Contents
Description
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-109
State Tables
w - Cheque Accept State
Table
Entry
No. of
Chars
Contents
Description
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 76.
5
3
Image Lift
(000 ‐ 003)
Specifies whether a front and/or rear image is to be lifted, if
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 69.
6
3
Extension State 1
(Range 000‐999 or
000‐ZZZ)
State number for extension state 1.
See “Extension 1 to State w” on page 2‐112.
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‐5.
7
3
Extension State 2
(Base 10 range 000‐254
or 256‐999)
(Base 36 range 000‐254
or 256‐ZZZ)
State number for extension state 2.
See “Extension 2 to State w” on page 2‐114.
If a value of 255 is used for this entry, this indicates there is no
extension state 2.
For more information about extension states, see “Extension States”
on page 2‐5.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-110
APTRA™ Advance NDC, Reference Manual
State Tables
w - Cheque Accept State
Table
Entry
No. of
Chars
Contents
Description
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 70.
Table Note 69: 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 70: 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-111
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-62
Extension 1 to State w
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Please Insert Cheque
Screen
(Range 000‐Z99)
This screen is displayed when the cheque processor has been
successfully enabled (or re‐enabled) to accept a customer’s cheque.
See Table Note 71
3
3
Processing Cheque
Screen
(Range 000‐Z99)
This screen is displayed when the cheque has been successfully
entered into the cheque processor.
4
3
Unacceptable Cheque
Screen
(Range 000‐Z99)
This screen is displayed when a cheque cannot be accepted by the
cheque processor.
See Table Note 72
5
3
Incorrect Orientation
Screen
(Range 000‐Z99)
This screen is displayed when an incorrectly orientated cheque has
been entered and retries still remain.
6
3
Further Processing
Screen
(Range 000‐Z99)
This screen is displayed after the Processing Cheque screen, and
may be used to display the lifted images.
7
3
Cheque Captured
Screen
(Range 000‐Z99)
This screen is displayed when a cheque has been captured.
Typically a cheque is captured if it is returned to the consumer but
not taken.
This screen is displayed for the period defined by timer 87.
See Table Note 73
8
3
Device Error Screen
(Range 000‐Z99)
This screen is displayed when a hardware error such as a cheque
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
Screen
(Range 000‐Z99)
This screen is displayed when the cheque is returned, and is waiting
to be taken by the consumer.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-112
APTRA™ Advance NDC, Reference Manual
State Tables
w - Cheque Accept State
Table Note 71: 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 72: 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, an unsolicited timeout
status message is sent to Central, and there is an attempt 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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-113
State Tables
w - Cheque Accept State
journaled at this point to indicate that the clearing action has taken
place.
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 73: 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-63
Extension 2 to State w
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Cheque Already Present
Next State Exit
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This exit is taken if a cheque is detected as already present in the
cheque processor. The recommended next state is the Close state, to
perform error recovery.
3
3
No Exception Next State
Exit
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This exit is taken if the cheque is accepted and processed without
error, although the codeline may not have been read. The
recommended next state is an Information Entry state, which
prompts the consumer to enter the amount on the cheque, and
optionally displays the image lifted from the cheque.
See Table Note 72
4
5
3
3
Exception Next State Exit
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This exit is taken when an exception has occurred (that is, a device
failure occurs in the cheque processor). The recommended next
state is the Close state, to perform error recovery.
Customer Cancel/
Timeout Next State Exit
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This exit is taken when the consumer fails to insert a physically
acceptable cheque within the required time or number of retries.
The recommended next state is the 4 or 8 FDK Selection Function
state from which the Cheque Deposit transaction was selected.
See Table Note 74
See Table Note 75.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-114
APTRA™ Advance NDC, Reference Manual
State Tables
w - Cheque Accept State
Table
Entry
No. of
Chars
6
3
Contents
Description
Cheque Captured Exit
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
This exit is taken when the consumer fails to take a returned
cheque, which is then cleared to the cheque processor reject bin.
See Table Note 76
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 74: 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‐121.
Table Note 75: 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 76: 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-115
State Tables
z – Master Expansion State
z – Master Expansion State
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-64
z - Master Expansion State
Table
Entry
No. of
Chars
Contents
Description
1
1
‘z’ (7AH)
State Type
2
3
State subtype
(Range 000‐999)
Identifies the state subtype
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-116
APTRA™ Advance NDC, Reference Manual
2
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-65
z001 - Bunch Cheque Accept State
Table
Entry
No. of
Chars
Contents
Description
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 77 and Table Note 78
4
3
Enable Image Processing
(Range 000‐003)
Specifies the level of processing to be carried out on the cheque
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-117
State Tables
z001 – Bunch Cheque Accept State
Table
Entry
No. of
Chars
5
6
7
8
9
Contents
Description
3
Max Items
(Range 000‐999)
Specifies the maximum number of cheques that can be accepted
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
3
Extension State 1
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension state 1
See “Extension 1 to State z001” on page 2‐119
Extension State 2
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension state 2
See “Extension 2 to State z001” on page 2‐120
3
3
3
Extension State 3
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Must be 000
If a value of 255 is used for this entry, the default Close state is
taken
For more information about extension states, see “Extension
States” on page 2‐5.
If a value of 255 is used for this entry, this indicates there is no
extension state 2
For more information about extension states, see “Extension
States” on page 2‐5.
State number for extension state 3
See “Extension 3 to State z001” on page 2‐121
If a value of 255 is used for this entry, this indicates there is no
extension state 3
For more information about extension states, see “Extension
States” on page 2‐5.
Reserved
Table Note 77: 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 78: 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-118
APTRA™ Advance NDC, Reference Manual
State Tables
z001 – Bunch Cheque Accept State
Table 2-66
Extension 1 to State z001
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Please Wait for Device
Screen
(Range 000‐Z99)
Prompts the consumer to wait for the device to be ready to accept
cheques
If the screen is not to be changed while waiting for the device, set
this field to 000
3
3
Please Insert Cheques
Screen
(Range 000‐Z99)
Prompts the consumer to enter cheques when the device is
successfully enabled, or re‐enabled, to accept a cheque deposit
4
3
Processing Cheques
Screen
(Range 000‐Z99)
Replaces the ‘Please Insert Cheques’ screen while the device
processes the inserted cheques
5
3
Please Wait for Refused
Cheques Screen
(Range 000‐Z99)
Prompts the consumer to wait while refused cheques are returned
If multiple bunches are returned, this screen can be displayed
multiple times
6
3
Retracting Cheques
Screen
(Range 000‐Z99)
Informs the consumer that returned cheques, which have not been
taken, are being retracted
The retract is initiated if Timer 94 expires before the cheques are
taken
See Table Note 79
7
3
Device Unavailable
Screen
(Range 000‐Z99)
Informs the consumer that the device is unavailable when the
Bunch Cheque Accept state is entered
The screen is displayed for the time defined by Timer 63
See Table Note 79
8
3
Hardware Error Screen
(Range 000‐Z99)
Informs the consumer that the transaction cannot continue because
a hardware error, such as a cheque jam, has occurred
The screen is displayed for the time defined by Timer 63
See Table Note 79
9
3
Stacker/Escrow Full
Screen
(Range 000‐Z99)
Informs the consumer that the stacker is already full when entering
the Bunch Cheque Accept state
The screen is displayed for the time defined by Timer 63
If the timer expires, the Good Exit is taken
See Table Note 79
Table Note 79: 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-119
State Tables
z001 – Bunch Cheque Accept State
Table 2-67
Extension 2 to State z001
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Please Remove Rejected
Cheques Screen
(Range 000‐Z99)
Informs the consumer that cheques have been rejected before they
were fully inserted.
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 Cheque Rejection” on page 2‐122
See Table Note 80
3
3
Please Remove Refused
Cheques Screen
(Range 000‐Z99)
Informs the consumer that cheques have been refused after being
successfully inserted
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‐122
See Table Note 80
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 80: 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-120
APTRA™ Advance NDC, Reference Manual
State Tables
z001 – Bunch Cheque Accept State
Table 2-68
Extension 3 to State z001
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Good Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if at least one cheque has been
successfully accepted into the device and any refused cheques have
been taken by the consumer
If all cheques have been either refused or rejected, the state does not
take an exit and the device is re‐enabled for cheque insertion
3
3
Cancel Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Cancel key is pressed to
stop the cheque deposit or ‘No’ is selected from the Timeout screen.
4
3
Device Error Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if an exception has occurred
which may require subsequent action by Central
5
3
Timeout Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer fails to enter
any cheques before Timer 04 expires
6
3
Cheques Retracted Next
State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if refused cheques are
subsequently successfully retracted
All cheques, not just those that have been rejected, are retracted. All
cheques must be retracted because there is no consumer interaction
to continue with the deposit of cheques that have been inserted but
not rejected
The retract is initiated after Timer 94 expires
7
3
Good with Refused
(Base 10 range 000‐254 or
256‐99)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if at least one cheque is
refused, and taken when returned, and at least one good cheque is
accepted.
If this state parameter is not specified, the SST goes to the Good
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-121
State Tables
z001 – Bunch Cheque Accept State
Defining Dynamic Text for
Cheque Rejection
2
To define the text to be displayed when a cheque is rejected during
the Bunch Cheque Accept state, 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‐69 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-69
Rejected Reasons
Defining Dynamic Text for
Cheque Refusal
2
Enumerated Value
Definition
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
refused during the Bunch Cheque Accept state, 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 001. For details of this control
sequence, see “Display Dynamic Text Dictionary Control Sequence”
on page 3‐39.
Table 2‐69 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-70
Refused Reasons
Enumerated Value
Definition
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-122
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-123
State Tables
z002 – Bunch Cheque Handling State
z002 – Bunch Cheque Handling State
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-71
z002 - Bunch Cheque Handling State
Table
Entry
No. of
Chars
Contents
Description
1
1
‘z’ (7AH)
Master Extension State
2
3
State subtype
‘002’
3
3
Media Control
(Range 000‐002)
Specifies what happens to the cheques, as follows:
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 “Timer 94 *” on page 7‐29
4
3
Deposit Bin Number
(Range 000‐999)
Specifies the bin number into which the cheque is to be
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
(Range 000‐Z99)
Specifies the screen containing the text used to endorse the
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-124
APTRA™ Advance NDC, Reference Manual
2
State Tables
z002 – Bunch Cheque Handling State
Table
Entry
No. of
Chars
6
Contents
Description
3
Stamp Flag
(Range 000‐001)
Specifies whether to stamp the cheques, as follows:
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
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension state 1
See “Extension 1 to State z002”
Extension State 2
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension state 2
See “Extension 2 to State z002”
9
3
For more information about extension states, see “Extension
States” on page 2‐5
For more information about extension states, see “Extension
States” on page 2‐5.
Table 2-72
Extension 1 to State z002
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Please Wait Processing
Cheques Screen
(Range 000‐Z99)
Prompts the consumer to wait while the action specified in the
Media Control field is carried out
3
3
Please Remove Returned
Cheques Screen
(Range 000‐Z99)
Prompts the consumer to remove cheques that have been returned
4
3
Please Wait for More
Returned Cheques Screen
(Range 000‐Z99)
Prompts the consumer to wait for further cheques to be returned
5
3
Please Wait Retracting
Cheques Screen
(Range 000‐Z99)
Informs the consumer that returned cheques that have not been
taken are being retracted
6
3
Device Unavailable
Screen
(Range 000‐Z99)
Informs the consumer that the device is unavailable when the
Bunch Cheque Handling state is entered
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-125
State Tables
z002 – Bunch Cheque Handling State
Table
Entry
No. of
Chars
7
Contents
Description
3
Hardware Error Screen
(Range 000‐Z99)
Informs the consumer that the transaction cannot continue because
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-73
Extension 2 to State z002
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Good Operation Next
State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the cheques have been
successfully processed as defined in the Media Control field, as
follows:
If Media Control is 000, the media has been deposited into the
specified bin and any returned cheques have been taken by the
consumer
If Media Control is 001 or 002, the media has been returned and
taken by the consumer
3
3
Device Error Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if an exception has occurred
which may require subsequent action by Central
4
3
Customer Timeout Next
State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer has not taken
the returned cheques
If Media Control is 002, this exit is taken after Timer 94 expires,
otherwise it is taken after any returned cheques are successfully
retracted
5
3
Endorse Control
(Range 000‐001)
Defines where and how the data used to endorse the cheque is
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-126
APTRA™ Advance NDC, Reference Manual
State Tables
z002 – Bunch Cheque Handling State
Table
Entry
No. of
Chars
Contents
Description
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-127
State Tables
z003 – Cheque Detail Display State
z003 – Cheque Detail Display State
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-128
APTRA™ Advance NDC, Reference Manual
2
State Tables
z003 – Cheque Detail Display State
Table 2-74
z003 - Cheque Detail Display State
Table
Entry
No. of
Chars
Contents
Description
1
1
‘z’ (7AH)
Master Extension State
2
3
State subtype
‘003’
3
3
Operation Mode
(Range 001‐003)
Specifies the mode of operation, as follows:

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‐135) 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-129
State Tables
z003 – Cheque Detail Display State
Table
Entry
No. of
Chars
4
Contents
Description
3
Allow Zero
(Range 000‐001)
Specifies whether a cheque can be left with an amount of zero,
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
(Range 000‐Z99)
Informs the consumer of the cheque details and allows an
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‐133
6
3
Amount Display Screen
Number
(Range 000‐Z99)
Overlay screen to set the cursor position and optionally defines
the initial display format before 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 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
(Range 000‐Z99)
Overlay screen to prompt the consumer to provide a non‐zero
amount for the displayed cheque
8
3
Extension State 1
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension state 1
See “Extension 1 to State z003”
Extension State2
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension state 2
See “Extension 2 to State z003”
9
3
For more information about extension states, see “Extension
States” on page 2‐5.
For more information about extension states, see “Extension
States” on page 2‐5.
Table Note 81: 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-130
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-75
Extension 1 to State z003
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Proceed Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the cheques deposited have
met the conditions of the transaction and wants to proceed
3
3
Cancel Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Cancel key is pressed
If any amount has been modified during this state before the Cancel
key is pressed, the modified amount is retained
4
3
Timeout Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer fails to respond
within the specified time limit
Enter 255 if the time‐out function is not required
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-131
State Tables
z003 – Cheque Detail Display State
Table 2-76
Extension 2 to State z003
Table
Entry
No. of
Chars
Contents
Description
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 82
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 82
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 82
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 82
6
3
Previous Cheque Key
Mask
Specifies the FDKs or touch screen areas that are associated with
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 82
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-132
APTRA™ Advance NDC, Reference Manual
State Tables
z003 – Cheque Detail Display State
Table
Entry
No. of
Chars
Contents
Description
7
3
Must be 000
Reserved
8
3
Must be 000
Reserved
9
3
Must be 000
Reserved
Table Note 82: 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.
Defining Dynamic Data for
Cheque Deposit Status
2
When the deposit status of a cheque is to be displayed, the data is
defined using an enumerated list. This list is included in a display
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‐77, “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-77
Cheque Acceptance States
Enumerated Value
Definition
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-133
State Tables
z004 – Display Cheque Summary State
z004 – Display Cheque Summary
State
The Display Cheque Summary state displays a summary of the
cheques that have been accepted during the Bunch Cheque Accept
state (see page 2‐117). 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 refused
— 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: If a timeout occurs, or the consumer cancels the transaction,
no unsolicited message is sent to Central or journaled.

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.
If no cheques are available for display, only the Cheque Summary
screen is displayed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-134
APTRA™ Advance NDC, Reference Manual
2
State Tables
z004 – Display Cheque Summary State
Current Cheque Index
2
The Display Cheque Summary state, Bunch Cheque Accept state
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-78
z003 - Cheque Detail Display State
Table
Entry
No. of
Chars
Contents
Description
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-135
State Tables
z004 – Display Cheque Summary State
Table
Entry
No. of
Chars
7
3
8
9
3
3
Contents
Description
Extension State 1
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension state 1
See “Extension 1 to State z004”
Extension State 2
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension state 2
See “Extension 2 to State z004”
Extension State 3
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension state 3
See “Extension 3 to State z004”
For more information about extension states, see “Extension
States” on page 2‐5.
For more information about extension states, see “Extension
States” on page 2‐5.
For more information about extension states, see “Extension
States” on page 2‐5.
Table 2-79
Extension 1 to State z004
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Cheque Summary Screen
(Range 000‐Z99)
Contains the background for the cheque summary display
3
3
Next FDK Screen
(Range 000‐Z99)
Nested screen to overlay the Cheque Summary screen when the
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
(Range 000‐Z99)
Nested screen to overlay the Cheque Summary screen when the
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
Top Row
(Range 000‐015)
Specifies the top of the area used to display dynamic cheque data
6
3
Cheque Display Area
Left Column
(Range 000‐031)
Specifies the left of the area used to display dynamic cheque data
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-136
APTRA™ Advance NDC, Reference Manual
State Tables
z004 – Display Cheque Summary State
Table
Entry
No. of
Chars
7
Contents
Description
3
Max Cheque Details
(Range 00‐010)
Specifies the maximum number of cheques to display on a single
screen
8
3
Cheque Details Overlay
Screen
(Range 000‐Z99)
Overlay screen to define what is displayed for each cheque.
If the cheque deposit status is to be displayed, a dynamic text
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‐133
See Table Note 83 and Table Note 84
9
3
Cheque Details Overlay
Size
(Range 000‐015)
Specifies the number of rows allocated for the display of the cheque
details
Table Note 83: Any position co‐ordinates used in the overlay
screen are relative.
Table Note 84: New display control codes are added to allow the
display of dynamic data associated with the inserted cheques.
Table 2-80
Extension 2 to State z004
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Cheque Detail Area
Background Screen
(Range 000‐Z99)
Overlay screen to clear the area for cheque detail display on initial
entry to the state and when either the Next or Previous FDK or
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 85
4
3
Proceed Key Mask
Specifies the FDKs or touch screen areas that are associated with
the option to proceed
See Table Note 85
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 85
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-137
State Tables
z004 – Display Cheque Summary State
Table
Entry
No. of
Chars
Contents
Description
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 85
7
3
Add More FDK Key
Mask
Specifies the FDKs or touch screen areas that are associated with
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 85
8
3
Add More FDK Screen
(Range 000‐Z99)
Nested screen to overlay the Cheque Summary screen when the
Add More FDK key or touch screen area is enabled
9
3
Must be 000
Reserved
Table Note 85: 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-81
Extension 3 to State z004
Table
Entry
No. of
Chars
Contents
Description
1
1
State type
‘Z’ (5AH)
2
3
Cancel Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Cancel key is pressed
3
3
Proceed Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Proceed key is pressed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-138
APTRA™ Advance NDC, Reference Manual
State Tables
z004 – Display Cheque Summary State
Table
Entry
No. of
Chars
4
Contents
Description
3
Add More Next State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Add More key is pressed
5
3
Timeout Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer fails to respond
in the specified time limit
Enter 255 if the time‐out function is not required
6
3
View Cheque Detail State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer chooses to
view the details of a cheque
This identifies the Cheque Detail Display state, which must have
the Operation Mode set to 001
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-139
State Tables
z008 – Insert Card State
z008 – Insert Card State
The Insert Card state supports motorised card readers and smart
dip 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 the extension state table entry value 6
is set to 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’s 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 following functions are not supported by the Insert Card state:




Cardless entry
Idle sequence
Initialization of the following:
— Buffer B
— Buffer C
— Amount buffer
— Operation code buffer
— FDK buffer
Promote flow points.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-140
APTRA™ Advance NDC, Reference Manual
2
State Tables
z008 – Insert Card State
Table 2-82
z008 - Insert Card State
Table
Entry
No. of
Chars
Contents
Description
1
1
State Type
‘z’
2
3
Sub‐Type
008
3
3
Insert Card Screen
Number
(Range 000‐Z99)
Prompts the consumer to enter a card. This screen is displayed
while the SST is waiting for card entry.
4
3
Good Read Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes in either of the following
situations:

After a successful read of the card if FITs are not used (Table
entry 4 in the extension state = 000).

If the Financial Institution number on the card matches a
Financial Institution number in a FIT.
5
3
Error (Misread) Screen
Number
(Range 000‐Z99)
Screen to display if the read conditions are not satisfied due to an
invalid card or a mechanism error.
After ejecting the card, the card reader is reactivated and waits for
the card entry.
6
3
Read condition 1
7
3
Read condition 2
These three entries specify which card track(s) and/or chip data will
be read. The possible values for these entries are shown in
Table 2‐4, “Read Condition Bit Information” on page 2‐9.
8
3
Read condition 3
9
3
Extension State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number of the extension state.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-141
State Tables
z008 – Insert Card State
Table 2-83
Extension to State z008
Table
Entry
No. of
Chars
Contents
Description
1
1
State Type
‘Z’
2
3
Cancel next state number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the Cancel key is pressed.
3
3
Time‐Out Next state
number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes when timer 04 expires or when
a card is ejected due to an invalid read but not taken by the
consumer.
If the card is not taken within the duration of timer 09, the card is
captured and the Time‐Out Next State is taken.
4
3
No FIT Match Next state
number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if either the Financial
Institution number on the card does not match any FIT, or the card
reader is a smart card reader and the read condition being
evaluated has the chip connect bit set (bit 3).
If FITs are not used this entry must be 000.
5
3
Fatal Next state number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes in the following situations:

The card reader is in a fatal condition

The card reader is out of operation

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
(Range 000‐Z99)
If the card reader is a smart dip reader and a chip connect bit is set,
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.
2-142
APTRA™ Advance NDC, Reference Manual
State Tables
z008 – Insert Card State
Table
Entry
No. of
Chars
Contents
Description
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
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
z009 – Buffer Validation State
z009 – Buffer Validation State
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 require 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.
2-144
APTRA™ Advance NDC, Reference Manual
2
State Tables
z009 – Buffer Validation State
Table 2-84
z009 - Buffer Validation State
Table
Entry
No. of
Chars
Contents
Description
1
1
State Type
‘z’
2
3
Subtype
009
3
3
RuleSetID
(Range 001‐999)
Defines the rule identifier to match with the ID attribute in the
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 86
5
3
Good Validation Next
State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to go to if the data is successfully validated.
6
3
Validation Fail Next State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to go to if the data validation fails.
7
3
Must be 000
Reserved
8
3
Must be 000
Reserved
9
3
Must be 000
Reserved
Table Note 86: If the identified buffer contains no data, the
Validation Fail Next State exit is taken.
Date Validation Scenario
2
The following scenario illustrates how the state table and XML
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.
APTRA™ Advance NDC, Reference Manual
2-145
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 of the APTRA Advance NDC, Developer’s
Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-146
APTRA™ Advance NDC, Reference Manual
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.
Cardless Transactions
Dispense Functionality
2
2
If this state is used with cardless transactions, consumer
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
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.
Foreign Currency
Exchange Transactions
State Flow after a
Successful Dispense
2
2
A typical use of this state is in a foreign currency exchange
transaction, where the consumer initiates the transaction (with or
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
to the Good Dispense Next State. When only notes have to be
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.
APTRA™ Advance NDC, Reference Manual
2-147
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



State Flow after a Short
Dispense
When the cash dispensed is less than the amount of requested cash,
the state flow goes to the Short Dispense Next State.
2
Short Dispense Examples


State Flow after a Failed
Dispense
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 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
Next State.
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.
2-148
APTRA™ Advance NDC, Reference Manual
2
State Tables
z010 – Local Cash Dispense State
State Flow after an
Unknown Dispense
2
When notes have been dispensed and the number of notes
dispensed is unknown, the state goes to the Unknown Dispense
Next State.
Unknown Dispense Examples


State Flow on Card
Ejection
State Operation
2
2
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
cash is presented only after the card is taken. If the ejected card is
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
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.
APTRA™ Advance NDC, Reference Manual
2-149
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
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.
2-150
APTRA™ Advance NDC, Reference Manual
2
State Tables
z010 – Local Cash Dispense State
Message Handling
2
The Local Cash Dispense state does not send all the status messages
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-85
z010 – Local Cash Dispense State
Table
Entry
No. of
Chars
Contents
Description
1
1
State Type
‘z’ — Master Expansion State
2
3
Subtype
010
3
3
Please Wait Screen
(Range 000‐ Z99)
Displayed when notes are being stacked. If a spray dispenser is
present this screen is not displayed
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-151
State Tables
z010 – Local Cash Dispense State
Table
Entry
No. of
Chars
4
Contents
Description
3
Take Card Screen
(Range 000‐Z99)
Displayed when the card is ejected. This screen is not displayed if
the card is not returned or there is no card in the reader
5
3
Take Notes Screen
(Range 000‐Z99)
Displayed when the notes are presented. If a spray dispenser is
present, this screen is displayed when the dispense operation starts
to dispense notes.
6
3
Take Coins Screen
(Range 000 ‐ Z99)
Displayed when the coins are dispensed
7
3
Operation Mode
(Range 001 to 004)
Specifies how the state is to operate, as follows:
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-86
Extension 1 to State z010
Table
Entry
No. of
Chars
Contents
Description
1
1
State Type
Z
2
3
Good Dispense Next
State Number
(Base 10 range 000‐254 or
256‐999
Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to when the amount of cash requested
has been dispensed
3
3
Short Dispense Next
State Number
(Base 10 range 000‐254 or
256‐999
Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to when the cash dispensed is less than
the cash requested
4
3
No Dispense Next State
Number
(Base 10 range 000‐254 or
256‐999
Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to when no cash is dispensed.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-152
APTRA™ Advance NDC, Reference Manual
State Tables
z010 – Local Cash Dispense State
Table
Entry
No. of
Chars
5
Contents
Description
3
Unknown Dispense Next
State Number
(Base 10 range 000‐254 or
256‐999
Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to when the number of notes dispensed
is unknown
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-153
State Tables
z013 – Data Copy and Compare State
z013 – Data Copy and Compare State
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-87
z013 – Data Copy and Compare State
Table
Entry
No. of
Chars
Contents
Description
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‐156)
002 ‐ Compare buffers (case insensitive)
003 ‐ Compare buffers (case sensitive)
4
3
Copy/Compare Good
Next State Number
(Base 10, range 000‐254 or
256‐999)
(Base 36, range 000‐254 or
256‐ZZZ)
State number to which the SST proceeds after either of the
following:
5
3
Error Next State Number
(Base 10, range 000‐254 or
256‐999)
(Base 36, range 000‐254 or
256‐ZZZ

A successful data copy

For a data comparison, the two buffers have identical values.
State number to which the SST proceeds if either of the following
errors occurs when the Operation Identifier is 001 (copy):

The source buffer length is greater than the destination buffer
length

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.
2-154
APTRA™ Advance NDC, Reference Manual
2
State Tables
z013 – Data Copy and Compare State
Table
Entry
No. of
Chars
6
Contents
Description
3
Extension State 1
(Base 10, range 000‐254 or
256‐999)
(Base 36, range 000‐254 or
256‐ZZZ)
State number for extension state 1.
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-88
Extension 1 to State z013
Table
Entry
No. of
Chars
Contents
Description
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.
APTRA™ Advance NDC, Reference Manual
2-155
State Tables
z013 – Data Copy and Compare State
Table
Entry
No. of
Chars
4
Contents
Description
3
Buffer ID1 Greater Than
Buffer ID2 Next State
Number
(Base 10, range 000‐254 or
256‐999)
(Base 36, range 000‐254 or
256‐ZZZ)
Used only for data comparisons.
State number to which the SST proceeds when the data value in
Buffer ID 1 is greater than the data value in Buffer ID 2
5
3
Buffer ID1 Less Than
Buffer ID2 Next State
Number
(Base 10, range 000‐254 or
256‐999)
(Base 36, range 000‐254 or
256‐ZZZ)
Used only for data comparisons
State number to which the SST proceeds when the data value in
Buffer ID 1 is less than the data value in Buffer ID 2.
6
3
Must be 000
Reserved
7
3
Must be 000
Reserved
8
3
Must be 000
Reserved
9
3
Must be 000
Reserved
Copy Operations
The following conventions apply to 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.
2-156
APTRA™ Advance NDC, Reference Manual
State Tables
z013 – Data Copy and Compare State
Compare Operations
2
Buffer comparison is done character by character using the ASCII
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.
APTRA™ Advance NDC, Reference Manual
2-157
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
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.
2-158
APTRA™ Advance NDC, Reference Manual
2
State Tables
z014 – Cash Deposit Handling State
Table 2-89
z014 – Offline Encash/Refund State
Table
Entry
No. of
Chars
Contents
Description
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
(000 ‐ Z99)
This screen is displayed while the items are being encashed or
refunded
5
3
Please Remove Items
Screen
(000 ‐ Z99)
This screen is displayed when the Cash Acceptor has returned
items to the cardholder. Only used in the Refund Function.
6
3
Retracting Items Screen
(000 ‐ Z99)
This screen is displayed during the Retract operation, which occurs
if the Presented items are not taken before Timer 78 expires, and
Option 45 is configured to enable Retract. Only used in the Refund
Function.
7
3
Extension State 1
(000‐ZZZ)
State number for extension 1
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.
APTRA™ Advance NDC, Reference Manual
2-159
State Tables
z014 – Cash Deposit Handling State
Table 2-90
Extension 1 to State z014
Table
Entry
No. of
Chars
Contents
Description
1
1
State Type
‘Z’ (5AH)
2
3
Good Next State Number
(000‐ZZZ)
State number the SST goes to after a successfully completed
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
Number (000‐ZZZ)
State number the SST goes to when an error occurs during either
the encash operation or the refund operation
4
3
Timeout Next State
Number
(000‐ZZZ)
State number the SST goes to if items are not taken. If retract is
enabled, this follows after completion of the retract operation
completes, 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.
2-160
APTRA™ Advance NDC, Reference Manual
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 when the Enter key is
pressed, the Cancel key or a Next State FDK is pressed or a time‐out
occurs. The Enter key is defined by table entry 4 of extension 1. The
Clear key is always active, if 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‐48, or can be installed locally.
For details of AppendBuffer.xml, refer to the APTRA Advance NDC,
Developer’s Guide.
Table 2-91
z017- Note Mix Selection State
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
ʹzʹ ‐ Master Expansion State
2
3
Sub Type
ʹ017ʹ ‐ Note Mix Selection State
3
3
Screen Number
(Range 000‐Z99)
Number of display screen prompting an amount
entry.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-161
State Tables
z017- Note Mix Selection State
Table
Entry
Number of
Characters
4
Contents
Description
3
Extension State 1
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension 1
See “Extension 1 to State z017” on page 2‐162
For more information about extension states, see
“Extension States” on page 2‐5.
5
3
Extension State 2
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension 2
See “Extension 2 to State z017” on page 2‐164
6
3
Extension State 3
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension 3
See “Extension 3 to State z017” on page 2‐166
7
3
Extension State 4
(Base 10 range 000‐254 or 256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number for extension 4
See “Extension 4 to State z017” on page 2‐167
8
3
Reserved (000)
Reserved for future use.
9
3
Reserved (000)
Reserved for future use.
Table 2-92
Extension 1 to State z017
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Timeout Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
fails to enter an amount within the specified time
limit.
3
3
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
presses the Cancel key.
4
3
Enter Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if the consumer
presses the Enter key.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-162
APTRA™ Advance NDC, Reference Manual
State Tables
z017- Note Mix Selection State
Table
Entry
Number of
Characters
5
Contents
Description
3
No Cassette Types Available
Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number to which the SST goes if no cassette
type values specified in “Extension 3 to State z017”
are available.
This can occur because of the following:

No dispenser is present

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
(Range 000‐255)
Specifies the time‐out value for this state:
ʹ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.
APTRA™ Advance NDC, Reference Manual
2-163
State Tables
z017- Note Mix Selection State
Table 2-93
Extension 2 to State z017
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
Next State FDK Flags
(Range 000‐255)
This field specifies the FDKs used to select the next
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
(Range 000‐255)
This field specifies the FDKs used to select NDC
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
Number
(Range 000‐Z99)
Overlay screen to set the cursor position and
optionally defines the initial display format before
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.
2-164
APTRA™ Advance NDC, Reference Manual
State Tables
z017- Note Mix Selection State
Table
Entry
Number of
Characters
5
3
Contents
Description
Language Dependency and
Overlay Screen Flag
(Range 000‐003)
This flag determines if the screens defined in table
entry 4 of this extension state and table entries 2 to
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
(Range 000‐002)
This field determines which buffer the amount
entered will be stored in, as follows:
000 ‐ Amount buffer
001 ‐ Buffer B
002 ‐ Buffer C
7
3
Note Mix Buffer
(Range 000‐002)
This field determines which buffer the note mix
entered will be stored in, as follows:
000 ‐ Not stored
001 ‐ Buffer B
002 ‐ Buffer C
See Table Note 87 and Table Note 88
8
3
Maximum Number of Notes
(Range 000‐200)
This field determines the maximum number of
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 89
9
3
Must be 000
Reserved
Table Note 87: 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 a cassette type, for example CCC represents cassette type
3.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-165
State Tables
z017- Note Mix Selection State
Table Note 88: 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 89: In the Transaction Reply, only two digits are
available for each note type in the dispense function.
Table 2-94
Extension 3 to State z017
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
FDK A
(Range 000‐ZZZ)
3
3
FDK B
(Range 000‐ZZZ)
Depending on table entries 2 and 3 of “Extension 2
to State z017”, contains either a next state number
or an NDC cassette type.
4
3
FDK C
(Range 000‐ZZZ)
5
3
FDK D
(Range 000‐ZZZ)
6
3
FDK F
(Range 000‐ZZZ)
7
3
FDK G
(Range 000‐ZZZ)
8
3
FDK H
(Range 000‐ZZZ)
9
3
FDK I
(Range 000‐ZZZ)
If the FDK specifies a next state, the range is as
follows:

Base 10 range 000‐254 or 256‐999

Base 36 range 000‐254 or 256‐ZZZ
If the FDK specifies an NDC cassette type, the valid
range is 1‐7 and the following apply:

If the specified cassette type is not present in the
dispenser or all cassettes of that type are in a fatal
condition, the FDK is not enabled

If the cassette type is in the range 5‐7, Enhanced
Configuration option 76 must be set to 001

If the cassette type is outside the valid range, the
FDK is not enabled.
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.
2-166
APTRA™ Advance NDC, Reference Manual
State Tables
z017- Note Mix Selection State
Table 2-95
Extension 4 to State z017
Table
Entry
Number of
Characters
Contents
Description
1
1
State Type
‘Z’
2
3
FDK A Overlay Screen
(Range 000‐Z99)
3
3
FDK B Overlay Screen
(Range 000‐Z99)
Specifies the overlay screen to display when table
entry 3 of “Extension 2 to State z017” specifies the
FDK as a note selection FDK.
4
3
FDK C Overlay Screen
(Range 000‐Z99)
5
3
FDK D Overlay Screen
(Range 000‐Z99)
6
3
FDK F Overlay Screen
(Range 000‐Z99)
7
3
FDK G Overlay Screen
(Range 000‐Z99)
8
3
FDK H Overlay Screen
(Range 000‐Z99)
9
3
FDK I 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
screens).
The FDK is not enabled and the overlay screen is
not applied if table entry 5 of “Extension 1 to State
z017” is 002 or 003 (do not use overlay screens). In
this situation, a textual representation of the
selected amount is displayed next to the FDK in the
current font. The displayed amount is the value of
the note in the cassette type specified in “Extension
3 to State z017”.
If the FDK is not a note selection FDK or the FDK is
not enabled, no overlay screen or textual
representation of the amount is displayed.
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.
APTRA™ Advance NDC, Reference Manual
2-167
State Tables
& - Barcode Read State
& ‐ Barcode Read State
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‐48. 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.
Table 2-96
& - Barcode Reader State
Table
Entry
No. of
Chars
Contents
Description
1
1
‘&’ (26H)
State Type
2
3
Screen Number (Range
000‐Z99)
Display screen prompting the consumer to scan a barcode.
3
3
Good barcode Read State
Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number the SST goes to if a barcode has successfully been
read and no Barcode Filter matches, or there is no exit defined
for the Barcode Filter Index in the Extension States.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-168
APTRA™ Advance NDC, Reference Manual
2
State Tables
& - Barcode Read State
Table
Entry
No. of
Chars
4
3
5
6
7
3
3
3
Contents
Description
Cancel Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if the barcode scan was
cancelled by the customer.
Error Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if there is a problem reading
the barcode, for example a barcode reader hardware or barcode
reader configuration error.
Timeout Next State Number
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if the barcode scan times out.
Barcode Data Destination
(0‐7)
Destination buffer for barcode data
See Table Note 90
See Table Note 91
See Table Note 92
1
Track3 buffer (default) (max 106 bytes)
2
Track1 buffer (max 78 bytes)
3
Track2 buffer (max 39 bytes)
4
General Purpose buffers A and B (max 64 bytes)
5
General Purpose buffers B and C (max 64 bytes)
6
General Purpose buffers C and A (max 64 bytes)
7
Barcode reader buffer identified by the character ‘e’ (max
size limited by message size)
8
Amount buffer (max 8 or 12 bytes, depending on
configuration).
See Table Note 93, Table Note 94, and Table Note 95.
8
3
Active Cancel FDK key mask
(Range 0‐255)
The FDK keys(s) enabled to cancel the barcode scanning
process. The Cancel key on the PINPad will always be enabled if
a Cancel exit is defined.
9
3
Extension State 1
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Extension state 1 allows additional parameters to be added in
the future, as all parameters in extension states 2 to N contain
the Barcode Filter exit values.
For more information about extension states, see “Extension
States” on page 2‐5.
Table Note 90: 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.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-169
State Tables
& - Barcode Read State
Table Note 91: 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 92: 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 93: 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 94: 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 95: When a barcode is successfully read it is placed in
the buffer specified by Barcode Data Destination. If the specified
destination buffer is unknown, the SST will go to Error Next State
Number.
Table Note 96: Table 2-97
Extension 1 to State &
Table
Entry
No. of
Chars
Contents
Description
1
1
State Type
‘Z’
2
3
Reserved
Must be ‘000’
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
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Extension state, ‘000’ if there is no extension state.
For more information about extension states, see “Extension
States” on page 2‐5.
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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-170
APTRA™ Advance NDC, Reference Manual
State Tables
& - Barcode Read State
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.
Table 2-98
Extensions 2—8 to State &
Table
Entry
No. of
Chars
Contents
Description
1
1
State Type
‘Z’
2
3
Next State for a Barcode
Filter match with index =
((Extension State n ‐ 2)*7).
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if the Barcode matches the
Barcode Filter with index equal to ((Extension state n ‐ 2)*7). If
this value is ‘000’ the Good Barcode Read Next State Exit is
taken when the filter matches.
3
3
Next State for a Barcode
Filter match with index =
((Extension State n ‐ 2)*7)+1.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if the Barcode matches the
Barcode Filter with index equal to
((Extension state n ‐ 2)*7)+1.
If this value is ‘000’ the Default Barcode Read Next State Exit is
taken when the filter matches.
4
3
Next State for a Barcode
Filter match with index =
((Extension State n ‐ 2)*7)+2.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if the Barcode matches the
Barcode Filter with index equal to
((Extension state n ‐ 2)*7)+2.
If this value is ‘000’ the Default Barcode Exit is taken when the
filter matches.
5
3
Next State for a Barcode
Filter match with index =
((Extension State n ‐ 2)*7)+3.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if the Barcode matches the
Barcode Filter with index equal to
((Extension state n ‐ 2)*7)+3.
If this value is ‘000’ the Good Barcode Exit is taken when the
filter matches.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
2-171
State Tables
& - Barcode Read State
Table
Entry
No. of
Chars
6
Contents
Description
3
Next State for a Barcode
Filter match with index =
((Extension State n ‐ 2)*7)+4.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if the Barcode matches the
Barcode Filter with index equal to ((Extension state n ‐ 2)*7)+4.
If this value is ‘000’ the Good Barcode Exit is taken when the
filter matches.
7
3
Next State for a Barcode
Filter match with index =
((Extension State n ‐ 2)*7)+5.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if the Barcode matches the
Barcode Filter with index equal to
((Extension state n ‐ 2)*7)+5.
If this value is ‘000’ the Good Barcode Exit is taken when the
filter matches.
8
3
Next State for a Barcode
Filter match with index =
((Extension State n ‐ 2)*7)+6.
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
State number that the SST goes to if the Barcode matches the
Barcode Filter with index equal to ((Extension state n ‐ 2)*7)+6.
If this value is ‘000’ the Good Barcode Exit is taken when the
filter matches.
9
3
Next Extension State
(Base 10 range 000‐254 or
256‐999)
(Base 36 range 000‐254 or
256‐ZZZ)
Extension State, ‘000’ signifies there are no more extension
states.
For more information about extension states, see “Extension
States” on page 2‐5.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-172
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‐99
Entry Conditions for the Time-Out State
Entry
Condition
Description
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-173
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‐100, “Action Taken on Selection of FDK B for Each Entry
Condition”, is taken for the associated condition, described in
Table 2‐99, “Entry Conditions for the Time‐Out State” on
page 2‐173.
Table 2-100
Action Taken on Selection of FDK B for
Each Entry Condition
Entry
Condition
Action
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‐96
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‐109
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‐117
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‐101, “Action Taken
on Selection of the Cancel Key for Each Entry Condition”, is taken
for the associated condition described in Table 2‐99, “Entry
Conditions for the Time‐Out State” on page 2‐173.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-174
APTRA™ Advance NDC, Reference Manual
State Tables
Time-Out State
Table 2-101
Action Taken on Selection of the Cancel
Key for Each Entry Condition
Entry
Condition
Action
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‐96
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‐109
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‐117
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-175
State Tables
Time-Out State
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
2-176
APTRA™ Advance NDC, Reference Manual
Table of Contents
Screen Data
Chapter 3
Screen Data
Overview
3‐1
The Screen Interface
Customer Screens
Customer Screen Groups
Reserved Screens
3‐2
3‐2
3‐3
3‐4
Types of Reserved Screen
C – Cardholder Display
Screen ‘C00’
Screen ‘C01’
Screen ‘C02’
Screen ‘C03’
Screen ‘C04’
Screen ‘C05’
Screen ‘C06’
Screen ‘C07’
Screen ‘C20’
G – Graphic Pictures
K – Extended Screen Controls
Receipt: ‘K01’
Receipt: ‘K09’
Journal: ‘K02’
Journal: ‘K10’
Receipt and Journal: ‘K07’
Receipt and Journal: ‘K08’
Statement: ‘K03’
Control Sequences for Receipt, Journal and Statement
Printers
L – Logos
M – Supervisor Menus
Editing the Contents of Reserved Screens
Reserved Screen Constraints
3‐5
3‐6
3‐6
3‐6
3‐6
3‐6
3‐6
3‐7
3‐7
3‐7
3‐7
3‐8
3‐8
3‐9
3‐10
3‐10
3‐10
3‐11
3‐11
3‐11
3‐11
3‐12
3‐12
3‐13
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
Operator Interface Display Characters
Control Characters
Track 1 Name Display
ISO Format Cards
VISA Format Cards
Auto Select Backwards Search
Auto Select Forwards Search
ABA Format Cards
Name Display
Control Codes for Special Features
Voice
Pre‐recorded Messages
Digital Audio Control for Voice Guidance
Screen Blinking and Colour Control
Changing Display During the Idle Loop
Select Primary Character Set
Select Secondary Character Set
Left Margin Control
Set Display Mode Control
Logo Control
Picture Control
Display Image Files Control
Lift Cheque Image Control
Bunch Cheque Image Display Control
Bunch Cheque Codeline Display Control
Bunch Cheque Amount Display Control
Bunch Cheque Value Display Control
Display Dynamic Text Dictionary Control Sequence
Dynamic Button Control
Syntax of Conditional Expressions
Dynamic Text Control
Animation and Digital Video
International Currency Display Format
Currency Echo Example
Example of Default Echo Display Format
Multi‐Language Screens
Multi‐Language Screen Numbering
Extended Screen Groups
Example Screen Group Definitions
Redefining Reserved Screens
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
3‐14
3‐15
3‐16
3‐18
3‐19
3‐19
3‐19
3‐20
3‐20
3‐20
3‐20
3‐21
3‐22
3‐23
3‐27
3‐30
3‐31
3‐31
3‐32
3‐32
3‐33
3‐33
3‐34
3‐35
3‐35
3‐37
3‐37
3‐38
3‐39
3‐42
3‐43
3‐43
3‐44
3‐45
3‐46
3‐46
3‐48
3‐48
3‐48
3‐49
3‐51
Table of Contents
Screen Data
Displaying Pictures
Picture Resolution
Guidelines for Pictures
3‐52
3‐52
3‐52
Screen Reset
3‐53
Supervisor Settlement Screens
Using the Front or Rear Interface for Settlement
Rear Settlement and International Security (DAPI‐7)
Supervisor Settlement Transactions
Valid Commands
Transactions Parameter Screens (C09–C19)
3‐54
3‐54
3‐54
3‐55
3‐55
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
Overview
C
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
Customer Screens
5
6
7
8
3
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
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 more details, see the “Screen/Keyboard Data Load”
section in Chapter 10, “Central to Terminal Messages”.
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
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
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.
3
3
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 see “Screen Numbers”
on page 2‐5 and “Multi‐Language Screens” on page 3‐48.
For examples, see “Multi‐Language Screens” on page 3‐48.
Reserved Screens
3
A reserved screen is a screen that is already defined in the resrvd.def
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 display correctly. To define consumer screens
locally, refer to “Specifying Local Customisation Data” in Chapter 5
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 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”.
C – Cardholder Display
3
Screen type ‘C’, with the exception of screens C09 and C10–C19, is
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’
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
3
Screen Data
Types of Reserved Screen
new transaction reply from Central. For details, see the “Terminal
Functions for Transaction Completion” on page 10‐65. 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‐109) 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‐29), 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.
G – Graphic Pictures
3
Screen type ‘G’ is reserved for graphic pictures. For details, see
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 1000 pictures can be displayed using the Picture Control
command. For details, see the “Control Codes for Special Features”
section on page 3‐20.
K – Extended Screen
Controls
Screen ‘K00’ contains the screen control sequence to display the
FIT‐dependent logo.
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 in Chapter 5,
“Printer Data”. By default, screen ‘K08’ is not defined.
Screens ‘K09’ and ‘K10’ may be edited to include the “Define
Downloadable Bit Image” control sequence (see page 5‐16), which
identifies an image and downloads it to the printer memory for
processing when the “Print Downloadable Bit Image” command 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’
Table 3-2
Screen Contents ‘K01’
3
1B 5B 31 36 33 75
Top margin 163/144 inch
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’
Table 3-3
Screen Contents ‘K09’
3
1B 65 31
Print position of HRI barcode characters
1B 77 33
Width of barcode
1B 68 31 36 32
Height of barcode
1B 2A 31 <image
filename> 1B 5C
Define Downloadable Bit Image
Journal: ‘K02’
Table 3-4
Screen Contents ‘K02’
3
1B 5B 30 72
Line spacing 7.6 lpi
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’
Table 3-5
Screen Contents ‘K010’
3
1B 65 31
Print Position of HRI barcode characters
1B 77 33
Width of barcode
1B 68 31 36 32
Height of barcode
1B 2A 31 <image
filename> 1B 5C
Define Downloadable Bit Image
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’
Table 3-6
Screen Contents ‘K07’
3
Path to the Financial Institution Receipt and
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’
Table 3-7
Screen Contents ‘K08’
1B 26 <code page
filename> 1B 5C
3
Define Custom Code Page. By default, this is
not defined.
Statement: ‘K03’
Table 3-8
Screen Contents ‘K03’
3
1B 5B 31 34 34 75
Top margin 144/144 inch
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
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.
3
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
ASCII representation of a number in the range 0‐7.
3
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
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
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
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.
L – Logos
3
Screen type ‘L’ is reserved for logos. Screens ‘L00’ to ‘L15’ are
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.
M – Supervisor Menus
3
Screen type ‘M’ is reserved for Supervisor menus. They contain
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
3
3
3
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.
Editing the Contents of
Reserved Screens
3
The reserved screens are defined in a plain ASCII text file named
resrvd.def, which you can edit. This file may be used as a source for
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
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.
Cardholder Screen:
Display Characters
Table 3-9
Cardholder Screen: Character Sets
The cardholder screen can display any character contained in the
following character sets:
3
Character Set ID
Number of
Characters
Designator
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
3
Screen Data
Formatting Rules for Cardholder Display Screens
The following character sets contain customer‐defined characters.
Table 3-10
Character Sets with Customer-Defined
Characters
Character Set ID
Number of
Characters
Designator
Customer graphics 2 (Arabic)
64
‘7’
Chinese 1
64
‘:’
Chinese 2
64
‘;’
Double size character graphics
(Arabic)
64
‘B’
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”.
Operator Interface Display
Characters
Table 3-11
Enhanced Operator Interface: Character
Set
The enhanced operator interface can display any character
contained in the following character set:
3
Character Set ID
Number of
Characters
Designator
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
Control Characters
Table 3-12
Cardholder Screen: Control Character
Functions
3
The function of each control character for cardholder screen activity
is defined in the following table:
Character
ASCII Hex
Code
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.
Function
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
Character
ASCII Hex
Code
Function
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).
Track 1 Name Display
3
For display purposes, Track 1 must contain the following data, in
one of two formats:
Table 3-13
Track 1 Data Formats
Format A
Format B
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.
Control Codes for Special
Features
Table 3-14
Screen Display Special Features
3
Special features can be accessed by using the ‘ESC’ character and
supplementary control codes. The following table provides links to
details of the control code:
Feature
Introducer
Identifier
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
(see 3‐35)
ESC ‘P’
‘t’
Bunch cheque codeline display control
(see 3‐37)
ESC ‘P’
‘u’
Bunch cheque amount display control
(see 3‐37)
ESC ‘P’
‘v’
Bunch cheque value display control
(see 3‐38)
ESC ‘P’
‘w’
Display dynamic text dictionary control
(see 3‐39))
ESC ‘P’
‘x’
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
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
Transaction Request message is sent to Central.
Card Taken (Message 8) The message starts as soon as a card is
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
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
Digital Audio Control in Screen Display
Character
Description
Number of
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
flag
Number of messages to be played (0‐3)
This parameter is included for migration
purposes only and is ignored. Only one
message can be played for each voice
control sequence.
1
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
3
3
3
3
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‐51.
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
Digital Audio Control for Voice Guidance
Character
Description
Number of
Characters
ESC ʹPʹ
Device control string introducer
2
ʹ0ʹ
Control string ID
1
Variable
Message number, range 00 ‐ 999
See Table Note 1
Var (2 ‐ 3)
ʹ;ʹ
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
Characters
Character
Description
Parameter
flag
A digit if parameters follow (for example,
1)
1
ʹ;ʹ
Separator
See Table Note 2
1
Voice
guidance
variable
Audio placeholder data with a fixed or
dynamic format
See Table Note 2, Table Note 3, Table Note
4 and Table Note 5
1
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
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
3
Screen Data
Formatting Rules for Cardholder Display Screens
If the second screen does contain 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
Screen Blinking and Colour Control
Character
Description
Number of
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
Blinking Commands
Resets colours to defaults and blinking off
00
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
Foreground Colour Commands
Intensity
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
Background Colour Commands
Intensity
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
Default Foreground Colour Commands
Intensity
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
Default Background Colour Commands
Intensity
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
Change Display While Idle
Character
Description
Number of
Characters
ESC ‘[‘
Control Sequence Introducer
2
Variable
Delay Time in 100 millisecond intervals
(000‐999)
3
‘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
Select Primary Character Set
Character
Description
Number of
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
Select Secondary Character Set
Character
Description
Number of
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
Set Left Margin Position
Character
Description
Number of
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
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
3
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
Select Logo
Character
Description
Number of
Characters
ESC ‘P’
Device Control String Introducer
2
‘1’
Control String ID
1
Parameter
The logo number to be displayed in the range
00‐99.
2
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
1000 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
following control string:
Table 3-28
Picture Control Command
Pictures can be displayed with the
Character
Description
Number of
Characters
ESC ‘P’
Device Control String Introducer
2
‘2’
Control String ID
1
parameter
The picture number to be displayed. Range
0‐999.
Var (1‐3)
ESC ‘\’
String Terminator
2
3
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 1000 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
Display Image File Command
Character
Description
Number of
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
Display Lifted Cheque Image Command
Character
Description
Number of
Characters
ESC ‘P’
Device Control String Introducer
2
‘S’
Control String ID
1
(x,y)
x = Width Scaling
y = Height Scaling
as percentages of total width/height
Var
Image Path
Path to directory where image is stored.
Must be the same directory as specified
when the cheque processor was configured.
Var
‘/’
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‐134
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
Bunch Cheque Image Display Control
Character
Description
Number of
Characters
ESC ‘P’
Device Control String Introducer
2
‘t’
Control String ID
1
Side
The side of the cheque to display as follows:
0 ‐ the front
1 ‐ the back
1
‘;’
Separator
1
x
Defines the scaling used for the width of the
image as a percentage of the display width
Var
‘;’
Separator
1
y
Defines the scaling used for the height of the
image as a percentage of the display height
Var
‘;’
Text terminator
1
Image
selector
Identifies which of the multiple images of a
cheque to display using an index from the
list of images requested for each cheque
2
‘;’
Separator
1
Cheque ID
Specifies the cheque to display
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
3
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
Bunch Cheque Codeline Display Control
Character
Description
Number of
Characters
ESC ‘P’
Device Control String Introducer
2
‘u’
Control String ID
1
Cheque ID
Specifies the cheque to display
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
3
ESC ‘\’
String Terminator
2
Bunch Cheque Amount Display Control
3
This displays the amount for a cheque during bunch cheque
acceptance.
Table 3-33
Bunch Cheque Amount Display Control
Character
Description
Number of
Characters
ESC ‘P’
Device Control String Introducer
2
‘v’
Control String ID
1
Cheque ID
Specifies the cheque to display
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
3
;
Separator
1
Amount
screen
Selects the screen used to define the display
of the amount
3
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
Character
Description
Number of
Characters
;
Separator
1
Amount
selector
Specifies whether to display the Courtesy
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
3
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
Bunch Cheque Value Display Control
Character
Description
Number of
Characters
ESC ‘P’
Device Control String Introducer
2
‘w’
Control String ID
1
Value
Selector
Specifies the value to display, as follows:
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
3
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
Character
Description
Number of
Characters
;
Separator
1
Value
Format
Screen
Selects the overlay screen that defines how
the value is to be displayed
If this is set to 000, no formatting is applied
3
ESC ‘\’
String Terminator
2
Displaying the Amount Buffer Value When the Value Selector is
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.
3
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
Bunch Cheque Value Display Control sequence is the following:
3
<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
Display Dynamic Text Dictionary Control
Character
Description
Number of
Characters
ESC ‘P’
Device Control String Introducer
2
‘x’
Control String ID
1
Dictionary
ID
Dictionary identifier
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
3
‘;’
Separator
1
Enumerated
value list 0
Defines one or more enumerated values to
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
Var
‘;’
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
Characters
Character
Description
Display text
0
The text associated with the previous
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
Var
‘;’
Text terminator
1
Enumerated
value list 1
Defines one or more enumerated values to
which the text following the next Separator
relates
Var
‘;’
Separator
1
Display text
1
The text associated with the previous
enumerated value.
Var
‘;’
Text terminator
1
Enumerated
value list n
Defines one or more enumerated values to
which the text following the next Separator
relates
See Table Note 7
Var
‘;’
Separator
1
Display text
n
The text associated with the previous
enumerated value
See Table Note 7
Var
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
the screen that uses the dictionary value, as shown in the following
examples:
3
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
Dynamic Button Definition
Character
Description
Number of
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
Character
Description
Number of
Characters
‘;’
Separator
1
Variable
Conditional expression
If none is specified, the button is always
enabled
Var
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
Syntax of Conditional Expressions
Query
Type
Syntax
To check whether two devices
are both available
Simple
E&G
To check whether either the cash
handler or receipt printer is
available
Simple
E|G
To check that the cash handler is
available but the receipt printer
is not available
Simple
E&!G
To check whether cassette type 1
AND cassette type 2 are
available OR cassette type 3 is
available
Complex
E001&E002|E003
or
(E001&E002)|E003
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
Dynamic Text Definition
Character
Description
Number of
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
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
3
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
Video and Animation File Formats
Extension
Description
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
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.
International Currency
Display Format
3
The Amount Display screen is an overlay screen which you assign
and which is referenced from an amount entry state. This feature
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
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).
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
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
Currency Echo Example
LIRA 0,000
Initial display before amount entry by cardholder
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 the “Configuration Parameters
Load” section in Chapter 10, “Central to Terminal Messages”. 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
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
3
Screen Data
Formatting Rules for Cardholder Display Screens
Table 3-41
Default Echo Display Format
bbbbb$b0.00
Initial default display before amount entry by
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:



Multi‐Language Screen
Numbering
3
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.
The first group must start at ‘000’ or ‘0000’, and contain those
screens for which language selection is not possible, that is, screens
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‐79)
“V ‐ Language Select From Card State” (page 2‐73)
“m ‐ PIN & Language Select State” (page 2‐89).
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
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
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
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,
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:
3
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
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:
3
Language A ‐ ‘0000’
Language B – ‘2500’
Language C – ‘5000’
Language D – ‘7500’
The screen group size defined in state ‘V’ would be ‘025’,
representing ‘2500’.
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
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
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
3
Screen Data
Multi-Language Screens
Redefining Reserved
Screens
When multi‐language screens are supported, you must redefine the
reserved screens used during cardholder transactions as follows:
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
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.
Picture Resolution
3
Guidelines for Pictures
3
The first picture displayed determines the amount of stretching that
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
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
3
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.
Using the Front or Rear
Interface for Settlement
3
On a front‐access SST, the cardholder display and keyboard or the
front operator keyboard can be used to perform the transactions. On
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)
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
3
Screen Data
Supervisor Settlement Screens
Supervisor Settlement
Transactions
3
When the operator selects the Supervisor Transactions function at
the SST, screens C09–C19 are checked for valid Supervisor
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
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‐33.
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.
Transactions Parameter
Screens (C09–C19)
3
The following fields are defined for screens C09 and C10–C19. You
must ensure that the field data is correct and within the permitted
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 Definitions for Screens C09–C19
Field
Length (Bytes)
Content/Meaning
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’.
Var (0‐10)
Amount Buffer Flags ‐ length is that of the
number of transactions specified by field ‘a’.
1 byte for each transaction specified
n
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
Physical Keyboards
Touch Screen Keyboards
FDK Emulation
Full Touch Screen
Associating Screens and Keyboards for FDKs
Keyboard Mapping Examples
Time‐Out State Example
Information Entry State Example
4‐2
4‐2
4‐2
4‐2
4‐4
4‐4
4‐6
4‐6
4‐7
States and Keyboards
Associated Keyboards for FDKs
Secure PIN Entry and Keyboards
Keyboards in Operation
4‐8
4‐9
4‐9
4‐9
Standard Keyboard Layouts
Transaction Processing
Front Interface: Supervisor Mode
Encryption Key Entry
Secure Key Entry
Rear Interface: Operator Keyboard Layout
4‐10
4‐10
4‐12
4‐13
4‐13
4‐14
Defining Full Touch Screens
Touch Areas
Generic Keyboard Example
Calculating Full Touch‐Screen Positions
The Unary Co‐Ordinate System
Co‐ordinate Format
Conversion to IEEE Example
4‐16
4‐16
4‐16
4‐17
4‐17
4‐18
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
Overview
D
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.
Physical Keyboards
Touch Screen Keyboards
4
4
A physical keyboard consists of the keypad and FDKs. It is
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
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
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
4
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 the “Screen/Keyboard Data
Load” section in Chapter 10, “Central to Terminal Messages”.
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
FDK I Touch Area
FDK A Touch Area
FDK H Touch Area
FDK B Touch Area
FDK G Touch Area
FDK C Touch Area
FDK F Touch Area
FDK D Touch Area
B
C
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
Emulated FDKs: Touch Area
Measurements
Measurement
Reference
Fraction/Screen
Height
Fraction/Screen
Width
Corresponding
Row
A
5/16ths
5
B
2/16ths
2
C
1/16th
1
Corresponding
Column
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
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.
Associating Screens and
Keyboards for FDKs
Associated keyboards and downloadable keyboard definitions are
supported for physical and emulated FDKs only.
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
4
Keyboard Data and Layouts
The Keyboard Interface
Table 4-2
FDKs, Key Codes and CEN-XFS
equivalents
FDK
Key Position Code
Default Key Code
CEN-XFS Code
FDK
Key Position Code
Default Key Code
CEN-XFS Code
I
17
FA
WFS_PIN_FK_FDK01
A
18
F6
WFS_PIN_FK_FDK05
H
19
F9
WFS_PIN_FK_FDK02
B
20
F5
WFS_PIN_FK_FDK06
G
21
F8
WFS_PIN_FK_FDK03
C
22
F4
WFS_PIN_FK_FDK07
F
23
F7
WFS_PIN_FK_FDK04
D
24
F3
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
Mapping CEN-XFS Keys
Number of
Characters
Supported
Range in
Advance NDC
Key
position
2
17 ‐ 24
Identifies the CEN‐XFS key
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.
Data
Description
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.
Keyboard Mapping
Examples
The following examples illustrate keyboard mapping in the
Time‐Out and Information Entry states.
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
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
4
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‐29) 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
Mapping CEN-XFS Example
Key Enabled (Key position, Default Key Code)
Mapped to...
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
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
4
Keyboard Data and Layouts
States and Keyboards
Associated Keyboards for
FDKs
Secure PIN Entry and
Keyboards
4
4
If a screen number referenced in one of these state tables is
associated with a keyboard layout, the layout is set up. Options such
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
not secure, any keyboard layout specified for secure PIN entry must
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.
Keyboards in Operation
4
If, during a transaction, a user‐defined keyboard is about to be used
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.
Transaction Processing
Figure 4-2
Standard Keyboard Layout for Cardholder
Transactions
4
The following illustration shows the layout of the standard
cardholder keyboard during transaction processing, defined by
screen M06:
FDK ‘I’
1
2
3
CLR
FDK ‘A’
FDK ‘H’
4
5
6
CNL
FDK ‘B’
FDK ‘G’
7
8
9
ENT
FDK ‘C’
FDK ‘F’
0
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
4-10
APTRA™ Advance NDC, Reference Manual
FDK ‘D’
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
Numeric Autoactivators (PIN)
1
WFS_PIN_FK_1
2
WFS_PIN_FK_2
3
WFS_PIN_FK_3
4
WFS_PIN_FK_4
5
WFS_PIN_FK_5
6
WFS_PIN_FK_6
7
WFS_PIN_FK_7
8
WFS_PIN_FK_8
9
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’)
WFS_PIN_FK_FDK01
FF (Clear)
WFS_PIN_FK_CLEAR
F6 (FDK ‘A’ )
WFS_PIN_FK_FDK05
F9 (FDK ‘H’ )
WFS_PIN_FK_FDK02
F2 (Cancel)
WFS_PIN_FK_CANCEL
F5 (FDK ‘B’ )
WFS_PIN_FK_FDK06
F8 (FDK ‘G’ )
WFS_PIN_FK_FDK03
F1 (Enter)
WFS_PIN_FK_ENTER
F4 (FDK ‘C’ )
WFS_PIN_FK_FDK07
F7 (FDK ‘F’ )
WFS_PIN_FK_FDK04
F3 (FDK ‘D’ )
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
Front Interface: Supervisor
Mode
4
The layout of the cardholder keyboard during Supervisor mode is
shown in the following illustration. If you define an invalid
keyboard for Supervisor mode, it is ignored and this keyboard is
enabled.
Figure 4-3
Supervisor Mode: Keyboard Layout
FDK ‘F’
1
2
3
CLR
4
5
6
CNL
7
8
9
ENT
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)
WFS_PIN_FK_CLEAR
F1 (Enter)
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
Encryption Key Entry
4
Figure 4-4
Encryption Key Entry Keyboard Layout
The cardholder keyboard layout for encryption key entry is shown
in the following illustration. If you define an invalid keyboard for
encryption key entry, it is ignored and this keyboard is enabled.
A
1
2
3
B
C
4
5
6
D
E
7
8
9
CLR
ENT
0
F
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
Encryption Key Entry Autoactivators (PIN)
F1 (Enter)
WFS_PIN_FK_ENTER
FF (Clear)
WFS_PIN_FK_CLEAR
F1 (Enter)
WFS_PIN_FK_ENTER
Table 4-9
Encryption Key Entry Autoactivators (TTU)
F1 (Enter)
WFS_TTU_CK_ENTER
FF (Clear)
WFS_TTU_CK_CLEAR
Secure Key Entry
4
Figure 4-5
Cardholder Keyboard: Secure Key Entry
Layout
F1 (Enter)
WFS_TTU_CK_ENTER
The following layout shows the positions for the cardholder
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.
1
2
3
A
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
Rear Interface: Operator
Keyboard Layout
The operator keyboard layout for the rear interface is as follows:
4
Figure 4-6
Operator Keyboard Layout
Clear
1
2
3
CLR
4
5
6
CNL
7
8
9
ENT
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
Non-Numeric Autoactivators (TTU)
FF (Clear)
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.
Touch Areas
Table 4-11
Touch Area Definition
Each touch area is defined as follows:
4
Label
No. Of
Chars
Range
Description
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
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
4
Keyboard Data and Layouts
Defining Full Touch Screens
Calculating Full
Touch‐Screen Positions
Touch screen definitions are supported for legacy definitions. If you
want to define new ones, this section explains the format of the
co‐ordinates that are used to define touch areas on the screen and
how to calculate them.
4
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
Exponent
Sign
Mantissa
24 23
31 30
byte 0
8 7
16 15
byte 1
byte 2
0
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:
N = 2
 exp – 127 
  1 +  mant  2
– 23

where:
exp is a value in the range 0‐255
mant is a value in the range 0‐2
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
B = mant  2
– 23
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
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:
0.635 = 2
–1
 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
4
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
Exponent
Sign
Mantissa
0 1 1 1 1 1 1 0
24 23
31
0
byte 0
4
To calculate the mantissa (mant):
B = mant  2
– 23
mant = 0.27  2
= 0.27
23
= 2264924 = 228F5C hex
mant = 0100010 10001111 01011100 bin
Figure 4-10
Calculate Mantissa
Exponent
Sign
Mantissa
0 1 0 0 0 1 0 1 0 0 0 1 1 1 1 0 1 0 1 1 1 0 0
24 23
31
byte 1
5
8 7
16 15
byte 2
0
byte 3
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
Exponent
Sign
Mantissa
0
24 23
31
0
byte 0
6
Putting all these together gives the following:
Figure 4-12
Calculate Co-ordinate
Exponent
Sign
Mantissa
24 23
31 30
byte 0
8 7
16 15
byte 1
byte 2
0
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
Eight‐Character Amount Buffer
Twelve‐Character Amount Buffer
5‐4
5‐4
5‐5
Printer Control Characters
Enhanced Printer Control Codes
Set Left Margin
Set Right Margin
Printer‐Independent Margin Control
Select OS/2 Code Page
Select International Character Sets
Select Arabic Character Sets
Print Downloadable Bit Image
Print Barcode
Print Graphics
Print Cheque Image
Define Downloadable Character Set
Define Downloadable Bit Image
Select Printing Position of HRI Characters
Select Width of Barcode
Select Horizontal Height of Barcode
Select Dual‐sided Printing
5‐6
5‐7
5‐7
5‐8
5‐9
5‐9
5‐9
5‐10
5‐10
5‐12
5‐13
5‐14
5‐15
5‐16
5‐17
5‐17
5‐18
5‐18
Character Sets
Primary Print Page
Secondary Print Page
5‐20
5‐22
5‐22
Statement Printer Controls
Left Margin Control
5‐23
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
Margin Control Use
Lines Per Inch Control
5‐23
5‐24
5‐24
Simulated Pre‐printed Receipt Messages
Printing Images Using Screens ‘R00’ and ‘R01’
Screen ‘R00’
Screen ‘R01’
Other Uses of Screens ‘R00’ and ‘R01’
5‐25
5‐25
5‐25
5‐25
5‐26
Sideways Printing on Receipt
Unsupported Functions
5‐29
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
Overview
E
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
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 the “Transaction Reply
Command” section in Chapter 10, “Central to Terminal Messages”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-2
APTRA™ Advance NDC, Reference Manual
5
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:
Eight‐Character Amount
Buffer
The following is printed for this buffer:
●
5
●
●
●
●
Transaction serial number
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 the “Enhanced Configuration
Parameters Load” section in Chapter 10, “Central to Terminal
Messages”. 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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
5-4
APTRA™ Advance NDC, Reference Manual
15:30:29
000000
Printer Data
PPD Default Print
Twelve‐Character Amount
Buffer
The following is printed for this buffer:
●
5
●
●
●
Transaction serial number ‐ this four‐character number is
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
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.
FF
SO
0C hex
0E hex
Journal
Subsequent LF controls with no intervening graphic
characters are ignored.
PPD Envelope
All ignored.
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.
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
5
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.
HT
09 hex
PPD Envelope
Ignored.
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
Maximum Printed Lines
Size of Media
Lines Per Inch
Maximum 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.
Enhanced Printer Control
Codes
5
These codes are all introduced into the control sequence by the
control code 1BH (ESC) and are used for the SDC and RS232 receipt
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
Set Left Margin Position
Character
Description
Number of
Characters
1BH 5BH
(ESC) ‘[‘
Control Sequence Introducer
2
Variable
Position of the left‐most print column from
the left edge of the paper
3
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
Set Right Margin Position
Character
Description
Number of
Characters
1BH 5BH
(ESC) ‘[‘
Control Sequence Introducer
2
Variable
Position of the right‐most print column from
column 2
3
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
You can select one of the supported OS/2 code pages (for details, see
the “Code Pages” section in Appendix B, “Character Sets”) with this
control sequence. Once the OS/2 code page is selected, print data in
the range 20H to FFH will be accepted and printed.
Table 5-5
Select OS/2 Code Page
Character
Description
Number of
Characters
1BH (ESC)
Escape Sequence Indicator
1
25H ‘%’
Escape Sequence ID
1
3xH 3yH
3zH
OS/2 Code Page Identifier
3
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
Select International Character Sets
Character
Description
Number of
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
Select Arabic Character Sets
Character
Description
Number of
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
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
5
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
Print Downloadable Bit Image
Character
Description
Number of
Characters
1BH (ESC)
Private use Escape Sequence Indicator
1
2FH ‘/’
Escape Sequence ID
1
3xH
‘1’ ‐ print bit image one
‘2’ ‐ print bit image two
1
3yH
‘0’ ‐ normal width, normal height
‘1’ ‐ normal width, double height
‘2’ ‐ double width, normal height
‘3’ ‐ double width, double height
1
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
filename are printed, for example:
5
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
Downloadable Bit Image and printed using Print Downloadable Bit
Image by printing a form with the graphic. If there is no file, the
5
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
Print Barcode
Character
Description
Number of
Characters
1BH (ESC)
Private use Escape Sequence Indicator
1
6BH ‘k’
Escape Sequence ID
1
3xH
Type of Barcode
‘0’ ‐ UPC‐A
‘1’ ‐ UPC‐E
‘2’ ‐ JAN13(EAN)
‘3’ ‐ JAN8(EAN)
‘4’ ‐ Code 39
‘5’ ‐ Interleaved 2 of 5
‘6’ ‐ Codabar
1
<ASCII
data>
ASCII characters to be printed as barcodes
Variable
1BH 5CH
(ESC) ‘\’
Control Sequence Terminator
2
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 120180 dots per inch.
The following control sequence is used to print this type of file:
Table 5-10
Print Graphics
Character
Description
Number of
Characters
1BH
ESC
Private use Escape Sequence
Indicator
1
47H
‘G’
Escape Sequence ID
1
Name of file with graphics data
Variable
Control Sequence Terminator
2
<filename>
1BH 5CH
ESC ‘\’
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
printed, for example,
5
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
as .prn, is converted to .bmp. The extension is defined in the
following registry entry:
5
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
Print Cheque Image
Character
Description
Number of
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
cheque
‘0’ ‐ front
‘1’ ‐ back
1
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
Character
Description
<codeline
control>
How the codeline is printed
‘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.
Number of
Characters
1
Note: For PA‐DSS compliance, the codeline
control variable must be set to 1 or 2 if
<side> is set to 0
<image
selector>
Index identifying the image to print. This is
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
3
<cheque
ID>
The cheque identifier. This is the same
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
3
1BH 5CH
(ESC) ’\’
Control Sequence Terminator
2
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
Define Downloadable Character Set
Character
Description
Number of
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
Character
Description
Number of
Character
s
26H ‘&’
Escape Sequence ID
1
<filename>
Name of file with the data for the selected
character set
Variable
1BH 5CH
(ESC) ’\’
Control Sequence Terminator
2
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
Define Downloadable Bit Image
Character
Description
Number of
Characters
1BH (ESC)
Private use Escape Sequence Indicator
1
2AH ‘*’
Escape Sequence ID
1
Var
‘1’ ‐ Define bit image one
‘2’ ‐ Define bit image two
1
<ASCII
filename>
Name of file with the data for the selected bit
image
Variable
1BH 5CH
(ESC) ’\’
Control Sequence Terminator
2
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
Select HRI Character Printing Position
Character
Description
Number of
Characters
1BH (ESC)
Private use Escape Sequence Indicator
1
65H ‘e’
Escape Sequence ID
1
Var
Printing position
‘1’ ‐ not printed (default)
‘2’ ‐ above the barcode
‘3’ ‐ below the barcode
‘4’ ‐ both above and below the barcode
1
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
Select Barcode Width
Character
Description
Number of
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
Select Barcode Horizontal Height
Character
Description
Number of
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
Select Dual-sided Printing
Character
Description
Number of
Characters
1BH (ESC)
Private use Escape Sequence Indicator
1
71H ‘q’
Escape Sequence ID
1
Var
‘0’ ‐ Print on front of paper
‘1’ ‐ Print on back of paper
1
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
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
Character Set Designators
Designator
Characters
Per Inch
Character Set
‘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
5
Printer Data
Character Sets
Designator
Characters
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)
Character Set
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
Select Primary Print Page
Character
Description
Number of
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
Select Secondary Print Page
Character
Description
Number of
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
5
Table 5-21
Set Left Margin (Statement Printer)
Left margin control
Right margin control
Margin control use
Lines/inch control.
This control sequence gives the column where the print head is
positioned following an LF character. The default value is 0.
Description
Number of
Characters
Control Sequence Introducer
2
<ASCII DATA>
Column number range
From 000 to (right margin ‐ 4)
Var (1‐3)
70H
Function‐defining character
1
Character
1BH
(ESC)
5BH
‘[‘
‘p’
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.
Right Margin Control
Table 5-22
Set Right Margin (Statement Printer)
5
This control sequence gives the column position for the right
margin. This is the column at which an automatic LF is performed.
The default value is 80.
Description
Number of
Characters
5BH
‘[‘
Control Sequence Introducer
2
<ASCII DATA>
Column number range
From (left margin + 4) to 132
Var (1‐3)
71H
Function‐defining character
1
Character
1BH
(ESC)
‘q’
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.
Margin Control Use
5
The margins are under the control of Central. When left and right
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.
Lines Per Inch Control
Table 5-23
Switch Lines Per Inch (6/8)
5
This control sequence provides you with the capability of switching
between six and eight lines per inch. The default value is eight.
Description
Number of
Characters
Control Sequence Introducer
2
<ASCII DATA>
Lines per inch selector range (from 00
to 03)
2
72H
Function‐defining character
1
Character
1BH
(ESC)
5BH
‘[‘
‘r’
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
Line Spacing Values
Value
Spacing
(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.
Printing Images Using
Screens ‘R00’ and ‘R01’
5
When screen ‘R00’ is used to define images to be printed on the
thermal receipt printer, the application is not aware of the size of the
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
Invalid Control Sequences for Screen R01
Character
Description
1BH 32H
Select International Character Sets
1BH 33H
Select Arabic Character Sets
1BH 2FH 3xH 3yH
Print Downloadable Bit Image
1BH 6BH 3xH <ASCII
Data> 1BH 5CH
Print Barcode
1BH 47H <filename>
1BH 5CH
Print Graphics
Screen ‘R01’ is not supported in sideways printing mode.
Other Uses of Screens ‘R00’
and ‘R01’
5
This feature allows blank stationery to be used with a Central
application program that was originally designed to operate with
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
Screen R00 Data
Print Line
(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‐51.
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).
Unsupported Functions
The following are not supported in sideways printing mode:
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
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
Control
NDC Control Code
(Hex)
Registry Name
USB Control Code
(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
Variable Description
5
Printer Data
Printer Control Sequences and Registry Settings
NDC Control Code
(Hex)
Registry Name
USB Control Code
(Hex)
Variable Description
0C
FORM_FEED
1D 54 19 1B 46
—
Carriage return
character
0D
CR
0A
—
Horizontal tab
character
09
HT
09
—
Set left margin
1B 5B var 70
LEFT_MARGIN
1D 4C bvar
Column position of
the left margin in
standard characters,
typically between 1
and 39
Control
Form‐feed
character
See Table Note 2
See Table Note 3
See Table Note 4
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
page
1B 25 var
OS2_CODE_PAGE
1B 25 bvar
Code page number
Copy code page to
RAM
1B 3A var
COPY_CODE_PAGE
1B 3A 30 bvar 30
Code page number
Select international
character set
1B var
INTR_CHAR_SET
—
—
1B var
ARAB_CHAR_SET
—
—
1B 2F var &
BIT_IMAGE
1D 2F bvar
Bit image identifier /
bit image size
See Table Note 3
Select Arabic
character set
See Table Note 3
Print downloaded
bit image
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
Control
NDC Control Code
(Hex)
Registry Name
USB Control Code
(Hex)
Print barcode
1B 6B var 1B 5C &
BARCODE
1D 6B bvar
Variable Description
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.
Print last image
processed
See Table Note 6
and Table Note 7
1B 47 var 1B 5C
$*&
CHEQUE
bvar
$
Side of cheque to
print and how the
codeline is printed
Select primary
character set G0
0F
SHIFT_IN
—
—
Select secondary
character set G1
0E
SHIFT_OUT
—
—
Select character set
as active set G0
1B 28 var
CHAR_SET1
—
Character set number
Select character set
as active set G1
1B 29 var
CHAR_SET2
—
Character set number
Define character set
1B 26 var 1B 5C
DEF_CHAR_SET
var
Path/filename
containing the
character set
definition
1B 2A var 1B 5C
&
DEF_BIT_IMAGE
1D 23 bvar
Bit image ID and the
path/filename
containing the
definition
See Table Note 8
See Table Note 13
Define bit image
See Table Note 5
Position of
human‐readable
characters
(for barcode)
1B 65 var * &
POS_HRI_CHAR
See Table Note 11
1D 48 bvar
See Table Note 12
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
Position of characters
Printer Data
Printer Control Sequences and Registry Settings
Control
NDC Control Code
(Hex)
USB Control Code
(Hex)
Variable Description
Height of barcode
1B 68 var * &
HZ_HGHT_BARCO
DE
1D 68 bvar
Height in dots
1B 77 var * &
WIDTH_BARCODE
1D 77 bvar
Width in dots
1B 5B var 73
SET_FORM_LEN
1B 62 bvar
Length of form in
rows
Cut
(and feed on some
printers)
11
CUT
1D 54 19 1B
46
—
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
1B 5B var 74
LINE_SPACE
1B 33 bvar
Line spacing
1B 5B var 75
FIRST_LINE_POS
1B 65 bvar
First line position
Select print mode
—
PRNT_MODE
1B 21 var
Print mode value
Select logo
—
SELECT_LOGO
1D 23 bvar
Bit map identifier
Registry Name
See Table Note 13
Width of barcode
See Table Note 13
Form length
See Table Note 14
See Table Note 15
Set line spacing
See Table Note 16
Set first line
position
See Table Note 18
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” in Appendix B.
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
Print Cheque Image Variable Data
Variable
Description
Chars
<side>
Selects the front or back of the cheque to be
printed.
Values can be as follows:
●
‘0’ for front image
●
‘1’ for back image
1
<codeline
control>
Defines how the codeline is printed. Values
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
1
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” in Appendix B. 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
USB Receipt and Journal Printer: Barcode
Types, Length, and Data
tvar
Type Name
lvar
dvar
‘65’
UPC‐A
48‐57 (ASCII numerals)
Fixed Length: 11, 12
‘66’
UPC‐E
48‐57
Fixed Length: 11,12
‘67’
JAN‐13
(EAN13)
48‐57
Fixed Length: 12,13
‘68’
JAN‐8
(EAN8)
48‐57
Fixed Length: 7,8
‘69’
CODE39
48‐57
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)
Variable
‘70’
Interleave
d 2 of 5
(ITF)
48‐57
Variable
Even number
‘71’
CODABA
R (NW‐7)
65‐68 (start code)
48‐57
36, 43, 45, 46, 47, 58
Variable
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
dl=103‐105 (must be a
start code)
d2=0‐102 (data bytes)
Stop code is provided
by the printer
Variable
‘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
Character Sets
Control Codes
Screen Size Limitations
Cardholder Screen /Enhanced Operator Interface Layout
Printer Layout
Automatic Screen Editing
Media Status Messages
Test Cash Report
6‐2
6‐2
6‐2
6‐3
6‐3
6‐4
6‐4
6‐4
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
Overview
F
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
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, see ‘Supervisor Messages’ in Chapter 3
of the APTRA Advance NDC, Multi‐Vendor Support Reference Manual.
Character Sets
Control Codes
6
All display/print characters are obtained from the Single Size
Alphanumeric 1 character set.
The following control codes are supported:
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
6
Supervisor Messages
Supervisor Messages
Screen Size Limitations
6
Table 6-1
Screen Size Limits
The following table shows the maximum number of columns and
rows for each type of screen:
Screen
Type
Table 6-2
Display Positions
No. Of
Rows
No. Of
Columns
‘A’
Cardholder/Enhanced Operator
Interface Acknowledgement Lines
1
32
‘E/e’
Error Messages
1
32
‘I’
Cardholder/Enhanced Operator
Interface/Printer Information Output
14
32
‘M/m’
Cardholder/Enhanced Operator
Interface/Printer Menus
13
32
‘P/p’
Cardholder/Enhanced Operator
Interface Data Entry Prompts
1
27
‘S/s’
Media Status Lines
1
32
‘T/t’
Journal Trace
15
32
Supervisor TCP/IP Screens
15
32
Supervisor Bunch Note Acceptor
(BNA) Screens
14
32
Supervisor VISA 2 screens
15
32
‘i’
Cardholder Screen
/Enhanced Operator
Interface Layout
Usage
If Supervisor functions are selected from the facia keyboard or the
enhanced operator interface, all screens are displayed from the
left‐most column. The following table shows the display positions.
6
Screen
Type
Usage
Row
Position
Column
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.
Printer Layout
6
Automatic Screen Editing
Media Status Messages
Test Cash Report
6
6
6
All printing of reserved screens starts at column 6 and extends as far
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
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
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
(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
Camera Control (Field ‘h’)
Supply Mode, Ready Status & Amount Buffer
Length (Field ‘m’)
Logical Unit Number – LUNO (Field ‘o’)
Timer Number (Field ‘p’)
Millisecond Ticks per Timer Field (Field ‘q’)
Unsupported Parameters
Reserved Parameters
7‐2
7‐2
7‐2
7‐3
7‐3
7‐4
7‐5
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
Option 37 – Print Track 2 to Journal
Option 41 – Send Track Details on Card Retract
Option 44 – BNA Journal Notes Count
Option 45 – BNA Settings
Option 46 – MCRW Enhanced Card Device Security Jitter
Option 48 – Barcode Reader
Option 69 – EMV Smart Card Extended Status
Option 70 – EMV Smart Card
Option 71 – Time‐Out State Entry
Option 74 – Destination for Cash Deposit Retract
Option 76 – Cash Handlers
Option 77 – Next State Number
Option 78 – GBRU M‐Status Reporting
Option 79 – Coin Dispenser
Option 80 – Alphanumeric State Entry
Option 83 – Cheque Processor
Timer Number – Field ‘k’
Number of Seconds per Timer Field – Field ‘l’
Unsupported Parameters
Timers
Time Units for Timers
Timer Descriptions
Timer Adjustment For Voice Guidance
Timer 00 *
Timer 01 *
Timer 02
Timer 03
Timer 04 *
Timer 05 *
Timer 06
Timer 07 *
Timer 08 *
Timer 09 *
Timer 10
Timer 60
Timer 61 *
Timer 63
Timer 68
Timer 69
Timer 72
Timer 77 *
Timer 78 *
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
7‐13
7‐13
7‐14
7‐14
7‐14
7‐17
7‐17
7‐18
7‐18
7‐18
7‐18
7‐19
7‐19
7‐20
7‐21
7‐21
7‐21
7‐22
7‐22
7‐22
7‐24
7‐24
7‐24
7‐24
7‐24
7‐24
7‐25
7‐25
7‐25
7‐25
7‐26
7‐26
7‐26
7‐27
7‐27
7‐27
7‐27
7‐27
7‐28
7‐28
7‐28
7‐28
7‐28
Table of Contents
Configuration Parameters
Timer 87 *
Timer 92
Timer 94 *
Timer 95 *
Timer 96 *
Reserved Timers
Unsupported Timers
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
7‐28
7‐29
7‐29
7‐29
7‐29
7‐29
7‐30
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
Overview
G
Overview
7
To customise the way an SST operates, in addition to states, screens
and printer data, youcan download either a configuration
parameter message, or an enhanced configuration parameter
message with additional options, .
This chapter describes the parameters available in these two
configuration message formats.
Note: The SST can be further configured locallyby 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
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.
Camera Control (Field ‘h’)
7
Table 7-38
Values for Camera Control
If the SST is fitted with a camera, this parameter sets automatic
picture taking on or off. Possible values are as follows:
Value
Description
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.
Supply Mode, Ready
Status & Amount Buffer
Length (Field ‘m’)
Table 7-39
Values for Supply Mode, Ready Status and
Amount Buffer Length
7
This single parameter is used to set three configuration options and
the value to be downloaded is formed by adding the values for the
three options together. The values for the three options are as
follows:
Value
Description
000
No option selected (default)
001
Ready Status
Send a separate Ready ‘B’ status message to Central 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
7
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 Central,
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’.
Logical Unit Number –
LUNO (Field ‘o’)
7
This parameter determines whether the logical unit number, LUNO,
will be transmitted in Transaction Request, Solicited and
Unsolicited Status messages.
The number tells Central 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’.
Timer Number (Field ‘p’)
7
This parameter sets the time‐out value for each of the timers that the
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-40
Summary of Timers
Millisecond Ticks per
Timer Field (Field ‘q’)
7
Timer Number
Function
‘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 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. The valid range is 000—255, providing a time‐out
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
Unsupported Parameters
7
The following parameters are not supported in Advance NDC but
are reserved in the message:


Reserved Parameters
Card Read Error Threshold (Field ‘i’)
Card Write Error Threshold (Field ‘l’)
The following parameters are reserved for future use:
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
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.
Option 00 – Camera
Control
If the SST is fitted with a camera, this parameter sets automatic
picture taking on or off. Possible values are as follows:
7
Option Code
Description
001
Advance NDC Security Camera is switched on
(default). The flowpoints at which pictures are taken
depend on the configuration of NDCSecurityCamera.xml.
002
Advance NDC 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.
Option 01 – Supply Mode,
Ready Status, & Amount
Buffer Length
This is the same as option ‘m’ in the Configuration Parameters Load
message. For details, see “Supply Mode, Ready Status & Amount
Buffer Length (Field ‘m’)” on page 7‐2.
7
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-6
APTRA™ Advance NDC, Reference Manual
7
Configuration Parameters
Enhanced Configuration Parameters Load Message
Option 02 – Auto Voice
7
Table 7-41
Option 02: Auto Voice Values
If the SST is fitted with an automatic voice feature, this parameter
sets auto voice on or off. Possible values are as follows:
Option Code
Description
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.
Option 03 – Date Format
This parameter sets the date format. Values are as follows:
7
Table 7-42
Option 03: Date Formats
Option 04 – Roll Width
Option 05 – Left Print
Column
7
7
Option Code
Description
001
MMDDYY (default)
002
DDMMYY
003
Not supported
004
Not supported
This parameter defines the number of columns used in receipt print
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
screens in messages from Central. The range is 001 to 040, and the
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
Option 07 – Track 1
Format
This parameter sets the method of extracting the name and title
from Track 1 data on the card. Possible values are as follows:
7
Table 7-43
Option 07: Track 1 Format Values
Option 12 – Specific
Command Reject
001
ISO format (default)
002
VISA format
003
Autosearch backwards
004
Autosearch forwards.
7
7
Table 7-45
Option 15: Transaction Status Information
Values
Option 16 – Journal Printer
Backup Time
Description
This parameter determines whether the SST transmits Specific
Command Reject options. Possible values are as follows:
Table 7-44
Option 12: Specific Command Reject
Values
Option 15 – Transaction
Status Information
Option Code
7
Option Code
Description
000
Do not transmit specific command reject statuses, except
MAC (default)
001
Transmit specific command reject statuses.
This parameter determines whether the transaction status
information from the last command is appended to Transaction
Request messages. Possible values are as follows:
Option Code
Description
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
backup is allowed before all journalling is discontinued. It is not
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.
Option 17 – Journal Printer
Backup Print Operations
7
This parameter sets the maximum number of print operations (in
hundreds) to be buffered while the journal printer is fatal. It is not
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.
Option 23 – Envelope
Dispenser Status
This option determines whether envelope dispenser status
messages are sent. Possible values are as follows:
7
Table 7-46
Option 23: Envelope Dispenser Status
Values
Option 24 – Enhanced/TI
Sensor Status Unsolicited
Message
Table 7-47
Option 24: Enhanced/TI Sensor Status
Unsolicited Message Values
7
Option Code
Description
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
unsolicited message is sent from the SST when tampering is
suspected on devices not supported in the existing TI/Sensor Status
unsolicited message. Possible values are as follows:
Option Code
Description
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‐49.
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
Option 25 – Media
Entry/Exit Indicators Flash
Rate
This parameter sets the flash rate for the Media Entry/Exit
Indicators. The flash rate can range from 4.0 Hz to continuously on
as follows:
7
Table 7-48
Option 24: Media Entry/Exit Indicators
Flash Rate
Option Code
Description
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.”
Option 27 – Remote Relay
7
Table 7-49
Option 27: Remote Relay
Option 30 – Include PAN
in DCS Data
7
Table 7-50
Option 30: Include PAN in DCS data
Option 32 – Unsolicited
Reporting Control
This parameter determines when the remote relay is active. Possible
values are as follows:
Option Code
Description
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
depending on hardware capability. It is used to superimpose the
PAN on the image. Values are as follows:
Option Code
Description
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
camera. It also controls the reporting of state changes
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-51
Option 32: Unsolicited Reporting Control
Option 33 – Simulate
Supervisor Mode
Entry/Exit
Table 7-53
Option 34: MCN Range Values
Description
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
safe door activity. Possible values are as follows:
7
Table 7-52
Option 33: Simulate Supervisor Mode
Entry/Exit Values
Option 34 – MCN Range
Option Code
7
Option Code
Description
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
(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:
Bit
Description
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 (the
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
The following table shows the values for the MCN Range option:
Table 7‐54
Option 34: MCN Range Option Code
Examples
Option Code
Description
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ʹ
002
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 of Chapter 9, “Terminal to Central
Messages”
“Message Coordination Number (MCN)” on page 10‐87 of
Chapter 10, “Central to Terminal Messages”.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
7-12
APTRA™ Advance NDC, Reference Manual
7
Configuration Parameters
Enhanced Configuration Parameters Load Message
Option 35 – Report Dual
Mode EJ & Hardcopy B/U
Unsolicited Messages
This option controls the reporting to Central of unsolicited device
status messages for dual mode EJ and hardcopy backup. Possible
values are as follows:
7
Table 7-55
Option 35: Report Dual Mode & Hardcopy
B/U Unsolicited Message Values
Option Code
Description
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 “Unsolicited Message Sequences for Option 35 (EJ Dual
Mode)” on page 9‐101.
Option 36 – Enhanced EJ
Backup
This option determines whether multiple or standard EJ backups
are allowed. Possible values are as follows:
7
Table 7-56
Option 36: Enhanced EJ Backup Values
Option Code
Description
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.
Option 37 – Print Track 2
to Journal
Table 7-57
Option 37: Print Track 2 to Journal
7
This option determines whether the first 22 characters of data from
card track 2 are automatically journaled when a card is read.
Possible values are as follows:
Option Code
Description
000
Do not print data on the journal (default)
001
Print data on the journal
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
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
Option 41 – Send Track
Details on Card Retract
7
This option determines whether data from the card is included in
Card Reader/Writer status messages sent following a card retract
operation. Possible values are as follows:
Table 7-58
Option 41: Send Track Details on Card
Retract
Option Code
Description
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.
Option 44 – BNA Journal
Notes Count
7
If a Bunch Note Acceptor (BNA) is present, this option determines
whether vaulted and refunded note counts are automatically
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-59
Option 44: BNA Journal Notes
Count Values
Option Code
Description
000
Do not journal vaulted notes (default)
001
Journal all vaulted notes.
002
Journal all returned counts
003
Journal all vaulted and returned counts
Note: Note counts are always printed to the journal printer in the
Close state.
Option 45 – BNA Settings
If a BNA is present, this parameter sets the following:
7



Inclusion of the BNA counts for the last transaction status in the
Transaction Request message sent to Central
Number of notes to accept
Retract option configuration
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
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-60
Option 45: BNA Settings Bit Values
Bit Number
Description
0
Inclusion of BNA last transaction status counts in the
Transaction Request message sent to Central
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‐45

“Fitness Data” on page 9‐48

“Extended Send Supply Counters” on page 9‐61

“Note Acceptor (Solicited/Unsolicited)” on page 9‐113
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-61
Example Option 45: BNA Settings Values
Option 46 – MCRW
Enhanced Card Device
Security Jitter
Description
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)
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
the level of ECD Jitter to be applied during card entry/exit. The
default value is 000.
7
Note: A reboot is required if this parameter is changed, to allow the
new setting to take effect at device level.
Table 7-62
Option 46: MCRW Enhanced Card Device
Security Jitter Values
Option 48 – Barcode
Reader
Option Code
7
Option Code
Description
000
No ECD Jitter, or ECD Jitter not required (default)
001
Standard ECD Jitter
002
Maximum ECD Jitter (but slower card read/write).
If the barcode reader is present, this option defines whether the
barcode reader‐specific fields are included in the messages sent to
the host.
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
Table 7-63
Option 48: Barcode Reader Values
Option 69 – EMV Smart
Card Extended Status
Option 70 – EMV Smart
Card
Option 71 – Time‐Out State
Entry
Table 7-65
Option 74: Destination Values for
Retracted Notes During Cash Deposit
Description
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.
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
supported in Advance NDC.
7
For details, refer to the EMV Integrated Circuit Card (ICC) Reference
Manual.
7
Table 7-64
Option 71: Time-Out State Entry
Option 74 – Destination for
Cash Deposit Retract
Option Code
This option controls entry to the Time‐Out state and how many
times the Time‐Out state can be entered for each cardholder action.
Once the specified limit is reached, the time‐out action is performed.
Valid values are as follows:
Option Code
Description
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
cash deposit transaction as follows:
7
Option Code
Description
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
Option 76 – Cash Handlers
7
Table 7-66
Option 76: Cash Handlers
This option specifies the cassette type support and message format
for single or dual cash handler systems as follows:
Option Code
Description
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.
Option 77 – Next State
Number
7
When Advance NDC is installed, the next state number is not set
and cardless transactions are disabled. The next state number can be
downloaded remotely using this option or set locally through the
Configure menu in Supervisor.
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.
If the next state number is set to 000, cardless transactions are
disabled.
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
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
and Associated Components” in the APTRA Advance NDC
Developer’s Guide.
Possible values are as follows:
Table 7-67
Option 77: Next State Number Values
Option 78 – GBRU
M‐Status Reporting
Option Code
Description
000
Cardless transactions not allowed (default)
001‐254 or
256‐999
State number to go to from the Card Read state when
cardless transactions are enabled and when Enhanced
Configuration Parameter option 80 is set to 0
001‐254 or
256‐ZZZ
State number to go to from the Card Read state when
cardless transactions are enabled and Enhanced
Configuration Parameter option 80 is set to 1
This option controls the reporting of the M‐Status for a GBRU used
as a dispenser in the following cases:
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‐75
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-68
Option 78: GBRU M-Status Reporting
Option Code
Description
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
Option 79 – Coin
Dispenser
7
Table 7‐69
This option allows the modification of the message format to
support up to eight coin hopper types. Possible values are as
follows:
Option Code
Description
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
Option 79: Coin Dispenser
Option 80 – Alphanumeric
State Entry
This option controls which number system is used to interpret state
number fields. Possible values are as follows:
7
Table 7-70
Option 80: Alphanumeric State Entry
Option Code
Description
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.
Option 83 – Cheque
Processor
Table 7-71
Option 83: Cheque Processor
7
This option allows the modification of the message format to
support the reporting of bins in the cheque processor and further
support for bunch cheque acceptors. Possible values are as follows:
Option Code
Description
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
Timer Number – Field ‘k’
Number of Seconds per
Timer Field – Field ‘l’
7
7
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
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 specified in field ‘k’. The maximum number of seconds is
255.
For a description of the field in the “Enhanced Configuration
Parameters Load” message, see page 10‐17.
Unsupported Parameters
Table 7-72
Unsupported Parameters
7
The following table lists the enhanced configuration load
parameters that are not supported in Advance NDC. The option
numbers are reserved in the message format.
Option Number
Configuration Parameter Description
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
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.
Time Units for Timers
Timer Descriptions
7
7
When a configuration load message is sent, the timer values are in
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
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 *
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
7
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
Communication message time‐out interval. When the SST is ready
to transmit a Transaction Request to Central, the SST starts timer 03.
If the SST does not receive a Transaction Reply command before
timer 03 expires, through the Central Response Timeout Next State,
the SST exits the Transaction Request state specified in the
Transaction Request state table. If this occurs, a host transaction
time‐out message is journaled, (as in reserved screen t68.).
Timer 04 *
7
Cheque/envelope insertion response time‐out. When a screen is
displayed which prompts the cardholder to insert a cheque or
envelope into a depository, the cardholder must respond within the
time‐out interval specified by timer 04, otherwise the SST enters the
Time‐Out state. The keyboard beeper sounds while this timer is
active. The default is 30 ticks. If this timer is set to greater than one
minute on the cheque processor, the cheque processor firmware will
time‐out.
Timer 05 *
7
Cash retract time‐out. When cash is presented to a cardholder, 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
sound. This timer is used in Card Before Cash transactions to allow
beeping when the SST is configured not to retract cash.
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
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‐23 on page 10‐71)

Card Before Parallel Dispense and Print
(see Table 10‐24 on page 10‐72)
The timer is started after notes are taken in the following:


Dispense and Print
(see Table 10‐17 on page 10‐67)
Card Before Cash
(see Table 10‐22 on page 10‐70).
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 *
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
7
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‐67
Display and Print. For details, see “Display and Print (Function
ID ‘3’ or ‘9’)” on page 10‐68.
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‐91) 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 cardholder 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 Bunch Note Acceptor (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 *
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
7
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’.
Reserved Timers
The following timers are reserved for future use:
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
Unsupported Timers
7
The following timers are for functions that are not supported in
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
FIT Fields
.PIDDX (Institution ID Index)
PFIID (Institution ID)
PSTDX (Indirect Next State Index)
PMXPN (Maximum PIN Digits Entered)
PCKLN (Maximum PIN Digits Checked)
PINPD (PIN Pad)
PANDX (PAN Data Index)
PANLN (PAN Data Length)
PANPD (PAN Pad)
PRCNT (Track 3 PIN)
POFDX (PIN Offset Data)
PDCTB (Decimalisation Table)
PEKEY (Encrypted PIN Key)
PINDX (Index Reference Point)
PLNDX (Language Code Index)
PMMSR (MM Sensor Flag)
PBFMT (PIN Block Format)
8‐2
8‐3
8‐4
8‐4
8‐4
8‐4
8‐5
8‐6
8‐7
8‐7
8‐8
8‐8
8‐9
8‐9
8‐9
8‐9
8‐11
8‐11
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
Overview
H
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 terminal by a message from Central. 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.
Each entry in the FIT Data load message has a value in the range
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 you convert each digit pair
from hex to decimal to produce a three‐character string in the range
000‐255.
For details of the FIT message format, see “FIT Data Load” on
page 10‐22.
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
Digits
Offset
Index for Financial Institution ID number on
card
2
Yes
PFIID
Financial Institution ID number
10
No
Indirect next state index
PSTDX
Index for entries in the Indirect next state table
2
No
d
Algorithm/ Bank ID
index
PAGDX
Algorithm index for Diebold
Not supported as local Diebold PIN verification
is not supported.
2
Yes
e
Maximum PIN digits
entered
PMXPN
Maximum number of PIN digits allowed for the
cardholder to enter
2
No
f
Maximum PIN digits
checked
PCKLN
Number of digits used for local PIN check
2
No
g
PIN pad
PINPD
Character used to pad PIN for transmission to
Central and the encryption method used
2
No
h
PAN data index
PANDX
Index for location of PAN (Personal Account
Number) on card
2
Yes
i
PAN data length
PANLN
PAN data field length
2
No
Field
Contents
Acronym
Definition
a
Institution ID Index
PIDDX
b
Institution ID
c
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
Field
Contents
Acronym
Definition
No of
Digits
Offset
j
PAN pad
PANPD
Character used to pad PAN field for encryption
2
No
k
Track 3 PIN retry count
index
PRCNT
Index for PIN retry count field on card
2
Yes
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
all card‐related entries in FIT
6
Yes
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
sensor in the FIT
Not supported
2
No
r
Reserved
‐
‐
6
No
s
PIN Block format
PBFMT
Selects PIN block format for remote PIN
verification
2
No
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.
FIT Fields
8
Some of the fields in the FIT are not supported and this is indicated
in the following text. These fields 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 field gives the offset for the FIID on the card. The
range is 00‐7F hex.
You should add 80 hex to this number if it is required to modify the
index delimiters in table entry PINDX. See the “PINDX (Index
Reference Point)” section for details. 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)
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)
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
8
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
PIN Block Type Selection
Bits
PIN Block to be used
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.If PCKLN is zero, remote
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
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
PINPD Bit Encoding Significance
Table 8-4
PINPD First Digit Coding
Bit 0 (1 hex) =
double encryption sequence:
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.
First Digit
Hex Value
Type of
Encryption
Encryption Key and Sequence
First
Second
0
Single
COM
‐
2
Double
See Table Note 2 and
Table Note 3.
MASTER
COM
3
Double
PEKEY
COM
4
None
See Table Note 1 and
Table Note 3.
‐
‐
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
8
Single
COM
‐
A
Double
See Table Note 3.
MASTER
COM
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”.
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
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.
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
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‐12.
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
Master key or the PEKEY entry in the FIT for PIN verification. This
digit must be 0 or 8:


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.
PRCNT (Track 3 PIN)
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.
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.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
8-8
APTRA™ Advance NDC, Reference Manual
8
8
Financial Institution Tables
FIT Data
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.
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
as local Diebold PIN verification is not supported.
PANDX locates the PAN
POFDX locates the PIN Offset 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.
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
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.


Note: The delimiter is not included in the offset count.
The following table gives the digit corresponding to each valid
combination of track number, delimiter and direction:
Table 8-5
PINDX Index Reference Point
Hex Value
Track No.
Delimiter
Direction
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
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 Assignment
PINDX Digit
Related Index
Related Card Data
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
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
PLNDX (Language Code Index)
8
The field gives the offset for the language code on the card. This
field can be used in conjunction with a Language Select From Card
state to set the screen group that should be displayed. The terminal
uses the language code to display multi‐language 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 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
This section explains how to use linked Financial Institution Tables.
This feature only applies for 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 referred to 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
8
Table of Contents
Terminal to Central Messages
Chapter 9
Terminal to Central Messages
Overview
9‐1
Transaction Request Messages
Transaction Request Message Format
SST Reply to Interactive Transaction Response
9‐2
9‐2
9‐19
Solicited Status Messages
Content of Solicited Status Messages
Status Descriptor Field
Status Information Field
Status Information
Ready (‘B’) Status
Cash Deposit Recycle Data ‐ Sub‐field ‘g3’
Recycle Cassette Dispense Data ‐ Sub‐field ‘g3’
Specific Command Reject
Terminal State
Send Configuration Information
Hardware Fitness—Sub‐field ‘g3’
Hardware Configuration Data—Sub‐Field ‘g4’
Supplies Status—Sub‐field ‘g5’
Hardware Configuration Data
Supplies Data
Fitness Data
Tamper and Sensor Status Data
Software ID and Release Number Data
Enhanced Configuration Data
Local Configuration Option Digits
Report Cash Deposit Definition
Send Supply Counters
Basic Send Supply Counters
Example Message Analysis
Extended Send Supply Counters
Send Tally Information
Send Error Log Information
Send Date/Time Information
Send Configuration ID
9‐20
9‐20
9‐20
9‐20
9‐22
9‐22
9‐23
9‐24
9‐25
9‐29
9‐30
9‐31
9‐34
9‐41
9‐43
9‐45
9‐48
9‐49
9‐52
9‐52
9‐53
9‐53
9‐55
9‐56
9‐59
9‐61
9‐68
9‐69
9‐70
9‐71
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
Solicited Device Fault Status
Device Fault Status Responses
Device Fault Status Information Field
GBRU to CDM M‐Status Mapping
9‐72
9‐72
9‐73
9‐75
Other Solicited Messages
Encryptor Initialisation Data
Upload EJ Data Message
9‐76
9‐76
9‐81
Unsolicited Status Messages
Conditions for Sending Unsolicited Messages
Unsolicited Status Information Field
9‐84
9‐84
9‐85
Device Status Information
Time‐Of‐Day Clock (Unsolicited)
Power Failure (Unsolicited)
Card Reader/Writer (Solicited/Unsolicited)
Cash Handler (Solicited/Unsolicited)
Cassette Re‐enabled During Deposit Transactions
Depository (Solicited/Unsolicited)
Receipt Printer (Solicited/Unsolicited)
Journal Printer (Unsolicited)
Electronic Journal Printer (Unsolicited)
Night Safe Depository (Solicited/Unsolicited)
Encryptor (Unsolicited)
Camera (Unsolicited)
Sensors (Unsolicited)
Touch Screen Keyboard (Unsolicited)
Supervisor Keys (Unsolicited)
Cardholder Display Alarm (Unsolicited)
Statement Printer (Solicited/Unsolicited)
Voice Guidance (Unsolicited)
Note Acceptor (Solicited/Unsolicited)
Counts in ECB 6 Unsolicited Messages
Envelope Dispenser (Unsolicited)
Cheque Processor (Solicited/Unsolicited)
Coin Dispenser (Solicited/Unsolicited)
Barcode Reader (Unsolicited)
9‐87
9‐87
9‐87
9‐88
9‐90
9‐94
9‐95
9‐96
9‐97
9‐99
9‐102
9‐103
9‐104
9‐105
9‐107
9‐108
9‐110
9‐110
9‐112
9‐113
9‐114
9‐120
9‐121
9‐125
9‐127
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Overview
I
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
Note: For any differences on other vendors’ SSTs, 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
9-1
Terminal to Central Messages
Transaction Request Messages
Transaction Request Messages
Transaction Request messages are sent from the SST and contain the
data that Central 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.
Transaction Request
Message Format
The format of the Transaction Request message is given in the
following table:
9
Table 9-1
Transaction Request Message Format
Field
Number of
Characters
Mandatory/Optional
Description
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 Central 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
9
Terminal to Central Messages
Transaction Request Messages
Field
Number of
Characters
Mandatory/Optional
Description
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. Central 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.
Central 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
(106)
See Table Note 1
Track 3 Data. Contains up to 106 characters of Track 3 data from the start
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 cardholder.
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
Field
Number of
Characters
k
Mandatory/Optional
Description
8 or 12
See
Table Note 1
Table Note 4
Amount Entry Field. Identifies the amount entry made at the keyboard.
The content of this field is determined by the Amount Entry, Enhanced
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.
May contain 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.
May contain an amount value or a note mix specified during the Note
Mix Selection state.
FS
1
See
Table Note 2
Table Note 9
Field Separator
o
1
O
Track 1 Identifier. Identifies data in the next field as Track 1 data:
‘1’ ‐ Track 1 data.
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.
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
Field
Number of
Characters
FS
q
Mandatory/Optional
Description
1
See
Table Note 5 &
Table Note 9
Field Separator
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,
Table Note 6 &
Table Note 7
Last Transaction Status contains status data relating to the previous
transaction performed by the SST, as follows:
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 Central, this 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
Field
Number of
Characters
Mandatory/Optional
Description
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
Field
Number of
Characters
Mandatory/Optional
Description
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
Table Note 8
Table Note 9
Field Separator
av1
1
See
Table Note 8
Table Note 9
CSP Data ID ‘U’. A value of ‘U’ (55H, ASCII) in this field identifies the
following field as the first Customer Selected PIN data. 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.
av2
Var(16)
See
Table Note 8
Table Note 9
CSP Data. This field contains an encrypted 16 character PIN. See the “FIT
Data” table in Chapter 8, “Financial Institution Tables”.
FS
1
See
Table Note 8
Table Note 9
Field Separator
aw
1
1
See
Table Note 8
Table Note 9
Confirmation CSP Data ID ‘V’. A value of ‘V’ (56H, ASCII) in this field
identifies the following field as the second Customer Selected PIN data. 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.
aw
2
Var(16)
See
Table Note 8
Table Note 9
Confirmation CSP Data. This field contains an encrypted 16 character
PIN. For details, see the “FIT Data” table in Chapter 8, “Financial
Institution Tables”.
FS
1
See
Table Note 8
Table Note 9
Table Note 10
Field Separator
ax1
1
See
Table Note 8
Table Note 9
Table Note 10
VC Data ID ‘W’. The value ‘W’ in this field identifies the following field
as containing data inserted by Exits.
ax2
Var
See
Table Note 8
Table Note 9
Table Note 10
This field is available for use by Exits.
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
Field
Number of
Characters
FS
Mandatory/Optional
Description
1
See
Table Note 8
Table Note 9
Table Note 10
Field Separator
ay1
1
See
Table Note 8
Table Note 9
Table Note 10
VC Data ID ‘X’. The value ‘X’ in this field identifies the following field as
containing data inserted by Exits.
ay2
Var
See
Table Note 8
Table Note 9
Table Note 10
This field is available for use by Exits.
FS
1
See
Table Note 8
Table Note 9
Table Note 10
Field Separator
az1
1
See
Table Note 8
Table Note 9
Table Note 10
VC Data ID ‘Y’. The value ‘Y’ in this field identifies the following field as
containing data inserted by Exits.
az2
Var
See
Table Note 8
Table Note 9
Table Note 10
This field is available for use by Exits.
FS
1
See
Table Note 8
Table Note 9
Table Note 10
Field Separator
ba1
1
See
Table Note 8
Table Note 9
Table Note 10
VC Data ID ‘Z’. The value ‘Z’ in this field identifies the following field as
containing data inserted by Exits.
ba2
Var
See
Table Note 8
Table Note 9
Table Note 10
This field is available for use by Exits.
FS
1
See
Table Note 8
Table Note 9
Table Note 10
Field Separator
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
Field
Number of
Characters
bb1
Mandatory/Optional
Description
1
See
Table Note 8
Table Note 9
Table Note 10
VC Data ID ‘[’. The value ‘[’ in this field identifies the following field as
containing data inserted by Exits.
bb2
Var
See
Table Note 8
Table Note 9
Table Note 10
This field is available for use by Exits.
FS
1
See
Table Note 8
Table Note 9
Table Note 10
Field Separator
bc1
1
See
Table Note 8
Table Note 9
Table Note 10
VC Data ID ‘\’. The value ‘\’ in this field identifies the following field as
containing data inserted by Exits.
bc2
Var
See
Table Note 8
Table Note 9
Table Note 10
This field is available for use by Exits.
FS
1
See
Table Note 8
Table Note 9
Table Note 10
Field Separator
bd1
1
See
Table Note 8
Table Note 9
Table Note 10
Smart Card Data ID ‘5’. The value ‘5’ in this field identifies the following
field as containing data inserted by EMV/CAM2 Exits.
bd2
Var
See
Table Note 8
Table Note 9
Table Note 10
Smart Card Data. This field is available for use by EMV/CAM2 Exits.
FS
1
See
Table Note 12
Field Separator
ca1
1
See
Table Note 12
and Table Note
17
Device ID ‘w’. The value ‘w’ in this field identifies the following two
fields as containing cash acceptor data.
ca2
2
See
Table Note 12
and Table Note
17
Two‐digit hexadecimal number (01 ‐ 32) representing a note type,
allowing up to 50 note types to be represented.
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
Field
Number of
Characters
ca3
Mandatory/Optional
Description
2 or 3
See
Table Note 12
Table Note 13
and Table Note
17
Number of notes in the escrow, or vaulted if using direct deposit to
cassettes, for the note type defined in ca2.
This field has either 2 or 3 digits, depending on whether option 45 is set
to report more than 90 notes or not.
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
Table Note 14
Table Note 16
Field Separator
cb1
1
See
Table Note 14
Table Note 16
Document Data ID ‘a’. The value ‘a’ in this field identifies the following
field as containing single cheque deposit data.
cb2
1
See
Table Note 14
Table Note 15
Table Note 16
Table Note 21
Codeline detected.
A value of ‘1’ indicates that a minimum number of codeline characters
has been detected,
A value of ‘0’ indicates that a codeline has not been detected after all
allowed retries.
cb3
Var(256)
See
Table Note 14
Table Note 16
Codeline value. This field is present only if field cb2 has a value of ‘1’,
and contains the codeline read from the cheque.
See
Table Note 8
Field Separator
See
Table Note 17
Data ID ‘c’ for notes regarded as suspect under the ECB 6 regulations.
FS
cc1
1
cc2
2
cc3
4
See
Table Note 18
Note type identifier as a hexadecimal number in the range ‘0001’ to ‘00FF’
cc4
3
See
Table Note 18
Number of suspect notes of the note type identified in field ‘cc3’, as a
decimal number in the range ‘001’ to ‘999’
FS
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
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
Field
Number of
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
Table Note 19
Note type identifier. The hexadecimal identifier of the note type in the
range ‘0001’ to ‘00FF’
cd4
3
See
Table Note 19
Number of counterfeit notes of the note type identified in field ‘cd3’, as a
decimal number in the range ‘001’ to ‘999’
FS
1
ce1
1
O
See
Table Note 20
Data ID ‘e’. The value ‘e’ in this field shows that barcode data is being
reported.
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
Mandatory/Optional
Description
Field Separator
:
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<
n+
1>
2
Number of coins dispensed from hopper type n
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
Field
Number of
Characters
FS
Mandatory/Optional
Description
1
See
Table Note 8
Table Note 9
Field Separator
cg1
1
See
Table Note 8
Table Note 9
Table Note 23
Table Note 24
Data ID ‘g’. The value ‘g’ in this field shows that a bunch cheque deposit
is being reported
cg2
3
See Table Note
23
Total Cheques to Return. This field contains a count of the cheques
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
cg4
3
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.
cg9
4
Must be ‘0000’
Must be ‘0000’
See Table Note
23
Deposit Currency. This field contains the three‐character ISO 4217
currency code for the deposited cheques
If multiple currencies are deposited, fields cg4 to cg16 are repeated for
each deposited currency
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
Field
Number of
Characters
Mandatory/Optional
Description
cg1
0
3
See
Table Note 25
Cheque Identifier. This field contains a three‐digit number in the range
‘001’‐’999’ that identifies a specific cheque in the deposit request
The value starts at ‘001’ for each new transaction
cg1
1
12
See
Table Note 25
Customer Cheque Amount. This field contains the value of the cheque
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
2
12
See
Table Note 25
Derived Cheque Amount. This field contains the value of the cheque
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
3
See
Table Note 25
Codeline Length. This field contains the length of the data reported in
field cg14 for the cheque identified in field cg10
This field contains a decimal number in the range ‘000’‐’999’
cg1
4
var
See
Table Note 26
Table Note 27
Table Note 25
Table Note 28
Table Note 29
Codeline Data. This field contains the codeline read from the cheque
cg1
5
1
See
Table Note 25
Cheque Group separator
cg1
6
1
See
Table Note 24
Currency Group separator
FS
1
See
Table Note 8
Table Note 9
Field Separator
ci1
1
See
Table Note 8
Table Note 9
Table Note 30
Field ID ‘<’. The value ‘<’ in this field shows that voice guidance data is
being reported.
ci2
2
See
Table Note 8
Table Note 9
Table Note 30
Voice guidance language identifier.
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
Field
Number of
Characters
Mandatory/Optional
Description
w
1
O
Field Separator
1
O
Optional data fields. These fields will be used for future expansion.
Var
O
Data.
FS
1
See
Table Note 8 &
Table Note 9
Field Separator
x
8
See
Table Note 3
Message Authentication Code Data. This field contains the calculated
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
Central.
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 Codeline Encoding
E13B
Character
E13B Meaning
0‐9
0‐9
NDC Character
Hex Value
0‐9
0x30 to
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 Codeline Encoding
CMC7
Character
CMC7 Meaning
0‐9
0‐9
NDC Character
Hex Value
0‐9
0x30 to
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
Character
NDC Character
Hex Value
CMC7 Meaning
‐
0x2D
space
0x20
space
Space
!
0x41
N/A
Reject/Unreadable
S3 ‐ Terminate Routing
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
SST Reply to Interactive
Transaction Response
9
The host can request further information during a transaction using
an Interactive Transaction Response (ITR). If this occurs, a sub‐set of
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
Transaction Request in Reply to an
Interactive Transaction Response
b
Message Class
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.
For further 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-19
Terminal to Central Messages
Solicited Status Messages
Solicited Status Messages
9
The SST responds to a command from Central by sending a solicited
status message. This section gives information about the format and
content of solicited status messages.
Content of Solicited Status
Messages
9
The information in the status message depends on the command
received and whether or not the SST can perform the command. The
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
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‐22.
Table 9-5
Solicited Status Message Format
Field
Number of
Characters
Mandatory/Optional
Description
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-20
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Field
Number of
Characters
Mandatory/Optional
Description
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, see the APTRA Advance NDC, Supervisor’s Guide.
FS
1
M
Field Separator
FS
1
M
Field Separator
e
8
See
Table Note 32
Table Note 33
Time Variant Number. Contains an eight‐digit number derived from
the time of day by the SST for each status message. The digits can be
0‐9, A‐F.
FS
1
See
Table Note 32
Field Separator
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 Central.
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-21
Terminal to Central Messages
Solicited Status Messages
Field
Number of
Characters
Mandatory/Optional
Description
‘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
Table Note 34
Field Separator
g
Var
See
Table Note 34
Status Information. Additional status information is sent only
when the status descriptor contains ‘8’, ‘C’ or ‘F’.
FS
1
See
Table Note 32
Table Note 33
Field Separator
h
8
See
Table Note 32
Table Note 33
Message Authentication Code (MAC) Data. Contains the
calculated value for authentication of this message. The
characters are in the range 0‐9 and A‐F.
i
Var
M
Trailer. Protocol‐dependent.
Table Note 32: 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 33: This is not sent if the Status Descriptor field contains
‘9’ or ‘B’.
Table Note 34: This is not sent unless the Status Descriptor field
contains ‘8’, ‘C’ or ‘F’.
Status Information
9
Additional information can optionally be contained in the Status
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.
Ready (‘B’) Status
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.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-22
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Table 9-6
Ready (‘B’) - Status Information
Field
Number of
Characters
Mandatory/Optional
Description
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 35
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‐23
For a dispense using recycle cassettes, see “Recycle Cassette Dispense
Data ‐ Sub‐field ‘g3’” on page 9‐24.
See Table Note 36
Table Note 35: If no additional data is present, the field separator is
omitted. New data groups may be included in the future.
Table Note 36: A group separator follows each reported cassette,
except the last.
Cash Deposit Recycle Data ‐ Sub‐field ‘g3’ If the transaction is
identified as a deposit using recycling cassettes or has caused the
status of the recycling cassettes to change, the data shown in
Table 9‐7 is returned in the Ready ‘B’ message.
9
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 further information, refer
to ʺ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.
APTRA™ Advance NDC, Reference Manual
9-23
Terminal to Central Messages
Solicited Status Messages
Table 9-7
Cash Deposit: Recycle Data
Number of Bytes
Description
2
Number of CDM Recycle Cassette Types
Reported. This is in the range 01 to 99.
3
CDM 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 cassette that has
accepted notes. See Table Note 37
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 cassette that has
accepted notes. See Table Note 37
1
Current Fitness Status. For details, see “Fitness
Data” on page E‐19.
This is repeated for each CDM cassette that has
accepted notes. See Table Note 37
1
Current Supplies Status. For details, see
“Supplies Data” on page E‐11. This field does
not report no change.
This is repeated for each CDM cassette that has
accepted notes. See Table Note 37
1
GS. See Table Note 37
Table Note 37: If the number of CDM recycle cassette types is
greater than 1, fields CDM NDC Cassette Type to 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
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‐8 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 Chapter 5, ʺFixed Cassette Mapping
for Recyclingʺ in the APTRA Advance NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-24
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Table 9-8
Recycle Cassette: Dispense Data
Number of Bytes
Description
2
Number of CIM Recycle Cassette Types
Reported. This is in the range 01 to 99.
3
CIM 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 cassette that
has dispensed notes. See Table Note 37
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 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 37
1
Current Fitness Status. For details, see “Cash
Acceptor Fitness (DIG ‘w’)” on page E‐24.
This is repeated for each CIM cassette that has
dispensed notes. See Table Note 37
1
Current Supplies Status. For details, see “Cash
Acceptor Supplies (DIG ‘w’)” on page E‐16. This
field does not report no change.
This is repeated for each CIM cassette that has
dispensed notes. See Table Note 37
1
GS. See Table Note 37
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‐96.
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
Table 9-9
Specific Command Reject - Status
Information
Field
Number of
Characters
Mandatory/
Optional
Description
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.
9-26
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Status Messages
Field
Number of
Characters
Mandatory/
Optional
Description
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.
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
Field
Number of
Characters
Mandatory/
Optional
Description
‘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.
02
Time‐of‐Day Clock failure or invalid data sent during Date/Time Set
command
03‐05
Reserved
06
Insufficient disk space.
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
Field
Number of
Characters
Mandatory/
Optional
Description
07
File IO error.
08
File not found.
‘E’ ‐ Function Not Supported.
(g2) Status Qualifier:
g2
2
O
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
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-10
Terminal State - Status Information
Sub-Field ‘g1’
Terminal Command
Sub-Field ‘g1’
Send configuration information
1
Send supply counters
2
Send tally information. Not Supported
3
Send error log information. Not supported
4
Send date/time information
5
Send configuration ID
6
EKC retrieve hallmark key (unsupported)
F
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
Terminal Command
Sub-Field ‘g1’
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
Send Configuration Information
This solicited status message is sent to Central 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” on page 9‐43
to “Report Cash Deposit Definition” on page 9‐53.
Table 9-11
Send Configuration Information Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
1
M
Message Identifier. This message is sent to Central 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 Central
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‐31
FS
1
M
Field Separator
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-30
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Field
Number of
Characters
Mandatory/Optional
Description
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‐34.
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‐41
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‐105.
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 38.
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 38.
Table Note 38: 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
position of the byte, as shown in the following table. The field
9
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
returns the fitness of most devices and modules for an overall view
of the state of the SST.
Table 9-12
Hardware Fitness Sub-Field ‘g3’
Byte position
Device indicated
0
Time‐of‐Day Clock, see Table Note 39
1
High Order Communications
2
System Disk
3
Magnetic Card Reader/Writer, see Table Note 39
4
Cash Handler, see Table Note 39
5
Depository, see Table Note 39
6
Receipt Printer, see Table Note 39
7
Journal Printer, see Table Note 39 and Table Note 40
8
Reserved
9
Reserved
10
Night Safe Depository, see Table Note 39
11
Encryptor, see Table Note 39
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 device (= 0)
21
Statement Printer, see Table Note 39
22
Signage Display, see Table Note 41
23‐24
Reserved, see Table Note 41
25
System Display, see Table Note 41
26
Media Entry Indicators, see Table Note 41
27
Envelope Dispenser, see Table Note 39 and Table
Note 41
28
Document Processing Module. Not supported
See Table Note 41
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
Byte position
Device indicated
29
Coin Dispensing Module Tamper Indication
See Table Note 41
30
Document Processing Module, Module Tamper
Indication. Not supported
See Table Note 41
31
Reserved, see Table Note 41
32
Voice Guidance System
See Table Note 41
33
Reserved, see Table Note 41
34
Bunch Note Acceptor
See Table Note 41
35
Cheque Processor
See Table Note 41
36‐37
Reserved, see Table Note 41
Table Note 39: 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 40: 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 41: 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
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.
Table 9-13
Hardware Fitness Severity Values
Severity Value
Meaning
0
No error
1
Routine errors have occurred
9
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
Severity Value
Meaning
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
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-14
Hardware Configuration Data: Sub-Field
‘g4’
Byte
Device
0
Product
Class
0E
0F
10
11
12
13
14
15
16
17
18
19
1A
1B
1C
1D
1E
1F
20
21
22
23
24
25
26
27
28
29
5663
5674
5675
5684
5685
5688
5665
5670
Personas 75
Personas 88
Personas 40
Personas 70
Personas 74
Personas 84
Personas 85
Personas 90
EasyPoint 55 or EasyPoint 57
Personas 86
5588
Personas 73
Personas 72
Personas 77
6674
6676
5879
5887
5362
Personas 71
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-34
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Byte
Device
58676622
6624
6626
6628
6631
6632
6634
6638
6625
6618
6636
2012 (SelfServ 22e)
2016 (SelfServ 16)
6642 (SelfServ 42)
2004 (SelfServ 4)
2008 (SelfServ 8)
2014 (SelfServ 14)
Note: This list does not imply Advance NDC
support for all these product classes.
2A30
31
32
33
34
35
36
37
38
39
3A
3B
3C
3D
3E
3F
40
1
7F
2
System Disk
00
01
02
3
No configuration
Hard disk present
Reserved
Reserved
Magnetic Card Reader/Writer. See Table Note 42.
00
01
03
05
07
08
09
0A
0B
0C
10
11
1D
1E
1F
20
No card reader attached
Track 2 (read only)
Track 1/2/3 MCRW (write on track 3 only).
(Also returned if card reader cannot be identified)
PC Dip Reader
3 Track Write MCRW
Track 2 Smart Card Reader
Track 1/2/3 Smart Card Reader
3 Track Write Smart Card Reader
Track 1/2 and Track 2/3 Dip MSR
Track 1/2/3 CIM86 MCRW
Track 1/2 Dip MSR
Track 1/2 Swipe Reader
Dip and Smart Hardware (DASH) Reader
Track 1/2/3 with MM
Track 1/2/3 Smart with MM
Track 3 Smart with MM
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
Byte
Device
4
Cash Handler. See Table Note 42, Table Note 46 and Table Note
47
00
01
02
03
04
5
Envelope Depository. See Table Note 42.
00
01
02
03
04
6
Not configured
Integral journal printer
Reserved
Thermal printer
Electronic journal
Electronic journal and integral journal printer
Reserved
Electronic journal and thermal printer
Reserved
00
9
Not configured
Plain paper
Black dot paper
Sideways printing, no black mark
Sideways printing, black mark
Thermal printer ‐ no black mark
Thermal printer ‐ black mark
Thermal printer ‐ sideways printing, no black mark
Thermal printer ‐ sideways printing, black mark
Journal Printer. See Table Note 42.
00
01
02
03
80
81
82
83
8
Not configured
Reserved
Programmable Printing Depository (PPD)
Reserved
Reserved
Receipt Printer. See Table Note 42.
00
01
02
03
04
05
06
07
08
7
Not configured
Stacking cash handler
Spray cash dispenser
Stacking cash handler with recycle capabilities. See
Table Note 43
Stacking cash handler capable of recycling with recycle
capabilities disabled. See Table Note 43
Not configured
Reserved
00
Not configured
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
Device
10
Night Safe Depository. See Table Note 42.
00
01
02
11
Encryptor. See Table Note 42.
?0
?1
02
03
04
05
06
?7
12
13
14
Not configured
Configured
Reserved
Not configured
BAPE encryptor.
Reserved
Reserved
Reserved
Reserved
Reserved
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 44
For example, C7 = double‐length key entry with an EPP
encryptor.
Security Camera
00
Not configured
01
Fixed format
02
Variable format
03
Reserved
04
Digital
Door Access. Not supported
00
Not configured
01
Configured
Flex Disk
00
01
02
Not configured
1.44 MB flex disk connected
2.88 MB flex disk connected
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
Byte
Device
15
Tamper Indicating (TI) Bins. See Table Note 42.
Not coin dispenser
00
01
02
03
16
Cardholder Keyboard
00
01
02
17
Reserved
Standard (BAPE) keyboard
EPP keyboard
Operator Keyboard
00
01
02
18
Not configured
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.
Secure cash, insecure cards and secure deposits. Not
supported
Secure cash and cards, and either insecure deposit bin
or no envelope depository (PPD). Not supported
Not configured
Standard keyboard (basic)
Keyboard plus FDKs (enhanced)
Cardholder Display/Voice
Bit 0
Bit 1
Bit 2
Bit 2
Bit 3
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
0 ‐ (always)
0 ‐ (always)
0 ‐ Voice not supported
1 ‐ Voice supported if digital audio present.
0 ‐ Standard FDKs
1 ‐ Touch screen
0 ‐ (always)
0 ‐ (always)
0 ‐ (always)
0 ‐ (always)
19
7F
No configuration
20
7F
No configuration
21
Statement Printer. See Table Note 42.
00
01
02
03
09
Not configured
Standard statement printer
Reserved
Reserved
Enhanced thermal statement printer (SDC+)
22‐23
Reserved. See Table Note 45.
24
Coin Dispenser.
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
00
01
02
03
25
System Display.
See Table Note 45.
00
01
02
26
Not configured
Coin Dispensing Module Tamper Indication.
See Table Note 45.
00
01
30
Not configured
Configured
Reserved
Reserved
Document Processing Module. Not supported.
See Table Note 45.
00
29
Not configured
Configured
Envelope Dispenser.
See Table Note 42 and Table Note 45.
00
01
02
03
28
Not configured
Reserved
Configured
Media Entry Indicators.
00
01
27
Not Configured
Reserved
Coin Dispenser with four hopper types
Coin Dispenser with more than four hopper types
Not configured
Configured
Document Processing Module Tamper Indication. Not
supported.
See Table Note 45.
00
Not configured
31
Reserved. See Table Note 45.
32
Voice Guidance
See Table Note 45
00
01
02
33
Not configured
Standard Audio present
Enhanced Audio present
Reserved. See Table Note 45.
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
34
Note Acceptor
See Table Note 42 and Table Note 45
00
01
02
03
04
Not configured
Reserved
Reserved
Bunch note acceptor
Bunch note acceptor with recycle capabilities, also
known as a recycling unit. On NCR SSTs this is called a
GBRU. See Table Note 43
05
Bunch note acceptor. On NCR SSTs, this is called a
GBNA but it can also be reported when a GBRU with
recycling disabled is present. See Table Note 43
06
Bunch note acceptor that can accept either cash or
cheques but not both in a single transaction. See Table
Note 47
07
Bunch note acceptor that can accept notes and cheques
separately or together in a single transaction. Not
supported.
Single note acceptor
08
35
36‐37
Cheque Processor
See Table Note 42 and Table Note 45
00
01
02
03
Not configured
Single cheque accept module (CPM)
Bunch cheque acceptor
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 47
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.
Reserved. See Table Note 45.
Table Note 42: The relationship between the DIG and the
configuration table offset is: offset = 2 x (DIG - 41 hex)
Table Note 43 The M‐Status values reported in device status
messages are compatible with the GBXX family of devices.
Table Note 44 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’.
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
Table Note 45: 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 46: 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 47: 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
is identified by the byte position, as shown in the following table:
Table 9-15
Supplies Status Sub-Field ‘g5’
Byte position
Device indicated
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)
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
9
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 position
Device indicated
19
Not used (= 0)
20
Not used (= 0)
21
Statement Paper
22
Statement Ribbon
23
Reserved, see Table Note 48
24
Reserved, see Table Note 48
25
Envelope Dispenser, see Table Note 48
Table Note 48: 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
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‐11.
Table 9-16
Supplies Value
Meaning
0
Not configured
1
Good state
2
Media low
3
Media out
4
Overfill
Supplies Status Values
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-42
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Hardware Configuration Data
9
This solicited status message is sent to Central in response to a Send
Configuration Information terminal command with a command
code of ‘7’ and a command modifier of ‘1’.
Table 9-17
Hardware
Configuration Data Response
:
Field
Number of
Characters
Mandatory/Optional
Description
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 Central.
FS
1
M
Field Separator
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-43
Terminal to Central Messages
Solicited Status Messages
Field
Number of
Characters
Mandatory/Optional
Description
‘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)
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
See
Device Identifier Graphic (DIG). This identifies the device to which
the following hardware configuration data applies. For details, see
see “Hardware Configuration Data” on page E‐2.
Var
O
See
Hardware Configuration. This contains information for each device
indicating which variant of the device is configured and any other
configuration data available. For details, see “Hardware
Configuration Data” on page E‐2.
1
O
See Table Note 49
Group Separator.
1
O
See Table Note 49
Device Identifier Graphic (DIG).
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
Field
g5
Number of
Characters
Mandatory/Optional
Description
Var
O
See Table Note 49
Hardware Configuration.
1
O
See Table Note 50
Field Separator.
1
O
See Table Note 50
Device Identifier Graphic (DIG).
Var
O
See Table Note 50
Data.
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 49: 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 50: These fields are reserved for future expansion.
Supplies Data
9
This solicited status message is sent to Central in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘2’). For details,
see the “Terminal Commands” section of Chapter 10, “Central to
Terminal Messages”.
Note: If option 83 is set to ‘000’, no supplies data is sent to Central
for the cheque processor.
Table 9-18
Supplies Data Response
Field
Number of
Characters
Mandatory/Optional
Description
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.
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
Field
Number of
Characters
Mandatory/Optional
Description
If a device is not present, there will be no corresponding DIG in the
field.
1
O
See Table Note 51
Device Identifier Graphic (DIG). This identifies the device to which
the following supplies status data applies. For details, see Chapter E,
“Device Identifiers”.
Var
O
See Table Note 51
Supplies Status. This contains information for each device indicating
the condition of the device’s replenishables. For details, see
“Supplies Data” on page E‐11.
Except for cash acceptors—see “Cash Acceptor Supplies (DIG ‘w’)”
on page E‐16— each element of the supplies status data will take one
of the following values:
g3
Value
Description
‘0’
Not configured/reserved
‘1’
Good state
‘2’
Media low
‘3’
Media out
‘4’
Overfill
1
O
See Table Note 52
Group Separator.
1
O
See Table Note 52
Device Identifier Graphic (DIG).
Var
O
See Table Note 52
Supplies Status.
1
O
See Table Note 53
Field Separator
1
O
See Table Note 53
Data Identifier.
Var
O
See Table Note 53
Data.
Table Note 51: 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 52: 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
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
as often as necessary to ensure that the data relating to all devices
present in the SST is reported.
Table Note 53: These fields are reserved for future expansion.
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
Fitness Data
This solicited status message is sent to Central in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘3’). For details,
see the “Terminal Commands” section of Chapter 10, “Central to
Terminal Messages”.
Table 9-19
Fitness Data Response
Field
Number of
Characters
Mandatory/Optional
Description
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
See Table Note 54
Device Identifier Graphic (DIG). This identifies the device to which
the following fitness data applies. For details, see Appendix E,
“Device Identifiers”.
Var
O
See Table Note 54
Fitness. Each fitness character is encoded with one of the following
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‐19.
1
O
See Table Note 55
Group Separator.
1
O
See Table Note 55
Device Identifier Graphic (DIG).
Var
O
See Table Note 55
Fitness.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-48
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Field
Number of
Characters
Mandatory/Optional
Description
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 54: 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 55: 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.
Tamper and Sensor Status Data
9
This solicited status message is sent to Central in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘4’). For details,
see the “Terminal Commands” section of Chapter 10, “Central to
Terminal Messages”. 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-20
Tamper and Sensor Data Response
Field
Number of
Characters
Mandatory/Optional
Description
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
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.
g3
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
Field
Number of
Characters
Mandatory/Optional
Description
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 in Advance NDC
If a device is not configured, any associated TI byte will take the value
‘0’.
g4
1
O
Extended Tamper Indicator Identifier ‘C’. See Table Note 56
1
See Table Note
57 and Table
Note 58
Device Identifier Graphic (DIG). This field contains data on each
device present in the SST.
Var
See Table Note
57 and Table
Note 58
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.
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‐25.
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’.
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
Field
Number of
Characters
g5
Mandatory/Optional
Description
1
See Table Note
59
Field Separator.
1
See Table Note
59
Data Identifier.
Var
See Table Note
59
Data.
Table Note 56: 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 57: 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 58: A DIG and associated data are included as often as
required to report on all devices.
Table Note 59: 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-51
Terminal to Central Messages
Solicited Status Messages
Software ID and Release Number Data
9
This solicited status message is sent to Central in response to a Send
Configuration Information terminal command message (a
command code of ‘7’ with a command modifier of ‘5’). For details,
see the “Terminal Commands” section of Chapter 10, “Central to
Terminal Messages”.
Table 9-21
Software ID and Release Number Data
Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
1
M
Message Identifier. This message has identifier ‘L’.
g2
1
M
Release Number Identifier ‘A’.
Var (6)
M
NDC Release Number. 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, 020600 is release 2.06.
FS
1
M
Field Separator
g3
1
M
Software ID Identifier ‘B’.
Var (9)
M
Advance NDC Software ID. Contains the Advance NDC Software ID.
For this release, the field takes the following values:
G531‐0283 (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
This solicited status message is sent to Central 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-52
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
For details of this message, see “Send Configuration Information”
on page 9‐30. 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‐31
“Hardware Configuration Data—Sub‐Field ‘g4’” on page 9‐34
“Supplies Status—Sub‐field ‘g5’” on page 9‐41.
Local Configuration Option Digits
9
This solicited status message is sent to Central 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 digit 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-22
Local Configuration Option Digits
Response
Field
Number of
Characters
Mandatory/Optional
Description
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 which may be 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 Central 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-53
Terminal to Central Messages
Solicited Status Messages
Table 9-23
Note Definitions (BNA) Response
Field
Number of
Characters
Mandatory/Optional
Description
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 60 and Table Note 61.
FS
1
O
See Table Note 62
g3
1
O
ECB 6 Note Retention Mode ID (ʹDʹ)
3
O
ECB 6 Note Retention Mode
1
O
See Table Note 62
1
O
Data Identifier. Reserved for future expansion
Var
O
Data. Reserved for future expansion
FS
Table Note 60: 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 61: 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-54
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 62: The field separators must be present if any other
fields follow.
Table Note 63: 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 Central 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‐61.
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
Basic Send Supply Counters
the following:


The basic message format can report
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-24
Send Supply Counters Response
Field
Number of
Characters
Mandatory/Optional
Description
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 Central, 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 Central 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-56
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Field
Number of
Characters
Mandatory/Optional
Description
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 Central 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’.
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 64
Group Separator.
g20‐g22
Var(15)
O
Reserved.
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
Field
Number of
Characters
Mandatory/Optional
Description
GS
1
See Table Note 64
Group Separator.
g30‐g32
Var(15)
O
Reserved.
GS
1
See Table Note 64
Group Separator.
g40‐g4x
Var(x)
O
Reserved.
GS
1
See Table Note 64
Group Separator.
g50‐g53
Var(20)
O
Reserved.
GS
1
See Table Note 64
Group Separator.
g60
Var(20)
O
See Table Note 65
Coins remaining
g61
Var(20)
O
See Table Note 65
Coins dispensed
g62
Var(20)
O
See Table Note 65
Last transaction coins dispensed
GS
1
See Table Note 64
Group Separator.
g70
5
O
See Table Note 66
Total notes refunded
g71
5
O
See Table Note 66
Total notes rejected
g72
5
O
See Table Note 66
Total notes encashed
g73
5
O
See Table Note 66
Total notes escrowed
GS
1
See Table Note 64
Group Separator.
g80‐g89
5
O
Reserved.
GS
1
See Table Note 64
Group Separator.
g90‐g99
5
O
Reserved.
GS
1
See Table Note 64
Group Separator.
g100‐
g109
5
O
Reserved.
GS
1
See Table Note 64
Group Separator.
g110‐
g119
5
O
Reserved.
GS
1
See Table Note 64
Group Separator.
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
Field
Number of
Characters
Mandatory/Optional
Description
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 64
Group Separator.
g130‐
g139
5
O
Reserved.
GS
1
See Table Note 64
Group Separator.
g140
5
O
Reserved.
GS
1
See Table Note 64
Group Separator.
g150‐
g154
5
O
Reserved.
GS
1
See Table Note 64
Group Separator.
g160
5
O
Number of passbooks captured.
Table Note 64: 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‐61.)
Table Note 65 Fields ‘g60’ ‐ ‘g62’ form a group and will only be
present if a coin dispenser is present.
Table Note 66: 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
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:
9
22<FS>000<FS><FS>F<FS>202730000267012670168101629007780000300052000020000200194001330113100
2800000000005000000000000000000000000000000
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
The content of this message is described in the following table:
Table 9-25
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
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
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
Extended Send Supply Counters The extended message format
supports the reporting of up to eight coin hoppers. The counts are
grouped and separated by group separators.
9
Table 9-26
Send Supply Counters: Extended
Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
1
M
Message Identifier. This message has identifier ‘7’.
g2
1
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 Central, 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.
Transaction group id ‘A’.
A transaction attempt is detected when it is recognised that the TSN
received from Central is different from the previously received
TSN.
GS
1
See Table Note 67
Group Separator.
g5
1
See Table Note 67
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’.
GS
1
See Table Note 67
Group Separator.
g7
1
See Table Note 67
Cash Handler 0 data group ID ‘C’
g8
3
See Table Note 67
and Table Note 68
Cassette Type. Consists of one three‐digit identifier of the cassette
type being reported on. The identifier can be between 000 and 007
depending on the cash handler configuration.
g9
5
See Table Note 67
and Table Note 68
Notes In Cassettes. Consists of a five‐digit decimal count of the
number of notes in the cassette.
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
Field
Number of
Characters
g10
5
Mandatory/Optional
Description
See Table Note 67
and Table Note 68
Notes Rejected. Consists of a five‐digit decimal count of the number
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 67
and Table Note 68
Notes Dispensed. Consists of a five‐digit decimal count of the
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 67
and Table Note 68
Last Transaction Notes Dispensed. Consists of a five‐digit decimal
count of the number of notes dispensed during the last transaction.
g13
5
See Table Note 67,
Table Note 68 and
Table Note 70
Notes Deposited. Consists of a five‐digit decimal count of the total
number of deposited notes.
GS
1
See Table Note 67
Group Separator.
g14
1
See Table Note 67
Cash Handler 1 data group ID ‘D’
g15
3
See Table Note 67
and Table Note 68
Cassette Type. Consists of one three‐digit identifier of the cassette
type being reported on. The identifier can be between 000 and 007
depending on the cash handler configuration.
g16
5
See Table Note 67
and Table Note 68
Notes In Cassettes. Consists of one five‐digit decimal count of the
number of notes in the cassette.
g17
5
See Table Note 67
and Table Note 68
Notes Rejected. Consists of a five‐digit decimal count of the number
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 67
and Table Note 68
Notes Dispensed. Consists of a five‐digit decimal count of the
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.
g19
5
See Table Note 67
and Table Note 68
Last Transaction Notes Dispensed. Consists of a five‐digit decimal
count of the number of notes dispensed during the last transaction.
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
Field
Number of
Characters
g20
Mandatory/Optional
Description
5
See Table Note 67,
Table Note 68 and
Table Note 70
Notes Deposited. Consists of a five‐digit decimal count of the
number of deposited notes.
GS
1
See Table Note 67
Group Separator.
g21
1
See Table Note 67
Coin dispenser data group ID ‘E’
g22
2
See Table Note 67
and Table Note 69
Hopper Type Number. Consists of one two‐digit identifier of the
hopper type being reported on. The identifier can be between 01
and 08 depending on the coin hopper configuration.
g23
5
See Table Note 67
and Table Note 69
Coins Remaining. Consists of a five‐digit decimal count of the total
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 67
and Table Note 69
Coins Dispensed. Consists of a five‐digit decimal count of the total
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 67
and Table Note 69
Last Transaction Coins Dispensed. Consists of a five‐digit decimal
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 67,
Table Note 69, and
Table Note 70
Coins Deposited. Consists of a five‐digit decimal count of the total
number of coins deposited 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.
GS
1
See Table Note 67
Group Separator.
g27
1
See Table Note 67
Envelope Depository data group ID ‘F’
g28
5
See Table Note 67
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 67
Last Envelope Serial Number. The last envelope serial number is
always 00000.
GS
1
See Table Note 67
Group Separator.
g30
1
See Table Note 67
Camera data group ID ‘G’.
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
Field
Number of
Characters
Mandatory/Optional
Description
g31
5
See Table Note 67
Camera Film Remaining. The camera film remaining is always
00000.
GS
1
See Table Note 67
Group Separator.
g32
1
See Table Note 67
DPM data group ID ‘H’. Not supported.
g33
2
See Table Note 67
Deposit Bin Identifier. Not supported.
g34
5
See Table Note 67
and Table Note 97
Documents Deposited in Bin. Not supported.
GS
1
See Table Note 67
Group Separator.
g35
1
See Table Note 71
and Table Note 72
BNA Cassette Counts data group ID ‘I’.
g36
3
See Table Note 71,
Table Note 72
and Table Note 73
NDC Cassette Type. Consists of one three‐digit identifier. The
identifier can be between 001 and 999.
g37
5
See Table Note 71,
Table Note 72
and Table Note 73
Total Notes In Cassette. Consists of a five‐digit decimal count of the
number of notes in the cassette.
g38
3
See Table Note 71,
Table Note 72
and Table Note 73
Number of Note Types Reported. This is a value in the range ‘000’
to ‘999’
g39
4
See Table Note 71,
Table Note 72
and Table Note 74
Note Type Identifier. This is a value in the range’0001’ to ‘FFFF’
g40
5
See Table Note 71,
Table Note 72,
Table Note 74 and
Table Note 75
Number of notes of the type identified by the note type identifier in
field g39. Consists of a five‐digit decimal count of the number of
notes of an identified type.
GS
1
See Table Note 67
Group Separator.
g41
1
See Table Note 76
Cheque processor data group ID ‘J’
g42
1
See Table Note 76
and Table Note 77
Bin Number
g43
5
See Table Note 76
and Table Note 77
Cheques deposited in bin
GS
1
See Table Note 67
Group Separator.
g44
1
See Table Note 78
BNA Emulation (and Extended Emulation) deposit data group ID
‘K’
g45
5
See Table Note 78
and Table Note 79
Total Notes Refunded
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
Field
Number of
Characters
g46
Mandatory/Optional
Description
5
See Table Note 78,
Table Note 79 and
Table Note 82
Total Notes Returned Rejected
g47
5
See Table Note 78
and Table Note 79
Total Notes Encashed
g48
5
See Table Note 78
and Table Note 79
Total Notes Escrowed
GS
1
See Table Note 67
Group Separator.
g49
1
See Table Note 67,
Table Note 70 and
Table Note 80
Dual Dispenser combined data group ID ‘l’
g50
3
See Table Note 73
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 73
Notes in Cassette. Consists of a five‐digit decimal count of the
number of notes in the cassette.
g52
5
See Table Note 73
Notes Rejected. Consists of a five‐digit decimal count of the number
of reject notes.
g53
5
See Table Note 73
Notes Dispensed. Consists of a five‐digit decimal count of the
number of dispensed notes.
g54
5
See Table Note 73
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 73
and Table Note 81
Notes Deposited. Consists of a five‐digit decimal count of the
number of deposited notes.
GS
1
See Table Note 67
Group Separator.
g58
1
See Table Note 71
ECB 6 Category 2 Notes data group ID ‘N’
Not supported by Advance NDC.
g59
3
See Table Note 71
and Table Note 73
NDC Cassette Type. Consists of one three‐digit identifier of the
cassette type. The identifier can be between 001 and 999 depending
on the cash handler configuration.
g60
5
See Table Note 71
and Table Note 73
Total Number Category 2 Notes. Consists of a five‐digit decimal
count of the number of deposited notes identified as counterfeit
under ECB 6.
g61
3
See Table Note 71
and Table Note 73
Number of Reported Category 2 Note Types. Consists of a
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.
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
Field
Number of
Characters
g62
Mandatory/Optional
Description
4
See Table Note 71
and Table Note 74
Category 2 Note Type Identifier. Consists of one four‐digit identifier
of the note type reported as counterfeit under ECB 6. The identifier
can be between 0001 and FFFF.
g63
5
See Table Note 71
and Table Note 74
Category 2 Notes. Consists of a five‐digit decimal count of the total
number of notes of the note type in field g62 identified as
counterfeit under ECB 6.
GS
1
See Table Note 67
Group Separator.
g64
1
See Table Note 71
ECB 6 category 3 notes group data id ‘O’
Not supported by Advance NDC.
g65
3
See Table Note 71
and Table Note 73
NDC Cassette Type. Consists of one three‐digit identifier of the
cassette type being reported on. The identifier can be between 001
and 999 depending on the cash handler configuration.
g66
5
See Table Note 71
and Table Note 73
Total Number Category 3 Notes. Consists of a five‐digit decimal
count of the number of deposited notes identified as category 3
under ECB 6.
g67
3
See Table Note 71
and Table Note 73
Number of Reported Category 3 Note Types. Consists of a
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 71
and Table Note 74
Category 3 Note Type Identifier. Consists of one four‐digit identifier
of the note type reported as category 3 under ECB 6. The identifier
can be between 0001 and FFFF.
g69
5
See Table Note 71
and Table Note 74
Category 3 Notes. Consists of a five‐digit decimal count of the total
number of notes of the note type identified in field g62 identified as
category 3 under ECB 6.
GS
1
See Table Note 67
Group Separator.
Table Note 67: 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.
Table Note 68: 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 69: Fields g22 to g26 are repeated for each configured
hopper type in the coin dispenser.
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
Table Note 70: These fields used only on devices that can recycle
deposited items.
Table Note 71: These fields are included in Enhanced Cash Deposit
mode.
Table Note 72: 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‐14.
Table Note 73: Fields g36 to g38, g49 to g55 and g58 to g69 are
repeated for each NDC cassette type.
Table Note 74: 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 75: Field g40 includes all notes identified as category 2,
category 3, or category 4 under ECB 6.
Table Note 76: Fields g41 to g43 are only included when a cheque
processor is present.
Table Note 77: Fields g42 and g43 report the number of cheques
stored in each bin.
Table Note 78: Fields g44 to g48 are only included in BNA
Emulation modes.
Table Note 79: Fields g45 to g48 contain the counts for all note types.
Table Note 80: Fields g49 to g55 are included only when dual cash
handlers are emulating a single cash handler as defined by
enhanced configuration option 76. For details of option 76, see
“Option 76 – Cash Handlers” on page 7‐19.
Table Note 81: Field g55 is used only if recycling is enabled. If
recycling is not enabled, this field contains ‘00000’.
Table Note 82: Notes returned to the cardholder without being
processed are unknown under CEN XFS.
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
Send Tally Information
From Advance NDC 2.06 onwards, tally reporting is not supported.
A default message is sent to Central 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-27
Send Tally Information Response
Field
Number of
Characters
Mandatory/Optional
Description
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-68
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Send Error Log Information
9
Note: From Advance NDC 2.06 onwards, error log reporting is
not supported. A default message is sent to Central 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-28
Send Error Log Information Response
Field
Number of
Characters
Mandatory/Optional
Description
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-69
Terminal to Central Messages
Solicited Status Messages
Send Date/Time Information
This solicited status message is sent to Central in response to a Send
Date And Time message (a command code of ‘8’). For details, see
the “Terminal Commands” section of Chapter 10, “Central to
Terminal Messages”.
Table 9-29
Send Date/Time Information Response
Field
Number of
Characters
Mandatory/Optional
Description
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-70
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Status Messages
Send Configuration ID
9
This solicited status message is sent to Central in response to a Send
Configuration ID terminal command message (a command code of
‘3’). For details, see the “Terminal Commands” section of
Chapter 10, “Central to Terminal Messages”.
Table 9-30
Send Configuration ID Response
Field
Number of
Characters
Mandatory/Optional
Description
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 Central.
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 Device Fault Status
Solicited Device Fault Status
This section describes the information contained in the Status
Information field when the Status Descriptor is ‘8’ ‐ Device Fault,
For details, see the “Device Fault Status Information Field” section.
All solicited status device fault messages require Central 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”.
Device Fault Status
Responses
Table 9-31
Device Fault Status in Response to
Transaction Reply Commands
The following table shows the solicited device fault status messages
which may be returned for each Transaction Reply command.
9
Transaction Reply Command
Device Faults
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
Print
Card Reader/Writer, Cash
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-72
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Solicited Device Fault Status
Device Fault Status
Information Field
9
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
given in Table 9‐32 is present in the Status Information field. In the
“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‐19.
Table 9-32
Device Fault Status Information Field
Field
Number of
Characters
Mandatory/Optional
Description
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 83
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 Central, 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-73
Terminal to Central Messages
Solicited Device Fault Status
Field
Number of
Characters
Mandatory/Optional
Description
‘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 83
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‐75 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 83
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-74
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Solicited Device Fault Status
Field
Number of
Characters
Mandatory/Optional
Description
‘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 83: Included if any of the subsequent fields are present.
As the field lengths may change with the hardware being used,
Central 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-75
Terminal to Central Messages
Other Solicited Messages
Other Solicited Messages
Other solicited messages that can be sent from the terminal to
Central are as follows:


Encryptor Initialisation
Data
9
Encryptor Initialisation Data
Upload EJ Data Message
This message class/sub‐class is used when initialising the encryptor
module, and is used in a similar way to the terminal state message.
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-33
Encryptor Initialisation Data Response
Field
Number of
Characters
Mandatory/Optional
Description
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-76
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Other Solicited Messages
Field
Number of
Characters
Mandatory/Optional
Description
‘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
‘B’
Encryptor capabilities and state
‘C’
Key deleted
‘D’
EPP attributes
‘E’
Variable‐length EPP serial number and signature
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’:
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 Central.
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
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
Other Solicited Messages
Field
Number of
Characters
Mandatory/Optional
Description
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: Central 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
Var
RSA KVV base 94 encoded
When Information Identifier = ‘8’
3
Binary data length
Var
SST certificate base 94 encoded
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.
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
Other Solicited Messages
Field
Number of
Characters
Mandatory/Optional
Description
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 84
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
3‐7
Reserved and must be 0
Examples are as follows:
2
‘00’
None
‘01’
Signature
‘02’
Certificate
‘03’
Signature and certificate
‘04’
Enhanced signature
‘06’
Enhanced signature and certificate
Certificate state
‘00’ Not ready or not supported
‘01’ Certificate primary
‘02’ Certificate secondary
1
EPP Variable Length Serial Number Capability
See Table Note 85
‘0’
Variable length EPP serial numbers not supported
See Table Note 86
‘1’
Variable length EPP serial numbers supported
See Table Note 87
When Information Identifier = ‘C’
For Key Deleted, this field is absent
When Information Identifier = ‘D’
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
Other Solicited Messages
Field
Number of
Characters
Mandatory/Optional
Description
EPP attributes are defined as follows:
1
‘0’
Var
EPP Vendor Company Name Identifier
Alphanumeric characters that define the EPP vendor company
name as registered with PCI
1
Group Separator
1
‘1’
Var
EPP Model Identifier Data Identifier
Alphanumeric characters that define the EPP model identifier
as registered with PCI
1
Group Separator
1
‘2’
Var
EPP Hardware Identifier Data Identifier
Alphanumeric characters that define the EPP hardware
identifier as registered with PCI
1
Group Separator
1
‘3’
Var
EPP Firmware Identifier(s) Data Identifier
Alphanumeric characters that define the EPP firmware
module identifiers as registered with PCI.
1
Group Separator
1
‘4’
Var
EPP Application Identifier(s) Data identifier
Alphanumeric characters that define the application module
identifiers as registered with PCI
When Information Identifier = ‘E’
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)
Table Note 84 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
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
Other Solicited Messages
RHost
= Host’s random number
RSST
= SST’s random number.
IHost
= Host identifier
Table Note 85 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 86: 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’).
Table Note 87 If variable length EPP serial numbers are supported
the following apply:



Upload EJ Data Message
9
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.
The SST sends this solicited message to Central in response to an EJ
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.
For details of EJ Options and Timers and acknowledgement
messages, see the “EJ Commands” on page 10‐91.
The SST will continue to upload EJ data blocks as long as an
acknowledgement message is received from Central for each
message sent. If an acknowledgement is not received within the
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
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 the
APTRA Advance NDC, Supervisor’s Guide, Chapter 3, “Replenish
Menu”.
Table 9-34
Format of the Upload EJ Data Message
Field
Number of
Characters
Mandatory/Optional
Description
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.
g
6
M
Last Char Previous Block.
Range 000000 to 999999. See Table Note 88.
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
Field
Number of
Characters
Mandatory/Optional
Description
h
6
M
Last Char This Block.
Range 000000 to 999999. See Table Note 88.
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 001‐350 as specified by Field ‘i’. 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 89.
Table Note 88: 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 89: 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.
APTRA™ Advance NDC, Reference Manual
9-83
Terminal to Central Messages
Unsolicited Status Messages
Unsolicited Status Messages
Unsolicited status messages are used to report any change of
condition at the SST, such as the following:



Conditions for Sending
Unsolicited Messages
Recognition of an external event
Device errors
Supplies problems.
Unsolicited status messages do not require a reply from Central.
They are sent under the following conditions:
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
Central recovery action. This means that Transaction Reply
processing can continue as if no fault had occurred
A device fault is detected which 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
cardholder 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 the publication, APTRA Advance NDC,
Extending the Product.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-84
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Unsolicited Status Messages
Table 9-35
Unsolicited Status: Message Format
Field
Number of
Characters
Mandatory/Optional
Description
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 90
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‐36.
f
Var
M
Trailer. Protocol‐dependent.
Table Note 90: In power‐up status messages, this field contains
either the LUNO that has been previously downloaded, or ‘000’.
Unsolicited Status
Information Field
One of the following conditions must be satisfied before an
unsolicited message is sent:
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.
APTRA™ Advance NDC, Reference Manual
9-85
Terminal to Central Messages
Unsolicited Status Messages
Table 9-36
Unsolicited Status: Status Information Field
Field
Number of
Characters
Mandatory/Optional
Description
e1
1
M
Device Identifier Graphic (DIG). The device identifier
e2
Var
(154 max)
O
Device Status. Used for recording any transaction exception of
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 91
Field Separator
e3
Var (14)
O
Error Severity. As ‘g3’ in Solicited messages.
FS
1
See Table Note 91
Field Separator
e4
Var
O
Diagnostic Status. As ‘g4’ in Solicited messages.
FS
1
See Table Note 91
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 91: This field separator is included if any of the
following optional fields that follow it are included.
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
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 journalling that occurs, refer to the APTRA
Advance NDC, Supervisor’s Guide.
Time‐Of‐Day Clock
(Unsolicited)
This message indicates that the Time‐of‐Day Clock is not available.
Central can either keep the SST out‐of‐service or return it to service.
9
Table 9-37
Time-Of-Day Clock Status
Field
Number of
Characters
Content
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.
Power Failure
(Unsolicited)
9
This message is sent during power‐up to tell Central that a power
interruption has occurred. If the SST is configured to send a
message whenever communications is restored, this message is sent
when the connection is re‐established.
Central 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 in‐service
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
Device Status Information
Table 9-38
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. Central 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.
Card Reader/Writer
(Solicited/Unsolicited)
9
This message gives details of any exception condition that is
detected during card processing. Solicited device faults are reported
only on Card Before Cash transactions.
Note: If failure occurs in the physical connection, an unsolicited
status message is reported indicating that the MCRW has a fatal
severity and that the device is inoperative. Advance NDC does not
put the SST into Out of Service mode when the MCRW enters a fatal
state. It is the responsibility of the host and the host must be
configured to do this if required.
Table 9-39
Card Reader/Writer Status
Number of
Characters
Content
g1/
e1
1
Device Identifier Graphic ʹDʹ.
g2/
e2
1
Transaction/Device Status. Gives details of any transaction‐related exception condition
detected while processing a card at the SST. Possible values are:
Field
Sol/
Unsol
Code
Description
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 92 and Table Note 93
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
Device Status Information
Field
Number of
Characters
Content
S/U
‘2’
The mechanism failed to eject the card, which was either captured or
jammed.
See Table Note 92 and Table Note 93
S/U
‘3’
The mechanism failed to update the requested tracks on the card.
S/U
‘4’
Invalid track data received from Central.
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 further information about EMV/CAM2 messages, refer to the EMV Integrated Circuit
Card (ICC) Reference Manual.
g3/
e3
Var
(1 or 2)
Error Severity. This is a one or two character field coded in the standard way to be used to
make a shut‐down decision.
g4/
e4
Var
Diagnostic Status (M‐status plus M‐data). This contains information to be used for
logging device errors. The M‐status describes the main error found.
g5/
e5
1
Supplies Status. This is a single character field indicating the state of the card capture bin.
Code
Description
‘0’
No new state
‘1’
No overfill condition (capture bin)
‘4’
Overfill condition (capture bin)
Table Note 92: 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 93: 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‐40, “Additional Track Data on Card
Retract” are added to the message.
Table 9-40
Additional Track Data on Card Retract
Field
Number of Characters
Content
FS
1
Field separator
e600
Var (78)
Track 1 data
GS
1
Group separator
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
Device Status Information
Cash Handler
(Solicited/Unsolicited)
Field
Number of Characters
Content
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
Transaction Reply command message.
9
The format depends on the setting of Enhanced Configuration
option 76, as described in Table 9‐41 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‐94. 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-41
Cash Handler Status
Field
Number of
Characters
Content
g1/e1
1
Device Identifier Graphic ‘E’.
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, 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.
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
Device Status Information
Field
Number of
Characters
Content
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 100
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
4‐5
6‐7
8‐9
1
2
3
4
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
Device Status Information
Field
Number of
Characters
Content
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
10‐11
12‐13
14‐15
16‐17
1
2
3
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
4‐5
6‐7
8‐9
10‐11
12‐13
14‐15
1
2
3
4
5
6
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
18‐19
20‐23
24‐25
26‐27
28‐29
30‐31
1
2
3
4
5
6
7
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
Device Status Information
Field
Number of
Characters
Content
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
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 95
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
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
Device Status Information
Field
Number of
Characters
Content
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 96
‘1’
Sufficient notes.
‘2’
Notes low.
‘3’
Out of notes.
Codes for character 0 are:
Code
Description
‘0’
No new state (cassette not accessed or state unknown because of fatal
hardware malfunction).
See Table Note 96
‘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 94: 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 95: When notes are retracted, the supplies status of all
cassettes is included in the unsolicited message and journaled.
Table Note 96: 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
A recycling cassette previously reported as out of notes can be
replenished during a deposit transaction. When this occurs, the
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-94
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Device Status Information
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
— No change (‘0’) for any supply status that has not changed.
This message gives details of a deposit operation in response to a
Transaction Reply Command message.
Depository
(Solicited/Unsolicited)
9
Table 9-42
Depository Status
Field
Number of
Characters
Content
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/
Unsol
Code
Description
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.
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
Field
Number of
Characters
g5/e5
Content
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
Receipt Printer
(Solicited/Unsolicited)
9
This message indicates whether or not a print operation has been
successfully completed. A solicited status message may be sent in
response to the following Transaction Reply commands if sideways
printing has been requested:


Print Statement and Wait
Print Statement and Set Next State.
Table 9-43
Receipt Printer Status
Field
Number of
Characters
Content
e1
1
Device Identifier Graphic ‘G’.
e2
1
Transaction/Device Status. Indicates whether or not the print was successfully completed.
e3
e4
Var (2)
Var
Sol/
Unsol
Code
Description
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
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” in the APTRA Advance NDC Developer’s Guide
Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found.
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
Field
Number of
Characters
e5
5
Content
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’
Ribbon OK
‘2’
Ribbon replacement recommended
‘3’
Ribbon replacement mandatory
‘1’
Print‐head OK
‘2’
Print‐head replacement recommended
‘3’
Print‐head replacement mandatory
‘1’
Knife OK
‘2’
Knife replacement recommended
1
Capture bin OK
4
Capture bin overfill
1
2
3
4
When a ‘paper exhausted’ condition is detected, and 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).
Journal Printer
(Unsolicited)
9
This message indicates whether or not a print operation has been
completed successfully. From Advance NDC 2.06 onwards,
continuous messaging of fatal journal 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.
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-44
Journal Printer Status
Field
Number of
Characters
Content
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 97, Table Note 98, and Table Note 99.
Sol/
Unsol
Code
Description
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
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’
Ribbon OK
‘2’
Ribbon replacement recommended
‘3’
Ribbon replacement mandatory
1
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
Field
Number of
Characters
Content
2
3
‘1’
Print‐head OK
‘2’
Print‐head replacement recommended
‘3’
Print‐head replacement mandatory
‘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 97: 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
YYYY
the record number relative to the last
printed Security Trace Number
Table Note 98: 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 99: As in NDC+, 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.
Electronic Journal Printer
(Unsolicited)
This message indicates whether or not a print operation has been
completed successfully.
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.
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
Table 9-45
Electronic Journal Printer Status
Field
Number of
Characters
Content
e1
1
Device Identifier Graphic ‘H’.
e2
1
Transaction/Device Status. Indicates whether or not the print was completed successfully.
See Table
Note 100.
Sol/
Unsol
Code
Description
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.
U
‘=’
EJ in dual mode print operation successful
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:
0
1
5
6
7
50
51
52
53
54
55
e5
1
EJ status OK
EJ fatal
EJ log file full
EJ not configured
EJ log file not found
EJ log file open failure
EJ log file close failure
EJ flex disk not found
EJ flex disk drive head jam
EJ flex disk protected
EJ flex disk full.
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.
9-100
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Field
Number of
Characters
Content
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 100: If option 35 in the Enhanced Configuration
Parameters load (see page 10‐19) 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-46
Unsolicited Message Sequences for
Option 35 (EJ Dual Mode)
Option 35
Value
000
Type
Message Sequence
Comment
Physical
journal
H0
Print operation succeeded
Paper supplies are low or out
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
journal
EJ only
H0
Print operation succeeded
Paper supplies are low or out
H1
Print operation failed
Sent when the print operation is
unsuccessful
H=
EJ print operation
succeeded
Sent in addition to messages for physical
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
hardcopy
backup
H0
Print operation succeeded
Paper supplies are low
H6
Journal printer backup
activated
Sent when the physical journal printer
enters a fatal state
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
Option 35
Value
Type
EJ only
Message Sequence
Comment
H8
Journal printer backup
reprint started
Sent when the journal printer restarts
H7
Journal printer backup
and reprint terminated
Sent after H8 when the reprint is
successfully completed
H;
Journal printer backup
reprint halted
Sent if the journal printer enters a fatal
state during a reprint
H=
Successful EJ print
operation
Sent in addition to messages for physical
journal. EJ is nearly full
H>
EJ print operation failed
EJ is full
Night Safe Depository
(Solicited/Unsolicited)
9
A solicited status message is sent in response to a Transaction Reply
Command message if the deposit has not been detected. It indicates
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-47
Night Safe Depository Status
Field
Number of
Characters
Content
g1
1
Device Identifier Graphic ‘K’.
g2
1
Transaction/Device Status.
g3
1
Sol/
Unsol
Code
Description
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 101.
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.
9-102
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Field
Number of
Characters
Content
‘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 101: 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, see 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.
Encryptor (Unsolicited)
9
This message indicates that an attempt to use the encryptor has
failed. If an error status is reported, NCR recommends that an
attempt be made to re‐enter the local encryption keys.
Table 9-48
Encryptor Status
Field
Number of
Characters
Content
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.
APTRA™ Advance NDC, Reference Manual
9-103
Terminal to Central Messages
Device Status Information
Field
Number of
Characters
Content
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.
Camera (Unsolicited)
9
This message indicates that a camera error has been detected. For
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-49
Camera Status
Field
Number of
Characters
Content
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.
9-104
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Sensors (Unsolicited)
9
This message is sent on Supervisor mode entry and exit, tamper
indicating bin in/out conditions and alarm conditions.
Table 9-50
Sensors Status
Field
Number of
Characters
Content
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
104
‘5’
Full TI and full alarms change detected
See Table Note
104
‘6’
Flexible TI and alarms change detected
If byte 1 = ‘2’ (mode change) the next byte gives details of the current state:
2
3
‘0’
Supervisor mode exit
‘1’
Supervisor mode entry
‘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 of chapter 5 in 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.
APTRA™ Advance NDC, Reference Manual
9-105
Terminal to Central Messages
Device Status Information
Field
Number of
Characters
Content
3
‘0’
Vibration and/or heat sensor inactive.
See Table Note 102 and Table Note 103.
‘1’
Vibration and/or heat sensor active
‘0’
Door contact sensor inactive. See Table Note 102 and Table Note 103.
‘1’
Door contact sensor active
‘0’
Silent signal sensor inactive. See Table Note 102 and Table Note 103.
‘1’
Silent signal sensor active
‘0’
Electronics enclosure sensor inactive. See Table Note 102 and Table Note
103.
‘1’
Electronics enclosure sensor active
‘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
‘0’
Currency cassette in position 1 (top) out
‘1’
Currency cassette in position 1 (top) in
‘0’
Currency cassette in position 2 (second) out
‘1’
Currency cassette in position 2 (second) in
‘0’
Currency cassette in position 3 (third) out
‘1’
Currency cassette in position 3 (third) in
‘0’
Currency cassette in position 4 (bottom) out
‘1’
Currency cassette in position 4 (bottom) in
4
5
6
7
10
11
12
13
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
‘0’
Coin dispenser hopper 1 out
‘1’
Coin dispenser hopper 1 in
‘0’
Coin dispenser hopper 2 out
15
16
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
Field
Number of
Characters
Content
17
18
19
‘1’
Coin dispenser hopper 2 in
‘0’
Coin dispenser hopper 3 out
‘1’
Coin dispenser hopper 3 in
‘0’
Coin dispenser hopper 4 out
‘1’
Coin dispenser hopper 4 in
‘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‐20, “Tamper and Sensor Data Response” on page 9‐49.
e3
Not present
e4
Not present
e5
Not present
Table Note 102: 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 103: If a device is not configured, the associated tamper
byte will take the value zero.
Table Note 104: These types of change are reported only when
option 24 is set to send the Enhanced TI/Sensor status.
Touch Screen Keyboard
(Unsolicited)
This message indicates that the keyboard has detected an error.
9
Table 9-51
Touch Screen Keyboard Status
Field
Number of
Characters
Content
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.
APTRA™ Advance NDC, Reference Manual
9-107
Terminal to Central Messages
Device Status Information
Field
Number of
Characters
Content
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 Central of the functions selected by
the operator after entry to Supervisor mode.
Supervisor Keys
(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-52
Supervisor Keys Status
Field
Number of
Characters
Content
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
2‐3
‘0’
Select menu
‘1’
Replenishment menu
‘2’
Configure menu
‘3’
Access menu
‘4’
Reserved.
‘7’
Exit menu. See Table Note 105.
‘8’
Exit menu. See Table Note 105.
‘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.
9-108
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Field
Number of
Characters
Content
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 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 105: 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 106: 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.
APTRA™ Advance NDC, Reference Manual
9-109
Terminal to Central Messages
Device Status Information
Cardholder Display Alarm
(Unsolicited)
9
An unsolicited message is sent to indicate a state change in the
cardholder display sensor. The reporting of unsolicited message is
controlled through Enhanced Configuration Parameter option 32.
For details, see “Option 32 – Unsolicited Reporting Control” on
page 7‐10.
Table 9-53
Cardholder Display Alarm Status
Field
Number of
Characters
Content
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.
Statement Printer
(Solicited/Unsolicited)
9
A solicited status message is sent to Central if a fault requiring
attention occurs during transaction processing. An unsolicited
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-54
Statement Printer Status
Number of
Characters
Content
g1/
e1
1
Device Identifier Graphic ‘V’.
g2/
e2
1
Transaction/Device Status.
Field
Sol/
Unsol
Code
Description
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.
9-110
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Field
Number of
Characters
Content
S
‘2’
Device not configured
U
‘3’
Statement present in transport
U
‘4’
Cardholder pressed Cancel during a ‘print statement and wait’ function.
g3/
e3
1
Error Severity. Standard code used to make a shut‐down decision.
g4/
e4
Var
Diagnostic Status (M‐status plus M‐data). The M‐status describes the main error found.
g5/
e5
5
This five‐character field indicates the status of the printer paper, paper ribbon, print‐head,
knife and capture bin.
Char
Code
Description
0
‘1’
Sufficient paper
‘2’
Paper low
‘3’
Paper exhausted
‘1’
Ribbon OK
‘2’
Ribbon replacement recommended
‘3’
Ribbon replacement mandatory
‘1’
Print‐head OK
‘2’
Print‐head replacement recommended
‘3’
Print‐head replacement mandatory
‘1’
Knife OK
‘2’
Knife replacement recommended
‘3’
Knife replacement mandatory
‘1’
Capture bin OK
‘4’
Capture bin overfill. See Table Note 108.
1
2
3
4
Table Note 107: If message mode Option Digit 3C is set, the Cancel
key on the cardholder 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 Central. If this option is used,
the Central application must be changed so that it recognises the
new status message.
The statement print that is being performed when the cardholder
presses Cancel is unaffected and is completed as normal.
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
Table Note 108: 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.
Voice Guidance
(Unsolicited)
9
If there is a problem with the voice guidance system and Enhanced
Configuration option 32 is set, this unsolicited message gives the
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-55
Voice Guidance Status
Field
Number of
Characters
Content
e1
1
Device Identifier Graphic ‘a’.
e2
1
Device Status. Indicates there is a problem with the voice guidance system. The value is:
e3
e4
1
Var
Sol/
Unsol
Code
Description
U
‘1’
An error has occurred
Error Severity.
Code
Description
0
No errors
2
Warning
4
Fatal
Diagnostic Status. The diagnostic status is formatted as follows:
Byte
Code
Description
1
00
Audio card is inaccessible
01
Audio card is accessible
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.
2
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
Field
Number of
Characters
Content
3
4
e5
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.
00
No audio jack is present
01
A headset is connected
02
No headset is connected
00
The XML definition file is inaccessible
01
The XML definition file is accessible
Not used.
Note Acceptor
(Solicited/Unsolicited)
This message gives the status of the cash acceptor or recycling unit
in the following situations:
9



Solicited device status messages sent in response to the
following Transaction Reply command messages:
— Refund Cash Deposit
— Deposit Cash
— Deposit Cash and Wait
— 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
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
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, then
the message COUNTS MAY BE INACCURATE is journaled.
Counts in ECB 6 Unsolicited Messages
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:


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
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-114
APTRA™ Advance NDC, Reference Manual
9
Terminal to Central Messages
Device Status Information
Table 9-56
Bunch Note Acceptor Status
Field
(Subfield)
Number of
Characters
Content
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/
e200)
1
Error Code
See Table Note 109
Sol/
Unsol
Code
Description
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 110
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 110
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 110 and Table Note 111
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 110
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
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 112 and Table Note 113
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
Field
(Subfield)
Number of
Characters
Content
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 114, Table Note 115 and Table Note 116
U
‘@’
Suspect notes have been detected.
See Table Note 114, Table Note 115 and Table Note 116
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
(g201/
e201)
50
Escrow counts up to 90 for each of the 50 NDC note types (1 byte each)
See Table Note 117
(g202/
e202)
50
Vaulted counts up to 90 for each of the 50 NDC note types (1 byte each)
See Table Note 117
(g203/
e203)
50
Returned counts up to 90 for each of the 50 NDC note types (1 byte each)
See Table Note 117
(g204/
e204)
1
Total number of notes, up to 90, returned to the exit slot
See Table Note 118
g205/
e205)
1
Total number of notes, up to 90, in the escrow
See Table Note 118
(g206/
e206)
1
Total number of notes, up to 90, just vaulted
See Table Note 118
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/
e207)
Escrow counts for each NDC note type with more than 90 notes
See Table Note 119
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/
e208)
Vaulted counts for each NDC note type with more than 90 notes
See Table Note 119
2
Note type as a hexadecimal value
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
Field
(Subfield)
Number of
Characters
3
(g209/
e209)
Content
Note count as a decimal value, added to the previous note count for that type, to report
the total number of notes entered
Returned counts for each NDC note type with more than 90 notes
See Table Note 119
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/
e210)
3
Total number (decimal value) of notes returned (moved to the exit slot) in excess of 90
See Table Note 120
(g211/
e211)
3
Total number (decimal value) of notes in the escrow or in the top transport in excess of 90
See Table Note 120
(g212/
e212)
3
Total number (decimal value) of notes just vaulted in excess of 90
See Table Note 120
g3/e3
Var
Error severity, as described in “Cash Acceptor Fitness (DIG ‘w’)” on page E‐24
g4/e4
Var
Diagnostic status (M‐status plus M‐data); the M‐status describes the main error found
See Table Note 121 and Table Note 122
g5/e5
Var
Supplies status of all cassettes in the device, as described in “Cash Acceptor Supplies
(DIG ‘w’)” on page E‐16
The status is reported as follows:
Code
Description
‘0’
No change
‘1’
Good state
‘2’
Bin out (missing or removed)
‘3’
Media high (nearly full)
‘4’
Media full (overfull)
Table Note 109: For field ‘g2’, the error code information is obtained
by mapping from XFS to the corresponding error code.
Table Note 110 Counts are cumulative up to the point that notes are
refunded. Then a retract operation will restart the count.
Table Note 111: If a deposit transaction is initiated on an SST
without a BNA, no status message is sent to the host.
Table Note 112: 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
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
or Clear BNA Supervisor options must be performed to resolve this
condition.
Table Note 113: 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 114: 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 115: 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
independently of the actual possible physical location of the suspect
notes.
The ‘w?’ and ‘w@’ messages are not sent in the following situations:


When automatic error recovery is performed at the end of the
transaction.
If no notes of the category have been inserted during the
transaction.
Table Note 116: 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‐57 are added to the message. For details of configuring this
extension to the message, refer to Chapter 5 of the APTRA Advance
NDC, Developer’s Guide.
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-118
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Table 9-57
Additional Cardholder Data
Field
Number of Characters
Content
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 117: 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 118: 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 119: 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 120: 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 121: 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 122 Native diagnostics data is reported if available
(always available on NCR SSTs) otherwise XFS values are mapped
to GBRU M‐Status values.
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
Envelope Dispenser
(Unsolicited)
9
The envelope dispenser reports unsolicited status messages
depending on the value of Enhanced Configuration Parameter
option 23 (see page 10‐18). 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-58
Envelope Dispenser Status
Field
Number of
Characters
Content
e1
1
Device Identifier Graphic ‘\’.
e2
1
Device Status. Indicates whether the last operation was successful.
Sol/
Unsol
Code
Description
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.
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-120
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Cheque Processor
(Solicited/Unsolicited)
9
This message gives details of possible cheque processor responses to
a Transaction Reply command, some of which can be controlled by
Enhanced Configuration option 83. For details, see described on
“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-59
Cheque Processor Status
Field
Number of
Characters
Content
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/
Unsol
Code
Description
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)
(space)
Code
Description
‘’
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-121
Terminal to Central Messages
Device Status Information
Field
Number of
Characters
Content
‘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 123
1
GS
3
Cheque ID. The three‐digit decimal number assigned to each cheque in the range 000‐999
2
Cheque Location
2
Group Separator
See Table Note 124 and Table Note 125
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
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-122
APTRA™ Advance NDC, Reference Manual
Terminal to Central Messages
Device Status Information
Field
g3/
e3
Number of
Characters
Content
Var
Error Severity.
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:
g4/
e4
Var
Value
Description
‘0’
No error / Not configured
‘1’
Routine
‘2’
Warning
‘3’
Suspend
‘4’
Fatal
Diagnostic Status.
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-123
Terminal to Central Messages
Device Status Information
Field
g5/
e5
Number of
Characters
Content
Var
Supplies Status.
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 123: If an error occurs, it is not always possible to
accurately report the location of a cheque.
Table Note 124: 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 125: When the unsolicited message is generated before a
transaction request has been sent to Central, no information on the
cardholder or the cheques is available to Central. However, all local
data is journalled.
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
Coin Dispenser
(Solicited/Unsolicited)
This message gives details of a Coin Dispenser response to a
Transaction Reply Command message. Unsolicited messages
always have a device status of 0.
9
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-60
Coin Dispenser Status
Number of
Characters
Content
g1/
e1
1
Device Identifier Graphic ‘Y’.
g2/
e2
1
See Table
Note 126
Transaction/Device Status. Gives details of a coin dispense operation in response to a
Transaction Reply Command message. The values are:
See Table
Note 127
Sol/
Unsol
Code
Description
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.
Field
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
Characters
Content
S
g3/
e3
‘=’
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
Note 128
Char
Description
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
>+1)
Decimal representation of the number of coins dispensed from hopper type
<n>
Var
Error Severity. Used to make a shut‐down decision. Holds the severity information for the
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:
g4/
e4
Var(14)
Value
Description
‘0’
No error
‘1’
Routine
‘2’
Warning
‘3’
Suspend. This is only used for the coin dispenser core components character
‘4’
Fatal
Diagnostic Status. Maintenance data reported by the coin dispenser.
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
g5/
e5
Number of
Characters
Var(4)
Content
Supplies Status. Holds the replenishable condition for the coin dispenser and the
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 126: For field g2, the error code information is obtained
by mapping the received ActiveXFS event to its corresponding error
code.
Table Note 127: Unsolicited messages always have a device status of
‘0’.
Table Note 128: 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.
Barcode Reader
(Unsolicited)
9
This message gives details of the barcode reader response to a
Transaction Reply command message. Unsolicited device status
messages are sent only if option 48 is set to 1. For more information,
see “Option 48 – Barcode Reader” on page 7‐17.
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
Table 9-61
Barcode Reader Status
Number of
Characters
Content
e1/
g1
1
Device Identifier Graphic ‘f’
e2/
g2
1
Device Transaction Status
Error Code (e200/g200)
Field
e3/
g3
e4/
g4
e5/
g5
Sol/
Unsol
Code
Description
U
‘0’
Good operation but some exception has occurred as detailed in the
accompanying data.
U
‘1’
Barcode reader is inoperative.
1
Field Separator
1
Overall Barcode Reader Error Severity
Code
Description
‘0’
No error / Not configured
‘1’
Routine
‘2’
Warning
‘3’
Suspend
‘4’
Fatal
1
Field Separator
Var
Diagnostic status
Barcode reader diagnostic information
1
Field Separator
0
Supplies Status
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
9-128
APTRA™ Advance NDC, Reference Manual
Table of Contents
Central to Terminal Messages
Chapter 10
Central to Terminal Messages
Overview
10‐1
Command Limitations
Terminal Command Limitations
Customisation Data Command Limitations
EMV Message Class Support
10‐2
10‐2
10‐2
10‐2
Terminal Commands
10‐3
Customisation Data Commands
10‐7
State Tables Load
10‐9
Screen/Keyboard Data Load
Managing Keyboards and Associations
10‐11
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‐45
XML Configuration Download
10‐48
Transaction Reply Command
Terminal Functions for Transaction Completion
10‐51
10‐65
Interactive Transaction Response
Support for Touch‐Screen Emulation
Support for Voice‐Guided Sessions
Message Coordination Number (MCN)
10‐86
10‐86
10‐86
10‐87
EJ Commands
EJ Options and Timers
Acknowledge EJ Upload Block
Acknowledge and Stop EJ
Continuous and Batch Upload Methods
10‐91
10‐91
10‐92
10‐93
10‐94
Message Validation
Valid Message Classes
SST to Central
Central to SST
Command Reject Causes
Other Invalid Parameters
Exits
10‐96
10‐96
10‐96
10‐96
10‐96
10‐102
10‐103
Messages Received in Wrong Operational Mode
Customisation Data Commands
Transaction Reply Command
Terminal Commands
10‐104
10‐104
10‐105
10‐106
Confidential and proprietary information of NCR.
Unauthorised use, reproduction and/or distribution is strictly prohibited.
APTRA™ Advance NDC, Reference Manual
Central to Terminal Messages
Overview
J
Overview
10
This chapter describes Central 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
Note: For any differences on other vendors’ SSTs, 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
10-1
Central to Terminal Messages
Command Limitations
Command Limitations
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.
Terminal Command
Limitations
All terminal commands are processed and acknowledged, with the
exception of the following:
10





Customisation Data
Command Limitations
All data commands are processed and acknowledged, with the
exception of the following:
10



EMV Message Class
Support
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 =)
Enable FREE JDATA (command code >)
Enable image dumping information (command code ?).
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
Advance NDC. For details, 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.
10-2
APTRA™ Advance NDC, Reference Manual
10
Central to Terminal Messages
Terminal Commands
Terminal Commands
10
These commands are sent by Central 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
Field
Number of
Characters
Mandatory/
Optional
Description
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 place the terminal In‐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
Field
Number of
Characters
Mandatory/
Optional
Description
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
Field
g
Number of
Characters
1
Mandatory/
Optional
0
Description
<
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”.
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
Code
Tally (Command Code = 5)
Not supported
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
Field
Number of
Characters
Mandatory/
Optional
Description
‘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
Customisation Data Commands
Message
Class
Message
Sub-Class
Identifier
Command
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
Class
Message
Sub-Class
Identifier
Command
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,
A‐K
Extended Encryption Key Change
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
Field
Number of
Characters
Mandatory/ Optional
Description
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, _,&, >.
Characters 2 to 25 give associated state data.
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-9
Central to Terminal Messages
State Tables Load
Field
Number of
Characters
Mandatory/ Optional
Description
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
Field
Number of
Characters
Mandatory/Optional
Description
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
Table Note 4
Screen Number. Identifies the screen data being transmitted. For
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
Field
Number of
Characters
Mandatory/Optional
Description
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 by Advance NDC.
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.
Managing Keyboards and
Associations
10
It is possible to add, delete and change keyboard layouts and
associations between screens and layouts. The following list gives
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
Field
Number of
Characters
Mandatory/Optional
Description
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
Field
Number of
Characters
Mandatory/Optional
Description
l
3
See Table Note 6
Reserved
m
3
O
See Table Note 6
Supply Mode, Ready Status and Amount Buffer Length Options.
(For details, see page 7‐2)
n
9
O
See Table Note 6
Reserved. Must be 000 000 000.
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
See Table Note 8
Timer Number.
(For a list of timers, see Table 7‐40 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‐91.
Table 10-6
Enhanced Configuration Parameters Load
Field
Number of
Characters
Mandatory/Optional
Description
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
Field
Number of
Characters
i
j
Mandatory/Optional
Description
2
O
See Table Note 11
Option Number. Contains a configuration option number, for which
the values are held in field ‘j’.
3
O
See Table Note 11
Option Code. Specifies the configuration for the function (option
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
Number
Description of Option
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
Field
Number of
Characters
Mandatory/Optional
See Table Note 10
See Table Note 12
Description
33
Simulate Supervisor Mode entry/exit
34
MCN range
35
Report Dual Mode EJ and Hardcopy Backup Unsolicited
Messages
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
80
Alphanumeric State Entry
82
Unsolicited application status
83
Cheque Processing Module
FS
1
See Table Note 9
Field Separator.
k
2
O
See Table Note 11
Timer Number. Contains the timer number. The use of the timers is as
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
Field
Number of
Characters
Mandatory/Optional
Description
‘02’
Close state screen time‐out
‘03’
Communications response time‐out
‘04’ *
Envelope/cheque 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 ‐
59’
Reserved
‘60’
EJ acknowledgement timer
‘61’ *
Barcode reader scan time‐out
‘62’
Reserved
‘63’
Hardware failure screen time‐out
‘64 ‐
67’
Reserved
‘68’
Statement MEI duration time‐out
‘69’
Receipt MEI duration time‐out
‘70’
71’
Reserved
‘72’
DASH card removal time‐out
‘73
‐76’
Reserved
‘77’ *
BNA cash acceptance time‐out
‘78’ *
GBXX cash retract time‐out
‘79 ‐
86’
Reserved
‘87’ *
Cheque capture screen time‐out
‘88 ‐
91’
Reserved
‘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
Field
Number of
Characters
Mandatory/Optional
Description
‘93’
Reserved
‘94’ *
Cheque removal time‐out
‘95’ *
Statement retract time‐out
‘96’ *
Statement present time‐out
‘97 ‐
99’
Reserved.
l
3
O
See Table Note 11
Customisation Data Commands Number of Seconds per Timer Field.
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
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
Field
Number of
Characters
Mandatory/Optional
Description
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
10
Central to Terminal Messages
FIT Data Load
Field
Number of
Characters
Mandatory/Optional
Description
i
Var
M
FIT Data. Specifies control words for local PIN verification, remote
PIN encryption and indirect next state processing. FIT data consists of
a number of three character entries. The valid range is 000 to 255,
representing decimal values 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 “FIT
Data” on page 8‐2..
FS
1
M
Field Separator.
j
3
M
See Table Note 13
FIT Number. As field ‘h’.
k
Var
M
See Table Note 13
FIT Data. As field ‘i’.
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
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
Field
Number of
Characters
Mandatory/ Optional
Description
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
10
Central to Terminal Messages
Configuration ID Number Load
Field
Number of
Characters
Mandatory/ Optional
Description
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
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
Field
Number of
Characters
Mandatory/Optional
Description
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
10
Central to Terminal Messages
Message Authentication Field Selection Load
Field
Number of
Characters
Mandatory/Optional
See Table Note 15
Description
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’
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
Field
Number of
Characters
Mandatory/Optional
Description
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
and Table Note 19
Transaction Reply Field. This field contains the selection data for the
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
Field
Number of
Characters
Mandatory/Optional
Description
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:
See Table Note 15
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’
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
Field
Number of
Characters
Mandatory/Optional
Description
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, 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.
n
11
See Table Note 16
Track 3 Field. This field contains the MAC selection data for magnetic
card track 3.
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
Field
Number of
Characters
Mandatory/Optional
Description
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 the “Selective Message
Authentication” section of Chapter 11, “Security Features”.
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.
This is because of the different EMV field offsets (35 for NDC+ and
36 for Advance NDC). For more information about EMV Integrated
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
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
Field
Number of
Characters
Mandatory/Optional
Description
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
MM = Month
DD = Day
HH = Hour
MM = Minute
(‘00’ ‐ ‘99’)
(‘01’ ‐ ‘12’)
(‘01’ ‐ ‘31’)
(‘00’ ‐ ‘23’)
(‘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
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
10
Central to Terminal Messages
Encryption Key Change
Table 10-11
Encryption Key Change
Field
Number of
Characters
Mandatory/ Optional
Description
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
Field
Number of
Characters
Mandatory/ Optional
Description
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
Field
Number of
Characters
Mandatory/ Optional
Description
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.
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
Field
Number of
Characters
Mandatory/ Optional
Description
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.
‘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.
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
Field
Number of
Characters
Mandatory/ Optional
Description
‘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
‘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.
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
Field
Number of
Characters
Mandatory/ Optional
Description
‘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
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.
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
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.
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
Certificate, base 94 encoded
3 bytes
VAR
M
Certificate type
‘0’ = encryption certificate
‘1’ = verification certificate
1
‘N’ & ‘Q’
No key data
‘O’
Binary data length
Key Load Packet
3 bytes
VAR
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 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
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. T
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
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
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.
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.
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
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
Central to the terminal that contain a MAC field must have this
optional field present.
Table 10-13
Dispenser Currency Cassette Mapping
Field
Number of
Characters
Mandatory/ Optional
Description
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 40.
i1
2
See Table Note 40
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.
APTRA™ Advance NDC, Reference Manual
10-45
Central to Terminal Messages
Dispenser Currency Cassette Mapping Table
Field
Number of
Characters
Mandatory/ Optional
Description
i2
1
See Table Note 40
Cassette Type. Single‐digit ASCII hex value (range 0 to F, types 1 to 4
supported).
i3
5
See Table Note 40
Denomination for Cassette. Five‐digit ASCII numeric value (for
example, 00005 for $5).
FS
1
See Table Note 41
Field Separator.
j
8
See Table Note 41
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 40: 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 terminal only when
the terminal is in out‐of‐service mode or supply/supervisor mode.
If Central transmits a Data Command message and it does not
conform to the format above, or is sent at a time when it is not
expected, 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, dollars and euros, with:




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 c