b66180

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


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.


APTRA™ Advance NDC, Reference Manual

iii

Federal Communications Commission (FCC) Radio Frequency Interference Statement


iv


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 Added that the parameters defined in table entry 9 and 2‐32 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



v

Date

Page


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


vi


Date

Page


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



vii

Date

Page


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


viii


Date

Page


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



ix

Date

Page


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)


x


Date

Page


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, Updated values returned for TI BINS (Alarms) E‐29 (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)



xi

Date

Page


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


xii


Date

Page


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



xiii

Date

Page


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


xiv


Date

Page


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



xv

Date

Page


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


xvi


Date

Page


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



xvii

Date

Page


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 Added byte 19 for Unsolicited Sensors message 9‐107 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 Added additional Table Notes to explain the 10‐21 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’.


xviii


Date

Page


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.


xix

Date

Page


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


xx


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.


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


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.


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


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.


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


xxvi


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.


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


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.


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


xxx


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



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


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



xxxiii

Table of Contents


xxxiv


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.


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 Figure 11‐10 Figure 11‐11 Figure 11‐12 Figure 11‐13 Figure 11‐14 Figure 11‐15 Figure 11‐16 Figure 11‐17 Figure 11‐18 Figure 11‐19 Figure 11‐20 Figure 11‐21

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 Authentication of EPP/HSM Public Keys in Standard Mode ..........................................................................11‐23 HSM/EPP Signature Verification in Standard Mode ..... 11‐23 EPP Authentication Message Sequence in Standard Mode ..........................................................................11‐24 Authentication of EPP/HSM Public Keys in Enhanced Mode ..........................................................................11‐25 EPP Authentication Message Sequence in Enhanced Mode ..........................................................................11‐26 DES Key Load Standard Message Sequence ..........11‐27 DES Key Load Enhanced Message Sequence.........11‐28 Enhanced Signature Remote Key Load Mode: Delete PK‐HOST...................................................................11‐29 Enhanced Signature Remote Key Load Mode: Delete PK‐HOSTRoot...........................................................11‐29 Key Entry Mode Remote Change Sequence...........11‐32 Exchange Certificates.................................................11‐34 Load a Certificate DES Key.......................................11‐35


xxxvi


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



xxxvii

List of Figures


xxxviii


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



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


xl


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



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


xlii


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



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


xliv


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



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


xlvi


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



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


xlviii


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



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


l


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



li

List of Tables


lii


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.


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.


liv



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.


lv


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.


lvi



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.



lvii


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:


lviii


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”.



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.


lx


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



Table of Contents Introducing the Advance NDC System



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.



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


Go In Service Command Message



1-2


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.



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”.


1-4


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.



1-5

Introducing the Advance NDC System Role of the Central Control Application


1-6


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




G ‐ Amount Check State

2‐24

H ‐ Information Entry State Data Entry Overriding Entry Mode, Buffer and Display Parameters Data Entry and Voice Guidance Exiting the Information Entry State Emulated FDKs and Touch‐screen Keyboards Clear Function Key and General‐Purpose Buffers

2‐29 2‐29 2‐29 2‐29 2‐29 2‐30 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




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




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




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






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.



2-1

State Tables Introduction to State Tables

Introduction to State Tables

2

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


2-2



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



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


2-4



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.



2-5


Table Entry Value 000

2

Whether an extension state is optional or mandatory depends on the context and conditions of the transaction flow. Conditions for the use of value ‘000’ are as follows: 



If an extension state is not mandatory and not used in the transaction flow, use the value ‘000’ unless a different value is explicitly specified in the state table description. If an extension state is mandatory, do not use the ‘000’ value.


2-6


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



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.


2-8


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



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”.


2-10


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)



2-11

State Tables B - PIN Entry State

B ‐ PIN Entry State

2

The SST should not enter this state unless the Financial Institution number on the card matches a Financial Institution number in a FIT during the Card Read state. For details, see Chapter 8, “Financial Institution Tables”. This state does not have to be the next state after the Card Read state. When specified in the FIT, PIN verification can take place at either the SST or Central. If verified at Central, the PIN is transmitted in an encrypted form. If local DES PIN verification is specified in the FIT and no DES encryptor is available, the Maximum Bad PINs Next State exit is taken. If DES encrypted PIN transmission is specified in the FIT and no DES encryptor is available, an empty PIN buffer field is included in the Transaction Request message. If the conditions specified in the FIT Data Load message (detailed on page 10‐22) for local PIN verification, remote PIN encryption and indirect next state processing are not met, PIN verification will fail and the Maximum Bad PINs Next State exit is taken. The consumer enters the PIN, which can consist of four to sixteen digits, on the facia keyboard. If the consumer enters fewer than the number of digits specified in the FIT entry, PMXPN, the consumer must press FDK ‘A’ (or FDK ‘I’ if the keys to the left of the consumer screen are enabled) or the Enter key after the last digit has been entered. Pressing the Clear key clears all digits. Table 2-5 B - Pin Entry State Table Entry


Contents

Description

1

1

State Type

‘B’

2

3


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.


2-12


State Tables B - PIN Entry State Table Entry


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.



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”.


2-14


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


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



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


Contents

Description

1

1

State Type

‘D’

2

3


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.


2-16


2

State Tables D - Pre-Set Operation Code Buffer State Table Entry


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


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



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.


2-18


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.



2-19

State Tables E - Four FDK Selection Function State Table 2-9 E - Four FDK Selection Function State Table Entry


Contents

Description

1

1

State Type

‘E’

2

3


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


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


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


2-20


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 2

State Processing

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



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


Contents

Description

1

1

State Type

‘F’

2

3


Display screen that prompts the consumer to enter an amount. This screen is displayed when the SST enters the Amount Entry state.

3

3


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



5

3


6

3


7

3


8

3


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.


2-22


State Tables F - Amount Entry State Table Entry


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.



2-23

State Tables G - Amount Check State

G ‐ Amount Check State

2

This state checks whether the amount entered can be dispensed. This does not check for coins. Two checks are performed: 



Whether the amount held within a specified buffer is a multiple of an identified value. Whether the amount held within a specified buffer is dispensable when taking into account the currency required, denominations available, dispenser status and cassette status. Note counts are ignored.

Note: For dual cash handlers, this state is not supported when the “Amount Check Condition (Range 000 ‐ 003)” on page 2‐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.


2-24


State Tables G - Amount Check State Table 2-11 G - Amount Check State Table Entry


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.



2-25

State Tables G - Amount Check State Table Entry


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


2-26


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.



2-27

State Tables G - Amount Check State Error Message

Cause(s)

ERROR ‐ Invalid Value ‘< field h2 value >’ found in field h2 (at position ) 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 ) 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 ‘’ found in field h4 (at position ) 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.


2-28


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.



2-29

State Tables H - Information Entry State

Emulated FDKs and Touch‐screen Keyboards

2

The SST may support touch‐screen FDK emulation instead of physical FDKs. In this case, eight fixed touch areas are defined on the screen, which the consumer touches instead of pressing the corresponding FDK. The touch areas are enabled/disabled in exactly the same way as the FDKs. For details, see the “FDK Emulation” section in Chapter 4, “Keyboard Data and Layouts”. Alternatively, the SST may support full touch‐screen keyboards, with touch areas defined on the screen for all the required keys. The consumer touches these instead of pressing a key on the keypad or an FDK. For details, see Chapter 4, “Keyboard Data and Layouts”. For information about configuring consumer data entry and the touch‐screen sample keyboards provided with Advance NDC, refer to chapter 5, “Configuring Advance NDC and Associated Components” of the APTRA Advance NDC Developer’s Guide.

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.


2-30


State Tables H - Information Entry State Table 2-14 H - Information Entry State Table Entry


Contents

Description

1

1

State Type

‘H’

2

3


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


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



5

3


6

3


7

3


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


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.



2-31

State Tables H - Information Entry State Table Entry


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.


2-32


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


Contents

Description

1

1

State Type

‘I’

2

3


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.



2-33

State Tables I - Transaction Request State Table Entry


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


2-34



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


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’



2-35



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


2-36




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.


2-37


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


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


2-38


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,



2-39


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


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.


2-40


State Tables J - Close State Table Entry


3

4

Contents

Description

3


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


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.



2-41


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



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



2-43


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



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



2-45

State Tables K - FIT Switch State

K ‐ FIT Switch State

2

Each Financial Institution Table (FIT) contains a next state index number. This index number refers to the next state number that the SST goes to when it exits from the FIT Switch state, if the Financial Institution number on the card matches a Financial Institution number in a FIT. For more details, see the“A ‐ Card Read State” section. The FIT Switch state table contains a list of these next state numbers, together with an index which matches the index numbers of the FITs. For example, if the FIT that has been identified during the Card Read state contains a next state index number of 3, this corresponds to index number 3 in the FIT Switch state table. This index number is found in table entry 5, so the SST goes to the next state number contained in table entry 5 when it exits from this state. Table 2-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


2-46


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


9

State number of the mandatory Extension state. For more information about extension states, see “Extension States” on page 2‐5.



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


2-48


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.



2-49

State Tables L - Card Write State Table 2-27 L - Card Write State Table Entry


Contents

Description

1

1

State Type

‘L’

2

3


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


2-50


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”.



2-51

State Tables M - Enhanced PIN Entry State Table 2-28 M - Enhanced PIN Entry State Table Entry


Contents

Description

1

1

State Type

‘M’

2

3


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


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



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.


2-52


State Tables M - Enhanced PIN Entry State Table Entry


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


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.



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.


2-54


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


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


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.



2-55

State Tables R - Enhanced Amount Entry State

R ‐ Enhanced Amount Entry State

2

Use this state if you wish to use multi‐language screens for enhanced amount entry. The 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.


2-56


State Tables R - Enhanced Amount Entry State Table 2-31 R - Enhanced Amount Entry State Table Entry


Contents

Description

1

1

State Type

‘R’

2

3


Number of display screen prompting an amount entry.

3

3


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


State number to which the application goes if the consumer presses the Cancel key.

5

3


6

3


7

3


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


9

3


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


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



2-57

State Tables R - Enhanced Amount Entry State Table Entry


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.


2-58


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


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





2-59

State Tables S - Language Code Switch State Table Entry


5

Contents

Description

3



6

3



7

3



8

3



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.


2-60


State Tables S - Language Code Switch State Table 2-34 Extension to State S Table Entry


Contents

Description

1

1

State Type

‘Z’

2

3



3

3



4

3



5

3



6‐9

3

Must be 000

Reserved



2-61

State Tables T - Card Read - PIN Entry Initiation State

T ‐ Card Read ‐ PIN Entry Initiation State

2

You can use this state instead of the Card Read state and optionally initiate PIN entry by the consumer at the same time as the card is read. This state must be used if a smart dip card reader is used and smart cards are to be accepted. However, if the smart dip card reader is used without the chip connect bit being set, it will behave as a standard dip reader. In this case, Card Read state A can also be used. A difference between this state and the Card Read state is that this state does not allow the card to be returned early using the Card Return Flag in table entry 8. When used, this state must be the first state table used during transaction processing by assigning state number 000 to it. The SST automatically enters state 000 when put into service. This state performs the same functions as the ‘A’ Card Read state and optionally enables the keyboard for PIN entry while the card is being read, as follows: 





 

The SST displays a screen prompting the consumer to enter a card Optionally, the SST displays a screen prompting the consumer to enter a PIN while the card is read The state table identifies the next state number that the SST goes to following a successful card read The SST displays an error screen if the card cannot be read The state table specifies which card tracks are to be read.

If PIN entry is enabled while the card is being read, the keyboard is enabled for a maximum number of numeric keys (16). You can specify which FDKs are to be active as Accept or Clear keys. The Clear key itself is always active during PIN entry. The Enter key is active if you specify FDK ‘A’ as an Accept key. Note 1: The BAPE (Basic Alphanumeric PINpad Encryptor) does not support this early enabling of the keyboard with secure PIN entry. When the BAPE is configured, the keyboard is not enabled for PIN entry in this state; the keyboard is enabled only in the PIN Entry state.


2-62



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.



2-63


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


Contents

Description

1

1

State Type

‘T’

2

3


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


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


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


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.


2-64


State Tables T - Card Read - PIN Entry Initiation State Table 2-36 Extension to State T Table Entry


Contents

Description

1

1

State Type

‘Z’

2

3


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


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



2-65


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.


2-66


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


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



2-67

State Tables U – Device Fitness Flow Select State Table Entry


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.


2-68



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



2-69


Device

Cassette Type 1 See Table Note 35

Device Number (table entry 2)

015


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


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


017






Table entry 6: 003


018






Table entry 6: 004


095






Table entry 6: 005


2-70


State Tables U – Device Fitness Flow Select State Device Number (table entry 2)

Device


096


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


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.



2-71


Table Note 35: This is available only when Enhanced Configuration option 76 is set to 001

Cash Handlers

2

The following table gives examples of the table entries used in the Device Fitness Flow Select state to query the fitness of different cash handler configurations: Table 2-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 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


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


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 4 identifies the device as the primary cash handler



Table entry 6 identifies cassette type 3


2-72


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


Contents

Description

1

1

State Type

‘V’

2

3


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



5

3



6

3





2-73

State Tables V - Language Select From Card State Table Entry


7

Contents

Description

3



8

3



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.


2-74


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


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



2-75

State Tables X - FDK Information Entry State

X ‐ FDK Information Entry State

2

Table entries 2‐9 in the Extension to this state contain values relating to FDKs ‘A’ ‐ ‘I’. When the consumer selects an FDK, this state places the corresponding value in the General Purpose buffer or Amount buffer that you have specified in Table Entry 7. You can use this 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


Contents

Description

1

1

State Type

‘X’

2

3


Display screen that prompts key selection by consumer.

3

3


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.


2-76


State Tables X - FDK Information Entry State Table Entry


4

Contents

Description

3



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


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.


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


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


2-78


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.



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


Contents

Description

1

1

State Type

‘Y’

2

3


Display screen that prompts the consumer to select keys.

3

3


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


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


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’.


2-80


State Tables Y - Eight FDK Selection Function State Table Entry


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


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.



2-81

State Tables Y - Eight FDK Selection Function State Table 2-45 Extension 1 to State Y Table Entry


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


2-82


State Tables Y - Eight FDK Selection Function State Table 2-46 Extension 2 to State Y Table Entry


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.



2-83

State Tables b - Customer-Selectable PIN State

b ‐ Customer‐Selectable PIN State

2

This state allows the consumer to input a new PIN. It differs from the PIN entry state in the number of retries. The state will prompt for the new PIN twice and will take a good exit if both are the same and the SST checking feature is enabled. If checking is local, the exit will be taken when the two new PINs have been built into the PIN blocks for transmitting. If checking is enabled and the two PINs entered are not the same the consumer will be asked to re‐enter the Customer Selectable PIN (CSP) and the state will not exit. If the FIT specifies that short PIN entry is to be tested for, short PINs will be regarded as one try against the limit specified in the state table. The screen association for this state is derived from the screen specified in table entry 2. The consumer PIN is entered on the facia keyboard and consists of four to sixteen digits. If the number of digits entered is less than the value specified in the FIT entry PMXPN the consumer must press FDK A (or FDK I if the option enabling the keys to the left of the consumer screen is set) or the ‘ENTER’ key on the facia keyboard after the last digit entered. Note that pressing the ‘CLEAR’ key on the facia clears all the digits. Table 2-47 b - Customer-Selectable PIN State Table Entry


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


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


State number to which the SST goes if the consumer presses the Cancel key to stop the CSP transaction.


2-84


State Tables b - Customer-Selectable PIN State Table Entry


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


State number of the Extension state. For more information about extension states, see “Extension States” on page 2‐5.



2-85

State Tables b - Customer-Selectable PIN State Table 2-48 Extension to State b Table Entry


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”.


2-86


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.



2-87

State Tables k - Smart FIT Check State

k ‐ Smart FIT Check State

2

This state is required when chip data is to be used in a FIT check. The Smart FIT Check state is designed to be entered from your own C‐Exit state, such as the example Chip Data Read state, which will have read the chip data from the smart card and placed the data in the magnetic track buffers. For details of the example Chip Data Read state, see Chapter 12, “EMV Smart Card Handling”. The Smart FIT Check state then performs a FIT check for a Smart Card. It is possible to create more than one Smart FIT Check state to accommodate multiple FIT checks. This would allow different FIT checks to be performed on data from the same card. Table 2-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


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)


5

3

Reserved (000)


6

3

Reserved (000)


7

3

Reserved (000)


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.


2-88


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.



2-89


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


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


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.


2-90


State Tables m - PIN & Language Select State Table Entry

No of Chars

4

Contents

Description

3



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


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.



2-91


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


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.


2-92



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



2-93


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,


2-94



refer to Chapter 5, “Configuring Advance NDC and Associated Components” in the APTRA Advance NDC, Developer’s Guide.



2-95

State Tables > - Cash Accept State

> ‐ Cash Accept State

2

If a cash acceptor is present, this state can be used to let the consumer deposit single notes or bunches of notes. Most of the cash deposit transaction is not controlled by Central, as the time taken for a successful cash deposit could exceed the transaction request/reply timers. For this reason, the processing of a cash deposit transaction is performed by the Cash Accept state before a transaction request is sent. Cash acceptor unsolicited messages are sent to inform Central when notes have been processed or when an error occurs. Under state table control, the Cash Accept state performs the 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.


2-96



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



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)”


State number for extension 2 See “Extension 2 to State > (Cash Accept)” on page 2‐101





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



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



2-99


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



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


State number the SST goes to when the Deposit key is selected.

3

3


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



2-101


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)


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.


2-102



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


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



5

3





2-103


No of Chars

6

Contents

Description

3


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)


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’


2-104



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)


3

3

Reserved (000)


4

3

Reserved (000)


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



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)


8

3

Reserved (000)


9

3

Reserved (000)


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.


2-106



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



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


2-108


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.



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.


2-110



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



2-111


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.


2-112



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



2-113


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.


2-114



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)


8

3

Reserved (000)


9

3

Reserved (000)


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.



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



5

3



6

3



7

3



8

3



9

3




2-116


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



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


State number for extension state 1 See “Extension 1 to State z001” on page 2‐119


State number for extension state 2 See “Extension 2 to State z001” on page 2‐120

3

3

3


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.


2-118


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


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.



2-119


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.


2-120



No. of Chars

Contents

Description

1

1

State type

‘Z’ (5AH)

2

3


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


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


State number to which the SST goes if an exception has occurred which may require subsequent action by Central

5

3


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



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


2-122


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



2-123

State Tables z002 – Bunch Cheque Handling State

z002 – Bunch Cheque Handling State

2

The Bunch Cheque Handling state allows control of cheques held in the escrow. This state is used in the following circumstances: 





If the consumer cancels the transaction before making a transaction request and the cheques are to be returned If the consumer fails to take refused cheques and the cheques are to be retracted To deposit the cheques into a bin if an off‐line cheque deposit solution is required,

Table 2-71 z002 - Bunch Cheque Handling State Table Entry

No. of Chars

Contents

Description

1

1

‘z’ (7AH)


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


2-124


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


State number for extension state 1 See “Extension 1 to State z002”



9

3

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



2-125


No. of Chars

7

Contents

Description

3


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


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


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


2-126



No. of Chars

Contents

Description

7

3

Must be 000

Reserved

8

3

Must be 000

Reserved

9

3

Must be 000

Reserved



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.


2-128


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)


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.



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


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 State2 (Base 10 range 000‐254 or 256‐999) (Base 36 range 000‐254 or 256‐ZZZ)


9

3



Table Note 81: For details of defining a dynamic text dictionary control sequence, see “Display Dynamic Text Dictionary Control


2-130


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


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


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



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


2-132


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



2-133

State Tables z004 – Display Cheque Summary State

z004 – Display Cheque Summary State

2

The Display Cheque Summary state displays a summary of the cheques that have been accepted during the Bunch Cheque Accept state (see page 2‐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.


2-134


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)


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



2-135

State Tables z004 – Display Cheque Summary State Table Entry

No. of Chars

7

3

8

9

3

3

Contents

Description











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


2-136



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



2-137


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


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


2-138



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


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



2-139

State Tables z008 – Insert Card State

z008 – Insert Card State

2

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.


2-140


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


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


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


State number of the extension state.



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)


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.


2-142


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



2-143

State Tables z009 – Buffer Validation State

z009 – Buffer Validation State

2

The Buffer Validation state is used to validate data entered by the consumer and held in buffers B, C or the Amount buffer. The validation is achieved using an XML configuration file. For details of the XML configuration file, ValidationRuleSet.xml, and its related schema, refer to Chapter 5, “Configuring Advance NDC and Associated Components” in the APTRA Advance NDC, Developer’s Guide. Examples of states that 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.


2-144


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



2-145

State Tables z009 – Buffer Validation State

The XML configuration file contains the following:

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.


2-146


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



2-147


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 notes and coins are requested, on successful dispense of notes and coins, the state flow goes to the Good Dispense Next State. When only notes are requested and cash dispenser tampering occurs while the consumer is taking the presented notes, the state flow goes to the Good Dispense Next State as the requested notes have been dispensed. When only notes are requested and the consumer does not take the requested notes, the notes are retracted if retract is enabled or left at the SST throat if retract is disabled and the state flow goes to the Good Dispense Next State.

When the cash dispensed is less than the amount of requested cash, 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, 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.


2-148

2



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.


2-149


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.


2-150


2


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



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


9

3

Must be 000

Reserved


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.


2-152


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



2-153

State Tables z013 – Data Copy and Compare State

z013 – Data Copy and Compare State

2

The Data Copy and Compare state is used to process the data in Buffer B, Buffer C and the Amount buffer as follows:  

To compare the data in two buffers for validation purposes To copy the data in one buffer to a second buffer, that is, from a source buffer to a destination buffer.

This state allows data entered by the consumer to be processed locally on the SST rather than by the host. For example, when data is entered by the consumer for the first time in the Information Entry state ‘H’, it is copied to one buffer. When the data is re‐entered, it is copied to another buffer. The two buffers can then be compared using the Data Copy and Compare state. If the values in the two buffers are identical, the data is valid. Table 2-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.


2-154


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”.


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



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.


2-156


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.



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

2

Print data is output in parallel when the device starts the encash operation, and after notes are taken in the refund function, or after an error occurs during a refund. Off‐line receipt printing is called from the following print points:   

OfflineDeposit OfflineRefundSuccess OfflineRefundFailed.

Equivalent journal entries are output by default. For more information about customising or configuring this print output, refer to Chapter 10, “Developing Hooks” in APTRA Advance NDC, Extending the Product.


2-158


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


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.



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


2-160


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


Contents

Description

1

1

State Type


2

3

Sub Type

ʹ017ʹ ‐ Note Mix Selection State

3

3


Number of display screen prompting an amount entry.



2-161

State Tables z017- Note Mix Selection State Table Entry


4

Contents

Description

3


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


State number for extension 2 See “Extension 2 to State z017” on page 2‐164

6

3



7

3



8

3

Reserved (000)


9

3

Reserved (000)




Contents

Description

1

1

State Type

‘Z’

2

3


State number to which the SST goes if the consumer fails to enter an amount within the specified time limit.

3

3


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.


2-162




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



2-163

State Tables z017- Note Mix Selection State Table 2-93 Extension 2 to State z017 Table Entry


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


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


2-164




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.


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


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”


2-166


State Tables z017- Note Mix Selection State Table 2-95 Extension 4 to State z017 Table Entry


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.



2-167

State Tables & - Barcode Read State

& ‐ Barcode Read State

2

The Barcode Read state allows an application to read a barcode. Optionally a filter can be used to select an alternative flow, based on the barcode content. When this state is entered, the screen identified by table entry 1 is displayed and the barcode reader is enabled. The barcode filters are defined in the barcode reader configuration file, which can be downloaded using the XML configuration download described on page 10‐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


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.


2-168


State Tables & - Barcode Read State Table Entry

No. of Chars

4

3

5

6

7

3

3

3

Contents

Description


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.


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 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.


2-169


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, ‘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



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


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


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.



2-171

State Tables & - Barcode Read State Table Entry

No. of Chars

6

Contents

Description

3



7

3



8

3



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.


2-172


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.



2-173


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


4

‘T’ is placed in general purpose buffer B

5

The Time‐Out next state exit from the previous state is taken

6


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.


2-174


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


3


4

‘E’ is placed in general purpose buffer B

5

The Cancel next state exit from the previous state is taken

6


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”.



2-175



2-176


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‐11 3‐12 3‐12 3‐13 3‐13

Formatting Rules for Cardholder Display Screens

3‐14



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


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



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


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






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.



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.


3-2


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ʺ. 3

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

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’.



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.


3-4


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.



3-5


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’

3

Displayed when the terminal captures a card as a result of a card reader failure. When this occurs, the next state is executed, except in a Card Before Cash Transaction reply, when the terminal waits for a


3-6



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.


3-7


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.


3-8



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



3-9

Screen Data Types of Reserved Screen 1B 29 32


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 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


1B 29 32


1B 5B 30 30 30 70

Left margin zero

1B 5B 30 34 30 71


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 1B 5C

Define Downloadable Bit Image


3-10



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 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


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



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.

3

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

3

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



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.



3-13

Screen Data Formatting Rules for Cardholder Display Screens

Formatting Rules for Cardholder Display Screens

3

The formatting rules for all screens that are displayed on the cardholder screen during State Table processing include the following:     

Display characters Control characters Track 1 name display Control codes for special features International currency display format.

For general points to consider when you are preparing screens for display, see “Displaying Pictures” on page 3‐52. Note: Cardholder screens must not be defined in the resrvd.def file.

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


Designator

Single Size Alphanumeric 1

96

‘1’


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

‘?’


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”.


3-14



The following character sets contain customer‐defined characters. Table 3-10 Character Sets with Customer-Defined Characters

Character Set ID


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

The enhanced operator interface can display any character contained in the following character set:

3

Table 3-11 Enhanced Operator Interface: Character Set

Character Set ID


Designator

Single size alphanumeric 1

96

‘1’



3-15


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,:,;,<,=,>,?


3-16



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.



3-17


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.


3-18



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).



3-19


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’


3-20


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.



3-21


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.

3

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

3

3

3

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.


3-22



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


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



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:

b66180

Recommend Documents